Message Description
protel I/O uses a request and response message pair to lookup or validate reservations. This lookup or validation can be used for checked in reservation or future reservations via protel.I/O. This functionality can be used by several systems. Different parameter, like internal Reservation ID, Lastname, Givenname, etc. can be used for the lookup or validation.
Reservation cannot be modified with an inbound OTA_ResRetrieveRS. It will not reply with an Error message, if Reservation Information is in the inbound request, but nothing is updated.
The message can be used to pull list of reservations over a period of time. The number of reservations in the response is also limited by the @MaxResponses attribute. This functionality should be used with caution since the responce is likely to result in a very large message. For better performance it is recommended to limit the response size as much as possible.
Note OnPremise
Message Attributes
OTA_ReadRQ
Element | @Attribute | Type | Num | Description | Comments + Content inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
OTA_ReadRQ | 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. | "1.00" | | |
@Version | decimal | 0..1 | Version of the message. | "2019-05-16T09:01:25Z" | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | | | |
| @MaxResponses | integer | 0..1 | A positive integer value that indicates the maximum number of responses desired in the return. By default 10 (OnPrem only) if not given. | "10" ! Recommended to use for short list of reservations to prevent performance issues | | |
| @ReturnListIndicator | boolean | 0..1 | To indicate if a list should always be returned even when only one reservation matches the input criteria. The default is to return the reservation record. If set to true, then always return a list. |
| | |
| OTA_ReadRQ | POS | 1 | Point of Sale (POS) identifies the party or connection channel making the request. | | | ||
| OTA_ReadRQ | POS | Source | 1..10 | This identifies the destination system (hotel) | | | ||
| OTA_ReadRQ | POS | Source | RequestorID | 1 | 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_ReadRQ | POS | Source | BookingChannel | 1 | This element is used to pass the booking source for the reservation. To send secondary booking channel information an additional Source element needs to be sent. | | | ||
| @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_ReadRQ | ReadRequests | 0..1 | A grouping of Read Requests by travel vertical. | | | ||
| OTA_ReadRQ | ReadRequests | ReadRequest | 0..n | To retrieve a hotel reservation when the booking reference is known. |
| | ||
| OTA_ReadRQ | ReadRequests | ReadRequest | UniqueID | 1 | The booking reference for the reservation. | | | ||
@ID | StringLength1to32 | 1 | The ID will transfer the ReservationID. | | | |
@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) | | | |
| OTA_ReadRQ | ReadRequests | HotelReadRequest | 0..n | To retrieve a hotel reservation when the booking reference is not known. | | | ||
| @HotelCode | StringLength1to16 | 0..1 | Global Hotel ID | "3152" | | |
| OTA_ReadRQ | ReadRequests | HotelReadRequest | SelectionCriteria | 0..n | Specific search by ResStatus, start and end date, etc. | | | ||
| @GroupCode | StringLength1to16 | 0..1 | ID of the Reservation Group (Group block) | "2365" | |  |
| @DateType | NMTOKEN | 0..1 | Type of the given dates. |
| | |
| @Start | date | 1 | The start of the given time frame depending on @DateType | "2019-05-24"  Caution: Keep the timeframe as short as possible to avoid performance issues! Preferred maximum is one day. | | |
| @End | date | 1 | The end of the given time frame depending on @DateType | "2019-05-25" Caution: Keep the timeframe as short as possible to avoid performance issues! Preferred maximum is one day. | | |
| @ResStatus | PMS_ResStatusType | 0..1 | The reservation status of the reservation | | | |
| OTA_ReadRQ | ReadRequests | HotelReadRequest | Verification | 0..1 | This is to be used for verification that the record being sent is the specific record requested. | | | ||
| OTA_ReadRQ | ReadRequests | HotelReadRequest | Verification | PersonName | 0..1 | Detailed name information for the request. | | | ||
| @Surname | StringLength1to16 | 1 | Last name | | | |
| @GivenName | StringLength1to64 | 0..5 | Given name, first name | | | |
| OTA_ReadRQ | ReadRequests | HotelReadRequest | TPA_Extensions | 0..1 | Allows extensions to be added to the Open Travel Alliance specification per trading partner agreement. | | | ||
| OTA_ReadRQ | ReadRequests | HotelReadRequest | TPA_Extensions | ReadRequestExtensions | 0..1 | | | |||
| OTA_ReadRQ | ReadRequests | HotelReadRequest | TPA_Extensions | ReadRequestExtensions | Room | 0..1 | | | |||
| @RoomID | 0..1 | The room ID of the reservation | "305" | | |
OTA_ResRetrieveRS
Element | @Attribute | Type | Num | Description | Comments + Content outbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
OTA_ResRetrieveRS | 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. | "1.00" | | |
@Version | decimal | 0..1 | Version of the message. | "2019-05-16T09:01:25Z" | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | | | |
| @MoreIndicator | boolean | 0..1 | Boolean flag which indicates, that parts of the result set exceed the number of @MaxResponses |
| | |
| OTA_ResRetrieveRS | Success | 0..1 | An element that is not intended to contain any data. 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. | | | ||
| OTA_ResRetrieveRS | Warnings | 0..1 | A collection of warnings. Indicates that the recipient of the request message identified one or more business-level warnings/errors but the message itself was successfully processed | | | ||
| OTA_ResRetrieveRS | Warnings | Warning | 1..999 | The detailed description of the warning | "No reservations found (2018-02-15 - 2018-02-15)" | | | |
@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_ResRetrieveRS | Errors | 0..1 | A collection of errors - indicates that an error occurred in the processing of the incoming request message. | | | ||
| OTA_ResRetrieveRS | Errors | Error | 1..99 | The detailed description of the error NOTE: There cannot be a Success element if there is an error. | "Invalid Hotelcode 2524" | | | |
@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_ResRetrieveRS | ReservationsList | 0..1 | Contains zero or more HotelReservation elements | | | ||
| OTA_ResRetrieveRS | ReservationsList | HotelReservation | 0..n | Contains the reservations that match the requested criteria. | | | ||
OTA_ResRetrieveRS | ReservationsList | 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_ResRetrieveRS | ReservationsList | HotelReservation | ResGuests | ResGuest | TPA_Extensions | 0..1 | Allows to transfer additional details about the reservation extension. | | | ||
OTA_ResRetrieveRS | HotelReservation | ResGuests | ResGuest | TPA_Extensions | px:GuestStayExtensions | 0..1 | _GuestStayExtensions | | | ||
| OTA_ResRetrieveRS | ReservationsList | HotelReservation | ResGuests | ResGuest | TPA_Extensions | ReservationGroupExtensions | 0..1 | Allows to transfer additional details about the reservation extension for groups. | | | ||
| @GroupID | string | 0..1 | ID of the group | | | |
| @GroupName | string | 0..1 | Name of the group | | | |
| @PrimaryInd | boolean | 0..1 | When true indicates this is the group lead. |
| | |
OTA_ResRetrieveRS | ReservationsList | HotelReservation | ResGuests | ResGuest | Profiles | 0..1 | A collection of Profile objects or Unique IDs of Profiles. | |
| ||
OTA_ResRetrieveRS | ReservationsList | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | 0..1 | A collection of Profile objects or Unique IDs of Profiles. | |
| ||
| OTA_ResRetrieveRS | ReservationsList | 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_ResRetrieveRS | ReservationsList | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | 1 | Provides detailed information regarding either a company or a customer profile. | |
|