Message Description
protel I/O uses this request and response message pair to notify central reservation office (CRO), or management company system about guest stay information. The Statistic Notification Request is a report that may be generated at regular intervals (e.g. End of Day process) by the property management system (PMS). It provides an update of hotel statistics for analysis and may be sent unsolicited by the PMS to the receiving system. The scope of the message provided by the originating system--a minimum of once per day--will be composed of the following four report definitions. These reports are necessary to facilitate the initial build of the revenue management system as well as to support the subsequent daily processing. They are also necessary for the revenue management system to maintain its updated forecasts and decisions, and comprise of the following:
- Reservation and non-reservation related revenue for a specified number of days in the past.
- Reservation and non-reservation related revenue for a specified number of days in the future.
- Room Type occupancy (including pseudo rooms) for a specified number of days in the past.
- Room Type occupancy (including pseudo rooms) for a specified number of days in the future.
Note!
- POS | @FiscalDate is always the Current Business Date of the PMS.
- Statistic | @FiscalDate is always the Date the last End Of Day process has been run for from the perspective of the report
- ALL CurrentDaily Reports do contain the data excluding Statistic | @FiscalDate (from FiscalDate +1 on for by default for 30 days)
- ALL PastDaily Reports do contain the data including Statistic | @FiscalDate (as a default 1 day (FiscalDate)
Sequence
- The Publisher (the system that maintains the statistical data) constructs IO_StatsNotifRQ containing the statistical change(s).
- The Publisher successfully transmits message payload.
- The Subscriber (the system that requires statistical data) receives the message payload.
- The Subscriber processes IO_StatsNotifRQ.
- The Subscriber acknowledges with the IO_StatsNotifRS indicating processing status of the message.
- The Publisher may update their database to log what was last successfully processed by the Subscriber.
Message Attributes
IO_StatsNotifRQ
Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
IO_StatsNotifRQ | 0..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 | Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z). | YYYY-MM-DDThh:mm:ssZ | | |
@Version | decimal | 0..1 | For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. | | | |
@PrimaryLangID | language | 0..1 | The default language of the property | ISO-639-1 (2-char code) | | |
IO_StatsNotifRQ | POS | Source | RequestorID | 1 | Reference to the sending system. | | | ||
@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” | | |
| IO_StatsNotifRQ | POS | Source | BookingChannel | 0..1 | Specifies the booking channel type and whether it is the primary means of connectivity of the source. |  | | ||
| @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. | | | |
| IO_StatsNotifRQ | POS | Source | TPA_Extensions | 0..1 | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | | | ||
| IO_StatsNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 0..1 | Extensions about the transferred POS. | | | ||
| IO_StatsNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Extensions about the transferred POS - specifying details about the hotel's system. | | | ||
| @FiscalDate | date | 1 | Current Business Date of the PMS | yyyy-mm-dd | | |
| IO_StatsNotifRQ | Statistics | Statistic | 1..n | If only sending one report then this element is present once. It is possible to send other reports in the same message by sending this element several times. | | | ||
| @ChainCode | StringLength1to8 | 1 | Chain code for the hotel (only on premise). As it is not possible to define a Chain Code in protelAir, "n/a" will be sent. | | | |
| @HotelName | StringLength1to128 | 0..1 | Hotel code for the hotel. Code value to be agreed by trading partners. | | | |
| @HotelCode | StringLength1to16 | 0..1 | This is the code of the property whose statistics are being updated. | | | |
@HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context (or source of ) the hotel ReferenceGroup codes. | Default value is “protelIO” | | |
| @ReportCode | StringLength1to64 | 0..1 | Empty at this time. |
| | |
| @FiscalDate | date | 1 | The last Valuation date in the message. | This value display the last date of the export. For instance if the CBD is 2020-06-15, triggering message with daysForth= 5, will set the value of 2020-06-19 and triggering the message with daysBack = 5 will set the value of 2020-06-14. | | |
IO_StatsNotifRQ | Statistics | Statistic | StatisticApplicationSets | StatisticApplicationSet | 1..n | This element represents a “row” in the report and so it is repeated for the length of the report. For this report N is the number of days in the report. | | | ||
| @Start | date | 1 | The start date for which the statistics in the sub-elements that follow was collected. | | | |
| @End | date | 1 | The end date for which the statistics in the sub-elements that follow was collected. | | | |
IO_StatsNotifRQ | Statistics | Statistic | StatisticApplicationSets | StatisticApplicationSet | StasticCodes | StatisticCode | 1..n | Element with the categories at which the data has been gathered. This element is Required when sending values at room type level. | | | ||
| @StatCode | StringLength1to64 | 0..1 | Code for the Room Type or the number "0/1" to display if it is a Pseudo Room or not, or "n/a" for Passerby-Account |
| | |
| @StatCategoryCode | OTA_CodeType SCC | 0..1 | Code "Pseudo" Room or Code = 3 for the RoomType | | | |
IO_StatsNotifRQ | Statistics | Statistic | StatisticApplicationSets | StatisticApplicationSet | RevenueCategorySummaries | RevenueCategorySummary | 0..17 | Repeating element for each revenue value in the report (one element for NET and one element for GROSS values) All values correspond to the totals for the date in the @Start attribute defined above. | | | ||
| @RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | If the Amount is 0.00 for all RevenueCategoryCode we don't display this Element | | |
| @Amount | Money | 1 | Amount spent, depending on the RCC if net or gross | | | |
| @Currency | AlphaLength3 | 0..1 | Hotel currency (ref. ISO 4217). | | | |
IO_StatsNotifRQ | Statistics | Statistic | StatisticApplicationSets | StatisticApplicationSet | CountCategorySummaries | CountCategorySummary | 6..10 | | | |||
| @CountCategoryCode | OTA_CodeType CNT | 1 | Code value from Open Travel Alliance Code List Count Category Code (CNT). | Count Category (CNT) Genius_CurrentDailyRoomTypeStatistics_v1
Genius_PastDailyRoomTypeStatistics_v1
| | |
| @SummaryCount | integer | 1 | Number of rooms. | | |
IO_StatsNotifRS
Element | @Attribute | Type | Num | Description | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
IO_HotelStatsNotifRS | 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 | Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z). | YYYY-MM-DDThh:mm:ssZ | | |
@Version | decimal | 0..1 | For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. | | | |
@PrimaryLangID | language | 0..1 | The default language of the property | ISO-639-1 (2-char code) | | |
IO_HotelStatsNotifRS | Success | 1 | This is the annotation that the rate plan message batch was received successfully. It could be combined with warning messages if some of the messages in the batch had issues. | | | ||
IO_HotelStatsNotifRS | Errors | 1 | Indicates an error occurred during the processing of an OpenTravel message. | | | ||
IO_HotelStatsNotifRS | Errors | Error | 1..99 | An error that occurred during the processing of a message. | | | ||
@Type | OTA_CodeType | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType | 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. | | | |
IO_HotelStatsNotifRS | Warnings | 1 | Used when a message has been successfully processed to report any warnings or business errors that occurred. | | | ||
IO_HotelStatsNotifRS | Warnings | Warning | 1..99 | Used in conjunction with the Success element to define a business error. | | | ||
@Type | OTA_CodeType | 1 | Mandatory in OTA. Refers to OpenTravel Alliance EWT list (error warning type). | | | |
@Code | OTA_CodeType | 0..1 | Refers to OpenTravel Alliance list ERR. Should be used wherever possible. | | | |
@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 warning in short. Example: "Insufficient Days in Report" |