Message Description

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

Receive Transaction Info + Membership

protel I/O uses a request and response message pair to redeem loyalty points at an external system. In the request message include transcation info with currency and agent information.

Image Added

Info

Message Attributes

IO_LoyaltyAccountChargeRQ

Element \| @Attribute	Type	Num	Description outbound	Comments + Contents outbound
IO_LoyaltyAccountChargeRQ		1	Root element of the message.
@EchoToken	string	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	string	1	Used to match result messages (RS) to request messages (RQ) in asynchronous communication patterns. Therefore mandatory.
@TimeStamp	dateTime	0..1	Time of the transaction.	"2019-06-05T09:12:14Z"
@Version	string	0..1	Message version.	Version="3.001"
@PrimaryLangID	string	0..1	The primary language preference for the message encoded as ISO 639-3.
IO_LoyaltyAccountChargeRQ \| LoyaltyChargeRequest		1	Information of the Redemption
@TransactionAccount	IOCodeString	0..1	Describes the action of the points	ACCRUAL
@HotelCode	string	0..1	Full name of the property which the transferred stay information belongs to.
@HotelID	string	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	string	0..1	Full name of the property which the transferred stay information belongs to.
@ChainCode	string	0..1	Full name of the property which the transferred stay information belongs to.
@MemberCode	IOCodeString	1	The

member code

MemberCode attribute will indicate the actual member number.
@ProgramCode	string	1	The

program code

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	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1	The account status. Refer to Open Travel Code List Profile Status (PST).

4 = Active

5 = Inactive@TransactionReference

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>

@PrimaryInd

boolean

0..1

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

true
false

@PrimaryIndSpecified0..1

true
false

@TransactionReference

IOCodeString

IO_LoyaltyAccountChargeRQ \| LoyaltyChargeRequest \| TransactionAmount		0..1	Information of the Amount of the Redemption
0..1	external Reference ID for the Cancellation
@TransactionVoidInd	boolean	0..1	Displays if it is a Redemption or a Cancellation	true false
@Amount	decimal	1	The Amount of the points
@Type	string	1	Code for Points
IO_LoyaltyAccountChargeRQ \| LoyaltyChargeRequest \| TransactionAmount \| CurrencyAmount		0..1	Information of the Amount of the Redemption in the Hotel Currency
@CurrencyCode	decimal	1	The Currency Code which is used by the Amount
@ExchangeRate	string	0..1	Exchange Rate	decimal
IO_LoyaltyAccountChargeRQ \| LoyaltyChargeRequest \| TransactionAmount \| CurrencyAmount \| Amount	decimal	1	The amount which will be paid with the Point Redemption
IO_LoyaltyAccountChargeRQ \| LoyaltyChargeRequest \| StayInfo		0..1	Reservation Information
@ReservationID	string	0..1	Reservation ID
@ArrivalDate	dateTime	0..1	Arrival Date
@DepartureDate	dateTime	0...1	Departure Date
@CRSNumber	string	0...1	CRS ID
IO_LoyaltyAccountChargeRQ \| User		1	Information of the logged-in user
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the User belongs to
@Department	string	0..1	Name of the Department from the User
IO_LoyaltyAccountChargeRQ \| User \| Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountChargeRQ \| User \| UserID		0..1	This field would be used to pass the guest’s UserID
@Type

@ID

IOCodeString

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

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

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@ID

string

1

The unique profile ID from the PMS.

@ID_Context

string

1

Used to identify the source of the

identifier

ID. For

both outbound (from protel IO) and

inbound (to

protel IO

protelIO)

request messages

requests, this

must

will carry

the string value

@Type0..1A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists: Unique ID Type (UIT)

a string value identifying the protel I/O Integration Partner.

“protelIO"

IO_LoyaltyAccountChargeRS

Element \| @Attribute	Type	Num	Description inbound	Comments + Contents inbound
IO_LoyaltyAccountChargeRS	string	1	Root element of the message.
@EchoToken	string	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	dateTime	1	Used to match result messages (RS) to request messages (RQ) in asynchronous communication patterns. Therefore mandatory.	"2019-06-05T09:12:14Z"
@TimeStamp	string	0..1	Time of the transaction.

"2019-06-05T09:12:14Z

Version="3.001"
@Version	string	0..1	Message version

.Version="3

.

001"

IO_

@PrimaryLangID	boolean	0..1	The primary language preference for the message encoded as ISO 639-3.	true false

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS \| Success		0..1	Returning an empty element of this type indicates the successful processing of the message. It could be combined with warning message/s if the message had issue/s.
IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS \| Errors \|

