Message Description

Lookup by Member ID w/ Currency for Points
Receive Membership Info w/ Points & Account Balance in Hotel Currency

IO_LoyaltyAccountInfoRQ - Attributes

protel I/O uses a request and response message pair to asks an external system for the current amount of loyalty points attached to a specific loyalty card. In the response message from the external System the following information is included. The Account Balance is provided always in the Hotel Currency.

AccountBalance → current amount of points
AccountChargeLowerLimit → minimum redemption value
AccountChargeUpperLimit → maximum redemption value

Image Added

Message Attributes

IO_LoyaltyAccountInfoRQ

Element \| @Attribute	Type	Num	Description outbound

Element | @AttributeNumDescription

	Comments + Contents outbound	pAir	OnPrem
IO_LoyaltyAccountInfoRQ		1	Root element of the message.
@EchoToken	string	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	string	1	Used to match result messages (RS) to request messages (RQ) in asynchronous communication patterns. Therefore mandatory.
@TimeStamp	dateTime

0..

IO_
1	Time of the transaction.	"2019-06-05T09:12:14Z"
@Version	string	0..1	Message version.	Version="3.001"
@PrimaryLangID	string	0..1	The primary language preference for the message encoded as ISO 639-3.

LoyaltyAccountInfoRQ | POS | Source |

RequestorID

1

Reference to the sending system.

LoyaltyAccountInfoRQ \| ReadRequests		0..1
@HotelCode

@Type

string

0..1

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

10 = "Hotel"

Full name of the property which the transferred stay information belongs to.

@ID

@HotelID

string

0..1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the

same

same throughout the messages.
@HotelName

@ID_Context"protelIO"

string

0..1

Used to identify where the ID comes from.

Full name of the property which the transferred stay information belongs to.

IO_LoyaltyAccountInfoRQ | POS | Source | BookingChannel

@ChainCode

string

0..1

Specifies the booking channel type and whether it is the primary means of connectivity of the source.

IO_LoyaltyAccountInfoRQ \| ReadRequests \| LoyaltyReadRequest		1..n	Loyalty Information
Full name of the property which the transferred stay information belongs to.

@Primary

true

false

@CurrencyCode	IOCodeString	0..1	Default Hotel Currency Code
@MemberCode	IOCodeString	1

Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent.

The MemberCode attribute will indicate the actual member number.
@ProgramCode

@Type"4" = Property management system (PMS)

string

1

Indicates the type of booking channel. Refer to OpenTravel Code List Booking Channel Type (BCT).

The ProgramCode attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID.

IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions


@LevelCode	IOCodeString	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

Indicates special privileges in program assigned to individual.

IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | px:POSExtensions


@AccountStatus	IOCodeString	0..1

Extensions about the transferred POS.

The account status. Refer to Open Travel Code List Profile Status (PST).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>

Extensions about the transferred POS - specifying details about the hotel's system.

@FiscalDate1Current Business Date of the PMSyyyy-mm-dd

IO_LoyaltyAccountInfoRQ | ReadRequests

@PrimaryInd

boolean

0..1

@HotelCode

IO_LoyaltyAccountInfoRQ \| ReadRequests \| User		0..1
When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.	true false

Full name of the property which the transferred stay information belongs to.

Information of the logged-in user

@HotelID

@UserName

IOCodeString

0..1

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

Name of the User
@Organisation

@HotelName

string

0..1

Full name

Name of the

property which the transferred stay information

Group the user belongs to

.


@Department

@ChainCode

string

0..1

Full name

Name of the

property which the transferred stay information belongs to.

IO_LoyaltyAccountInfoRQ \| ReadRequests \|
Department from the User

LoyaltyReadRequest1

User \| Email	string	0..

nLoyalty Information

1	This field would be used to pass the guest’s Email.

@CurrencyCode

IO_LoyaltyAccountInfoRQ \| ReadRequests \| User \| UserID		0..1

Default Hotel Currency Code

This field would be used to pass the guest’s UserID
@ID

@MemberCode

string

1

The MemberCode attribute will indicate the actual member number

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.

@ProgramCode

@ID_Context

string

1

The ProgramCode attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID.

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

@LevelCode

@Type

IOCodeString

0..1

Indicates special privileges in program assigned to individual.

@AccountStatus0..1The account status. Refer to Open Travel Code List Profile Status (PST).

4 = Active
5 = Inactive

@PrimaryInd0..1When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.

true
false

IO_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | User

1Information of the logged-in user

@UserName0..1Name of the User

@Organisation0..1Name of the Group the user belongs to

@Department0..1Name of the Department from the User

IO_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | User | Email0..1This field would be used to pass the guest’s Email.

