Message Description
protel I/O uses a request and response message pair to lookup or validate profiles. This lookup or validation can be used for checked in guests and future reservations via protel.I/O. This functionality can be used by several systems. Different parameter, like Lastname, Email, etc. can be used for the lookup or validation.
Profiles cannot be modified with an inbound OTA_ProfileReadRS. It will not reply with an Error message, if Profile Information is in the inbound request, but nothing is updated. But it is possible to create new Profiles with the OTA_ProfileReadRS, but therefore first a profiles list needs to be requested, and in a second step, only one specific profile is in the response.
Note OnPremise
Message Attributes
OTA_ReadRQ
Element | @Attribute | Type | Num | Description | Comments + Content outbound | pAIR | OnPrem | 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. | "2019-05-16T09:01:25Z" | | | "2019-05-16T09:01:25Z" | |
|
@Version | decimal | 0..1 | Version of the message. | "3.500" | | | "3.500" | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | "en" | | | "en" | |
|
| @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. | "100" | | | "100" | |
|
| @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 | UniqueID | 0..1 | Used to convey the identify of the profile, 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) | 10 | | | | | |
| OTA_ReadRQ | UniqueID | CompanyName | 0..1 | Identifies the company that is associated with the UniqueID | | | | | |||
| @ID | StringLength1to32 | 1 | Unique hotel identifier | | | | | ||
| @CodeContext | StringLength1to32 | 0..1 | Identifies the context of the identifying code | "io.protel.onpremise" | | | | | |
| @CompanyShortName | StringLength1to32 | 0..1 | Used to provide the company common name | | | | | ||
| @TravelSector | OTA_CodeType | 0..1 | The Travel Sector the company is associated with. Refer to OpenTravel Code List Travel Sector (TVS) | | | | | ||
| OTA_ReadRQ | ReadRequests | 0..1 | A grouping of Read Requests by travel vertical. | | | | | |||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | 0..n | A request to read a profile. | | | | | |||
@ProfileTypeCode | OTA_CodeType PRT | 1 | Numeric reference to the type of profile such as guest, company, agent etc. Refer to the OTA Code Lists: Profile Type (PRT) | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | UniqueID | 0..9 | Used to convey the identify of the profile, 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) | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | 0..1 | Detailed customer information used for searching profiles. | | | | | |||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | PersonName | 0..5 | Detailed name information for the customer. | | | | | |||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | PersonName | Surname | StringLength1to64 | 1 | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | PersonName | NamePrefix | StringLength1to16 | 0..3 | This field would be used to pass the guest’s NamePrefix (e.g. salutation). | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | PersonName | GivenName | StringLength1to64 | 0..5 | Given name, first name or names. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | PersonName | MiddleName | StringLength1to64 | 0..3 | The second given name of the person name. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Telephone | 0..99 | Information on a telephone number for the customer. | | | | | |||
| @PhoneNumber | StringLength1to32 | 1 | Telephone number assigned to a single location. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Email | 0..99 | This path is used to transmit the customer details. Details of the company or travel agency use a different path. This field would be used to pass the guest’s email address. | | | | | |||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | 0..99 | Detailed information on an address for the customer. | | | | | |||
| @FormattedInd | boolean | 0..1 | "false" by deault | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | AddressLine | StringLength1to255 | 0..5 | This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s address. More than one line can be sent. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | CityName | StringLength1to64 | 0..1 | This path is used to transmit the customer details. Details of the company or travel agency use a different path. This field would be used to pass the guest’s city. City (e.g., Dublin), town or postal station (i.e., a postal service territory, often used in a military address). | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | StateProv | 0..1 | This path is used to transmit the customer details. Details of the company or travel agency use a different path. This field would be used to pass the guest’s state or province name (e.g., Texas). | | | | | |||
| @StateCode | StateProvCodeType | 0..1 | The standard code or abbreviation for the state, province, or region. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | PostalCode | StringLength1to16 | 0..1 | This path is used to transmit the customer details. Details of the company or travel agency use a different path. This field would be used to pass the guest’s postal | ZIP code. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Customer | Address | CountryName | 0..1 | This path is used to transmit the customer details. Details of the company or travel agency use a different path. This field would be used to pass the guest’s country name (e.g., Ireland). | | | | | |||
| @Code | ISO3166 | 0..1 | ISO 3166 code for a country. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | 0..1 | Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer. | | | | | |||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | CompanyName | 0..3 | Identifies a company by name. | | | Mandatory for a search for Company, TravelAgency, Source or Group profile. | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Email | 0..5 | Electronic email addresses, in IETF specified format. | | | One of Address or Email element is mandatory. | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Address | 0..5 | Information about an address that identifies a location for specific purpose. | | | One of Address or Email element is mandatory. | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Address | AddressLine | StringLength1to255 | 0..5 | When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will sent in first AddressLine occurance. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Address | CityName | StringLength1to64 | 0..1 | City, town or postal station name of the company, travel agency, group or source. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Address | PostalCode | StringLength1to16 | 0..1 | Post office code number of the company, travel agency, group or source. | | | | | ||
| OTA_ReadRQ | ReadRequests | ProfileReadRequest | Company | Address | CountryName | 0..1 | Country name of the company, travel agency, group or source. | | | | | |||
| @Code | ISO3166 | 0..1 | ISO 3166 code for a country. | | | | |
OTA_ProfileReadRS
| Element | @Attribute | Type | Num | Description | Comments + Content outbound | pAIR | OnPrem | Comments + Content inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|---|---|---|
| OTA_ProfileReadRS | 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. | "2019-05-16T09:01:25Z" | | | | | |
@Version | decimal | 0..1 | Version of the message. | "6.002" | | | | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | "en" | | | | | |
| OTA_ProfileReadRS | 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_ProfileReadRS | 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_ProfileReadRS | 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_ProfileReadRS | Errors | 0..1 | A collection of errors - indicates that an error occurred in the processing of the incoming request message. | | | | | |||
| OTA_ProfileReadRS | 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_ProfileReadRS | UniqueID | 0..99 | A unique ID for a hotel/reservation/profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple systems. | | | | | |||
@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) | | | | | ||
| OTA_ProfileReadRS | Profiles | 1 | Container element for a collection of Profiles. | | | | | |||
| OTA_ProfileReadRS | Profiles | ProfileInfo | 1..n | A collection of Profiles or Unique IDs of Profiles | | | | | |||
| OTA_ProfileReadRS | Profiles | ProfileInfo | UniqueID | 0..9 | A unique ID for a profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple system. | | | | | |||
@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) | | | | | ||
| OTA_ProfileReadRS | Profiles | ProfileInfo | Profile | _Profile element | 1 | The target profile | | | | |
Note OnPremise