Versionen im Vergleich

Alte Version 17

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

Gespeichert am

verglichen mit

Neue Version 18

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

  • Lookup by Member ID w/ Currency for Points
  • Receive Membership Info w/ Points & Account Balance in Hotel Currency

IO_LoyaltyAccountInfoRQ - Attributes

LoyaltyAccountInfoRQ | POS | Source |

RequestorID

Reference to the sending system.@Type10 = "Hotel"@ID same@ID_Context"protelIO"IO_LoyaltyAccountInfoRQ | POS | Source | BookingChannelSpecifies the booking channel type and whether it is the primary means of connectivity of the source
  • true
    • false1nLoyalty Information
  • true
    • false@UserNameName of the User@OrganisationName of the Group the user belongs toThis field would be used to pass the guest’s UserID

    Element | @Attribute

    Num

    Description outbound

    Comments + Contents outbound

    pAir

    OnPrem

    IO_LoyaltyAccountInfoRQ

    		1Root element of the message.


    		(Fehler)(Haken)

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


    		(Fehler)(Haken)

    @CorrelationID

    1

    Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.


    		(Fehler)(Haken)

    @TimeStamp

    0..1

    Time of the transaction.

    		"2019-06-05T09:12:14Z"(Fehler)(Haken)

    @Version

    0..1

    Message version.

    Version="3.001"

    		(Fehler)(Haken)

    @PrimaryLangID

    0..1

    The primary language preference for the message encoded as ISO 639-3.


    		(Fehler)(Haken)

    IO_

    1

    LoyaltyAccountInfoRQ | ReadRequests

    		0..1

    		(Fehler)(Haken)
    @HotelCode0..1

    A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type 

    		Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)
    @HotelID0..1

    The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the

    same throughout the messages.


    		(Fehler)(Haken)
    @HotelName0..1Used to identify where the ID comes from.Full name of the property which the transferred stay information belongs to.


    		(Fehler)(Haken)
    @ChainCode0..1Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)@Primary0..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.

    IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest

    		1..nLoyalty Information
    		(Fehler)(Haken)
    @CurrencyCode0..1Default Hotel Currency Code
    		(Fehler)(Haken)
    @Type1Indicates the type of booking channel. Refer to OpenTravel Code List Booking Channel Type (BCT)."4" = Property management system (PMS)(Fehler)(Haken)
    IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions0..1A 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.    		(Fehler)(Haken)IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | px:POSExtensions0..1Extensions about the transferred POS.(Fehler)(Haken)IO_LoyaltyAccountInfoRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo0..1Extensions about the transferred POS - specifying details about the hotel's system.(Fehler)(Haken)
    @MemberCode1The MemberCode attribute will indicate the actual member number
    @FiscalDate1Current Business Date of the PMSyyyy-mm-dd(Fehler)(Haken)

    IO_LoyaltyAccountInfoRQ | ReadRequests

    		0..1(Fehler)(Haken)@HotelCode0..1Full name of the property which the transferred stay information belongs to.(Fehler)(Haken)@HotelID0..1

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

    		(Fehler)(Haken)@HotelName0..1Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)
    @ChainCode

    @ProgramCode

    		0..1Full name of the property which the transferred stay information belongs toThe 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.
    		(Fehler)(Haken)
    @LevelCode0

    IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest

    		..1Indicates special privileges in program assigned to individual.
    		(Fehler)(Haken)
    @CurrencyCode@AccountStatus0..1Default Hotel Currency Code(Fehler)(Haken)The account status. Refer to Open Travel Code List Profile Status (PST).
    • 4 = Active
    • 5 = Inactive
    		@MemberCode1The MemberCode attribute will indicate the actual member number.
    		(Fehler)(Haken)
    @ProgramCode@PrimaryInd10..1When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.
    • true
    • false
    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.
    		(Fehler)(Haken)@LevelCode

    IO_LoyaltyAccountInfoRQ  | ReadRequests | User

    		0..1Information of the logged-in user
    		(Fehler)(Haken)
    @UserName0..1Name of the UserIndicates special privileges in program assigned to individual.
    		(Fehler)(Haken)
    @AccountStatus@Organisation0..1Name of the Group the user belongs to
    		(Fehler)(Haken)
    @Department0..1Name of the Department from the UserThe account status. Refer to Open Travel Code List Profile Status (PST).
  • 4 = Active
    • 5 = Inactive
    		(Fehler)(Haken)@PrimaryInd
    IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest | User | Email0..1When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.This field would be used to pass the guest’s Email.
    		(Fehler)(Haken)
    IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest | User1Information of the logged-in user(Fehler)(Haken)| User | UserID0..1This field would be used to pass the guest’s UserID
    		(Fehler)(Haken)
    @ID0..11A 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.


    		(Fehler)(Haken)@Department0..1Name of the Department from the User(Fehler)(Haken)IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest | User | Email0..1This field would be used to pass the guest’s Email.(Fehler)(Haken)IO_LoyaltyAccountInfoRQ  | ReadRequests | LoyaltyReadRequest | User | UserID0..1
    @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


    		(Fehler)(Haken)
    @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)


    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS - Attributes

    Element | @AttributeNumDescription inboundComments + Contents inboundpAirOnPrem

    IO_LoyaltyAccountInfoRS

    		1Root element of the message.


    		(Fehler)(Haken)

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


    		(Fehler)(Haken)

    @CorrelationID

    1

    Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.


    		(Fehler)(Haken)

    @TimeStamp

    0..1

    Time of the transaction.

    		"2019-06-05T09:12:14Z"(Fehler)(Haken)

    @Version

    0..1

    Message version.

    Version="3.001"

    		(Fehler)(Haken)

    @PrimaryLangID

    0..1

    The primary language preference for the message encoded as ISO 639-3.


    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | Success

    		0..1

    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | Errors

    		0..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.
    		(Fehler)(Haken)
    Errors | Error0..1

    An error that occurred during the processing of a message.


    		(Fehler)(Haken)
    @ShortText0..1An abbreviated version of the error in textual format.
    		(Fehler)(Haken)
    @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).
    		(Fehler)(Haken)
    @Type0..1Mandatory. Refer to OTA Code List: Error Warning Type (EWT).
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | Warnings

    		0..1Used in conjunction with the Success element to define one or more business errors.
    		(Fehler)(Haken)
    Warnings | Warning0..1Used when a message has been successfully processed to report any warnings or business errors that occurred.
    		(Fehler)(Haken)
    @ShortText0..1An abbreviated version of the error in textual format.
    		(Fehler)(Haken)
    @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).
    		(Fehler)(Haken)
    @Type0..1Mandatory. Refer to OTA Code List: Error Warning Type (EWT).
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults

    		0..1

    		(Fehler)(Haken)
    @HotelCode0..1Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)
    @HotelID0..1

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


    		(Fehler)(Haken)
    @HotelName0..1Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)
    @ChainCode0..1Full name of the property which the transferred stay information belongs to.
    		(Fehler)(Haken)

    LoyaltyReadResults | LoyaltyAccount

    		1

    		(Fehler)(Haken)
    @MemberCode1The MemberCode attribute will indicate the actual number.
    		(Fehler)(Haken)

    @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.
    		(Fehler)(Haken)
    @LevelCode0..1Indicates special privileges in program assigned to individual.
    		(Fehler)(Haken)
    @AccountStatus0..1OTA Code list PST
    • /** 1 */ MarkedForDeletion
    • /** 2 */ Lapsed
    • /** 3 */ Terminated
    • /** 4 */ Active
    • /** 5 */ Inactive
    		(Fehler)(Haken)
    @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
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | CardHolderName

    		0..1Name of the Membership card
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance

    		1The actual amount available, which can be used for redeeming the points
    		(Fehler)(Haken)

    @Amount

    		1Amount in Points
    		(Fehler)(Haken)
    @Type1Shortname of the Loyalty Program
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount

    		0..1Amount in the default Currency
    		(Fehler)(Haken)
    @ExchangeRate0..1Exchange Rate for the Loyalty Points

    decimal


    Account...@Amount * ExchangeRate = CurrencyAmount@Amount 

    		(Fehler)(Haken)

    @CurrencyCode

    		1Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountBalance | CurrencyAmount | Amount

    		1Amount in the Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued

    		0..1Total amount, the collected points
    		(Fehler)(Haken)

    @Amount

    		1Amount in Points
    		(Fehler)(Haken)

    @Type

    		1Shortname of the Loyalty Program
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued | CurrencyAmount

    		0..1Amount in the default Currency
    		(Fehler)(Haken)

    @ExchangeRate

    		0..1Exchange Rate for the Loyalty Points
    		(Fehler)(Haken)

    @CurrencyCode

    		0..1Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountAccrued | CurrencyAmount | Amount

    		1Amount in the Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed

    		0..1Total amount of points redeemed
    		(Fehler)(Haken)

    @Amount

    		1Amount in Points
    		(Fehler)(Haken)

    @Type

    		1Shortname of the Loyalty Program
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed | CurrencyAmount

    		0..1Amount in the default Currency
    		(Fehler)(Haken)

    @ExchangeRate

    		0..1Exchange Rate for the Loyalty Points
    		(Fehler)(Haken)

    @CurrencyCode

    		0..1Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountRedeemed | CurrencyAmount | Amount

    		1Amount in the Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeUpperLimit

    		0..1Maximum amount of points usable for a single redemption (Account and Invoice) 
    		(Fehler)(Haken)

    @Amount

    		1Amount in Points
    		(Fehler)(Haken)

    @Type

    		1Shortname of the Loyalty Program
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeUpperLimit| CurrencyAmount

    		0..1Amount in the default Currency
    		(Fehler)(Haken)

    @ExchangeRate

    		0..1Exchange Rate for the Loyalty Points
    		(Fehler)(Haken)

    @CurrencyCode

    		0..1Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeUpperLimit| CurrencyAmount | Amount

    		1Amount in the Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeLowerLimit  

    		0..1Minimum amount of points needed for a single redemption (Account and Invoice)
    		(Fehler)(Haken)

    @Amount

    		1Amount in Points
    		(Fehler)(Haken)

    @Type

    		1Shortname of the Loyalty Program
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeLowerLimit  | CurrencyAmount

    		0..1Amount in the default Currency
    		(Fehler)(Haken)

    @ExchangeRate

    		0..1Exchange Rate for the Loyalty Points
    		(Fehler)(Haken)

    @CurrencyCode

    		0..1Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | AccountChargeLowerLimit  | CurrencyAmount | Amount

    		1Amount in the Currency Code, from the RQ
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated

    		0..1Information of the logged-in user
    		(Fehler)(Haken)

    @UserName

    		0..1Name of the User
    		(Fehler)(Haken)

    @Organisation

    		0..1Name of the Group the user belongs to
    		(Fehler)(Haken)

    @Department

    		0..1Name of the Department from the User
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated | Email

    		0..1This field would be used to pass the guest’s Email.
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | LoyaltyAccount | UserCreated | UserID

    		0..1This field would be used to pass the guest’s UserID
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified

    		0..1

    		(Fehler)(Haken)

    @UserName

    		0..1

    		(Fehler)(Haken)

    @Organisation

    		0..1

    		(Fehler)(Haken)

    @Department

    		0..1

    		(Fehler)(Haken)

    @Occupation

    		0..1

    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | FirstName

    		0..1

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


    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | LastName

    		0..1This field would be used to pass the guest’s LastName.
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Email

    		0..1This field would be used to pass the guest’s Email.
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | Phone

    		0..1This field would be used to pass the guest’s Phone
    		(Fehler)(Haken)

    IO_LoyaltyAccountInfoRS | LoyaltyReadResults | LoyaltyAccount | UserModified | UserID

    		0..1This field would be used to pass the guest’s UserID
    		(Fehler)(Haken)


    Sample Message

    IO_LoyaltyAccountInfoRQ

    Codeblock
    languagexml
    collapsetrue
    <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
    languagexml
    collapsetrue
    <IO_LoyaltyAccountInfoRS xmlns="http://protel.io/soap" CorrelationID="Laureen_Info_3" Version="1.0" TimeStamp="2021-08-19T15:15:16">
    <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="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>
    </LoyaltyReadResults>
</IO_LoyaltyAccountInfoRS>