Message Description

protel I/O uses a request and response message pair 

• This message will be used to request points

pair to request at an external system the points, that are planned to be redeem. It is up to the external system if these points are somehow block in the external system. Protel will use the amount from the response for the redemption. 

Image Added

Message Attributes

IO_LoyaltyAccountInquiryRQ

Element | @Attribute	Type	Num	Description outbound	Comments + Contents outbound	pAir	OnPrem
IO_LoyaltyAccountInquiryRQ		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_LoyaltyAccountInquiryRQ | LoyaltyInquiryRequest		0..1
@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 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 Traveler and Company ID.
@LevelCode	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1	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
@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_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount		0..1	Information of the Amount of the Redemption
@Amount	decimal	1	The Amount of the points
@Type	string	1	Code for Points
IO_LoyaltyAccountInquiryRQ | 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_LoyaltyAccountInquiryRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount | Amount	decimal	1	The amount which will be paid with the Point Redemption
IO_LoyaltyAccountInquiryRQ | 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_LoyaltyAccountInquiryRQ | 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_LoyaltyAccountInquiryRQ | User | Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInquiryRQ | User | UserID		0..1	This field would be used to pass the guest’s UserID
@Type	IOCodeString	1	A 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 ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"

IO_LoyaltyAccountInquiryRS

Element | @Attribute	Type	Num	Description inbound	Comments + Contents inbound	pAir	OnPrem
IO_LoyaltyAccountInquiryRS		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_LoyaltyAccountInquiryRS | Success	boolean	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.	true false
IO_LoyaltyAccountInquiryRS | Errors | Error		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	string	0..1	An abbreviated version of the error in textual format.
@Type	OTA_CodeType EWT	0..1	Mandatory. Refers to the OTA Code List: Error Warning Type (EWT).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>
@Code	OTA_CodeType ERR	0..1	Refers to the OTA Code List: Error Codes (ERR).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>
IO_LoyaltyAccountInquiryRS | Errors | Error | Message	string	0...1	Description of the issue
IO_LoyaltyAccountInquiryRS | Warnings | Warning		0..1	Used in conjunction with the Success element to define one or more business errors.
@ShortText	string	0..1	An abbreviated version of the error in textual format.
@Type	OTA_CodeType EWT	0..1	Mandatory. Refers to the OTA Code List: Error Warning Type (EWT).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>
@Code	OTA_CodeType ERR	0..1	Refers to the OTA Code List: Error Codes (ERR).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>
IO_LoyaltyAccountInquiryRS | Warnings | Warning |  Message	string	0...1	Description of the issue
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult		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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | TransactionAmount		1	Information of the Amount of the Redemption
@Amount	decimal	1	The Amount of the points
@Type	string	1	Code for Points
IO_LoyaltyAccountInquiryRQ | LoyaltyInquiryResult | 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_LoyaltyAccountInquiryRQ | LoyaltyInquiryResult | TransactionAmount | CurrencyAmount | Amount	decimal	1	The amount which will be paid with the Point Redemption
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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 Traveler and Company ID.
@LevelCode	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1	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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | CardHolderName	string	0..1	Name of the Membership card
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountBalance | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInquiryRS | LoyaltyAccount | AccountAccrued		0..1	Total amount, the collected points
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountAccrued | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountRedeemed		0..1	Total amount of points redeemed
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount  | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | 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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserCreated | Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserCreated | UserID		0..1	This field would be used to pass the guest’s UserID
@Type	IOCodeString	1	A 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 ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified		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_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified | Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountInquiryRS | LoyaltyInquiryResult | LoyaltyAccount | UserModified | UserID		0..1	This field would be used to pass the guest’s UserID
@Type	IOCodeString	1	A 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 ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"