Table of Contents | ||||
---|---|---|---|---|
|
...
This message will be sent by the partner PMS application. The main payload of the OTA_HotelResNotifRQ message is a list of HotelReservation elements. The content may vary for different partner PMS applications depending on the application features and functionality supported by the respective partner PMS applications
IMPORTANT NOTE: It should be noted that no PCI sensitive data should be communicated within the OTA_HotelResNotifRQ. We ask that you implement a regex check across all elements and attributes to check for Credit Card numbers and strip them out before sending to SMX. There are various resources available that detail how to do this.
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ | 1 | Mandatory | |
@EchoToken | 1 | A reference for additional message identification, assigned by the requesting host system. | |
@TimeStamp | 1 | ISO 8601 encoded timestamp indicating the creation date and time of the message. | |
@Version | 1 | The OpenTravel message version indicated by a decimal value. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation | 1 | Mandatory | |
@ResStatus | 1 | Indicates the current status of the reservation.
| |
@CreateDateTime | 1 | This is the date when the reservation was first made. Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00' | |
@CreatorID | 0..1 | ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation. | |
@LastModifyDateTime | 0..1 | This indicates the last date and time when the reservation was last modified. Mandatory if a message relating to this reservation has already been uploaded. Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00' | |
@LastModifierID | 0..1 | Identifies the last software system or person to modify a record. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS | 1 | Mandatory | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source | 1..10 | This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. Provides information on the source of a request. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / RequestorID | 1 | This identifies the system which is sending the reservation. This element must appear in the first Source element. | |
@ID | 1 | The ID used will be agreed by the trading partners and remain the same throughout the messages. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / BookingChannel | 0..2 | Name of the Booking Channel. Must be sent in a separate 'Source' element to the 'RequestorID'. | |
@Type | 1 | The type of booking channel (e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), Sales and Catering System (SCS), Property Management System (PMS), Central Reservation System (CRS), Tour Operator System (TOS), Internet and ALL). Refer to OpenTravel Code List Booking Channel Type (BCT). | |
@Primary | 0..1 | Indicates the primary booking source. Mandatory if there are multiple BookingChannel sources. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / BookingChannel / CompanyName | 1 | Identifies the company that is associated with the booking channel. | |
@Code | 0..1 | Identifies a company by the company code. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / UniqueID | 1 | Mandatory | |
@ID | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays | 1 | Mandatory | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay | 1..n | One instance of RoomStay per room booked. | |
@MarketCode | 0..1 | The code that relates to the market being sold to (e.g., the corporate market, packages). | |
@SourceOfBusiness | 0..1 | To specify where the business came from e.g. radio, newspaper ad, etc. | |
@PromotionCode | 0..1 | Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign (TV, Press, Internet etc). |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total | 1 | Mandatory in both OpenTravel Alliance and HTNG if an instance of RoomRate is passed. | |
@AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |
@AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes | 0..1 | A collection of taxes. | |
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
@Amount | 0..1 | A monetary amount of tax. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax | 0..99 | An individual tax per tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. | |
@Code | 0..1 | The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT). | |
@Amount | 0..1 | A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value). | |
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
@Percent | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of the tax | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / ServiceRPHs | 0..1 | A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached this RoomRate. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / ServiceRPHs / ServiceRPH | 1..n | This is a reference placeholder used as an index for a service to be associated with this stay | |
@RPH | 1 | Provides a unique reference to the service. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / TimeSpan | 1 | Mandatory | |
@Start | 1 | The ending value of the time span (Check in date) | |
@End | 1 | The starting value of the time span (Check out date) |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total | 1 | Mandatory | |
@AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |
@AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total / Taxes | A collection of taxes relating to the total reservation cost. | ||
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
@Amount | 0..1 | A monetary amount of tax. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total / Taxes / Tax | 0..99 | This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. | |
@Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |
@Amount | 0..1 | A monetary amount of tax. | |
@CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |
@Percent | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of Discount Reason. |
...
Element | Attribute | Number | Description |
---|---|---|---|
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / BasicPropertyInfo | 1 | Mandatory | |
@ChainCode | 0..1 | The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. | |
@BrandCode | 0..1 | A code that identifies the brand or flag of a hotel, often used for independently-owned or franchised properties who are known by a specific brand. | |
@HotelCode | 1 | The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. | |
@HotelName | 0..1 | A text field used to communicate the proper name of the hotel. |
...
Element | @Attribute | Num | Description / Contents |
---|---|---|---|
OTA_HotelResNotifRS | 1 | Mandatory | |
@EchoToken | 1 | As per OpenTravel Alliance Specifications. | |
@Version | 1 | Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG in order to be able to use the same message. | |
@TimeStamp | 1 | Time of the transaction. | |
@ResResponseType | 0..1 | Given that the OTA_HotelResNotifRQ message is used for additions, modifications and cancellations, this attribute is used to replicate whether the original message was an addition, a modification or a cancellation and does not refer to the status of the transaction itself but rather to the nature of the original message. The only three enumerations allowed will therefore be: Committed, Modified and Cancelled. In this case Committed would be used. | |
OTA_HotelResNotifRS / Errors / Error | 1..99 | Mandatory ONLY if Success element is not sent. Only needed if RQ message was unsuccessful. | |
@Type | 1 | Mandatory in OTA. Refers to OpenTravel Alliance EWT list (error warning type). | |
@Code | 0..1 | Refers to OpenTravel Alliance list ERR. Should be used wherever possible. | |
@RecordID | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation failed, the uniqueID of the rejected reservation should be reported here. | |
OTA_HotelResNotifRS / Success | 1 | Mandatory if no Errors were sent. This is the annotation that the reservation batch was received successfully. It could be combined with warning messages if some of the reservations in the batch had issues. | |
OTA_HotelResNotifRS / Warnings / Warning | 0..99 | Can be used in conjunction with Success message. | |
@Type | 1 | Refers to OpenTravel Alliance EWT list (error warning type). | |
@Code | 0..1 | Refers to OpenTravel Alliance list ERR. Should be used wherever possible. | |
@RecordID | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation has a warning, the uniqueID of that reservation should be reported here. | |
OTA_HotelResNotifRS / HotelReservations / HotelReservation | 1 | Mandatory | |
@ResStatus | 0..1 | Indicates the current status of the reservation. | |
OTA_HotelResNotifRS / HotelReservations / HotelReservation / UniqueID | 1 | Mandatory | |
@Type | 0..1 | Type is assigned values from the UIT code list. If the original system was a CRS: | |
@ID | 1 | ID is the CRS confirmation number (or PMS number if the reservation was originated in the PMS). |
...