Message Description
The process being facilitated is that of having one or more (losing) guest profile/s set obsolete and merge into one (winning) other. This process has to be done generally, but not exclusively by a Customer Relationship System (CRM) and a Property Management System (PMS).
Note!
Each record in this table has been flagged to indicate whether an element or attribute is currently implemented in protel AIR or protel MPE/SPE (On-Prem). Functionality enhancements are ongoing, so it is important to check the SMP site documentation for regular updates.
Message Attributes
OTA_ProfileMergeRQ
| Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAIR | OnPrem | Comments + Contents inbound | pAir | onPrem |
|---|---|---|---|---|---|---|---|---|---|
OTA_ProfileMergeRQ | 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-06-05T09:12:14Z" | | | |
@Version | decimal | 0..1 | Version of the message. | | | | | ||
@PrimaryLangID | language | 0..1 | Default language of the property. | | | | | ||
OTA_ProfileMergeRQ | POS | Source | 1 | Provides information on the source of a request. | | | | | |||
OTA_ProfileMergeRQ | 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_ProfileMergeRQ | 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. | | | | | ||
| OTA_ProfileMergeRQ | UniqueID | 1..9 | Identifies the profile for which information is being merged from the profiles identified by the ObsoleteProfileID together with the owner of the profile or an id provided by the client. |
| | | | |||
@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) | | | "1" = Profile | | | |
@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. | | | "2918" | | | |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” | | | "protelIO" | | |
| @Instance | 0..1 | Used to identify the sending service | "com.demo_crm.crm" | | | "com.demo_crm.crm" | | | |
| OTA_ProfileMergeRQ | ObsoleteProfileID | 1..99 | The profile(s) to be merged into the profile represented by UniqueID |
| | | | |||
@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) | | | "1" = Profile | | | |
@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” | | | "protelIO" | | |
OTA_ProfileMergeRQ | Profile | _Profile element | 1 | The target profile |
|
| | |
OTA_ProfileMergeRS
| Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAIR | OnPrem | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|---|---|---|
OTA_ProfileMergeRS | 1 | This message provides the acknowledgement of a merge request | | | |||||
@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. | | | ||||
OTA_ProfileMergeRS | Errors | 0..1 | Indicates 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. | | | |||||
OTA_ProfileMergeRS | Errors | Error | 1..n | An error that occurred during the processing of a message. | | | |||||
@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_ProfileMergeRS | Success | 0..1 | The presence of the empty Success element explicitly indicates that the OpenTravel versioned message succeeded. | | | |||||
OTA_ProfileMergeRS | Warnings | 0..1 | Used in conjunction with the Success element to define one or more business errors. | | | |||||
OTA_ProfileMergeRS | Warnings | Warning | 1..n | 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." | | | ||||
OTA_ProfileMergeRS | UniqueID | 1..9 | Used to convey the identity of the created profile, the owner of the profile, or an id provided by the client. | | | |||||
@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_ProfileMergeRS | ObsoleteProfileID | 1..9 | Used to convey the identity of the created profile, the owner of the profile, or an id provided by the client. | | | |||||
@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” | | |