Message Description
protel I/O uses a request and response messages pair to update Partner systems with Guest Stay Information. This message set assumes a PUSH model whereby the sending system (Publisher) is typically a hotel Property Management System (PMS) and the responding system (Subscriber) is responsible for accumulating this information. The message is sent unsolicited as an update of guest data and provides a point-in-time snapshot of individual guest records (usually triggered during a hotel's End-of-Day process).
Sequence
1. Publisher sends a stay information notification request to the Subscriber system.
2. Subscriber uses this information to update guest stay information data in their system.
3. Subscriber responds with an appropriate response message which may include warnings from business processing rules or errors if the request did not succeed.
All message responses include the request identification. Responses may be returned in any order.
Message Attributes
OTA_HotelStayInfoNotifRQ
Element | @Attribute | Type | Num | Description outbound | Content outbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
OTA_HotelStayInfoNotifRQ | 1 | Root element of the message. |
|
| ||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. |  |
| |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | |
| |
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | |
| |
@Version | decimal | 0..1 | Version of the message. | |
| |
@PrimaryLangID | language | 0..1 | Default language of the property. | |
| |
OTA_HotelStayInfoNotifRQ | POS | 1 | The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner. |
|
| ||
OTA_HotelStayInfoNotifRQ | POS | Source | 1 | This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. |
|
| ||
OTA_HotelStayInfoNotifRQ | POS | Source | RequestorID | 1 | This identifies the system that is sending the request. |
|
| ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) |
|
| |
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” |
|
|
OTA_HotelStayInfoNotifRQ | POS | Source | BookingChannel |
|
| ||||
| @Primary | boolean | 0..1 | Indicates whether the enumerated booking channel is in the primary means of connectivity used by the source |
|
|
|
@Type | OTA_CodeType BCT | 1 | Indicates the type of booking channel per the Open Travel BCT codes. |
|
| |
OTA_HotelStayInfoNotifRQ | POS | Source | TPA_Extensions | 1 | A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA) |
| | ||
OTA_HotelStayInfoNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 1 |
| | |||
OTA_HotelStayInfoNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 1 |
| | |||
@FiscalDate | date | 1 | Hotel's today date | "yyyy-MM-dd" |
| |
OTA_HotelStayInfoNotifRQ | StayInfos | 1 | A collection of stay Information. |
|
| ||
@HotelName | StringLength1to128 | 1 | Full name of the property which the transferred stay information belongs to. |
|
| |
@HotelCode | StringLength1to16 | 1 | This is the Hotel Cloud ID for which the stay information are being transferred. |
|
| |
@HotelCodeContext | StringLength1to32 | 1 | Used to identify where the ID comes from | "protelIO" |
|
|
@ChainCode | StringLength1to8 | 0..1 | Chain name indicates the chain to which the property belongs. |
|
| |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | ReservationID | 1 | The confirmation number of the reservation associated with the stay. |
|
| ||
@Type | OTA_CodeType UIT | 1 | Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT).
|
|
| |
@ID | StringLength1to32 | 1 | ID is the internal confirmation number. |
|
| |
@ID_Context | StringLength1to32 | 0..1 | Used to identify where the ID comes from. | “protelIO” |
|
|
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | 1 | A collection of RevenueCategory classes that detail the categories of revenue data associated with the StayInfo report. |
|
| ||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | 1..n | The classifications of revenue data associated with the StayInfo report. A RevenueCategory provide a way to classify guest financial stay data and analyze guest spending for a certain category (e.g., food and beverage, room, etc.) |
|
| ||
| @RevenueCategoryCode | OTA_CodeType RCC | 0..1 | Describes the type of revenue generated. Refer to OpenTravel Code List Revenue Category Code (RCC). |
|
| |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | SummaryAmount | 1 | Total amount of the specific revenue category. |
|
| ||
@Amount | Money | 1 | Total amount of the specific revenue category. |
|
| |
@CurrencyCode | AlphaLength3 | 1 | Currency of total amount | ISO 4217 |
|
|
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | RevenueDetails | 1 | A collection of revenue details. |
|
| ||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | RevenueDetails | RevenueDetail | 1..n | Contains line item details about specific revenue transactions. |
|
| ||
@ReferenceID | StringLength1to8 | 0..1 | Internal ID of booking item. |
|
| |
@TransactionDate | date | 0..1 | Date item was booked. | "YYYY-MM-DD" R |
|
|
@Description | StringLength1to64 | 0..1 | Description of item booked. | e.g. "Logis", "Dinner", . |
|
|
@PMSRevenueCode | StringLength1to8 | 0..1 | Numeric value referencing the internal transaction account code of item booked. |
|
| |
@CurrencyCode | AlphaLength3 | 0..1 | Indicates the currency of the amount of the revenue category. | ISO 4217 |
|
|
@Amount | Money | 1 | Amount of item booked. |
|
| |
@RatePlanCode | StringLength1to64 | 0..1 | Rate Plan short name |
| | |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | RevenueDetails | RevenueDetail | FolioIDs | 1 | Collection of strings (recommended length - 20 characters) indicating the PMS folio identifiers associated with this revenue detail item. | OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories / |
|
| |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | RevenueCategories | RevenueCategory | RevenueDetails | RevenueDetail | FolioIDs | FolioID | StringLength1to32 | 1..99 | The PMS folio identifier associated with this revenue detail item. These string values reference an Invoice ID, Reservation ID, Guest ID or TAA Grp | <FolioID>InvID|408616</FolioID> <FolioID>ResID|2387956</FolioID> <FolioID>GstID|5374993</FolioID> <FolioID>TAAGrp|ROOMS</FolioID> |
|
|
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | 0..1 | A hotel reservation |
|
| ||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | 1..n | A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | | | ||
| @ArrivalTime | time | 0..1 | This represent the time of guests arrival. | |
| |
| @DepartureTime | time | 0..1 | This represent the time of guests departure. | |
| |
| @PrimaryIndicator | boolean | 0..1 | When true indicates this is the primary guest. |
| |
|
| @ResGuestRPH | RPH_Type | 0..1 | Used to refer to the guest associated with this reservation. | | | |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | TPA_Extensions | 0..1 | Could be used to pass additional Profile data upon agreement between partners (specific Keys or codes, for instance). | | | ||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | TPA_Extensions | px:GuestStayExtensions | _GuestStayExtensions | | | |||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | Profiles | 0..1 | A collection of Profile objects or Unique IDs of Profiles. | |
| ||
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | 1..n | A collection of Profiles or Unique IDs of Profiles. | |
| ||
| OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | UniqueID | 0..9 | Identifies the profile to be modified together with the owner of the profile or an id provided by the client. | |
| ||
@ID | StringLength1to32 | 1 | A unique identify 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. | | | |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | |
|
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). | |
| |
OTA_HotelStayInfoNotifRQ | StayInfos | StayInfo | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | 1 | Provides detailed information regarding either a company or a customer profile. | |
|
OTA_HotelStayInfoNotifRS
Element | @Attribute | Type | Num | Description | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
OTA_HotelStayInfoNotifRS | 1 | Root element of the message. | | | ||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. | | | |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | |||
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | | | |
@Version | decimal | 0..1 | Version of the message. | | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | | | |
OTA_HotelStayInfoNotifRS | Sucess | Warnings | 1..n | Results of message processing | | | ||
| OTA_HotelStayInfoNotifRS | Warnings | Warning | 1..n | Used when a message has been successfully processed to report any warnings or business errors that occurred. | | | ||
@Type | OTA_CodeType EWT | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided." | |||
| OTA_HotelStayInfoNotifRS | Errors | Error | 1..n | Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. | | | ||
@Type | OTA_CodeType EWT | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided." | |||
| OTA_ HotelStayInfoNotifRS | StayInfos | 0..1 | | | |||
| OTA_ HotelStayInfoNotifRS | StayInfos | StayInfo | 1..99 | | | |||
OTA_ HotelStayInfoNotifRS | StayInfos | StayInfo | ReservationID | 0..1 | Used to convey the identity of the reservation transferred. | | | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | | | |
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | | | |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” | | |