Message Description

This message will be used to request points

IO_LoyaltyAccountInquiryRQ - Attributes

protel I/O uses a request and response message pair to request at an external system the points, that are planned to be redeem. It is up to the external system if these points are somehow block in the external system. Protel will use the amount from the response for the redemption.

Image Added

Message Attributes

IO_LoyaltyAccountInquiryRQ

Element | @AttributeNumDescription outbound

Element \| @Attribute	Type	Num	Description outbound

Comments + Contents outbound	pAir	OnPrem
IO_LoyaltyAccountInquiryRQ		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_LoyaltyAccountInquiryRQ \| LoyaltyInquiryRequest		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.
@TransactionAccount	IOCodeString	0..1	Describes the action of the points	ACCRUAL
@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.
@MemberCode	IOCodeString	1	The

member code

MemberCode attribute will indicate the actual number.
@ProgramCode	string	1	The

program code

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

Traveler 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

@PrimaryInd

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

@TransactionReference

IOCodeString

0..1

external Reference ID for the Cancellation

@TransactionVoidInd

boolean

0..1

Displays if it is a Redemption or a Cancellation

true
false

IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount

0..1

Information of the Amount of the Redemption

@Amount

decimal

1

The Amount of the points

@Type

string

1

Code for Points

IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount

0..1

Information of the Amount of the Redemption in the Hotel Currency

@CurrencyCode

decimal

1

The Currency Code which is used by the Amount

@ExchangeRate

string

0..1

Exchange Rate

decimal

IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount | Amount

decimal

1

The amount which will be paid with the Point Redemption

IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | StayInfo

0..1

Reservation Information

@ReservationID

string

0..1

Reservation ID

@ArrivalDate

dateTime

0..1

Arrival Date

@DepartureDate

dateTime

0...1

Departure Date

@CRSNumber

string

0...1

CRS ID

IO_LoyaltyAccountInquiryRQ | User

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_LoyaltyAccountInquiryRQ | User | Email

string

0..1

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

IO_LoyaltyAccountInquiryRQ | User | UserID

0..1

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

@Type

@ID

IOCodeString

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)

IO_LoyaltyAccountInquiryRS - Attributes

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_LoyaltyAccountInquiryRS

Element | @Attribute

Element \| @Attribute	Type

Num	Description inbound	Comments + Contents inbound	pAir
IO_LoyaltyAccountInquiryRS		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.

LoyaltyAccountInquiryRS

LoyaltyAccountInquiryRS \| 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_

LoyaltyAccountInquiryRS

LoyaltyAccountInquiryRS \| Errors \|

Error

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.

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

@Type

0..1Mandatory. Refer to OTA

Mandatory. Refers to the OTA Code List: Error Warning

Type

Type (EWT).

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

IO_LoyaltyAccountInquiryRS | Errors | Error

| Message

0..1

@Code

IO_LoyaltyAccountInquiryRS | Warnings | Warning

OTA_CodeType ERR

0..

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

@ShortText

0..1An abbreviated version of the error in textual format.

@Code

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

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_LoyaltyAccountInquiryRS | Errors | Error | Message

string

0...1

Description of the issue

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

@Type

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

IO_LoyaltyAccountInquiryRS | Warnings | Warning | Message

0...1

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult0..1

@TransactionReference0..1external Reference ID for the Cancellation

@TransactionVoidInd0..1Displays if it is a Redemption or a Cancellation

true
false

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | TransactionAmount1Information of the Amount of the Redemption

@Amount

1The Amount of the points

@Type

1Code for Points

IO_

LoyaltyAccountInquiryRQ

LoyaltyAccountInquiryRS \|

LoyaltyInquiryResult

Warnings \|

TransactionAmount | CurrencyAmount

Warning \| Message	string	0...1

Information

Description of the

Amount of the Redemption in the Hotel Currency

issue

@CurrencyCode

1The Currency Code which is used by the Amount

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult		0..1
@TransactionReference	IOCodeString	0..1	external Reference ID for the Cancellation
@TransactionVoidInd

@ExchangeRate

boolean

0..1

Exchange Rate

Displays if it is a Redemption or a Cancellation

true
false

decimal

IO_

LoyaltyAccountInquiryRQ

LoyaltyAccountInquiryRS \|

LoyaltyInquiryResult

LoyaltyInquiryResult \| TransactionAmount

| CurrencyAmount | Amount

		1

The amount which will be paid with the Point Redemption

Information of the Amount of the Redemption

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount


@Amount	decimal	1	The Amount of the points

0..1


@Type

@MemberCode

string

1

The MemberCode attribute will indicate the actual number.

Code for Points

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

IO_LoyaltyAccountInquiryRQ \| LoyaltyInquiryResult \| TransactionAmount \| CurrencyAmount		0..1	Information of the Amount of the Redemption in the Hotel Currency
@CurrencyCode

@LevelCode

decimal

0..1Indicates special privileges in program assigned to individual.

1	The Currency Code which is used by the Amount
@ExchangeRate

@AccountStatus

string

0..1

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

4 = Active
5 = Inactive

@PrimaryInd

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

IO_LoyaltyAccountInquiryRQ \| LoyaltyInquiryResult \| TransactionAmount \| CurrencyAmount \| Amount	decimal	1	The amount which will be paid with the Point Redemption
Exchange Rate	decimal

true

false


IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount

| CardHolderName

		0..1

Name of the Membership card

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountBalance

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

@MemberCode

IOCodeString

1

The MemberCode attribute will indicate the actual number.

@Amount

@ProgramCode

string

1

Amount in Points

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 Traveler and Company ID.

@Type

1

@LevelCode

IOCodeString

0..1

Indicates special privileges in program assigned to individual.

Shortname of the Loyalty Program

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountBalance | CurrencyAmount


