Message Description
protel I/O uses a request and response message pair to notify external system about a check-out of a reservation if the check-out was processed via the Front Office.
As soon as an invoice is balanced, a KIOSK system can use this message as well to set a reservation to check-out.
Note: Reservation and Profile information can be added to the Message, but neither the reservation nor the profile is modified with an inbound HNTG_HotelCheckOutNotifRQ message. Only the reservation status is changed from "In-house" to "Checked-Out". If something else in the reservation or profile should be modified the OTA_HotelResNotfiRQ or OTA_ProfileModify need to be used.
Message Attributes
HTNG_HotelCheckOutNotifRQ
Element | @Attribute | Type | Num | Description | Content + Comment Outbound | pAir | OnPrem | Content + Comment Inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|---|---|---|
HTNG_HotelCheckOutNotifRQ | 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. | | | | | ||
| @RetransmissionIndicator | boolean | 0..1 | When true, indicates the message is being re-sent. | | | For reservations that are in the past and we receive the flag "true", the invoices are attached. For reservations with current departure date but not yet paid and flag "true" we send a warning. For reservations with current departure date and flag "false" the normal CheckOut will be done. | | | |
HTNG_HotelCheckOutNotifRQ | POS | 0..1 | See: POS_Type in the OpenTravel specification. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | POS | Source | 1..10 | This holds details regarding the requestor. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | POS | Source | RequestorID | 0..1 | An identifier of the entity making 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” | | | | | |
| HTNG_HotelCheckOutNotifRQ | 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. | | | | | ||
| HTNG_HotelCheckOutNotifRQ | POS | Source | TPA_Extensions | 0..1 | Allows extensions to be added to the OpenTravel specification per trading partner agreement. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 1 | Used to transport extensions on POS level for the system which initiated the transaction. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | 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. | | | | | ||
HTNG_HotelCheckOutNotifRQ | UniqueID | 0..1 | Identifies the profile to be modified together with the owner of the profile or an id provided by the client. | | | | | |||
@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" | | | | | |
@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) | | | | | ||
| HTNG_HotelCheckOutNotifRQ | PropertyInfo | 1 | | | | | ||||
@HotelCode | StringLength1to16 | 0..1 | This is the Hotel ID of the property whose availability is being updated. | | | | | ||
| @ChainCode | StringLength1to8 | 0.1 | The code that identifies a hotel chain per management group. The hotel code is decided btw vendors. The attribute is optional if the hotel is independent property that can be identified by the HotelCode attribute . | | | | | ||
@HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context (or source of ) the hotel ReferenceGroup codes. | Default value is “protelIO” | | | | | |
@HotelName | StringLength1to128 | 0..1 | A text field used to communicate the the proper name of the hotel | | | | | ||
| HTNG_HotelCheckOutNotifRQ | AffectedGuests | 1 | A collection of guests and/or reservations that are being checked out of a room. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | AffectedGuests | UniqueID | 1..n | | | | | ||||
@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" | | | | | |
@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) | | | | | ||
| HTNG_HotelCheckOutNotifRQ | Room | 1 | Used to convey information about a single room or a suite comprised of room components. | | | | | |||
@RoomID | StringLength1to64 | 0..1 | (string) room number | | | | | ||
| HTNG_HotelCheckOutNotifRQ | Room | RoomType | 0..1 | Provides details regarding rooms, usually guest rooms. | | | | | |||
| @IsRoom | boolean | 1 | Indicates the room is a sleeping room if 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 | A code value that indicates the type of room for which this request is made. | | | | | ||
| @RoomType | StringLength1to16 | 0..1 | A code value that indicates the type of room for which this request is made. | | | | | ||
| HTNG_HotelCheckOutNotifRQ | Room | RoomType | RoomDescription | 0..1 | Textual information regarding the room. | | | | | |||
| @Name | StringLength1to64 | 0..1 | Defines the information that is being sent. | | | | | ||
| HTNG_HotelCheckOutNotifRQ | Room | RoomType | RoomDescription | Text | 0..n | Formatted text content. | | | | | |||
| @TextFormat | PlainText | 0..1 | Indicates the format of text used in the description. | | | | | ||
HTNG_HotelCheckOutNotifRQ | Room | TelephoneExtensions | 0..1 | A collection of telephone extensions. | | | | | |||
HTNG_HotelCheckOutNotifRQ | Room | TelephoneExtensions | TelephoneExtension | 1..n | A telephone extension that is part of a single room or a suite of component rooms. | | | | | |||
HTNG_HotelCheckOutNotifRQ | Room | HKStatus | HTNG_HousekeepingStatusType | 0..1 | The current House Keeping status of the room. | | | | | ||
HTNG_HotelCheckOutNotifRQ | 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_HotelCheckOutNotifRQ | Room | TPA_Extensions | px:RoomStatusExtensions | 0..1 | | | | | ||||
| @EffectiveDate | dateTime | 0..1 | Indicates the starting date. | | | | | ||
| @ExpireDate | dateTime | 0..1 | Indicates the ending date. | | | | | ||
HTNG_HotelCheckOutNotifRQ | Room | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo | 0..1 | Attribute for room status transfer from PBX to PMS. | | | | | |||
@RoomStatus | RoomStatusType | 0..1 | The current room status defined with an integer. (would normally be 1 = Dirty) | | | | | ||
HTNG_HotelCheckOutNotifRQ | HotelReservations | 1 | Used to convey information about the arriving reservation and its supporting guest information. | | | | | |||
HTNG_HotelCheckOutNotifRQ | HotelReservations | HotelReservation | 1..n | A hotel reservation | | | | | |||
HTNG_HotelCheckOutNotifRQ | HotelReservations | HotelReservation | ResGuests | 0..1 | 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. | | | | | |||
HTNG_HotelCheckOutNotifRQ | HotelReservations | 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. | | | | | ||
| 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). | | | | | |||
| HotelReservation | ResGuests | ResGuest | TPA_Extensions | px:GuestStayExtensions | 0..1 | _GuestStayExtensions | | | | | |||
HTNG_HotelCheckOutNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | 0..1 | A collection of Profile objects or Unique IDs of Profiles. | | | | | |||
HTNG_HotelCheckOutNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | 1..n | A collection of Profiles or Unique IDs of Profiles. | | | | | |||
| HTNG_HotelCheckOutNotifRQ | HotelReservations | 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). | | | | | ||
HTNG_HotelCheckOutNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | 1 | Provides detailed information regarding either a company or a customer profile. | | | | |
HTNG_HotelCheckOutNotifRS
Element | @Attribute | Type | Num | Description | Content + Comment Outbound | pAIR | OnPrem | Content + Comment Inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|---|---|---|
HTNG_HotelCheckOutNotifRS | 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_HotelCheckOutNotifRS | 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_HotelCheckOutNotifRS | Warnings | 1 | Collection of warnings. | | | |||||
HTNG_HotelCheckOutNotifRS | 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_HotelCheckOutNotifRS | Errors | 1 | A collection of errors that occurred during the processing of a message. | | | |||||
| HTNG_HotelCheckOutNotifRS | 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." | | | ||||
| HTNG_HotelCheckOutNotifRS | TPA_Extensions | 0..1 | | | ||||||
| HTNG_HotelCheckOutNotifRS | TPA_Extensions | DocumentExtensions | 0..1 | A collection of document extensions | | | |||||
| HTNG_HotelCheckOutNotifRS | TPA_Extensions | DocumentExtensions | DocumentData | 1..99 | A base64 encoded document. For instance an invoice | "Base64 encoded PDF document" | | | ||||
| @Type | StringLength1to32 | 1 | The type of the document | "Invoice" | | | |||
| @ID | string | 1 | The internal Folio ID of the document in the sending system | "4711" | | | |||
| @ID_Context | StringLength1to32 | 1 | The identifier of the sending system | "protelIO" | | |