Message Description

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

Message Description

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

IO_LoyaltyAccountInfoRQ - Attributes

Element | @Attribute

Element | @Attribute	Type

Num	Description outbound	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..

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_LoyaltyAccountInfoRQ | ReadRequests		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.
IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest		1..n	Loyalty Information
@CurrencyCode	IOCodeString	0..1	Default Hotel Currency Code
@MemberCode	IOCodeString	1	The MemberCode attribute will indicate the actual member 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	The account status. Refer to Open Travel Code List Profile Status (PST).

• 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

@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 | User		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_LoyaltyAccountInfoRQ  | ReadRequests

| LoyaltyReadRequest

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

| LoyaltyReadRequest

| User | UserID		0..1	This field would be used to pass the guest’s UserID
@ID	string	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.
@ID_Context	string	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
@Type	IOCodeString	0..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)

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

0..

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

Errors | Error

string

0..1

An

error that occurred during the processing of a message.@ShortText0..1An

abbreviated version of the error in textual format.

@Code

@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 | 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	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 | Warnings | Warning |  Message	string	0...1	Description of the issue

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

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

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

IO_LoyaltyAccountInfoRS | LoyaltyReadResults

| LoyaltyAccount

		0..1

@MemberCode

@HotelCode

1The MemberCode attribute will indicate the actual number.

@ProgramCode

1The 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

string	0..1	Full name of the property which the transferred stay information belongs to.
@HotelID

@LevelCode

string

0..1

Indicates special privileges in program assigned to individual

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

@AccountStatus

@HotelName

string

0..1

OTA Code list PST

• /** 1 */ MarkedForDeletion

• /** 2 */ Lapsed

• /** 3 */ Terminated

• /** 4 */ Active

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.

/** 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_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | CardHolderName

0..1Name of the Membership card

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance

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

@Amount

1Amount in Points@Type1Shortname of the Loyalty Program

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount

0..1Amount in the default Currency@ExchangeRate0..1Exchange Rate for the Loyalty Points

decimal

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

@CurrencyCode

1Currency Code, from the RQ

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

 AccountBalance | CurrencyAmount | Amount

CardHolderName	string	0..1	Name of the Membership card

1Amount in the Currency Code, from the RQ

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountAccrued

AccountBalance

0..

	1

Total

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

collected

points
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountAccrued 

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

0..

1	Currency Code, from the RQ
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountAccrued 

AccountBalance |

 CurrencyAmount

CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountRedeemed

AccountAccrued		0..1	Total amount

of

, the collected points

redeemed

@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountRedeemed 

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
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountRedeemed 

AccountAccrued | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountChargeUpperLimit

AccountRedeemed		0..1

Maximum

Total amount of points

usable for a single redemption (Account and Invoice) 

redeemed

@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountChargeUpperLimit

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
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountChargeUpperLimit

AccountRedeemed | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

 AccountChargeLowerLimit

AccountChargeUpperLimit		0..1

Minimum

Maximum amount of points

needed

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 |

AccountChargeLowerLimit

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 |

 AccountChargeLowerLimit

AccountChargeUpperLimit | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

LoyaltyAccount | UserCreated

AccountChargeLowerLimit		0..1

Information of the logged-in user

Minimum amount of points needed for a single redemption (Account and Invoice)
@Amount

@UserName

decimal

0..

1

Name of the User

Amount in Points

@Organisation

0..1Name of the Group the user belongs to

@Department

0..1Name of the Department from the User

@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount |

LoyaltyAccount | UserCreated | Email

AccountChargeLowerLimit  | CurrencyAmount		0..1

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

Amount in the default Currency

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated | UserID

@ExchangeRate	decimal	0..1

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

Exchange Rate for the Loyalty Points

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified

@CurrencyCode

string

0..1

Currency Code, from the RQ

@UserName

0..1

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeLowerLimit  | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ

@Organisation

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated		0..1	Information of the logged-in user

@Department

@UserName	IOCodeString	0..1	Name of the User
@Organisation

@Occupation

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 |

 UserModified

UserCreated |

FirstName

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

GivenName

Email.
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated |

 UserModified | LastName

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

LastName.

UserID

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Email

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

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Phone

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

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | UserID

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

@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

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

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

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

Sample Message

IO_LoyaltyAccountInfoRQ

<?xml version="1.0" encoding="UTF-8"?>
<IO_LoyaltyAccountInfoRQ xmlns="http://protel.io/soap" EchoToken="12345" TimeStamp="2021-09-16T06:29:58Z" Version="1.000" CorrelationID="Laureen_Info_5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://protel.io/soap file:///C:/Users/ljacke/Desktop/xmlbinding-develop@0e346006532/io-binding/src/main/xsd/Loyalty.xsd">
	<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"/>
		<User UserName="HelloWorld" Organisation="Gruppe" Department="Department">
			<Email>EMail@Email</Email>
			<UserID ID="12315" ID_Context="protelID"/>
		</User>
	</ReadRequests>
</IO_LoyaltyAccountInfoRQ>

IO_LoyaltyAccountInfoRS

Success

<IO_LoyaltyAccountInfoRS xmlns="http://protel.io/soap" CorrelationID="Laureen_Info_5" Version="1.0" TimeStamp="2021-09-16T06:29:58">
	<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="940.0" Type="D$">
				<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316">
					<Amount>3452.808</Amount>
				</CurrencyAmount>
			</AccountBalance>
			<AccountAccrued Amount="4893.0" Type="D$">
				<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316">
					<Amount>17972.96760000000</Amount>
				</CurrencyAmount>
			</AccountAccrued>
			<AccountRedeemed Amount="3000.0" Type="D$">
				<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316">
					<Amount>11019.600000000000</Amount>
				</CurrencyAmount>
			</AccountRedeemed>
			<AccountChargeLowerLimit Amount="10" Type="D$">
				<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316">
					<Amount>36.732</Amount>
				</CurrencyAmount>
			</AccountChargeLowerLimit>
			<AccountChargeUpperLimit Amount="940.0" Type="D$">
				<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316">
					<Amount>3452.808</Amount>
				</CurrencyAmount>
			</AccountChargeUpperLimit>
		</LoyaltyAccount>
	</LoyaltyReadResults>
</IO_LoyaltyAccountInfoRS>

Error

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"
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified		0..1
@UserName	IOCodeString	0..1
@Organisation	string	0..1
@Department	string	0..1
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | UserID		0..1	This field would be used to pass the guest’s UserID
@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"