Message Description
Protel uses this message set when a checked-in guest is reassigned to another room.
Upon completion of the guest(s) Room Move process, a Room Stay Information Provider sends a notification message to subscribing systems indicating the room move process is complete.
A Room Stay Information Consumer may use this notification message to provision the current room's systems for housekeeping and the new room's system for guest(s) arrival.
The message contains affected guest(s), stay and room share details for the original room and the new room.
The message is to be sent after the Room Stay Information Provider has completed a guest room move process. As a result of it, the following should happen:
The original room is updated to a vacant state, which may include de-provisioning the room
The new room is provisioned for guest arrival
Message Attributes
HTNG_HotelRoomMoveNotifRQ
Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAIR | onPrem |
|---|---|---|---|---|---|---|
HTNG_HotelRoomMoveNotifRQ | 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) |
|
|
HTNG_HotelRoomMoveNotifRQ | POS | 0..1 | Point of Sale (POS) identifies the party or connection channel making the request. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | POS | Source | 1 | Provides information on the source of a request. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | POS | Source | RequestorID | 0..1 | Identifies the system that is sending the request. |
|
| ||
@ID | StringLength1to32 | 1 | A unique identifying value assigned by the creating system. In the context of protel IO, this will be the unique hotel ID where the profile was created. |
|
| |
@Type | OTA_CodeType UIT | 1 | A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists Unique ID Type (UIT) |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value | “protelIO” |
|
|
HTNG_HotelRoomMoveNotifRQ | 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 the primary means of connectivity used by the source. |
|
|
|
@Type | OTA_CodeType BCT | 1 | The type of booking channel. Refer to the OTA code lists Booking Channel Type (BCT). |
|
| |
HTNG_HotelRoomMoveNotifRQ | POS | Source | TPA_Extensions | 0..1 | Allows extensions to be added to the OpenTravel specification per trading partner agreement. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 0..1 | Used to transport extensions on POS level for the system which initiated the transaction. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Used to transport extensions on POS level for the property which holds the reservation. |
|
| ||
@FiscalDate | date | 0..1 | This attribute transfers the actual date of the PMS system. | yyyy-mm-dd OnPrem: by default not displayed, but if needed, it can be enabled |
|
|
HTNG_HotelRoomMoveNotifRQ | UniqueID | 0..1 | The unique identifier element allows the trading partners to uniquely identify each. |
|
| ||
@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). |
|
| |
HTNG_HotelRoomMoveNotifRQ | PropertyInfo | 1 | Hotel Reference - 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. The hotel chain code is decided between vendors. |
|
| |
@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 proper name of the hotel. |
|
| |
HTNG_HotelRoomMoveNotifRQ | AffectedGuests | 1 | A collection of guests and / or reservations that are impacted by a room move. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | AffectedGuests | UniqueID | 1..n | The unique identifier element allows the trading partners to uniquely identify each. |
|
| ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTrave Code list UIT. |
|
| |
@ID | StringLength1to32 | 1 | A unique identifying value assigned by the creating system. |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier. | "protelIO" |
|
|
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | 1 | This represents where the reservation/guest is moving from. NOTE: If this is a single reservation, Room information must be supplied, but reservations/guest information will not. If it is a shared room, the occupants remaining in the room must be represented in HotelReservations. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | 1 | Used to convey information about a single room or a suite comprised of room components. |
|
| ||
@RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room |
|
| |
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | RoomType | 0..1 | Container of details about the room/suite |
|
| ||
@IsRoom | boolean | 0..1 | Indicates the room is a guest room when true. |
|
|
|
@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 | Indicates the category of the room. |
|
| |
@RoomType | StringLength1to16 | 0..1 | A code value that indicates the type of room for which this request is made e.g - double, king etc. Values may use the Hotel Descriptive.Content table or a codes specific to the property or hotel brand. |
|
| |
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | RoomType | RoomDescription | 0..1 | Textual information regarding the room. |
|
| ||
@Name | StringLength1to64 | 0..1 | In case the description repeats, this will allow to define the information that is being sent. | e.g. "Description" |
|
|
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | RoomType | RoomDescription | Text | 1 | Formatted text content. |
|
| ||
@TextFormat | PlainText | 0..1 | Indicates the format of the text used in the description |
|
| |
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | HKStatus | HTNG_HousekeepingStatusType | 0..1 | The current House Keeping status of the room. |
|
| |
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | TPA_Extensions | px:RoomStatusExtensions | 0..1 | Full reservation period |
|
| ||
@EffectiveDate | dateTime | 0..1 | Date of arrival (CI date) | e.g. 2019-03-21T12:00:00+01:00 |
|
|
@ExpireDate | dateTime | 0..1 | Departure Date (CO date) | e.g. 2019-03-22T12:00:00+01:00 |
|
|
HTNG_HotelRoomMoveNotifRQ | SourceRoomInformation | Room | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo | 0..1 | Current room status |
|
| ||
@RoomStatus | RoomStatusType | 0..1 | The current room status defined with an integer. (would normally be 1 = Dirty) |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | 1 | This represents where the reservation/guest is moving to. NOTE: If a room share is being created, this must represent all reservations in the share and one reservation must be indicated as primary. |
|
| ||
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | 1 | Used to convey information about single room or a suite comprised of room components |
|
| ||
@RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | RoomType | 0..1 | Section could be repeated if there is a room move during the stay. |
|
| ||
@IsRoom | boolean | 1 | Indicates the room is a guest room when true. |
|
| |
@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 | 0..1 | Indicates the category of the room. |
|
| |
@RoomType | StringLength1to16 | 0..1 | A code value that indicates the type of room for which this request is made e.g - double, king etc. Values may use the Hotel Descriptive.Content table or a codes specific to the property or hotel brand. |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | RoomType | RoomDescription | 0..1 | Textual information regarding the room |
|
| ||
@Name | StringLength1to64 | 0..1 | In many case the description repeats , this will allow you to define the information that is being sent , typically used when multiple occurrences of Paragraph Type are being sent . |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | RoomType | RoomDescription | Text | 1 | Formatted text content |
|
| ||
@TextFormat | PlainText | 0..1 | Indicates the format of the text used in the description |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | HKStatus | HTNG_HousekeepingStatusType | 0..1 | The current House Keeping status of the room. |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | TPA_Extensions | 0..1 | A place holder in the schema to allow for additional elements and attributes to be included if required . |
|
| ||
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | TPA_Extensions | RoomStatusExtensions | 0..1 | Full reservation period |
|
| ||
@EffectiveDate | dateTime | 0..1 | Check in date |
|
| |
@ExpireDate | dateTime | 0..1 | Check out date |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | Room | TPA_Extensions | HouseKeepingInfo | 0..1 | Current room status |
|
| ||
@RoomStatus | RoomStatusType | 0..1 | The current room status defined with an integer. (would normally be 1 = Dirty) |
|
| |
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | HotelReservations | HotelReservation | 1 |
|
| |||
HTNG_HotelRoomMoveNotifRQ | DestinationRoomInformation | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | Profile | 0..1 |
|
|
HTNG_HotelRoomMoveNotifRS
Element | @Attribute | Type | Num | Description | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
HTNG_HotelRoomMoveNotifRS | 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 | 1 | Version of the message |
|
| |
@PrimaryLangID | language | 1 | Default language of the property. Example: "en" |
|
| |
HTNG_HotelRoomMoveNotifRS | 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_HotelRoomMoveNotifRS | Warnings | 0..1 | Collection of warnings. |
|
| ||
HTNG_HotelRoomMoveNotifRS | Warnings | Warning | 1..n | Used when a message has been successfully processed to report any warnings or business errors that occurred. |
|
| ||
@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.Example: "A rate plan 'XY' was not found for the code provided." |
|
| |
HTNG_HotelRoomMoveNotifRS | Errors | 1 | A collection of errors that occurred during the processing of a message. |
|
| ||
HTNG_HotelRoomMoveNotifRS | 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 | 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.Example: "A rate plan 'XY' was not found for the code provided." |
|
|