Error

string

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

OTA_CodeType EWT

0..1

An abbreviated version of the error in textual format.

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

@Code

@Type

OTA_CodeType ERR

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

Mandatory. Refers to the OTA Code List: Error Warning Type (EWT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@Type

@Code

string

0..

1

Mandatory. Refer to OTA Code

Refers to the OTA Code List: Error

Warning Type

Codes (

EWT

IO_
ERR).

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS \| Errors \|

Error

Error \| Message		0...1	Description of the issue
IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS \| Warnings \|

Warning

string

0..1

Used in conjunction with the Success element to define one or more business errors.

@ShortText

OTA_CodeType EWT

0..1

An abbreviated version of the error in textual format.

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

@Code

@Type

OTA_CodeType ERR

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

Mandatory. Refers to the OTA Code List: Error Warning Type (EWT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@Code

string

0..1

Refers to the OTA Code List: Error Codes (ERR).

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

IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS \|

Warnings

Warnings \|

Warning

Warning \| Message		0...1	Description of the issue
IO_LoyaltyAccountChargeRS \| LoyaltyChargeResult		0..1
@TransactionReference	IOCodeString	0..1	external Reference ID for the Cancellation
@TransactionVoidInd	boolean	0..1	Displays if it is a Redemption or a Cancellation	true false
IO_LoyaltyAccountChargeRS \| LoyaltyChargeResult \| LoyaltyAccount		0..1
@MemberCode	IOCodeString	1	The MemberCode attribute will indicate the actual number.
@ProgramCode	string	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	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1

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

4 = Active
5 = Inactive

OTA Code list PST

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>

@PrimaryInd

boolean

0..1

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

true
false

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | CardHolderName

string

0..1

Name of the Membership card

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountBalance

1

Actual amount available, which can be used for redeeming the points

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountBalance | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountAccrued

0..1

Total amount, the collected points

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountAccrued | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountRedeemed

0..1

Total amount of points redeemed

@Amount

decimal

1

Amount in Points

@Type

string

1

Shortname of the Loyalty Program

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount

0..1

Amount in the default Currency

@ExchangeRate

decimal

0..1

Exchange Rate for the Loyalty Points

@CurrencyCode

string

0..1

Currency Code, from the RQ

decimal

1

Amount in the Currency Code, from the RQ

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated

0..1

Information of the logged-in user

@UserName

IOCodeString

0..1

Name of the User

@Organisation

string

0..1

Name of the Group the user belongs to

@Department

string

0..1

Name of the Department from the User

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated | Email

0..1

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

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated | UserID

0..1

This field would be used to pass the guest’s UserID

@ID

@Type

IOCodeString

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

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

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@ID

string

1

The unique profile ID from the PMS.

@ID_Context

string

1

Used to identify the source of the

identifier

ID. For

both outbound (from protel IO) and

inbound (to

protel IO

protelIO)

request messages

requests, this

must

will carry

the string value

@Type0..1A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists: Unique ID Type (UIT)

IO_LoyaltyAccountChargeRS \| LoyaltyChargeResult \| LoyaltyAccount \| UserModified		0..1	Information of the logged-in user
a string value identifying the protel I/O Integration Partner.	“protelIO"
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the user belongs to
@Department	string	0..1	Name of the Department from the User
IO_LoyaltyAccountChargeRS \| LoyaltyChargeResult \| LoyaltyAccount \| UserModified \| Email		0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountChargeRS \| LoyaltyChargeResult \| LoyaltyAccount \| UserModified \| UserID		0..1	This field would be used to pass the guest’s UserID
@Type

@ID

IOCodeString

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

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

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@ID

string

1

The unique profile ID from the PMS.

@ID_Context

string

1

Used to identify the source of the

identifier

ID. For

both outbound (from protel IO) and

inbound (to

protel IO

protelIO)

request messages

requests, this

must

will carry

the string value

@Type0..1A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists: Unique ID Type (UIT)

a string value identifying the protel I/O Integration Partner.

“protelIO"

Target audience	CRM
Version	1.0.
Authentication	Bearer Token
Message type	Synchronous, Outbound
Direction	Outbound

Seitenhierarchie

Versionen im Vergleich

Alte Version 14

Neue Version 15

Schlüssel

Message Description

Message Attributes

IO_LoyaltyAccountChargeRQ

IO_LoyaltyAccountChargeRS

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 14

Neue Version 15

Schlüssel

Message Description

Message Attributes

IO_LoyaltyAccountChargeRQ

IO_LoyaltyAccountChargeRS