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 | pAir | OnPrem |
|---|---|---|---|---|---|
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 | POS | Source | RequestorID | 1 | Reference to the sending system. | | | |
@Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type | 10 = "Hotel" | | |
| @ID | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | | | |
@ID_Context | 0..1 | Used to identify where the ID comes from. | "protelIO" | | |
| IO_LoyaltyAccountInfoRQ | POS | Source | BookingChannel | 0..1 | Specifies the booking channel type and whether it is the primary means of connectivity of the source. | | | |
| @Primary | 0..1 | Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent. |
| | |
| @Type | 1 | Indicates the type of booking channel. Refer to OpenTravel Code List Booking Channel Type (BCT). | "4" = Property management system (PMS) | | |
| IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | 0..1 | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | | | |
| IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | px:POSExtensions | 0..1 | Extensions about the transferred POS. | | | |
| IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Extensions about the transferred POS - specifying details about the hotel's system. | | | |
| @FiscalDate | 1 | Current Business Date of the PMS | yyyy-mm-dd | | |
IO_LoyaltyAccountInfoRQ | ReadRequests | 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. | | | |
IO_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | 1..n | Loyalty Information | | | |
| @CurrencyCode | 0..1 | Default Hotel Currency Code | | | |
| @MemberCode | 1 | The MemberCode attribute will indicate the actual member 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_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | 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_LoyaltyAccountInfoRQ | ReadRequests | LoyaltyReadRequest | User | Email | 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 | | |
IO_LoyaltyAccountInfoRS - Attributes
| Element | @Attribute | Num | Description inbound | Comments + Contents inbound | pAir | OnPrem |
|---|---|---|---|---|---|
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 | OTA Code list 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_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | CardHolderName | 0..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 | 1 | Amount in Points | | | |
| @Type | 1 | Shortname of the Loyalty Program | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount | 0..1 | Amount in the default Currency | | | |
| @ExchangeRate | 0..1 | Exchange Rate for the Loyalty Points | decimal CurrencyAmount@Amount * ExchangeRate = Account...@Amount | | |
@CurrencyCode | 1 | Currency Code, from the RQ | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued | 0..1 | Total amount, the collected points | | | |
@Amount | 1 | Amount in Points | | | |
@Type | 1 | Shortname of the Loyalty Program | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | 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_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed | 0..1 | Total amount of points redeemed | | | |
@Amount | 1 | Amount in Points | | | |
@Type | 1 | Shortname of the Loyalty Program | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | 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_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed | CurrencyAmount | Amount | 1 | Amount in the Currency Code, from the RQ | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | 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_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated | Email | 0..1 | This field would be used to pass the guest’s Email. | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated | UserID | 0..1 | This field would be used to pass the guest’s UserID | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | 0..1 | | | ||
@UserName | 0..1 | | | ||
@Organisation | 0..1 | | | ||
@Department | 0..1 | | | ||
@Occupation | 0..1 | | | ||
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | FirstName | 0..1 | This field would be used to pass the guest’s GivenName. | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | LastName | 0..1 | This field would be used to pass the guest’s LastName. | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Email | 0..1 | This field would be used to pass the guest’s Email. | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Phone | 0..1 | This field would be used to pass the guest’s Phone | | | |
IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | UserID | 0..1 | This field would be used to pass the guest’s UserID | | |
Sample Message
IO_LoyaltyAccountInfoRQ
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<IO_LoyaltyAccountInfoRQ xmlns="http://protel.io/soap" EchoToken="Laureen_Info_2" TimeStamp="2021-08-19T14:41:25Z" Version="1.000" CorrelationID="Laureen_Info_2"> <POS xmlns="http://www.opentravel.org/OTA/2003/05"> <Source> <RequestorID Type="10" ID="2691" ID_Context="protelIO"/> <BookingChannel Type="4" Primary="true"/> <TPA_Extensions> <px:POSExtensions xmlns:px="http://protel.io/htng/extensions"> <px:HotelInfo FiscalDate="2019-08-17"/> </px:POSExtensions> </TPA_Extensions> </Source> </POS> <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" PrimaryIndSpecified="true"> <User UserName="HelloWorld" Organisation="Gruppe" Department="Department"> <Email>EMail@Email</Email> <UserID>12312</UserID> </User> </LoyaltyReadRequest> </ReadRequests> </IO_LoyaltyAccountInfoRQ> |
IO_LoyaltyAccountInfoRS
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<IO_LoyaltyAccountInfoRS xmlns="http://protel.io/soap" CorrelationID="Laureen_Info_2" Version="1.0" TimeStamp="2021-08-19T14:42:13"> <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="1903.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>6990.0996000000005</Amount> </CurrencyAmount> </AccountBalance> <AccountAccrued Amount="5000.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>18366,000003</Amount> </CurrencyAmount> </AccountAccrued> <AccountRedeemed Amount="3000.0" Type="D$"> <CurrencyAmount CurrencyCode="AED" ExchangeRate="0.27224218664924316"> <Amount>11019,6000019</Amount> </CurrencyAmount> </AccountRedeemed> <UserCreated UserName="HelloWorld" Organisation="Gruppe" Department="Department"> <Email>EMail@Email</Email> <UserID>12312</UserID> </UserCreated> </LoyaltyAccount> </LoyaltyReadResults> </IO_LoyaltyAccountInfoRS> |