Message Description
protel I/O uses this request and response message pair to notif external systems about room status. This message can be used by external system to send Room status (cleaning) transfer via phone, PBX to PMS.
Message Attributes
HTNG_HotelRoomStatusSearchRQ
Element | @Attribute | Type | Num | Description | Comments + Content inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
HTNG_HotelRoomStatusSearchRQ | 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. |
|
| |
| HTNG_HotelRoomStatusSearchRQ | POS | 0..1 | Point of sale object. | | | ||
| HTNG_HotelRoomStatusSearchRQ | POS | Source | 1..10 | Provides information on the source of a request. | | | ||
| HTNG_HotelRoomStatusSearchRQ | POS | Source | RequestorID | 0..1 | This identifies the system that is sending the room status update. | | | ||
| @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 | | | |
| @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” | | |
| HTNG_HotelRoomStatusSearchRQ | POS | Source | BookingChannel | 0..1 | This element is used to pass the booking source for the message. To send secondary booking channel information an additional Source element needs to be sent. | | | ||
| @Type | OTA_CodeType BCT | 1 | Indicates the type of booking channel. Refer to OpenTravel Code List Booking Channel Type (BCT). | | | |
| @Primary | boolean | 0..1 | Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent. |
| | |
HTNG_HotelRoomStatusSearchRQ | PropertyInfo | 1 | The HotelReferenceGroup identifies a specific hotel. The codes used are agreed upon by trading partners. | | | ||
| @ChainCode | StringLength1to8 | 0..1 | The code that identifies a hotel chain or management group. | n/a | | |
| @HotelCode | StringLength1to16 | 0..1 | The code that uniquely identifies a single hotel property. | | | |
| @HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context. | protelIO | | |
| @HotelName | StringLength1to128 | 0..1 | A text field used to communicate the name of the hotel. | "protel_IO_Testhotel_pAir_2000053" | | |
HTNG_HotelRoomStatusSearchRQ | Room | 0..1 | Used to convey information about a single room or a suite comprised of room components. | | | ||
@RoomID | StringLength1to64 | 0..1 | (string) room number | "0820" | | |
HTNG_HotelRoomStatusSearchRQ | Room | TelephoneExtensions | 0..1 | A collection of telephone extensions. | | | ||
HTNG_HotelRoomStatusSearchRQ | Room | TelephoneExtensions | TelephoneExtention | string | 1..n | A telephone extention that is part of a single room or a suite of component rooms. | "0820" | | |
HTNG_HotelRoomStatusSearchRQ | Room | HKStatus | HTNG_HousekeepingStatusType | 0..1 | The current housekeeping status of the room. | | | |
| HTNG_HotelRoomStatusSearchRQ | Room | RoomType | 0..1 | Provides details regarding rooms, usually guest rooms. | | | ||
| @IsRoom | boolean | 1 | Indicates the room is a sleeping room if true. | IsRoom = "true" - regular room IsRoom = "false" - pseudo room | | |
| @RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. | | | |
| @RoomTypeCode | StringLength1to64 | 1 | A code value that indicates the type of room for which this request is made. | "SUP" | | |
| @RoomType | StringLength1to16 | 0..1 | A code value that indicates the type of room for which this request is made. | | | |
| @NumberOfUnits | integer | 1 | The number of rooms that have been combined to create this room type. | | | |
| HTNG_HotelRoomStatusSearchRQ | Room | RoomType | RoomDescription | 0..1 | Textual information regarding the room. | "Superior King Studio" | | | |
| @Name | StringLength1to64 | 0..1 | Defines the information that is being sent. | | | |
| HTNG_HotelRoomStatusSearchRQ | Room | RoomType | RoomDescription | Text | 0..n | Formatted text content. | | | ||
| @TextFormat | PlainText | 0..1 | Indicates the format of text used in the description. | | | |
HTNG_HotelRoomStatusSearchRQ | Room | 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. | | | ||
HTNG_HotelRoomStatusSearchRQ | Room | TPA_Extensions | px:RoomStatusExtensions | 0..1 | Holds additional information about a room's status. | | | ||
HTNG_HotelRoomStatusSearchRQ | Room | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo | 0..1 | Attribute for room status transfer from PBX to PMS. | | | ||
@RoomStatus | RoomStatusType | 0..1 | An integer that shows the current room status. | | |
HTNG_HotelRoomStatusSearchRS
Element | @Attribute | Type | Num | Description | Comments + Content outbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
HTNG_HotelRoomStatusSearchRS | 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. Example: "en" | | | |
HTNG_HotelRoomStatusSearchRS | Success | 1 | Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors. | | | ||
HTNG_HotelRoomStatusSearchRS | Warnings | 0..1 | Collection of warnings. | | | ||
HTNG_HotelRoomStatusSearchRS | Warnings | Warning | 1..999 | 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." | | | |
HTNG_HotelRoomStatusSearchRS | Errors | 1 | A collection of errors that occurred during the processing of a message. | | | ||
HTNG_HotelRoomStatusSearchRS | Errors | Error | 1..99 | 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." | | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | 1 | | | |||
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | 0..n | | | |||
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | 1 | Used to convey information about a single room or a suite comprised of room components. | | | ||
| @RoomID | StringLength1to64 | 0..1 | (string) room number | "0820" | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | RoomType | 0..1 | Provides details regarding rooms, usually guest rooms. | | | ||
| @IsRoom | boolean | 1 | Indicates the room is a sleeping room if true | IsRoom = "true" - regular room IsRoom = "false" - pseudo room | | |
| @NumberOfUnits | integer | 1 | The number of rooms that have been combined to create this room type. | | | |
| @RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. | | | |
| @RoomType | StringLength1to16 | 0..1 | A code value that indicates the type of room for which this request is made. | | | |
| @RoomTypeCode | StringLength1to16 | 1 | A code value that indicates the type of room for which this request is made. | "SUP" | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | RoomType | RoomDescription | 0..1 | Textual information regarding the room | | | ||
| @Name | StringLength1to64 | 0..1 | Defines the information that is being sent | | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | RoomType | RoomDescription | Text | 0..n | Formatted text content. | | | ||
| @TextFormat | PlainText | 0..1 | Indicates the format of text used in the description. | | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | HKStatus | 0..1 | The current housekeeping status of the room | HTNG_HousekeepingStatusType | | | |
| @Value | string | 0..1 | The current housekeeping status of the room | | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | TelephoneExtensions | 0..1 | A collection of telephone extensions | | | ||
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | TelephoneExtensions | TelephoneExtension | 0..1 | A telephone extension that is part of a single room or a suite of component rooms | | | ||
| @Value | string | 1..n | The telephone extension number in the room | "0820" | | |
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | 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. | | | ||
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | TPA_Extensions | RoomStatusExtensions | 0..1 | Holds additional information about a room's status. | | | ||
| HTNG_HotelRoomStatusSearchRS | RoomInformationList | RoomInformation | Room | TPA_Extensions | RoomStatusExtensions | HouseKeepingInfo | 0..1 | Attribute for room status transfer from PBX to PMS. | | | ||
| @RoomStatus | RoomStatusType | 0..1 | An integer that shows the current room status. | IO Types#RoomStatusType | | |