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

Element | @Attribute

	Num	Description outbound

Content

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_LoyaltyAccountInfoRQ \| ReadRequests		0..1
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.
@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

An ISO 4217 (3) alpha character code that specifies a monetary unit.

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

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

LoyaltyReadRequest | EffectiveDateBefore0..1yyyy-mm-dd

IO_LoyaltyAccountInfoRQ \| ReadRequests \| User

LoyaltyReadRequest | ExpireDateAfter

		0..1

yyyy-mm-ddReadRequests | User

Information of the logged-in user

1


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

@Department0..1@Occupation0..1User | FirstName

Name of the Group the user belongs to
@Department	string	0..1

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

User | LastName0..1This field would be used to pass the guest’s LastName.

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

Phone

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

PhoneUser | UserID0..1This field would be used to pass the guest’s UserID

Sample Message

Codeblock

language	xml
collapse	true

<p:IO_LoyaltyAccountInfoRQ xmlns:p="http://protel.io/soap" CorrelationID="TRIGGER#000500#UPDATE#000420#1613999060824#E564" Version="1.0" TimeStamp="2021-02-22T13:04:20Z" EchoToken="TRIGGER#000500#UPDATE#000420#1613999060824#E564" PrimaryLangID="en" Target="Test" TargetName="Test">
	<p:ReadRequests HotelCode="2535" HotelID="500" HotelName="DEV 2535" ChainCode="n/a">
		<p:LoyaltyReadRequest CurrencyCode="CZK" MemberCode="2345754635123" ProgramCode="Lounge Coders Club" LevelCode="HighRoller" AccountStatus="4" PrimaryInd="true">
			<p:EffectiveDateBefore>2019-07-04</p:EffectiveDateBefore>
			<p:ExpireDateAfter>2019-07-04</p:ExpireDateAfter>
		</p:LoyaltyReadRequest>
		<p:User UserName="johnD" Organisation="Hotel 2535" Department="dev.protel.net" Occupation="">
			<p:FirstName>John</p:FirstName>
			<p:LastName>Dev</p:LastName>
			<p:Email>jdev@protel.net</p:Email>
		</p:User>
	</p:ReadRequests>
</p:IO_LoyaltyAccountInfoRQ>

IO_LoyaltyAccountInfoRS - Attributes

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

Element | @AttributeNumDescription outboundContent outbound

	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

0..

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

Errors | Error0..1

An error that occurred during the processing of a message.


@ShortText	string

@ShortText

0..1

An 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

Mandatory. Refers to the OTA Code List:

Error Codes (ERR

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

@Type

0..

1

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

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.

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


@ShortText	string

@ShortText

0..1

An abbreviated version of the error in textual format.


@Type	OTA_CodeType EWT

@Code

0..1

If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer

Mandatory. Refers to the OTA Code List:

Error Codes (ERR).

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

@Type

0..

1

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

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.

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults

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

string

0..1

LoyaltyAccount | ExpireDate0..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

LoyaltyAccount | EffectiveDate1LoyaltyAccount | AccountBalance1

@Amount

1@Type1AccountBalance

\| CurrencyAmount		0..1

@CurrencyCode

Amount in the default Currency
@ExchangeRate	decimal	0..1

@ExchangeRate0..1CurrencyAmount | Amount1

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountBalance \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
	Exchange Rate for the Loyalty Points	decimal Account...@Amount * ExchangeRate = CurrencyAmount@Amount
@CurrencyCode	string	1	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

AccountAccrued

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountAccrued \| CurrencyAmount		0..1
Shortname of the Loyalty Program

@CurrencyCode

Amount in the default Currency
@ExchangeRate	decimal	0..1

@ExchangeRate

	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1

CurrencyAmount | Amount1

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountAccrued \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
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

AccountAccrued

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountRedeemed \| CurrencyAmount		0..1
Shortname of the Loyalty Program

@CurrencyCode

Amount in the default Currency
@ExchangeRate	decimal	0..1

@ExchangeRate

	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1

CurrencyAmount | Amount1LoyaltyAccount | UserCreated

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

@UserName

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

@Organisation

Amount in the default Currency
@ExchangeRate	decimal	0..1

@Department

Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1

@Occupation0..1UserCreated | FirstName0..1

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

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| AccountChargeUpperLimit \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
	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

UserCreated | LastName

		0..1

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

Amount in the default Currency
@ExchangeRate	decimal

UserCreated | Email

0..1

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

Exchange Rate for the Loyalty Points
@CurrencyCode	string

UserCreated | Phone

0..1

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

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

UserCreated | UserID0..1This field would be used to pass the guest’s UserIDLoyaltyAccount | UserModified

		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

@Occupation0..1UserModified | FirstName

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| LoyaltyAccount \| UserCreated \| Email	string	0..1	This field would be used to pass the guest’s
	Name of the Department from the User

GivenName

Email.


IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| LoyaltyAccount \| UserCreated \| UserID

UserModified | LastName

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

LastName.

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"

IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified

0..1

@UserName

IOCodeString

0..1

@Organisation

string

UserModified | Email

0..1

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

IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| UserModified \| Email	string

@Department	string	0..1

UserModified | Phone

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

Phone

Email.
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults \| LoyaltyAccount \| UserModified

UserModified

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

code

@Type

language

IOCodeString

xmlcollapsetrue<p:IO_LoyaltyAccountInfoRS xmlns:p="http://protel.io/soap" CorrelationID="TRIGGER#000500#UPDATE#000420#1613999060824#E564" Version="1.0" TimeStamp="2021-02-22T13:07:02Z"> <p:Success>true</p:Success> <p:LoyaltyReadResults HotelCode="2535" HotelName="DEV 2535" ChainCode="n/a" ChainName="n/a"> <p:LoyaltyAccount MemberCode="2345754635123" ProgramCode="Lounge Coders Club" LevelCode="HighRoller" AccountStatus="4" PrimaryInd="true"> <p:CardHolderName>Oneoone K. Board</p:CardHolderName> <p:ExpireDate>2021-06-02</p:ExpireDate> <p:AccountBalance Amount="0" Type="L$C"> <p:CurrencyAmount CurrencyCode="CZK" ExchangeRate="1"> <p:Amount>0</p:Amount> </p:CurrencyAmount> </p:AccountBalance> <p:AccountAccrued Amount="0" Type="L$C"> <p:CurrencyAmount CurrencyCode="CZK" ExchangeRate="1"> <p:Amount>0</p:Amount> </p:CurrencyAmount> </p:AccountAccrued> <p:AccountRedeemed Amount="0" Type="L$C"> <p:CurrencyAmount CurrencyCode="CZK" ExchangeRate="1"> <p:Amount>0</p:Amount> </p:CurrencyAmount> </p:AccountRedeemed> <p:UserCreated UserName="johnD" Organisation="Hotel 2535" Department="dev.protel.net" Occupation=""> <p:FirstName>John</p:FirstName> <p:LastName>Dev</p:LastName> <p:Email>jdev@protel.net</p:Email> </p:UserCreated> <p:UserModified UserName="johnD" Organisation="Hotel 2535" Department="dev.protel.net" Occupation=""> <p:FirstName>John</p:FirstName> <p:LastName>Dev</p:LastName> <p:Email>jdev@protel.net</p:Email> </p:UserModified> </p:LoyaltyAccount> </p:LoyaltyReadResults> </p:IO_LoyaltyAccountInfoRS>

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 4

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS - Attributes

IO_LoyaltyAccountInfoRS

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 4

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS - Attributes

IO_LoyaltyAccountInfoRS