Message Description
- This message will be used to request points
IO_LoyaltyAccountInquiryRQ - Attributes
| Element | @Attribute | Num | Description outbound | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|
IO_LoyaltyAccountInquiryRQ | 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_LoyaltyAccountInquiryRQ | LoyaltyInquiryRequest | 0..1 | | | ||
@TransactionAccount | 0..1 | Describes the action of the points |
| | |
@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. | | | |
@MemberCode | 1 | The member code attribute will indicate the actual number. | | | |
@ProgramCode | 1 | The program code 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). |
| | |
@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. |
| | |
@TransactionReference | 0..1 | external Reference ID for the Cancellation | | | |
@TransactionVoidInd | 0..1 | Displays if it is a Redemption or a Cancellation |
| | |
IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | 0..1 | Information of the Amount of the Redemption | | | |
@Amount | 1 | The Amount of the points | | | |
@Type | 1 | Code for Points | | | |
IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount | 0..1 | Information of the Amount of the Redemption in the Hotel Currency | | | |
@CurrencyCode | 1 | The Currency Code which is used by the Amount | | | |
@ExchangeRate | 0..1 | Exchange Rate | decimal | | |
IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount | Amount | 1 | The amount which will be paid with the Point Redemption | | | |
IO_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | StayInfo | 0..1 | Reservation Information | | | |
@ReservationID | 0..1 | Reservation ID | | | |
@ArrivalDate | 0..1 | Arrival Date | | | |
@DepartureDate | 0...1 | Departure Date | | | |
@CRSNumber | 0...1 | CRS ID | | | |
IO_LoyaltyAccountInquiryRQ | 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 | | | |
IO_LoyaltyAccountInquiryRQ | User | Email | 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 | | | |
| @ID | 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 | 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 | 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_LoyaltyAccountInquiryRS - Attributes
Element | @Attribute | Num | Description inbound | Comments + Contents inbound | pAir | OnPrem |
|---|---|---|---|---|---|
IO_LoyaltyAccountInquiryRS | 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_LoyaltyAccountInquiryRS | Success | 0..1 | | | ||
IO_LoyaltyAccountInquiryRS | 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 | 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_LoyaltyAccountInquiryRS | Errors | Error | Message | 0..1 | | | ||
IO_LoyaltyAccountInquiryRS | Warnings | Warning | 0..1 | Used in conjunction with the Success element to define one or more business errors. | | | |
@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_LoyaltyAccountInquiryRS | Warnings | Warning | Message | 0...1 | | | ||
| IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 0..1 | | | ||
| @TransactionReference | 0..1 | external Reference ID for the Cancellation | | | |
| @TransactionVoidInd | 0..1 | Displays if it is a Redemption or a Cancellation |
| | |
| IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | TransactionAmount | 1 | Information of the Amount of the Redemption | | | |
@Amount | 1 | The Amount of the points | | | |
@Type | 1 | Code for Points | | | |
IO_LoyaltyAccountInquiryRQ | LoyaltyInquiryResult | TransactionAmount | CurrencyAmount | 0..1 | Information of the Amount of the Redemption in the Hotel Currency | | | |
@CurrencyCode | 1 | The Currency Code which is used by the Amount | | | |
@ExchangeRate | 0..1 | Exchange Rate | decimal | | |
IO_LoyaltyAccountInquiryRQ | LoyaltyInquiryResult | TransactionAmount | CurrencyAmount | Amount | 1 | The amount which will be paid with the Point Redemption | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | 0..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 | The account status. Refer to Open Travel Code List Profile Status (PST). |
| | |
@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. |
| | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | CardHolderName | 0..1 | Name of the Membership card | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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 | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountBalance | CurrencyAmount | 0..1 | Amount in the default Currency | | | |
@ExchangeRate | 0..1 | Exchange Rate for the Loyalty Points | | | |
@CurrencyCode | 0..1 | Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountBalance | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyAccount | AccountAccrued | 0..1 | Total amount, the collected points | | | |
@Amount | 1 | Amount in Points | | | |
@Type | 1 | Shortname of the Loyalty Program | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountAccrued | CurrencyAmount | 0..1 | Amount in the default Currency | | | |
@ExchangeRate | 0..1 | Exchange Rate for the Loyalty Points | | | |
@CurrencyCode | 0..1 | Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountAccrued | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountRedeemed | 0..1 | Total amount of points redeemed | | | |
@Amount | 1 | Amount in Points | | | |
@Type | 1 | Shortname of the Loyalty Program | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount | 0..1 | Amount in the default Currency | | | |
@ExchangeRate | 0..1 | Exchange Rate for the Loyalty Points | | | |
@CurrencyCode | 0..1 | Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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 | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserCreated | Email | 0..1 | This field would be used to pass the guest’s Email. | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserCreated | UserID | 0..1 | This field would be used to pass the guest’s UserID | | | |
| @ID | 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 | 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 | 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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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 | | | |
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified | Email | 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 | | | |
| @ID | 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 | 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 | 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) | | |
Sample Message
IO_LoyaltyAccountInquiryRQ
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<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 | ||||
|---|---|---|---|---|
| ||||
<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_LoyaltyAccountInquiryRS> |