Versionen im Vergleich

Alte Version 4

changes.mady.by.user Unbekannter Benutzer (jacke)

Gespeichert am

verglichen mit

Neue Version 5

changes.mady.by.user Unbekannter Benutzer (jacke)

Gespeichert am

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Inhalt


Target audience
Version1.0.
AuthenticationBearer Token
Message typeAsynchronous, Outbound


Message Description

  • Send Transaction Info w/ Currency + Profile info w/ Location and Agent info
  • Receive Transaction Info + Membership Info

IO_LoyaltyAccountChargeRQ - Attributes

User | LastNameThis field would be used to pass the guest’s LastName.
Element | @AttributeNumDescription outboundContent outboundpAirOnPrem

IO_LoyaltyAccountChargeRQ

1Root 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 | LoyaltyChargeRequest1@TransactionTime"2021-02-23T14:38:14Z"



@TransactionAccount0..1Describes the action of the points
  • ACCRUAL
@TransactionAccount



@HotelCode0..1Full name of the property which the transferred stay information belongs to.


@HotelID0..1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.




@HotelName0..1Full name of the property which the transferred stay information belongs to.


@ChainCode0..1Full name of the property which the transferred stay information belongs to.


@MemberCode1The MemberCode attribute will indicate the actual number.


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


@LevelCode0..1Indicates special privileges in program assigned to individual.


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


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


LoyaltyChargeRequest | TransactionAmount0..1Information of the Amount of the Redemption 


@Amount1The Amount of the points


@Type1Code for Points


TransactionAmount | CurrencyAmount0..1Information of the Amount of the Redemption in the Hotel Currency


@CurrencyCode1The Currency Code which is used by the Amount


CurrencyAmount | Amount1The amount which will be paid with the Point Redemption


LoyaltyChargeRequest | StayInfo0..1Reservation Information


@ReservationID0..1Reservation ID


@ArrivalDate0..1Arrival Date


@DepartureDate0...1Departure Date


@CRSNumber0...1CRS ID


IO_LoyaltyAccountChargeRQ | User1Information of the logged-in user


@UserName0..1Name of the User


@Organisation0..1@Department0..1@Occupation0..1User | FirstNameName of the Group the User belongs to


@Department0..1

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

0..1Name of the Department from the User


User | Email0..1This field would be used to pass the guest’s Email.


User | Phone0..1This field would be used to pass the guest’s PhoneUser | UserID0..1This field would be used to pass the guest’s UserID


Sample Message

Codeblock
languagexml
collapsetrue
<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 - Attributes

10..10..10..1This field would be used to pass the guest’s LastName.This field would be used to pass the guest’s LastName.
Element | @AttributeNumDescription outboundContent outboundpAirOnPrem

IO_LoyaltyAccountChargeRS

1Root 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 | Success0..1



IO_LoyaltyAccountInfoRS | Errors0..1Indicates 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 | Error0..1

An error that occurred during the processing of a message.




@ShortText0..1An abbreviated version of the error in textual format.


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


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


Error | Message0..1Message Text


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


Warnings | Warning0..1Used when a message has been successfully processed to report any warnings or business errors that occurred.


@ShortText0..1An abbreviated version of the error in textual format.


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


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


Warning | Message0...1



IO_LoyaltyAccountChargeRS | LoyaltyAccount




@MemberCode1The MemberCode attribute will indicate the actual number.


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


@LevelCode0..1Indicates special privileges in program assigned to individual.


@AccountStatus0..1The account status. Refer to Open Travel Code List Profile Status (PST).
  • 4 = Active
  • 5 = Inactive


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


LoyaltyAccount | CardHolderName0..1LoyaltyAccount | ExpireDate0..1LoyaltyAccount | EffectiveDate1LoyaltyAccount | AccountBalance1Name of the Membership card


LoyaltyAccount | AccountBalance1Actual amount available, which can be used for redeeming the points


@Amount

1Amount in Points

@Amount




@Type1Shortname of the Loyalty Program


AccountBalance | CurrencyAmount0..1Amount in the default Currency


@CurrencyCode

0..1@ExchangeRateCurrency Code, from the RQ


CurrencyAmount | Amount1Amount in the Currency Code, from the RQ


LoyaltyAccount | AccountAccrued0..1Total amount, the collected points


@Amount

1Amount in Points


@Type1Shortname of the Loyalty Program


AccountAccrued | CurrencyAmount0..1Amount in the default Currency


@CurrencyCode

0..1@ExchangeRateCurrency Code, from the RQ


CurrencyAmount | Amount1Amount in the Currency Code, from the RQ


LoyaltyAccount | AccountRedeemed0..1Total amount of points redeemed


@Amount

1Amount in Points


@Type1Shortname of the Loyalty Program


AccountAccrued | CurrencyAmount0..1Amount in the default Currency


@CurrencyCode

0..1@ExchangeRateCurrency Code, from the RQ


CurrencyAmount | Amount1Amount in the Currency Code, from the RQ


LoyaltyAccount | UserCreated0..1Information of the logged-in user


@UserName0..1Name of the User


@Organisation0..1Name of the Group the user belongs to


@Department0..1@Occupation0..1UserCreated | FirstName0..1

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

UserCreated | LastName0..1Name of the Department from the User


UserCreated | Email0..1This field would be used to pass the guest’s Email.UserCreated | Phone0..1


This field would be used to pass the guest’s PhoneUserCreated  | UserID0..1This field would be used to pass the guest’s UserID


LoyaltyAccount | UserModified0..1Information of the logged-in user


@UserName0..1Name of the User


@Organisation0..1Name of the Group the user belongs to


@Department0..1@Occupation0..1UserModified | FirstName0..1

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

UserModified | LastName0..1Name of the Department from the User


UserModified  | Email0..1This field would be used to pass the guest’s Email.UserModified | Phone0..1This field would be used to pass the guest’s Phone


UserModified | UserID0..1This field would be used to pass the guest’s UserID


Sample Message

Codeblock
languagexml
collapsetrue
<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>