UNDER CONSTRUCTION - IO_LoyaltyAccountInfoRQ/RS

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	Num	Description	Comments + Contents outbound
IO_LoyaltyAccountInfoRQ	1	Root 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_LoyaltyAccountInfoRQ \| ReadRequests	0..1
@HotelCode	0..1	Full name of the property which the transferred stay information belongs to.
@HotelID	1	The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.
@HotelName	0..1	Full name of the property which the transferred stay information belongs to.
@ChainCode	0..1	Full name of the property which the transferred stay information belongs to.
ReadRequests \| LoyaltyReadRequest	1..n
@CurrencyCode	0..1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
@MemberCode	1	The MemberCode attribute will indicate the actual number.
@ProgramCode	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	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	0..1	The account status. Refer to Open Travel Code List Profile Status (PST).	4 = Active 5 = Inactive
@PrimaryInd	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
ReadRequests \| User	1	Information of the logged-in user
@UserName	0..1	Name of the User
@Organisation	0..1	Name of the Group the user belongs to
@Department	0..1	Name of the Department from the User
User \| Email	0..1	This field would be used to pass the guest’s Email.
User \| UserID	0..1	This field would be used to pass the guest’s UserID

IO_LoyaltyAccountInfoRS - Attributes

Element \| @Attribute	Num	Description outbound	Comments + Contents outbound
IO_LoyaltyAccountInfoRS	1	Root 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..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 \| Error	0..1	An error that occurred during the processing of a message.
@ShortText	0..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).
@Type	0..1	Mandatory. Refer to OTA Code List: Error Warning Type (EWT).
IO_LoyaltyAccountInfoRS \| Warnings	0..1	Used in conjunction with the Success element to define one or more business errors.
Warnings \| Warning	0..1	Used when a message has been successfully processed to report any warnings or business errors that occurred.
@ShortText	0..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).
@Type	0..1	Mandatory. Refer to OTA Code List: Error Warning Type (EWT).
IO_LoyaltyAccountInfoRS \| LoyaltyReadResults	0..1
@HotelCode	0..1	Full name of the property which the transferred stay information belongs to.
@HotelID	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	0..1	Full name of the property which the transferred stay information belongs to.
@ChainCode	0..1	Full name of the property which the transferred stay information belongs to.
LoyaltyReadResults \| LoyaltyAccount	1
@MemberCode	1	The MemberCode attribute will indicate the actual number.
@ProgramCode	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	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	0..1
@PrimaryInd	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
LoyaltyAccount \| CardHolderName	0..1	Name of the Membership card
LoyaltyAccount \| AccountBalance	1	Actual amount available, which can be used for redeeming the points
@Amount	1	Amount in Points
@Type	1	Shortname of the Loyalty Program
AccountBalance \| CurrencyAmount	0..1	Amount in the default Currency
@CurrencyCode	1	Currency Code, from the RQ
CurrencyAmount \| Amount	1	Amount in the Currency Code, from the RQ
LoyaltyAccount \| AccountAccrued	0..1	Total amount, the collected points
@Amount	1	Amount in Points
@Type	1	Shortname of the Loyalty Program
AccountAccrued \| CurrencyAmount	0..1	Amount in the default Currency
@CurrencyCode	0..1	Currency Code, from the RQ
CurrencyAmount \| Amount	1	Amount in the Currency Code, from the RQ
LoyaltyAccount \| AccountRedeemed	0..1	Total amount of points redeemed
@Amount	1	Amount in Points
@Type	1	Shortname of the Loyalty Program
AccountAccrued \| CurrencyAmount	0..1	Amount in the default Currency
@CurrencyCode	0..1	Currency Code, from the RQ
CurrencyAmount \| Amount	1	Amount in the Currency Code, from the RQ
LoyaltyAccount \| UserCreated	0..1	Information of the logged-in user
@UserName	0..1	Name of the User
@Organisation	0..1	Name of the Group the user belongs to
@Department	0..1	Name of the Department from the User
UserCreated \| Email	0..1	This field would be used to pass the guest’s Email.
UserCreated \| UserID	0..1	This field would be used to pass the guest’s UserID
LoyaltyAccount \| UserModified	0..1	Information of the logged-in user
@UserName	0..1	Name of the User
@Organisation	0..1	Name of the Group the user belongs to
@Department	0..1	Name of the Department from the User
UserModified \| Email	0..1	This field would be used to pass the guest’s Email.
UserModified \| Phone	0..1	This field would be used to pass the guest’s Phone
UserModified \| UserID	0..1	This field would be used to pass the guest’s UserID

Sample Message

IO_LoyaltyAccountInfoRQ

<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

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

Target audience
Version	1.0.
Authentication	Bearer Token
Message type	Asynchronous, Outbound

Seitenhierarchie

UNDER CONSTRUCTION - IO_LoyaltyAccountInfoRQ/RS

Message Description

IO_LoyaltyAccountInfoRQ - Attributes

IO_LoyaltyAccountInfoRS - Attributes

Sample Message

IO_LoyaltyAccountInfoRQ

IO_LoyaltyAccountInfoRS