IO_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | User | UserID0..1This field would be used to pass the guest’s UserID

IO_LoyaltyAccountInfoRS - Attributes

A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists: Unique ID Type (UIT)

IO_LoyaltyAccountInfoRS

Element | @Attribute

Type

Num

Description inbound

Comments + Contents inbound

pAir

OnPrem

IO_LoyaltyAccountInfoRS

1

Root element of the message.

@EchoToken

string

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

string

1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

dateTime

1

Time of the transaction.

"2019-06-05T09:12:14Z"

@Version

string

0..1

Message version.

Version="3.001"

@PrimaryLangID

string

0..1

The primary language preference for the message encoded as ISO 639-3.

IO_LoyaltyAccountInfoRS | Success

boolean

0..1

Returning an empty element of this type indicates the successful processing of the message. It could be combined with warning message/s if the message had issue/s.

true
false

IO_LoyaltyAccountInfoRS | Errors | Error

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.

@ShortText

string

0..1

An abbreviated version of the error in textual format.

@Type

OTA_CodeType EWT

0..1

Mandatory. Refers 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

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>

IO_LoyaltyAccountInfoRS | Errors | Error | Message

string

0...1

Description of the issue

IO_LoyaltyAccountInfoRS | Warnings | Warning

0..1

Used in conjunction with the Success element to define one or more business errors.

@ShortText

string

Element | @AttributeNumDescription inboundComments + Contents inboundpAirOnPrem

IO_LoyaltyAccountInfoRS

1Root element of the message.

@EchoToken

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

1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

0..1

Time of the transaction.

"2019-06-05T09:12:14Z"

@Version

0..1

Message version.

Version="3.001"

@PrimaryLangID

0..1

The primary language preference for the message encoded as ISO 639-3.

IO_LoyaltyAccountInfoRS | Success

0..1

IO_LoyaltyAccountInfoRS | Errors

0..1Indicates 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.

Errors | Error0..1

An error that occurred during the processing of a message.

@ShortText

0..1

An abbreviated version of the error in textual format.

@Code@Type0..1Mandatory. Refer to OTA Code List: Error Warning Type (EWT).

IO_LoyaltyAccountInfoRS | Warnings

0..1Used in conjunction with the Success element to define one or more business errors.

Warnings | Warning0..1Used when a message has been successfully processed to report any warnings or business errors that occurred.

@ShortText0..1An abbreviated version of the error in textual format.

@Code0..1If 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).

@Type0..1Mandatory. Refer to OTA Code List: Error Warning Type (EWT).

IO_LoyaltyAccountInfoRS | LoyaltyReadResults

0..1

@HotelCode0..1Full name of the property which the transferred stay information belongs to.

@HotelID

@Type

OTA_CodeType EWT

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

Mandatory. Refers 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

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>

IO_LoyaltyAccountInfoRS | Warnings | Warning | Message

string

0...1

Description of the issue

IO_LoyaltyAccountInfoRS | LoyaltyReadResults

0..1

@HotelCode

string

0..1

Full name of the property which the transferred stay information belongs to.

@HotelID

string

0..1	The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.
@HotelName	string	0..1	Full name of the property which the transferred stay information belongs to.
@ChainCode	string	0..1	Full name of the property which the transferred stay information belongs to.

LoyaltyReadResults

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount		1
@MemberCode	IOCodeString	1	The MemberCode attribute will indicate the actual number.
@ProgramCode	string	1	The ProgramCode attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID.
@LevelCode	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1	OTA Code list PST

/** 1 */ MarkedForDeletion

/** 2 */ Lapsed

/** 3 */ Terminated

/** 4 */ Active

/** 5 */ Inactive

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>

@PrimaryInd

boolean

0..1

When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.

true
false

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | CardHolderName

string

0..1

Name of the Membership card

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance

1

The actual amount available, which can be used for redeeming the points

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

decimal

Account...@Amount * ExchangeRate = CurrencyAmount@Amount

@CurrencyCode

string

1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued

0..1

Total amount, the collected points

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed

0..1

Total amount of points redeemed

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeUpperLimit

0..1

Maximum amount of points usable for a single redemption (Account and Invoice)

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeUpperLimit | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

AccountChargeUpperLimit

AccountChargeUpperLimit \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountChargeLowerLimit		0..1	Minimum amount of points needed for a single redemption (Account and Invoice)
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountChargeLowerLimit

