Message Description
protel I/O uses a request and response message pair to notify booking agents of newly created (initial) packages or modifications to existing (active) packages. In practice, a request message can be sent to a Central Reservation System (outbound).
The packages contain the information needed to post internally certain sums of room rates / arrangements onto various transaction accounts (e.g. breakfast and half board). It is possible that multiple packages are assigned to one rate code. The packages can be configured as an inclusive package (included in the rate amount) or exclusive (added to the rate amount).
Message Attributes
IO_RatePackageNotifRQ
Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|---|
IO_RatePackageNotifRQ | 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 | 1 | Timestamp of the transaction. |
|
| |
@Version | string | 0..1 | Version of the message |  |
| |
@PrimaryLangID | string | 0..1 | Default language of the property. | ISO-639-1 (2-char code) "en" |
|
|
IO_RatePackageNotifRQ | Packages | 1 | Element grouping the package to be transferred. |
|
| ||
@HotelCode | string | 0..1 | This is the Hotel Cloud ID in protel for which the packages are being transferred. |
|
| |
@HotelID | string | 0..1 | ID of the hotel |
|
| |
@HotelName | string | 0..1 | Full name of the property which the transferred package belongs to. |
|
| |
@ChainCode | string | 0..1 | Code of the hotel chain |
|
| |
IO_RatePackageNotifRQ | Packages | Package | 1..n | Holds additional information about a package |
|
| ||
@ID | string | 0..1 | Internal ID of the package booked |
|
| |
@Action | IOTransactionActionType | 1 | Action to be done for the package |
|
| |
@BookableExtraInd | boolean | 0..1 | Indicates if package is only additionally bookable OR included with the rate used. | "true" means sell only separate |
|
|
@Code | string | 1 | Short name of package (calculation) to use |
|
| |
@Currency | string | 0..1 | Currency of the amount to charge |
|
| |
@CRSInd | boolean | 0..1 | Item can be used in CRS systems |
|
| |
@ExternalTaxInd | boolean | 0..1 |
|
| ||
| @AmountAfterTax | decimal | 0..1 | The total amount including all associated taxes (e.g. sales tax, VAT, GST or any associated tax). |
|  | |
| @AmountBeforeTax | decimal | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). |
| | |
IO_RatePackageNotifRQ | Packages | Package | Name | 1 | Provides details of the package name |
|
| ||
@Language | string | 0..1 | Language of the package name |
|
| |
IO_RatePackageNotifRQ | Packages | Package | Description | 1 | Textual information regarding the package |
|
| ||
@Language | string | 0..1 | Language of the package description |
|
| |
IO_RatePackageNotifRQ | Packages | Package | Validity | 1 |
|
| |||
@From | date | 0..1 | Earliest stay date this package can be used |
|
| |
@To | date | 0..1 | Latest stay date this package can be used |
|
| |
IO_RatePackageNotifRQ | Packages | Package | PackageItems | 0..1 | Information about package items |
|
| ||
IO_RatePackageNotifRQ | Packages | Package | PackageItems | PackageItem | 1..n | Details of a package item |
|
| ||
@Action | IOTransactionActionType | 1 | Action to be done for the package item |
|
| |
@Code | string | 1 | Internal item code |
|
| |
@ItemID | string | 0..1 | Internal item ID |
|
| |
@PrintInd | boolean | 0..1 | Item can be shown in reservations |
|
| |
@CRSInd | boolean | 0..1 | Item can be used in CRS systems |
|
| |
IO_RatePackageNotifRQ | Packages | Package | PackageItems | PackageItem | Name | 1 | Name of the package item |
|
| ||
@Language | string | 0..1 | Language of the package item name |
|
| |
IO_RatePackageNotifRQ | Packages | Package | PackageItems | PackageItem | Validity | 1 | Information about the validity of the package item |
|
| ||
@From | date | 0..1 | Earliest stay date that can be used in this package |
|
| |
@To | date | 0..1 | Latest stay date that can be used in this package |
|
| |
IO_RatePackageNotifRQ | Packages | Package | PackageItems | PackageItem | Calculation | Information on the Total Amount for the certain period of time depending on whether the package is included or not |
|
| |||
@AmountAfterTax | decimal | 0..1 | The total amount including all associated taxes (e.g. sales tax, VAT, GST or any associated tax). |
|
| |
@AmountBeforeTax | decimal | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). |
|
| |
@Currency | string | 0..1 | Hotel currency OR Foreign currency if defined for this item |
|
| |
| @FixedChargeInd | boolean | 0..1 | Whether the package item is a Fixed Charge (true) or not (false) Fixed Charge package items should not be calculated for inbound OTA_HotelResNotifRQ total amount. The PMS logic will do so during EOD. | "true" OnPrem: If the package is not a Fixed Charge, the attribute is not included in the message. |
|
|
@InclusiveInd | boolean | 0..1 | Whether the package item is to be included in the rate (INCLUDE) or added on top (extra amount). | "true" |
|
|
@Recurrence | RecurrenceType | 0..1 | Recurrence of the fixed charge |
|
| |
@Relation | string | 0..1 |
*: With OnPrem only supported with a formula created with the text (anzkin1+anzkin2+anzkin3+anzkin4)
|
|
| |
IO_RatePackageNotifRQ | Packages | Package | PackageItems | PackageItem | Calculation | DaysOfWeek | 1 | Days of the week when the package item is valid |
|
| ||
@Mon | boolean | 0..1 | The day of the week indicators selected are those on which the package is available and therefore could be used | "true" |
|
|
IO_RatePackageNotifRS
Element | @Attribute | Type | Num | Description | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
IO_RatePackageNotifRS | 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 | 1 | Timestamp of the transaction. | | | |
@Version | string | 0..1 | Version of the message | | | |
@PrimaryLangID | string | 0..1 | Default language of the property. | ISO-639-1 (2-char code) "en" | | |
IO_RatePackageNotifRS | Errors | 0..1 | Indicates an error occurred during the processing of the message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element instead. | | | ||
IO_RatePackageNotifRS | Errors | Error | 0..n | An error that occurred during the processing of a message. | | | ||
@Type | OTA_CodeType EWT | 0..1 | Mandatory. Refers to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@ReferenceCode | string | 0..1 | Business object causing the warning | | | |
@Message | string | 0..1 | Description of the issue | | | |
IO_RatePackageNotifRS | 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_RatePackageNotifRS | Warnings | 0..1 | Used when a message has been successfully processed to report any warnings or business errors that occurred. | | | ||
IO_RatePackageNotifRS | Warnings | Warning | 0..n | Used in conjunction with the Success element to define a business error. | | | ||
@Type | OTA_CodeType EWT | 0..1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@ReferenceCode | string | 0..1 | Business object causing the warning | | | |
@Message | string | 0..1 | Description of the issue | | |