| title | layout |
|---|---|
Reservation |
reference |
Message to reserve a hotel.
| SOAPAction | OTA name | Message structure |
|---|---|---|
| book | HotelRes | OTA_HotelResRQ |
OTA_HotelResRQ
| Element | Required | Data Type | Description |
|---|---|---|---|
| HotelReservations | Y | Complex | Concur will only ever send one Hotel Reservation. |
HotelReservation
| Element | Required | Data Type | Description |
|---|---|---|---|
| RoomStays | Y | Complex | A reference to identify the booking. |
| ResGuests | Y | Complex | List of Guests. Concur only supports one guest. |
| ResGlobalInfo | N | Complex | Contains various information that affects the Reservation as a whole, typically list of reward programs (see Memberships). |
RoomStays
| Element | Required | Data Type | Description |
|---|---|---|---|
| RatePlans | Y | Complex | Refer to RatePlans in Availability |
| Timespan | Y | Complex | Refer to Time-span in Availability |
| BasicPropertyInfo | Y | Complex | See Availability |
| Comments | N | Complex | Comments from the user which are passed on to the hotel. |
RatePlan
| Element | Required | Data Type | Description |
|---|---|---|---|
| Guarantee | Y | Complex | Refer to Guarantee in Availability |
Guarantee
| Element | Required | Data Type | Description |
|---|---|---|---|
| GuaranteeType | Y | StringLength1to32 | Refer to GuaranteeType in Availability |
| GuaranteesAccepted | Y | Complex | something |
GuaranteesAccepted
| Element | Required | Data Type | Description |
|---|---|---|---|
| Default | N | Boolean | This is to indicate that the information in the model is the default (e.g. if PaymentCard information is completed then this would be considered the default if the boolean is true). |
| NoCardHolderInfoReqInd | N | Boolean | If true, no credit card holder information is required. If false, it is required.” |
| NameReqInd | N | Boolean | If true, the credit card holder name is required. If false, it is not required. |
| AddressReqInd | N | Boolean | If true, credit card holder address is required. If false, it is not required. |
| PhoneReqInd | N | Boolean | If true, credit card holder phone number is required. If false, it is not required. |
| InterbankNbrReqInd | N | Boolean | If true, the credit card interbank number is required. If false, it is not required. |
| PaymentCard | Y | Complex | see Payment Card in Availability |
PaymentCard
| Element | Required | Data Type | Description |
|---|---|---|---|
| CardType | Y | StringLength1to32 | something |
| CardHolderName | Y | StringLength1to32 | The name on the card |
| CardNumber | Y | Complex | The Card Number |
CardNumber
| Element | Required | Data Type | Description |
|---|---|---|---|
| PlainText | Y | StringLength1to32 | The card number. Only one element of this type is sent. |
Comments
| Element | Required | Data Type | Description |
|---|---|---|---|
| Comment | Y | Complex | Concur will send one Text Element per Comment element. |
Comment
| Element | Required | Data Type | Description |
|---|---|---|---|
| Text | Y | String | Text representing the comment. |
Text
| Element | Required | Data Type | Description |
|---|---|---|---|
| TextFormat | Y | StringLength1to32 | Set to "Plain Text" |
ResGuest
| Element | Required | Data Type | Description |
|---|---|---|---|
| Profiles | Y | Complex | List of Profiles. Concur will only ever send on profile. |
| GuestCounts | Y | Complex | Refer to GetCounts in Availability. |
Profile
| Element | Required | Data Type | Description |
|---|---|---|---|
| Customer | Y | Complex | Element to describer a Customer. |
| CompanyInfo | N | Complex | Element to capture the company name. |
Customer
| Element | Required | Data Type | Description |
|---|---|---|---|
| Gender | N | String | Gender. Concur will send either, "Male", "Female", "Unknown", "Male_NoShare", "Female_NoShare" |
| BirthDate | N | Date | Customer's birthday. |
| PersonName | N | Complex | Element representing a Customers name |
| Telephone | N | Complex | Element representing a telephone number. |
| N | StringLength1to32 | Email address | |
| Address | N | Complex | Refer to Address in Search |
| CitizenCountryName | N | Complex | ISO3166 representation of the user's Country as defined in their Concur Profile |
PersonName
| Element | Required | Data Type | Description |
|---|---|---|---|
| NamePrefic | Y | StringLength1to32 | Customer's First name. |
| GivenName | N | StringLength1to32 | Customer's Given name. |
| Surname | Y | StringLength1to32 | Customer's Surname name. |
Telephone
| Element | Required | Data Type | Description |
|---|---|---|---|
| PhoneNumber | Y | StringLength1to32 | A string representing a customer's phone number. |
CitizenCountryName
| Element | Required | Data Type | Description |
|---|---|---|---|
| Code | Y | StringLength1to32 | ISO3166 Country Code |
CompanyInfo
| Element | Required | Data Type | Description |
|---|---|---|---|
| CompanyName | Y | StringLength1to32 | A string representing a customer's Company. |
ResGlobalInfo
| Element | Required | Data Type | Description |
|---|---|---|---|
| Memberships | N | Complex | A collection of Memberships, provides a list of reward programs like e.g. loyalty cards. |
Memberships
| Element | Required | Data Type | Description |
|---|---|---|---|
| Membership | N | Complex | A recurring element that identifies the type of reward program and customer's identification number for this program. |
Membership
| Element | Required | Data Type | Description |
|---|---|---|---|
| ProgramCode | Y | StringLength1to32 | The code or name of the reward program (e.g. "HotelLoyaltyProgram"). |
| AccountID | Y | StringLength1to64 | The account identification number for this particular member in this particular program. |
TPA_Extensions
| Element | Required | Data Type | Description |
|---|---|---|---|
| NotifyEmails | N | Complex | Email address which can be used by the vendor to contact the customer. |
| CustomFIelds | N | Complex | A reference to identify the booking |
NotifyEmails
| Element | Required | Data Type | Description |
|---|---|---|---|
| NotifyEmails | Y | StringLength1to32 | There will be one NotifyEmails element per email address in the configuration. |
CustomFields
| Element | Required | Data Type | Description |
|---|---|---|---|
| CustomField | Y | Complex | A Custom Field in the form of a key-value pair. |
CustomField
| Element | Required | Data Type | Description |
|---|---|---|---|
| Name | Y | StringLength1to32 | Name of the Custom Field |
| Value | N | StringLength1to32 | Value of the Custom Field |
OTA_HotelResRS
| Element | Required | Data Type | Description |
|---|---|---|---|
| ResResponseType | Y | StringLength1to32 | waiting to see what we actually support here as the list is quite big |
| HotelReservations | Y | Complex | Concur only supports one reservation. All extra reservations will be ignored. |
HotelReservations
| Element | Required | Data Type | Description |
|---|---|---|---|
| HotelReservation | Y | Complex | A reference to identify the booking |
HotelReservation
| Element | Required | Data Type | Description |
|---|---|---|---|
| UniqueID | Y | Complex | A reference to identify the booking max occurrence 2 |
| RoomStays | Y | StringLength1to32 | Refer to RoomStays in Availability |
UniqueID
| Element | Required | Data Type | Description |
|---|---|---|---|
| ID | Y | StringLength1to32 | A reference to identify the booking |
Note: OTA UIT Type "14" should hold the booking UUID, while OTA UIT Type "40" should hold the confirmation number from the supplier.
| Element | Required | Data Type | Description |
|---|---|---|---|
| RatePlans | Y | Complex | something |