\| CurrencyAmount		0..1	Amount in the default Currency
@ExchangeRate	decimal	0..1	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1	Currency Code, from the RQ
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountChargeLowerLimit \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| LoyaltyAccount \| UserCreated		0..1	Information of the logged-in user
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the user belongs to
@Department	string	0..1	Name of the Department from the User
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| LoyaltyAccount \| UserCreated \| Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| LoyaltyAccount \| UserCreated \| UserID		0..1	This field would be used to pass the guest’s UserID

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified

0..1

@Type

IOCodeString

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

string

1

The unique profile ID from the PMS.

@UserName

0..1

@Organisation

0..1

@Department

0..1

@Occupation

0..1

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | FirstName

0..1

@ID_Context

string

1

Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.

“protelIO"

This field would be used to pass the guest’s GivenName.

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| UserModified

| LastName

		0..1

This field would be used to pass the guest’s LastName.

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Email

@UserName	IOCodeString	0..1
@Organisation	string	0..1

This field would be used to pass the guest’s Email.

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| UserModified \|

@Department	string	0..1

Phone

Email	string	0..1	This field would be used to pass the guest’s

Phone

Email.
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| UserModified \| UserID		0..1	This field would be used to pass the guest’s UserID

Sample Message

IO_LoyaltyAccountInfoRQ

Codeblock

language	xml
collapse	true

<IO_LoyaltyAccountInfoRQ xmlns="http://protel.io/soap" EchoToken="Laureen_Info_2" TimeStamp="2021-08-19T14:41:25Z" Version="1.000" CorrelationID="Laureen_Info_2">
	<POS xmlns="http://www.opentravel.org/OTA/2003/05">
		<Source>
			<RequestorID Type="10" ID="2691" ID_Context="protelIO"/>
			<BookingChannel Type="4" Primary="true"/>
			<TPA_Extensions>
				<px:POSExtensions xmlns:px="http://protel.io/htng/extensions">
					<px:HotelInfo FiscalDate="2019-08-17"/>
				</px:POSExtensions>
			</TPA_Extensions>
		</Source>
	</POS>
	<ReadRequests HotelCode="2691" HotelID="7" HotelName="JA Ocean View Hotel, UAE-Dubai" ChainCode="HC1">
		<LoyaltyReadRequest CurrencyCode="AED" MemberCode="12898323" ProgramCode="GHA" LevelCode="Gold" AccountStatus="4" PrimaryInd="false" PrimaryIndSpecified="true">
			<User UserName="HelloWorld" Organisation="Gruppe" Department="Department">
				<Email>EMail@Email</Email>
				<UserID>12312</UserID>
			</User>
		</LoyaltyReadRequest>
	</ReadRequests>
</IO_LoyaltyAccountInfoRQ>

IO_LoyaltyAccountInfoRS

Codeblock

language	xml
collapse	true

<IO_LoyaltyAccountInfoRS xmlns="http://protel.io/soap" CorrelationID="Laureen_Info_2" Version="1.0" TimeStamp="2021-08-19T14:42:13"> <Success>true</Success> <LoyaltyReadResults HotelCode="2691" HotelName="JA Ocean View Hotel, UAE-Dubai" ChainCode="HC1"> <LoyaltyAccount MemberCode="12898323" ProgramCode="GHA" LevelCode="Gold" AccountStatus="4" PrimaryInd="false"> <CardHolderName>Gary</CardHolderName> <AccountBalance Amount="1903.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>6990.0996000000005</Amount> </CurrencyAmount> </AccountBalance> <AccountAccrued Amount="5000.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>18366,000003</Amount> </CurrencyAmount> </AccountAccrued> <AccountRedeemed Amount="3000.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>11019,6000019</Amount> </CurrencyAmount> </AccountRedeemed> <UserCreated UserName="HelloWorld" Organisation="Gruppe" Department="Department"> <Email>EMail@Email</Email> <UserID>12312</UserID> </UserCreated> </LoyaltyAccount> </LoyaltyReadResults> </IO_LoyaltyAccountInfoRS>

@Type

IOCodeString

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

string

1

The unique profile ID from the PMS.

@ID_Context

string

1

Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.

“protelIO"

Target audience	CRM
Version	13.0.
Authentication	Bearer Token
Message type	Synchronous
Direction	Asynchronous, Outbound

Seitenhierarchie

Versionen im Vergleich

Alte Version 16

Neue Version Aktuell

Schlüssel

Message Description

IO_LoyaltyAccountInfoRQ - Attributes

Message Attributes

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS - Attributes

IO_LoyaltyAccountInfoRS

Sample Message

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 16

Neue Version Aktuell

Schlüssel

Message Description

IO_LoyaltyAccountInfoRQ - Attributes

Message Attributes

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS - Attributes

IO_LoyaltyAccountInfoRS

Sample Message

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS