| WS Parameter | Required | Description | Additional Comments | Sample Data | Xpath for XML Message |
|---|---|---|---|---|---|
| UserName | Y | Username assigned by Cvent Passkey that has been granted API access. | reglinkapi | /CreateReservationRQ/Security/Login/UserName | |
| Password | Y | Password associated with API Username. | passkey1 | /CreateReservationRQ/Security/Login/Password | |
| PartnerID | Y | Unique ID which represents the Partner Profile or “Organization” in Cvent Passkey. | Assigned to all new partners at the time of setup in production. | 136260 | /CreateReservationRQ/Security/PartnerID |
| Version | Y | Identifies the Event Connector API Message version used. | Each Event Connector API Message will contain a version. Please note the most current supported version may differ between message types. | 4.00.02 | /CreateReservationRQ/Message/Version |
| Mode | Y | Communication Mode. Synchronous is the only mode supported for this API call. | Synchronous=S | S | /CreateReservationRQ/Message/Mode |
| OP | Y | API Operation/Message Type | CreateReservation | /CreateReservationRQ/Message/OP | |
| Service | Y | API Service Name | CreateReservation | /CreateReservationRQ/Message/Service | |
| Locale | Y | Locale for Guest | Please see the standard listing of locales or contact integrations@Cvent.com for a listing. | EN_US | /CreateReservationRQ/Message/Locale |
| HotelReservation | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /HotelReservation[@RoomStayReservation=“true”] | ||||
| RoomType | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /RoomStays/RoomStay/RoomTypes/RoomType[@NumberOfUnits=“1”] | ||||
| GuestCount | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /RoomStays/RoomStay/GuestCounts/GuestCount[@AgeQualifyingCode=“1” Count=“2”] | ||||
| ResGuest | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /ResGuests/ResGuest[@ResGuestRPH=“1”] | ||||
| NamePrefix | N | Attendee’s title | 1. Bishop 2. Brother 3. Dr. 4. Father 5. Frau 6. Herr 7. M. 8. Miss 9. Mlle. 10. Mme. 11. Mr. 12. Mrs. 13. Ms. 14. Prof. 15. Rabbi 16. Rep. 17. Rev. 18. Sister 19. Sr. 20. Sra. 21. Srta. | Mr. | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/NamePrefix |
| LastName | Y | Attendee’s Last Name | Smith | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname | |
| MiddleInitial | N | Attendee’s Middle Name / Initial | P | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName | |
| FirstName | Y | Attendee’s First Name | Simon | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName | |
| AddressLine | Y | Attendee’s Address Line 1 | 221 Crescent Street | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine | |
| AddressLine | N | Attendee’s Address Line 2 | Building 17 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine | |
| City | Y | Attendee’s City | Waltham | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CityName | |
| StateProv | Y | Attendee’s 2-letter State/Province code | 2-letter code | MA | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/StateProv |
| PostalCode | Y | Attendee’s Zip/Postal Code | 02453-123 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode | |
| CountryName | Y | ISO 3166 2-letter code | US | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code | |
| Telephone | Y | Attendee’s Phone Number | Type “1” = Business | Telephone | Y |
| Type “3” = Fax | 781-373-4100 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber | Type “3” = Fax | 781-373-4100 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber |
| Y | Email Address | noreply@Cvent.com | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo | ||
| EmployeeInfo | N | Attendee’s professional title/position | Software Engineer | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo | |
| CompanyName | N | Attendee’s Company or Organization | Cvent Solutions Inc. | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName | |
| EarliestDate | Y | Arrival date in format YYYY-MM-DD | 2018-12-01 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@EarliestDate | |
| LatestDate | Y | Departure date in format YYYY-MM-DD | 2018-12-15 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@LatestDate | |
| ExtReferenceID | Y | External Registration company record identifier (e.g., registration confirmation number) | This number should be unique per hotel room reservation. | ABC-123 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ExtReferenceID |
| EventID | Y | This is a unique code for a specific event, for example the “6th Annual Widget Maker’s Convention” would have a single event ID. This can be found in Cvent Passkey under the Event Home -> Website -> Event Website -> View All URLs and exposed at the end of the website URL ”…EventID=####### | 146021 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/EventID | |
| AttendeeCode | Y | This is a unique id which represents each Attendee Type within an Event. This can be used for General Attendees, VIP, Staff, etc. and can be found in Cvent Passkey under the Event Home -> Advanced Options -> Attendee Types. These codes are labeled as “Access Code” in the UI for each configured Attendee Type and typically formatted similar to “TMBATT041414” | RTEATT0117 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/AttendeeCode | |
| BlockID | Y | This is a unique id which represents a specific Room Type and Attendee Type combination within an Event. This can be found in Cvent Passkey under the Event Home -> Advanced Options -> Blocks. | 104585385 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BlockID | |
| HotelID | |||||
| HowBooked | Y | How the reservation was booked; numeric value between 100 and 105. | 100 = Phone 101 = Internet 102 = Email Form 103 = Fax Form 104 = Mail Form 105 = Other | 101 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/HowBooked |
| ReceivedFrom | Y | A free-text field to note the person or system creating the reservation | A Reg Company, Inc. | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ReceivedFrom | |
| ResSplitFolioTypeId | Y | Indicates whether a multi-guest reservation should be created as a “Share-With” or “Accompanied-By” reservation. | 101= Non-Split Folio (Accompanying Guests) 102 = Split Folio (Share-Withs) | 102 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ResSplitFolioTypeId |
| SmokingAllowed | Y | Smoking Request Yes/No | 0 = No 1 = Yes | 1 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/SpecRequestPref[@SmokingAllowed=“1”] |
| SpecRequestPref | N | Special Requests | Guest requests King Bed | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/SpecRequestPref | |
| PhysChallFeaturePref | Y | Handicap Access Required Flag | 0 = No 1 = Yes | 0 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/PhysChallFeaturePref@PhysChallFeature |
| MembershipID | N | Use Hyatt Gold Passport | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Memberships | ||
| PaymentType | Y | Type of Payment | Credit Card = cc Other Payment = other | CC | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/PaymentType |
| Note: If PaymentType=cc, then complete the following three parameters with the prefix “cc” in them and skip the seven tags which are prefixed with “oPay”. Similarly, if PaymentType=other, then skip the four parameters prefixed with “cc” and complete the seven “oPay”-prefixed parameters. | |||||
| CardType | Y | Visa = VI MasterCard = MC American Express = AX Diners Club = DC Discover = DS | VI | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardCode | |
| CardNumber | Y | Credit card number; no spaces | 4444333322221111 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardNumber | |
| ExpireDate | Y | Credit Card Expiration Date | 1130 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@ExpireDate | |
| CardHolderName | Y | Alexander Thomson | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard/CardHolderName | ||
| oPayAmt | Y | Amount paid | 105.99 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayAmt@Amount | |
| oPayDate | Y | Payment date in format YYYY-MM-DD | 2013-07-18 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayDate | |
| oPayReferenceNum | Y | External Reference Number, if any. | ABC-123 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayReferenceNum | |
| oPayCheckNum | Y | Check number. | 6549 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayCheckNum | |
| oPayReceived | Y | Flag acknowledging whether payment was received; 0 = no, 1 = yes. | 1 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayReceived | |
| oPayComments | Y | Comments; use this parameter to signify “bill-to-master” | Attendee lodging charges being billed to master account | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayComments | |
| oPayName | Y | Name of person on payment. | Credit Card Name | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName | |
| Note: Complete the following BillTo information regardless of payment type chosen above. | |||||
| OPayName | Y | Bill To Last Name | Jones | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName | |
| OPayName | Y | Bill To Middle Initial | M | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName | |
| OPayName | Y | Bill To First Name | Sam | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName | |
| AddressLine | Y | Bill To Address Line 1 | 123 Main Street | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine | |
| AddressLine | Y | Bill To Address Line 2 | Apt. 1 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine | |
| CityName | Y | Portsmouth | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CityName | ||
| StateProv | Y | 2-letter State/Province code | NH | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/StateProv | |
| PostalCode | Y | Zip / Postal Code | 03801 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/PostalCode | |
| CountryName | Y | Country Code - ISO 3166 2-letter code (e.g., US) | US | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CountryName@Code | |
| PhoneNumber | Y | Bill to Phone Number | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BillPhone@PhoneNumber | ||
| Additional Guests | |||||
| Surname | Y | Last name of first additional guest. | Bailey | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname | |
| MiddleName | N | Middle initial of first additional guest. | T | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName | |
| GivenName | Y | First name of first additional guest. | Baxter | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName | |
| NamePrefix | Y | Title of first additional guest. | Mr. | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/NamePrefix | |
| EmployeeInfo | N | Business Title / Position of first additional guest. | Analyst | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo | |
| CompanyName | N | Company / Organization of first additional guest. | Cvent Solutions Inc. | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName | |
| Division2 | N | Name of division of first additional guest. | |||
| AddressLine | Y | Address line 1 of first additional guest. | 1 Cate Street | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine | |
| AddressLine | N | Address line 2 of first additional guest. | 4th Floor | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine | |
| CityName | Y | City of first additional guest. | Portsmouth | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CityName | |
| StateProv | Y | 2-letter code; state abbreviation of first additional guest. | NH | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/StateProv | |
| PostalCode | Y | Zip code of first additional guest. | 03802 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode | |
| CountryName | Y | ISO 3166 2-letter code (e.g., US); country code for first additional guest. | US | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code | |
| Telephone | Y | Business Telephone Number of first additional guest. | 603-555-1212 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber | |
| Telephone | Y | Fax Number of first additional guest. | 603-555-1213 | /CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“3”]/@ PhoneNumber |
Last updated on