@AccountStatus	IOCodeString	0..1

Amount in the default Currency

OTA Code list PST

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

@ExchangeRate

0..1Exchange Rate for the Loyalty Points

@PrimaryInd

@CurrencyCode

boolean

0..1

Currency Code, from the RQ

IO_

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|
When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.	true false

AccountBalance | CurrencyAmount | Amount

CardHolderName	string	0..1	Name of the Membership card

1Amount in the Currency Code, from the RQ


IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|

AccountAccrued

AccountBalance

0..

	1

Total

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_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \|

LoyaltyAccount

LoyaltyAccount \|

AccountAccrued

AccountBalance \| 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_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|

AccountAccrued

AccountBalance \|

CurrencyAmount

CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInquiryRS

| LoyaltyInquiryResult

\| 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_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| 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_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|

AccountRedeemed

AccountAccrued \|

CurrencyAmount

CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|

UserCreated

AccountRedeemed		0..1

Information of the logged-in user

Total amount of points redeemed
@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

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|
@Type	string	1	Shortname of the Loyalty Program

UserCreated

AccountRedeemed \|

Email

CurrencyAmount		0..1

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

Amount in the default Currency

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserCreated | UserID

@ExchangeRate

decimal

0..1

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

Exchange Rate for the Loyalty Points

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

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \| AccountRedeemed \| CurrencyAmount \| Amount	decimal	1	Amount in the Currency Code, from the RQ
@CurrencyCode	string	0..1	Currency Code, from the RQ

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

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \| UserCreated		0..1	Information of the logged-in user

@Type

@UserName

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)

@UserName

0..1Name of the User

@Organisation

Name of the User

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified

0..1Information of the logged-in user

@Organisation

string

IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|
0..1	Name of the Group the user belongs to
@Department	string	0..1	Name of the Department from the User

UserModified

UserCreated \| Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInquiryRS \| LoyaltyInquiryResult \| LoyaltyAccount \|

UserModified

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

@ID

IOCodeString

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>

@ID_Context1Used 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..1A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists: Unique ID Type (UIT)

@ID

string

1

The unique profile ID from the PMS.

Sample Message

IO_LoyaltyAccountInquiryRQ

Codeblock

language	xml
collapse	true

<IO_LoyaltyAccountInquiryRQ xmlns="http://protel.io/soap" EchoToken="LaureenTest_Charge2" TimeStamp="2021-09-16T06:35:41Z" Version="1.000" CorrelationID="LaureenTest_Charge2">
	<LoyaltyInquiryRequest TransactionAccount="ACCRUAL" HotelCode="2691" HotelID="7" HotelName="JA Ocean View Hotel, UAE-Dubai" ChainCode="HC1" MemberCode="12898323" ProgramCode="GHA" LevelCode="Gold" AccountStatus="4" PrimaryInd="true" TransactionVoidInd="false">
		<TransactionAmount Amount="10.320252" Type="D$">
			<CurrencyAmount CurrencyCode="AED" ExchangeRate="0.272242186649243">
				<Amount>37.91</Amount>
			</CurrencyAmount>
		</TransactionAmount>
		<StayInfo ReservationID="2390534" ArrivalDate="2019-08-15T00:00:00" DepartureDate="2019-08-19T00:00:00"/>
		<User UserName="HelloWorld" Organisation="Gruppe" Department="Department">
			<Email>EMail@Email</Email>
			<UserID ID="12315" ID_Context="protelID"/>
		</User>
	</LoyaltyInquiryRequest>
</IO_LoyaltyAccountInquiryRQ>

IO_LoyaltyAccountInquiryRS

Codeblock

language	xml
collapse	true

<IO_LoyaltyAccountInquiryRS xmlns="http://protel.io/soap" CorrelationID="LaureenTest_Charge2" Version="1.0" TimeStamp="2021-09-16T06:35:41"> <Success>true</Success> <LoyaltyInquiryResult> <TransactionAmount Amount="10.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>36.732</Amount> </CurrencyAmount> </TransactionAmount> <LoyaltyAccount MemberCode="12898323" ProgramCode="GHA" LevelCode="Gold" AccountStatus="4" PrimaryInd="false"> <CardHolderName>Gary</CardHolderName> <AccountBalance Amount="1893.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>6953.3676000000005</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.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>36.7320000000000009068</Amount> </CurrencyAmount> </AccountChargeLowerLimit> <AccountChargeUpperLimit Amount="1893.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>6953.3676000000005</Amount> </CurrencyAmount> </AccountChargeUpperLimit> </LoyaltyAccount> </LoyaltyInquiryResult> </IO_

@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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | 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

Name of the Department from the User

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified | Email

string

0..1

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

IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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"

LoyaltyAccountInquiryRS>

3.0.
Authentication	Bearer Token
Message type	Synchronous

Seitenhierarchie

Versionen im Vergleich

Alte Version 2

Neue Version Aktuell

Schlüssel

Message Description

IO_LoyaltyAccountInquiryRQ - Attributes

Message Attributes

IO_LoyaltyAccountInquiryRQ

IO_LoyaltyAccountInquiryRS - Attributes

IO_LoyaltyAccountInquiryRS

Sample Message

IO_LoyaltyAccountInquiryRQ

IO_LoyaltyAccountInquiryRS

Target audience	CRM
Version


Direction	Outbound

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 2

Neue Version Aktuell

Schlüssel

Message Description

IO_LoyaltyAccountInquiryRQ - Attributes

Message Attributes

IO_LoyaltyAccountInquiryRQ

IO_LoyaltyAccountInquiryRS - Attributes

IO_LoyaltyAccountInquiryRS

Sample Message

IO_LoyaltyAccountInquiryRQ

IO_LoyaltyAccountInquiryRS