Message Description

protel I/O uses a request and response message pair to notify external system that one or more guest profile/s set obsolete and merge into one other. Additionally, external partners can use the message pair to inform protel, that one or more profile should be merged. These profiles will not automatically be merged in protel. The hotel has to run the merge process, but the profiles are already preselected in protel.

Image Added

Note: Profiles cannot be modified with an inbound OTA_ProfileMergeRQ. It will not reply with an Error message, if Profile Information is in the inbound request, but nothing is updated.

Message Attributes

OTA_ProfileMergeRQ

Element \| @Attribute	Type

OTA_ProfileMergeRQ

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).

Image Removed

Info

title	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.

OTA_ProfileMergeRQ - Attributes

Element | @Attribute

	Num	Description	Comments + Contents outbound	pAIR	OnPrem	Comments + Contents inbound	pAir	onPrem
OTA_ProfileMergeRQ		1	Root element of the message.
@EchoToken

@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.

@TimeStamp0..1Indicates 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.

YYY-MM-DDThh;mm;ssZ

(e.g.: 2019-06-11T06:14:42Z)

YYY-MM-DDThh;mm;ssZ

(e.g.: 2019-06-11T06:14:42Z)

@Version

1

For all Open Travel versioned messages,the version of the message is indicated by a decimal value .Version="4"

Version="4"

@CorrelationID

1

Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the WEB service message.

0B486ADD-005D-4DFC-AEA9-83D6964E2646

OTA_ProfileMergeRQ | POS

1

@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

Point of Sale (POS) identifies the party or connection channel making the request

.
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

@ID

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.

reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@Type10 - "Hotel"

@ID

StringLength1to32

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)

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

10 - "Hotel"


@ID_Context	StringLength1to32	1	Used to identify

the source of the identifier. For both outbound (from protel IO) and inbound (to protel IO) request messages, this must carry the string value

where the ID comes from.

“protelIO”

"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.

source

true
false

"true"
"false"


@Type

0..

OTA_CodeType BCT

1

The

Global distribution system (GDS)
Alternative distribution system (ADS)
Sales and catering system (SCS)
Property management system (PMS) – used by protel
Central reservation system (CRS)
Tour operator system (TOS)
Internet

Indicates the type of booking channel

. Refer to the OTA code lists: Booking Channel Type (BCT).

per the Open Travel BCT codes.

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810183" target="_blank">Booking Channel Type (BCT)</a>

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

@Type

1

A reference to the type of object defined by the

UniqueId

UniqueID element. Refer to

Open Travel

OpenTravel Code List Unique ID

type

Type (UIT)

"1" = Profile

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

"1" = Profile

@ID

StringLength1to32

1

A unique identifying 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

ProfileID in protel

"2918"0..

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

the source of the identifier

where the ID comes from.

"protelIO"

“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

@Type

1

A reference to the type of object defined by the

UniqueId

UniqueID element. Refer to

Open Travel

OpenTravel Code List Unique ID

type

Type (UIT)

"1" = Profile

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

"1" = Profile

@ID

StringLength1to32

1

A unique identifying 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

ProfileID in protel

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

0..

1	Used to identify

the source of the identifier

where the ID comes from.

"protelIO"

“protelIO”

"protelIO"

OTA_ProfileMergeRQ | Profile

_Profile element

1

The target profile

HTML
<a href="https://confluence.protel.net/display/PIODOC/_Profile+element+outbound" target="_blank">_Profile element outbound</a>

See

OTA_

ProfileModifyOTA_

ProfileMergeRS

- Attributes

Element \| @Attribute	Type	Num	Description
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

Time

Timestamp of the transaction.
@Version	decimal	0..1	Version of the message.

@Target


@PrimaryLangID	language	0..

1 Used to indicate whether the request is for the Test or Production system.

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.
1	Default language of the property.
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).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)

.

</a>

@Code

OTA_CodeType ERR

0..

1

Refer

Refers to the OTA Code List: Error Codes (ERR).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@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).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)

.

</a>

@Status


@Code	OTA_CodeType ERR	0..1

If present, recommended values are "NotProcessed," " Incomplete," "Complete," or "Unknown." This is a 'string' data type; Partners may identify and use additional status conditions not included in this enumeration.

Refers to the OTA Code List: Error Codes (ERR).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@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."

@ShortText

1

An abbreviated version of the error in textual format.

@Code

0..1

If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to the OTA Code List: Error Codes (ERR).

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)

.

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@ID_Context

0..1

Used to identify the source of the identifier (e.g.; IATA, ABTA).

@ID

1

A unique identifying 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	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_Context

0..1

Used to identify the source of the identifier (e.g.; IATA, ABTA).

@ID

1

A unique identifying 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.

Sample messages

Request messages

OTA_ProfileMergeRQ pAIr

Codeblock

language	xml
linenumbers	true
collapse	true

