Message Description
- Send Transaction Info w/ Currency + Profile info w/ Location and Agent info
- Receive Transaction Info + Membership Info
IO_LoyaltyAccountChargeRQ - Attributes
| Element | @Attribute | Num | Description | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|
IO_LoyaltyAccountChargeRQ | 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_LoyaltyAccountChargeRQ | LoyaltyChargeRequest | 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 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. |
| | |
| LoyaltyChargeRequest | TransactionAmount | 0..1 | Information of the Amount of the Redemption | | ||
| @Amount | 1 | The Amount of the points | | ||
| @Type | 1 | Code for Points | | ||
| 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 | | ||
| CurrencyAmount | Amount | 1 | The amount which will be paid with the Point Redemption | | ||
| 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_LoyaltyAccountChargeRQ | 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_LoyaltyAccountChargeRS - Attributes
| Element | @Attribute | Num | Description | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|
IO_LoyaltyAccountChargeRS | 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). | | ||
| Error | Message | 0..1 | Message Text | | ||
| 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). | | ||
| Warning | Message | 0...1 | | |||
| IO_LoyaltyAccountChargeRS | LoyaltyAccount | | ||||
| @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. |
| | |
| @TransactionReference | 0..1 | external Reference ID for the Cancellation | | ||
| @TransactionVoidInd | 0..1 | Displays if it is a Redemption or a Cancellation |
| | |
| 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 | 0..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 | UserID | 0..1 | This field would be used to pass the guest’s UserID | |
Sample Message
IO_LoyaltyAccountChargeRQ
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<p:IO_LoyaltyAccountChargeRQ xmlns:p="http://protel.io/soap" CorrelationID="TRIGGER#000104#UPDATE#000776#1614091094240#DB8A" Version="1.0" TimeStamp="2021-02-23T14:38:14Z" EchoToken="TRIGGER#000104#UPDATE#000776#1614091094240#DB8A" PrimaryLangID="en" Target="Test" TargetName="Test"> <p:LoyaltyChargeRequest TransactionTime="2021-02-23T14:38:14Z" TransactionAccount="ACCRUAL" HotelCode="2987" HotelID="104" HotelName="DEV 2280" ChainCode="MRHCH" MemberCode="2345754635123" ProgramCode="Lounge Coders Club" LevelCode="HighRoller" AccountStatus="4" PrimaryInd="true"> <p:TransactionAmount Amount="100" Type="L$C"> <p:CurrencyAmount CurrencyCode="CHF"> <p:Amount>30.00</p:Amount> </p:CurrencyAmount> </p:TransactionAmount> <p:StayInfo ReservationID="20013" ArrivalDate="2019-09-26T12:00:00+02:00" DepartureDate="2019-09-30T12:00:00+02:00" CRSNumber=""/> </p:LoyaltyChargeRequest> <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:IO_LoyaltyAccountChargeRQ> |
IO_LoyaltyAccountChargeRS
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<p:IO_LoyaltyAccountChargeRS xmlns:p="http://protel.io/soap" CorrelationID="TRIGGER#000104#UPDATE#000776#1614091094240#DB8A" Version="1.0" TimeStamp="2021-02-23T15:24:09Z" PrimaryLangID="en">
<p:Success>true</p:Success>
<p:Warnings>
<p:Warning ShortText="Low points balance" Code="0" ReferenceCode="L$C">
<p:Message>Just a test warning</p:Message>
</p:Warning>
</p:Warnings>
<p:LoyaltyAccount MemberCode="2345754635123" ProgramCode="Lounge Coders Club" LevelCode="HighRoller" AccountStatus="4">
<p:CardHolderName>Oneoone K. Board</p:CardHolderName>
<p:ExpireDate>2021-06-03</p:ExpireDate>
<p:AccountBalance Amount="0" Type="L$C">
<p:CurrencyAmount CurrencyCode="CHF">
<p:Amount>1</p:Amount>
</p:CurrencyAmount>
</p:AccountBalance>
<p:AccountAccrued Amount="0" Type="L$C">
<p:CurrencyAmount CurrencyCode="CHF">
<p:Amount>1</p:Amount>
</p:CurrencyAmount>
</p:AccountAccrued>
<p:AccountRedeemed Amount="0" Type="L$C">
<p:CurrencyAmount CurrencyCode="CHF">
<p:Amount>1</p:Amount>
</p:CurrencyAmount>
</p:AccountRedeemed>
</p:LoyaltyAccount>
</p:IO_LoyaltyAccountChargeRS> |