<OTA_ProfileMergeRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:p="http://protel.io/soap" xmlns:px="http://protel.io/htng/extensions" xmlns:htng="http://htng.org/2014B" CorrelationID="NSD_08/17_07" EchoToken="NSD_08/17_04" PrimaryLangID="fr" TimeStamp="2020-05-29T13:24:45Z" Version="2.001">
			<UniqueID ID="8632" ID_Context="protelIO" Type="4"/>
			<UniqueID ID="2920" ID_Context="protelIO" Type="10"/>			
			<ObsoleteProfileID ID="8617" ID_Context="protelIO" Type="4"/>
			<Profile CreateDateTime="2019-06-11T06:14:42Z" CreatorID="ndzhenkov" LastModifierID="ndzhenkov" LastModifyDateTime="2020-04-23T06:38:28Z" ProfileType="1" RPH="8617" ShareAllOptOutInd="No" StatusCode="4">				
			</Profile>
		</OTA_ProfileMergeRQ>

OTA_ProfileMergeRQ onPremise

Codeblock

language	xml
linenumbers	true
collapse	true

      <OTA_ProfileMergeRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:p="http://www.opentravel.org/OTA/2003/05" xmlns:px="http://protel.io/htng/extensions">
			<POS>
				<Source>
					<RequestorID Type="10" ID="3009" ID_Context="protelIO"/>
				</Source>
			</POS>
			<ObsoleteProfileID Type="4" ID="315311" ID_Context="protelIO"/>
			<UniqueID Type="4" ID="351536" ID_Context="protelIO"/>
			<Profile ProfileType="4" LastModifyDateTime="2019-10-23T13:11:17" CreateDateTime="2019-10-23T13:45:00" LastModifierID="protel 1">
				<Customer Gender="Unknown" Language="en">
					<PersonName>
						<NamePrefix>Yoo</NamePrefix>
						<GivenName></GivenName>
						<Surname>Abdat</Surname>
						<NameTitle/>
					</PersonName>					
					<Email DefaultInd="true" EmailType="1" Remark="EMAIL"></Email>					
				</Customer>								
				<CompanyInfo>
					<CompanyName CompanyShortName="" Department="">protel</CompanyName>
				</CompanyInfo>
			</Profile>
		</OTA_ProfileMergeRQ>

OTA_ProfileMergeRS - Success

Codeblock

language	xml
linenumbers	true
collapse	true

<?xml version='1.0' encoding='utf-8'?>
<OTA_ProfileMergeRS
            xmlns="http://www.opentravel.org/OTA/2003/05"
            xmlns:ns2="http://htng.org/2014B"
            xmlns:ns3="http://protel.io/soap" CorrelationID="PROFILE#2100254#UPDATE#000103#1562139357125#4E2C" EchoToken="PROFILE#2100254#UPDATE#000103#1562139357125#4E2C" TimeStamp="2019-04-4T03:00:39.663577" Version="4">
	<Success/>
</OTA_ProfileMergeRS>

OTA_ProfileMergeRS - Error

Codeblock

language	xml
linenumbers	true
collapse	true

<?xml version='1.0' encoding='utf-8'?>
<OTA_ProfileMergeRS
            xmlns="http://www.opentravel.org/OTA/2003/05"
            xmlns:ns2="http://htng.org/2014B"
            xmlns:ns3="http://protel.io/soap" CorrelationID="PROFILE#2100254#UPDATE#000103#1562162050211#FA17" EchoToken="PROFILE#2100254#UPDATE#000103#1562162050211#FA17" TimeStamp="2019-04-4T03:00:39.663577" Version="4">
	<Errors>
		<Error Code="450" ShortText="Unable to process" Type="3"/>
	</Errors>
	<UniqueID ID="9970" ID_Context="protelIO" Type="10"/>
</OTA_ProfileMergeRS>

OTA_ProfileMergeRS - Warning

Codeblock

language	xml
linenumbers	true
collapse	true

<?xml version='1.0' encoding='utf-8'?> <OTA_ProfileMergeRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:ns2="http://htng.org/2014B" xmlns:ns3="http://protel.io/soap" CorrelationID="PROFILE#2100254#UPDATE#000103#1562221116991#53F8" EchoToken="PROFILE#2100254#UPDATE#000103#1562221116991#53F8" TimeStamp="2019-04-4T03:00:39.663577" Version="4"> <Warnings> <Warning Code="320" ShortText="No Cancellation reference provided for Reservation 384725" Type="3"/> <Warning Code="320" ShortText="No Reservation record found for Reservation 384725 and will not be recorded" Type="3"/> </Warnings> <UniqueID ID="2920" ID_Context="protelIO" Type="10"/> </OTA_ProfileMergeRS>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@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”

Target audience	CRM
Version	3.0.
Authentication	Bearer Token
Message type	Push, Asynchronous
Direction	Inbound, Outbound

Seitenhierarchie

Versionen im Vergleich

Alte Version 2

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

OTA_ProfileMergeRQ

OTA_ProfileMergeRQ

Message Description

OTA_ProfileMergeRQ - Attributes

OTA_

ProfileMergeRS

Sample messages

Request messages

OTA_ProfileMergeRQ pAIr

OTA_ProfileMergeRS - Success

OTA_ProfileMergeRS - Error

OTA_ProfileMergeRS - Warning

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 2

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

OTA_ProfileMergeRQ

OTA_ProfileMergeRQ

Message Description

OTA_ProfileMergeRQ - Attributes

OTA_

ProfileMergeRS

Sample messages

Request messages

OTA_ProfileMergeRQ pAIr

OTA_ProfileMergeRS - Success

OTA_ProfileMergeRS - Error

OTA_ProfileMergeRS - Warning