Message Description
protel I/O uses a request and response messages pair to update Partner systems with reservation data. This message set assumes a PUSH model whereby the sending system (Publisher) is typically a booking source such as a hotel Property Management System (PMS) or Central Reservations System (CRS). The business model assumes the sending system has the authority to take a reservation or is passing along a message from such a system. This message is a notification of the creation, modification, or cancellation of a booking. It also support the provision of reservation data for reservation history and the bulk upload of booking data. The responding system (Subscriber) may add its own data (e.g. its own confirmation ID), and include that data in the response message.
protel I/O supports stay-level detail where each message represents a single stay. Each message facilitates the potential for a change of booking rate, rate code and room type on any given night during the stay.
Sequence
The Publisher sends a reservation notification request message to the Subscriber system (full overlay).
The Subscriber uses the message information to add a new booking record or modify an existing booking record.
The Subscriber responds with an appropriate response message which may include warnings from business processing rules or errors if the request did not succeed. All message responses include request identification. Responses may be returned in any order.
Profile Modify
It is possible to modify profiles with an inbound reservation message. The same handling as for a OTA_ProfileModifyRQ is used.
Message Attributes
OTA_HotelResNotifRQ
Element | @Attribute | Type | Num | Description | Comments + Content Outbound | pAIR | OnPrem | Comments + Content Inbound | pAIR | OnPrem | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
IDS | PWS | |||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | 1 | This message supports the functionality of updating other systems with reservation data. The message assumes a push model, with the originating system pushing the data to another system. The originating system would usually be a booking source, such as a Global Distribution System (GDS), a Central Reservation System (CRS) or some other agent of the hotel. | ||||||||||||||||||||||||||||||||||||||||||||
@EchoToken | StringLength1to128 | 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 | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | |||||||||||||||||||||||||||||||||||||||||||
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | "2019-06-05T09:12:14Z" | ||||||||||||||||||||||||||||||||||||||||||
@Version | decimal | 0..1 | Version of the message. | Version="1.001" | ||||||||||||||||||||||||||||||||||||||||||
@PrimaryLangID | language | 0..1 | Default language of the property. | |||||||||||||||||||||||||||||||||||||||||||
@ResStatus | Transaction Type | 1 | Transaction Type |
|
| |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | POS | Source | RequestorID | 0..1 | This identifies the system that is sending the reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | Unique ID Type (UIT) HotelID=10 | ||||||||||||||||||||||||||||||||||||||||||
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” | If the ID comes from protel, then it will be: “protelIO” | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | POS | Source | BookingChannel | 0..1 | This element is used to pass the booking source for the reservation. To send secondary booking channel information an additional Source element needs to be sent. | ||||||||||||||||||||||||||||||||||||||||||||
@Primary | boolean | 0..1 | Indicates whether the enumerated booking channel is in the primary means of connectivity used by the source |
| ||||||||||||||||||||||||||||||||||||||||||
@Type | OTA_CodeType BCT | 1 | Indicates the type of booking channel per the Open Travel BCT codes. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | 0..1 | Allows extensions to be added to the OpenTravel specification per trading partner agreement. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 1 | Used to transport extensions on POS level for the system which initiated the transaction. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Used to transport extensions on POS level for the property which holds the reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@FiscalDate | date | 0..1 | This attribute transfers the actual date of the PMS system. | yyyy-mm-dd | - | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | 1..n | Must be sent for the message to have a meaning. | Only 1 reservation per message is supported | Only 1 reservation per message is supported | ||||||||||||||||||||||||||||||||||||||||||
@CreatorID | StringLength1to32 | 1 | The user or the office that originated the reservation. | |||||||||||||||||||||||||||||||||||||||||||
@CreateDateTime | dateTime | 1 | This is the date when the reservation was first made. | |||||||||||||||||||||||||||||||||||||||||||
@LastModifyDateTime | dateTime | 0..1 | This indicates the last date and time when the reservation was modified. MANDATORY if the ResStatus is “Modify”. | |||||||||||||||||||||||||||||||||||||||||||
@LastModifierID | StringLength1to32 | 0..1 | This indicates the last user who modified the reservation. | |||||||||||||||||||||||||||||||||||||||||||
@ResStatus | PMS_ResStatusType | 1 | Indicates the current status of the reservation | PMS_ResStatusType | ||||||||||||||||||||||||||||||||||||||||||
@RoomNumberLockedIndicator | boolean | 0..1 | An indicator that shows whether the room number may be changed. | "true" → The room number may not be changed. "false" → The room number may be changed. | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | UniqueID | 1..10 | The unique ID depends on the system generating the booking; i.e., if the booking is generated by the PMS this field would contain the PMS confirmation number; if the system is a CRS, the CRS confirmation number. | ||||||||||||||||||||||||||||||||||||||||||||
@Type | OTA_CodeType UIT | 1 | Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT).
| The recommended value for this message is "14" (Reservation). | ||||||||||||||||||||||||||||||||||||||||||
@ID | StringLength1to32 | 1 | ID is the internal confirmation number. | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 0..1 | Used to identify where the ID comes from. | “protelIO” | It is highly recommended that each @ID reference has a respective @ID_Context to enable unique ownership of the @ID. For modification/cancellation the “protelIO” reference with the respective @ID is required. | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | 1 | A collection of RoomStay objects. Room stays associated with this reservation. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | 1..n | Only one instance of RoomStay is allowed. | ||||||||||||||||||||||||||||||||||||||||||||
@MarketCode | StringLength1to64 | 0..1 | This is the abbreviation of the market segment being sold and may be needed by the system for tracking purposes. | Info: the MarketCode needs to be mapped in the DCS matching for it to be activated by the IDS | ||||||||||||||||||||||||||||||||||||||||||
@SourceOfBusiness | StringLength1to64 | 0..1 | Used to specify where the business came from; e.g., radio, newspaper ad, or it could be a referring property. | Info: the SourceOfBusiness code needs to be mapped in the DCS matching for it to be activated by the IDS | ||||||||||||||||||||||||||||||||||||||||||
@PromotionCode | StringLength1to32 | 0..1 | A promotion code indicating a specific marketing campaign. Not to be confused with the rate code. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomTypes | 0..1 | A collection of Room Types associated with a particular Room Stay. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomTypes | RoomType | 1..n | Section could be repeated if there is a room move during the stay. | ||||||||||||||||||||||||||||||||||||||||||||
@IsRoom | boolean | 1 | Indicates the room is a sleeping room when true. If false it is a pseudo room reservation. |
| ||||||||||||||||||||||||||||||||||||||||||
@RoomType | StringLength1to16 | 0..1 | Internal room type ID in PMS system. | |||||||||||||||||||||||||||||||||||||||||||
@RoomTypeCode | StringLength1to64 | 1 | Abbreviated room type. | |||||||||||||||||||||||||||||||||||||||||||
@RoomID | StringLength1to64 | 0..1 | Room number when allocated. | |||||||||||||||||||||||||||||||||||||||||||
@NumberOfUnits | integer | 1 | The number of booked rooms. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomTypes | RoomType | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo | ||||||||||||||||||||||||||||||||||||||||||||||
@RoomStatus | StringLength1to32 | 1 | For reservations that will arrive on the business day, the status of the room (clean, dirty, etc.) will be sent with. | IO Types - protel.I/O documentation - Confluence There will be no new message if the room status is changed in OnPrem. | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | 0..1 | The RatePlans element is not required but can be sent to give further details on the rates booked in this reservation. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | 1..n | The RatePlan to be booked. This can repeat if multiple rate codes are booked against the reservation | ||||||||||||||||||||||||||||||||||||||||||||
@RatePlanCode | StringLength1to64 | 1 | This is the code of the rate booked. | |||||||||||||||||||||||||||||||||||||||||||
@RatePlanID | StringLength1to64 | 0..1 | Internal ID of the rate code booked | |||||||||||||||||||||||||||||||||||||||||||
@EffectiveDate | date | 0..1 | The Effective date attribute indicates when the specific rate value is applied. This is required reference at those times when there is a rate change during the stay. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@ExpireDate | date | 0..1 | The Expire date indicates the day when the specific value of the rate is changed to another value. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@MarketCode | StringLength1to64 | 0..1 | The code that relates to the market being sold to (e.g., the corporate market, packages). | |||||||||||||||||||||||||||||||||||||||||||
@PriceViewableInd | boolean | 0..1 | When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans| RatePlan | Guarantee | 0..5 | Guarantee provided with the reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@GuaranteeType | StringLength1to32 | 1 | This is the attribute that indicates what guarantee is provided with the reservation. |
| ||||||||||||||||||||||||||||||||||||||||||
@GuaranteeCode | StringLength1to32 | 0..1 | This is the guarantee code. More specified than @GuaranteeType. | Example: "CC" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | 0..9 | Optional. This can be used to pass the details of the guarantee if the guarantee used is not cc or deposit. | ||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Used in conjunction with Text element below. The name could be used to indicate Voucher and the Text could be used to indicate the voucher number, for instance. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | Text | 1 | Provides text and indicates whether it is formatted or not. | Example: "Credit Card." | |||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | Indicates the format of text used in the description (unformatted or HTML). | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans| RatePlan | CancelPenalties | 0..1 | A collection of cancellation penalty elements | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | 0..n | Defines the hotel cancellation penalty. The CancelPenalty class defines the cancellation policy of the hotel. | ||||||||||||||||||||||||||||||||||||||||||||
@PolicyCode | StringLength1to16 | 0..1 | This is the penalty code. | Example: "48HRS" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | 0..9 | Optional. This can be used to pass additional cancellation policy details. | ||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Policy Class used in conjunction with the Text element below. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | Text | 1 | Provides text and indicates whether it is formatted or not. | Example: "Free cancellation 48hrs before arrival" | |||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | Indicates the format of text used in the description. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | RatePlanInclusions | 0..1 | Defines charges that are included in this rate plan. | ||||||||||||||||||||||||||||||||||||||||||||
@TaxInclusive | boolean | 0..1 | Boolean value. Defines if the rate sent is tax inclusive or not. |
| protel On-Premise default = "False" (will send AmountBeforeTax values only). This can be changed. protel Air default = "true" (will send AmountAfterTax values only) | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | 0..1 | Commission associated with the RatePlan. This can be a percentage or a flat amount. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | 1 | A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | 1..n | One instance of RoomRate per room/rate/period booked. If more than one Rate plan can be booked in one reservation the entire RoomRate element must be repeated for each Room/rate combination. In addition, all RoomRate elements MUST share the same RoomTypeCode. | ||||||||||||||||||||||||||||||||||||||||||||
@RoomTypeCode | StringLength1to64 | 1 | This is the abbreviation for the room type booked. | |||||||||||||||||||||||||||||||||||||||||||
@RoomID | StringLength1to64 | 0..1 | Room No. (if already allocated) for the mentioned period. | |||||||||||||||||||||||||||||||||||||||||||
@InvBlockCode | StringLength1to32 | 0..1 | If the room booked is part of a block, the block ID is transferred in this field. | Receiving an inbound reservation with @InvBlockCode = "" will delete and remove the assigned allotment. | ||||||||||||||||||||||||||||||||||||||||||
@NumberOfUnits | integer | 1 | This is the number of rooms booked for the room type code listed in the RoomTypeCode attribute. In the case of shared reservations, this value will always be "1". | |||||||||||||||||||||||||||||||||||||||||||
@RatePlanCode | StringLength1to64 | 1 | This is the rate booked for the room type code listed in the RoomTypeCode attribute. | |||||||||||||||||||||||||||||||||||||||||||
@RatePlanID | StringLength1to64 | 0..1 | Internal ID of the rate code booked | |||||||||||||||||||||||||||||||||||||||||||
@BookingCode | StringLength1to16 | 0..1 | This is used to indicate the item booked and is primarily used to exchange information with GDSs. This field also can be used to display the initially booked room type in case of changing RoomType or reservation move. | |||||||||||||||||||||||||||||||||||||||||||
@EffectiveDate | date | 1 | Indicates the starting date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@ExpireDate | date | 1 | Indicates the ending date. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@RatePlanCategory | StringLength1to64 | 0..1 | Hotel systems often group multiple rate plans into a single category. This refers to that category that is specific to the hotel CRS/ PMS and should not be confused with a GDS rate category. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | BookingRules | BookingRule | 0..1 | Provides booking rule information for the room stay. | ||||||||||||||||||||||||||||||||||||||||||||
@AbsoluteCutoff | date | 0..1 | Defines the absolute deadline. Either this or the offset attributes may be used. | yyyy-mm-dd onprem:
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | 0..1 | Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | 1..n | At least one instance of Rate per Rate plan. Multiple instances of the Rate element must be sent if rate changes apply to the booking. | ||||||||||||||||||||||||||||||||||||||||||||
@RateTimeUnit | TimeUnitType | 0..1 | Rate Time unit is an Enumeration of time units upon which the rate amount is based (e.g., daily, weekly, single rate for full stay). | For protel only ‘Day’ is possible. | ||||||||||||||||||||||||||||||||||||||||||
@EffectiveDate | date | 1 | The Effective date attribute indicates the starting date of when the specific rate value is applied. This is needed when during the stay there are some rate changes. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@ExpireDate | date | 1 | The Expire date indicates the day when the specific value of the rate is changed to another value. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@UnitMultiplier | integer | 0..1 | UnitMultiplier is the number of RateTimeUnits that the rate amount is based upon (e.g., the rate for one day in case of nightly rates). As protel is dealing with days as a unit it should display the number of nights. If it is set to zero the reservation will be a day-use room for the specific date. | |||||||||||||||||||||||||||||||||||||||||||
@AlternateCurrencyInd | boolean | 0...1 | When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency. |
| ||||||||||||||||||||||||||||||||||||||||||
@CachedIndicator | boolean | 0...1 | When "true", then the rates will not be overwritten in the PMS.
|
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Base | 0..1 | Information on the Base Rate. | According to the schema it is optional, if this element is not provided in the inbound request the rate amount from the System Data is used, but as soon as it is used in the inbound request @AmountBeforeTax or @AmountAfterTax is mandatory otherwise the request will not be imported | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked. | |||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Total | 0..1 | Information on the Total Amount for the certain period of time if it contains more than one night. | ||||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | ISO 4217 codes to indicate the currency of the rate that is being booked. | |||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensions | 0..1 | Allows extensions to be added to the Open Travel Alliance specification per trading partner agreement. | ||||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | Indicates the starting date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | Indicates the ending date. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensions | RateAmount | 1..n | |||||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extension | px:FixedChargesAmountsExtensions | 0..1 | In this Element only manual booked fixed Charges are displayed. | ||||||||||||||||||||||||||||||||||||||||||||
@AlternateCurrencyInd | boolean | 0..1 | When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency. |
| ||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | Indicates the starting date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | Indicates the ending date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:FixedChargesAmountsExtensions | px:RateAmount | 0..1 | onPremise will only display these elements for reservations which are check-in or in the future by default. For check-out reservations it needs to be enabled for onPremise. In this element only manual booked fixed charges are displayed. | ||||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountBefore Tax | Money | 1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | GuestCounts | 1 | Contains the guest counts of the booking. | ||||||||||||||||||||||||||||||||||||||||||||
@IsPerRoom | boolean | 0..1 | Indicates that the guest count provided is on a per room basis. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | GuestCounts | GuestCount | 1..n | Contains the type and number of guests included in the reservation. | pAir only:
| |||||||||||||||||||||||||||||||||||||||||||
@AgeQualifyingCode | OTA_CodeType AQC | A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). | ||||||||||||||||||||||||||||||||||||||||||||
@Count | Numeric1to999 | 1 | The count will include the number and will be repeated for each Type of guest. | |||||||||||||||||||||||||||||||||||||||||||
@Age | Numeric0to999 | 0..1 | Defines the age of a guest. | |||||||||||||||||||||||||||||||||||||||||||
@AgeBucket | StringLength1to16 | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | RoomRateDescription | 0..20 | The description or name of a room rate. | The MarketCode and SourceCode which are used for the specific day will be displayed in the Element | |||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | In many cases the description repeats, this will allow you to define the information that is being sent, typically used when multiple occurrences of ParagraphType are being sent. |
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | RoomRateDescription | Text | 1 | Provides text and indicates whether it is formatted or not. | ||||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | Indicates the format of text used in the description e.g. unformatted or HTML. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | GuestCounts | 1 | Contains the guest counts of the booking. | ||||||||||||||||||||||||||||||||||||||||||||
@IsPerRoom | boolean | 0..1 | Indicates that the guest count provided is on a per room basis. |
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | GuestCounts | GuestCount | 1..n | Contains the type and number of guests included in the reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@AgeQualifyingCode | OTA_CodeType AQC | 1 | A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). AgeQualifyingCode = 10 (Adult) | |||||||||||||||||||||||||||||||||||||||||||
@Count | Numeric1to999 | 1 | The count will include the number and will be repeated for each Type of guest. | onPrem: always the highest count of the roomstay element | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | TimeSpan | 1 | These are the in and out dates of the booking. | ||||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | Arrival date/time. | yyyy-mm-dd | yyyy-mm-dd IDS: the "Thh:mm" will be used for the Arrival Time | |||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | Departure date/time. | yyyy-mm-dd | yyyy-mm-dd IDS: the Thh:mm will be used for the Departure Time | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | 0..5 | Guarantee provided with the reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@GuaranteeType | StringLength1to32 | 1 | This is the attribute that indicates what guarantee is provided with the reservation. |
|
Not supported:
| |||||||||||||||||||||||||||||||||||||||||
@GuaranteeCode | StringLength1to32 | 0..1 | This is the guarantee code. More specified than @GuaranteeType . | Example: "CC" | Example: "CC" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee |GuaranteesAccepted | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | GuaranteesAccepted | GuaranteeAccepted | 1..n | Guarantee Detail. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | GuaranteesAccepted | GuaranteeAccepted | PaymentCard | 0..1 | Specific payment card information. | ||||||||||||||||||||||||||||||||||||||||||||
@CardType | OTA Code Type CDT | 1 | Payment card type. | |||||||||||||||||||||||||||||||||||||||||||
@CardCode | PaymentCardCodeType | 1 | Issuer code | "VISA" | ||||||||||||||||||||||||||||||||||||||||||
@MaskedCardNumber | AlphaNumericStringLength1to19 | 1 | Credit card number embossed on the card.Secure information that supports PCI tokens, data masking and other encryption methods. | |||||||||||||||||||||||||||||||||||||||||||
@CardNumber | NumericStringLength1to19 | 1 | Clear text credit card number which will be tokenized by protel. | "4448545446839463" | ||||||||||||||||||||||||||||||||||||||||||
@EncryptionKey | string | 1 | Encryption-Key used by encryption methods. | |||||||||||||||||||||||||||||||||||||||||||
@ExpireDate | MMYYDate | 1 | Indicates the ending date | MMYY "0122" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | GuaranteesAccepted | GuaranteeAccepted | PaymentCard | CardHolderName | 0..1 | Card holder name. | "Max Mustermann" | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | GuaranteeDescription | 0..9 | Optional. This can be used to pass the details of the guarantee if the guarantee used is not cc or deposit. | ||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Used in conjunction with Text element below. The Name could be used to indicate Voucher and the Text could be used to indicate the voucher number, for instance. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee | GuaranteeDescription | Text | 1 | Provides text and indicates whether it is formatted or not. | Example: "Credit Card." | |||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | Indicates the format of text used in the description (unformatted or HTML). | Example: "PlainText" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | CancelPenalties | 0..1 | A collection of cancellation penalty elements | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | CancelPenalties | CancelPenalty | 0..n | Defines the hotel cancellation penalty. The CancelPenalty class defines the cancellation policy of the hotel. | ||||||||||||||||||||||||||||||||||||||||||||
@PolicyCode | StringLength1to16 | 0..1 | This is the penalty code. | Example: "48HRS" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | CancelPenalties | CancelPenalty | PenaltyDescription | 0..9 | Optional. This can be used to pass additional cancellation policy details. | ||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Policy Class used in conjunction with the Text element below. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | CancelPenalties | CancelPenalty | PenaltyDescription | Text | 1 | Provides text and indicates whether it is formatted or not. | Example: "Free cancellation 48hrs before arrival" | |||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | Indicates the format of text used in the description. | Example: "PlainText" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Total | 0..1 | This is the total amount for the stay. | PWS: is using the Base Amount for the Amount Value | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | ISO 4217 codes to indicate the currency of the rate that is being booked. | |||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | BasicPropertyInfo | 1 | Property Information for the Room Stay. | ||||||||||||||||||||||||||||||||||||||||||||
@HotelName | StringLength1to128 | 0..1 | Full name of the property which the transferred reservation belongs to. | |||||||||||||||||||||||||||||||||||||||||||
@HotelCode | StringLength1to16 | 1 | This is the Hotel Cloud ID for which the reservations are being transferred. | |||||||||||||||||||||||||||||||||||||||||||
@ChainCode | StringLength1to8 | 0..1 | Chain name indicates the chain to which the property belongs. | |||||||||||||||||||||||||||||||||||||||||||
@HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context of (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes. | "protelIO" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | TPA_Extension | px:RateAmountExtensions | 0..n | Allows extensions to be added to the Open Travel Alliance specification per trading partner agreement. | ||||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | Indicates the starting date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | Indicates the ending date. | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@AlternateCurrencyInd | boolean | 0..1 | When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency. |
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | TPA_Extensions | px:RateAmountExtensions | px:RateAmount | 1..n | In this Element display everything which is booked for a Rate Code, except from manual booked fixed charges. | ||||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountBefore Tax | Money | 1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | TPA_Extension | px:FixedChargesAmountsExtensions | 1..n | In this Element only manual booked fixed Charges are displayed. | ||||||||||||||||||||||||||||||||||||||||||||
@AlternateCurrencyInd | boolean | 0..1 | When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency. |
| ||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | Indicates the starting date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | Indicates the ending date | yyyy-mm-dd | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | TPA_Extensions | px:FixedChargesAmountsExtensions | px:RateAmount | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@AmountBefore Tax | Money | 1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||||||||||||||||||||||||||||||||||||
@RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | ResGuestRPHs | 0..1 | A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room | If the Profile is not longer existing in protel, we will display an empty ResGuestRPHs Element | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | ResGuestRPHs | ResGuestRPH | 1..n | This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service. | If a profile for a reservation is no longer existing in the database "kunden", the RPH will be "-1" and the ResGuest Element won't be displayed anymore. We will send the message without ResGuest Element to the third-party systems. | |||||||||||||||||||||||||||||||||||||||||||
@RPH | RHP Type | 1 | Used to refer to the guest associated with this reservation. If profiles for guest, travel agency and company are available in the message, they would all have a separate entry per profile type. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Comments | Comment | 1..n | Comment details. | pAir: If no @CommentOriginatorCode/@Name are provided, then multiple comments are to be overwritten where only the last value occuring is to be taken onPrem: configurable which comment field in protel should be used | |||||||||||||||||||||||||||||||||||||||||||
@GuestViewable | boolean | 0..1 | This indicates that the comment can actually be seen by the guest and is necessary when two different types of comments are passed: one that is guest viewable and one that isn’t. The Attribute is of Boolean nature. | |||||||||||||||||||||||||||||||||||||||||||
@CommentOriginatorCode | StringLength1to16 | 0..1 | Unique identifier of the originator of the comment. | e.g. "PMS-Frontend" for the intenral PMS comment. If the comment is created externally - the value will be as provided by the respective vendor | It is advisable each vendor to maintain their own unique value and edit only their comment section in the reservation | |||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Unique identifier for a specific section/type of the comment per Vendor | If not provided, then the external comments will be overwritten | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Comments | Comment | Text | 1 | Comments. | ||||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlainText | 0..1 | HTML versus Plain Text. | Example: "PlainText" | Example: "PlainText" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | 0..1 | A collection of deposit and/or payments for the Room Stay. | ||||||||||||||||||||||||||||||||||||||||||||
@GuaranteeType | StringLength1to32 | 1 | This is the attribute that indicates what guarantee is provided with the reservation. | Used to define the acceptable payment forms of the property. |
Not supported:
| |||||||||||||||||||||||||||||||||||||||||
@Type | StringLength1to32 | 0..1 | This is the guarantee code. More specified than @GuaranteeType . |
| Example: "CC" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | GuaranteePayment | AmountPercent | 0..1 | Payment expressed as a fixed amount, or a percentage of/or room nights. | ||||||||||||||||||||||||||||||||||||||||||||
@Amount | Money | 1 | A monetary amount. | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 0..1 | ISO 4217 codes to indicate currency of the rate that is being booked. | |||||||||||||||||||||||||||||||||||||||||||
@ApplyAs | NMTOKEN | 0..1 | Used to specify how the amount needs to be applied with respect to the stay |
| FirstNightDeposit = "Amount to be applied as a deposit for the first night." | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | GuaranteePayment | Deadline | 0..2 | Payment deadline, absolute or relative. | ||||||||||||||||||||||||||||||||||||||||||||
@AbsoluteDeadline | date | 0..1 | Payment deadline, absolute or relative. Protel will support only absolut dealines. | yyyy-mm-dd | yyyy-mm-dd | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | GuaranteePayment | AcceptedPayments | 0..1 | Used to define the types of payments accepted. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | GuaranteePayment | AcceptedPayments | AcceptedPayment | 1..n | Used to define the types of payments accepted. | ||||||||||||||||||||||||||||||||||||||||||||
@PaymentTransactionTypeCode | NMToken | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund. |
| charge | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | DepositPayments | GuaranteePayment | AcceptedPayments | AcceptedPayment | PaymentCard | 1 | Details of a debit or credit card. Specific payment card information. | ||||||||||||||||||||||||||||||||||||||||||||
@CardType | OTA Code Type CDT | 1 | Payment card type. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Memberships | 0..1 | A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Memberships | Membership | 1..n | The SelectedMembership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity. | ||||||||||||||||||||||||||||||||||||||||||||
@ProgramCode | StringLength1to32 | 0..1 | The code or name of the membership program ('Hertz', 'AAdvantage', etc.). | |||||||||||||||||||||||||||||||||||||||||||
@AccountID | StringLength1to64 | 0..1 | The account identification number for this particular member in this particular program. | |||||||||||||||||||||||||||||||||||||||||||
@BonusCode | StringLength1to32 | 0..1 | The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.) | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | 1..n | The ResGuest object contains the information about a guest associated with a reservation. | ||||||||||||||||||||||||||||||||||||||||||||
@ResGuestRPH | RPH_Type | 0..1 | This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service. | |||||||||||||||||||||||||||||||||||||||||||
@PrimaryIndicator | boolean | 0..1 | This indicates the primary guest on a reservation. In the case of multiple guests on a reservation, the guest responsible for payment, etc. will be marked true. Currently Optional but needs to be Mandatory to support passing of multiple guests on a reservation (Additional Profile). (MANDATORY for incoming messages to pAir!) |
Note: This means default message ResGuest@PrimaryInd set to true is saying "this booker is a guest as well" and ResGuest@PrimaryInd set to false says the booker (first ResGuest element) is not an arriving guest. | "true" "false" | |||||||||||||||||||||||||||||||||||||||||
@ArrivalTime | time | 0..1 | This represents the date and time of the guest's arrival at the hotel. For example, this could be used to indicate a late arrival. | pAir: will always display the time in UTC Time ArrivalTime="12:00:00+02:00" onprem: will always display the time in local Time ArrivalTime="14:05:00" | pAir: will always display the time in UTC Time ArrivalTime="12:00:00+02:00" onprem: will always display the time in local Time ArrivalTime="14:05:00" | |||||||||||||||||||||||||||||||||||||||||
@DepartureTime | time | 0..1 | This represents the date and time of the guest's departure from the hotel. | pAir: will always display the time in UTC Time DepartureTime="12:00:00+02:00" onprem: will always display the time in local Time DepartureTime="18:05:00" | pAir: will always display the time in UTC Time DepartureTime="12:00:00+02:00" onprem: will always display the time in local Time DepartureTime="18:05:00" | |||||||||||||||||||||||||||||||||||||||||
HotelReservation | ResGuests | ResGuest | TPA_Extensions | 0..1 | Could be used to pass additional Profile data upon agreement between partners (specific Keys or codes, for instance). | ||||||||||||||||||||||||||||||||||||||||||||
HotelReservation | ResGuests | ResGuest | TPA_Extensions | px:GuestStayExtensions | 0..1 | _GuestStayExtensions | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | UniqueID | 0..9 | Used to allow additional IDs for matching purposes. | To avoid creating duplicate profiles, always use a UniqueID/@ID and its reps @ID_Context | |||||||||||||||||||||||||||||||||||||||||||
@ID | StringLength1to32 | 1 | A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||||||||||||||||||||||||||||||||||||||||||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). | Unique ID Type (UIT) Customer=1 | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | UniqueID | CompanyName | 0..1 | Identifies the company that is associated with the UniqueID. | ||||||||||||||||||||||||||||||||||||||||||||
@CompanyShortName | StringLength1to32 | 0..1 | Used to provide the company common name. | |||||||||||||||||||||||||||||||||||||||||||
@TravelSector | OTA_CodeType TVS | 0..1 | The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). | Example: 3 = "Hotel" | ||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to16 | 0..1 | Identifies a company by the company code. | |||||||||||||||||||||||||||||||||||||||||||
@CodeContext | StringLength1to32 | 0..1 | Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc. |
| "io.protel.onpremise" "io.protel.air" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | 1 | Provides detailed information regarding either a company or a customer profile. | pAir and onpremise are using the same logic for updating the profile, as it is implemement for the OTA_ProfileModifyRQ OTA_ProfileModifyRQ/RS | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGlobalInfo | HotelReservationIDs | HotelReservationID | 1..n | The HotelReservationID element can be repeated multiple types to transfer: 1. The PNR number for the reservation assigned by the GDS. 2. The reservation number for reservations that are linked to this reservation as associated reservation either for guests travelling together, sharing a room, or as part of an Itinerary. | ||||||||||||||||||||||||||||||||||||||||||||
@ResID_Type | OTA_CodeType UIT | 1 | Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT). | Unique ID Type (UIT)
|
| |||||||||||||||||||||||||||||||||||||||||
@ResID_Value | StringLength1to64 | 1 | Internal reservation number in hotel property management system (PMS). | |||||||||||||||||||||||||||||||||||||||||||
@ResID_Source | StringLength1to64 | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value. | "protelIO" | It is highly recommended that each @ResID_Value reference has a respective @ResID_Source to enable unique ownership of the @ResID_Value. For modification/cancellation the “protelIO” reference with the respective @ResID_Value is required. | |||||||||||||||||||||||||||||||||||||||||
@ForGuest | boolean | 0..1 | A boolean value used to determine if the ResID_Value is given to a guest. This number should be searchable by the destination. | "true" "false" | "true" "false" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | Sharers | Sharer | boolean | 0..1 | The reservation for reservations that are linked to this reservation as associated reservation either for guests travelling together, sharing a room, or as part of an Itinerary. | Only supported by OnPremise outbound | ||||||||||||||||||||||||||||||||||||||||||
@IsMainSharer | boolean | 0..1 | If it is "true" then this is the main guest.
|
| ||||||||||||||||||||||||||||||||||||||||||
@ReservationId | boolean | 0..1 | Displays the independent reservation number | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:Traces | 0..1 | Indicates which traces are available for a reservation | ||||||||||||||||||||||||||||||||||||||||||||
@TraceBegin | StringLength1to32 | 0..1 | Start of the traces | |||||||||||||||||||||||||||||||||||||||||||
@TraceDepartment | StringLength1to64 | 0..1 | Indicates which department the trace is for. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | 0..1 | A collection of Service objects. This is the collection of all services associated with any part of this reservation | pAir: is displaying the Services for mandatory packages and bookable packages. onPrem: is displaying mandatory packages and bookable packages, but only for check-in Reservations and future Reservation - for checked-out Reservation it can be enabled onPrem: is displaying Rentable Objects in the service element with the name rentable object | pAir/onpremise: it is only possible to use packages with are attached to a Rate in the system. Please always send the amount inclusive the packages. The accommodation price will be reduce by the attached packages. | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | 1..n | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. | ||||||||||||||||||||||||||||||||||||||||||||
@ID | StringLength1to32 | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier (e.g., IATA, ABTA) | protelIO | ||||||||||||||||||||||||||||||||||||||||||
@RequestedIndicator | boolean | 0..1 | When true, the service has been requested by the guest. |
|
| |||||||||||||||||||||||||||||||||||||||||
@RatePlanCode | StringLength1to64 | 0..1 | The representation of the rate plan under which this service was booked | |||||||||||||||||||||||||||||||||||||||||||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | Unique ID Type (UIT) Reference=16 | ||||||||||||||||||||||||||||||||||||||||||
@ServiceInventoryCode | StringLength1to16 | 0..1 | The representation of the specific service being reserved. | |||||||||||||||||||||||||||||||||||||||||||
@ServicePricingType | PricingType | 0..1 | An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. | pAir:
OnPrem:
| ||||||||||||||||||||||||||||||||||||||||||
@Quantity | Numeric1to999 | 0..1 | The number of tickets, rounds of golf, etc. Also serves as the number of persons when pricing class is per person or per person per night. | |||||||||||||||||||||||||||||||||||||||||||
@Inclusive | boolean | 0..1 | Whether the price for this service is included in the room rate. Values: False (or No), and True (or Yes). |
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | Price | 0..99 | Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description. | ||||||||||||||||||||||||||||||||||||||||||||
@EffectiveDate | date | 1 | Indicates the starting date. | If the @ServicePricingType equals "Per person per night" the value of @EffectiveDate will be the first Start Posting Date if the @ServicePricingType equals "Per Stay" the value of @EffectiveDate will be the Arrival Date | ||||||||||||||||||||||||||||||||||||||||||
@ExpireDate | date | 1 | Indicates the ending date. | If the @ServicePricingType equals "Per person per night" the value of @EffectiveDate will be the latest Start Posting Date if the @ServicePricingType equals "Per Stay" the value of @EffectiveDate will be the Departure Date | ||||||||||||||||||||||||||||||||||||||||||
@NumberOfUnits | integer | 0..1 | The number of booked services. | |||||||||||||||||||||||||||||||||||||||||||
@RateTimeUnit | TimeUnitType | 0..1 | Indicates the time unit for the rate. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | Price | Total | 0..1 | The total amount charged for this rate including additional occupant amounts and fees. The total amount charged for the service including additional amounts and fees. | ||||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax) | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax) | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | Price | Base | 0..1 | The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements. The total amount charged for the service including additional amounts and fees. | ||||||||||||||||||||||||||||||||||||||||||||
@AmountBeforeTax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax) | |||||||||||||||||||||||||||||||||||||||||||
@AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax) | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | AlphaLength3 | 1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | ServiceDetails | 0..1 | A grouping of elements including Guest Counts, Time Span, pointers to Res Guests, guest Memberships, Comments and Special Requests and finally financial information including Guarantee, Deposit and Payment and Cancellation Penalties. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | ServiceDetails | TimeSpan | 1 | The Time Span which covers the Reservation, Room Stay or Service. | ||||||||||||||||||||||||||||||||||||||||||||
@Start | date | 1 | The starting value of the time span. | |||||||||||||||||||||||||||||||||||||||||||
@End | date | 1 | The ending value of the time span. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | ServiceDetails | Comments | 0..1 | A collection of Comment objects. Comments which apply to the whole Reservation or a particular Room Stay or Service. A collection of comments. | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | ServiceDetails | Comments | Comment | 1..n | Comment details. | ||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | Used in conjunction with Text element below. The name could be used to indicate Voucher and the Text could be used to indicate the voucher number, for instance. | RentableObject | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Services | Service | ServiceDetails | Comments | Comment | Text | 1 | Formatted text content. Provides text and indicates whether it is formatted or not. | ||||||||||||||||||||||||||||||||||||||||||||
@TextFormat | PlaintText | 0..1 | Indicates the format of text used in the description e.g. unformatted or html. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | 1 | |||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:ReservationCode | 0..n | Passes information pertaining to booking communication channel and reason for travel. | ||||||||||||||||||||||||||||||||||||||||||||
@ID | string | 0..1 | Internal ID | |||||||||||||||||||||||||||||||||||||||||||
@RPH | string | 0..1 | Numeric value referencing the PMS reservation number. | |||||||||||||||||||||||||||||||||||||||||||
@Type | StringLength1to32 | 0..1 | String value indicating "CommunicationChannel" or "TravelReason" | |||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to255 | 0..1 | Values taken from the hotel PMS and used to reference the booking communication method and reason for travel (one instance of the ReservationCode element for each respectively) | |||||||||||||||||||||||||||||||||||||||||||
@Language | StringLength1to32 | 0..1 | The language code for which the name data is represented. | |||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to32 | 0..1 | Shortcode of the Reservation code | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value | "protelIO" | "protelIO" | |||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:ReservationStatus | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to32 | 0..1 | Defined Code |
| ||||||||||||||||||||||||||||||||||||||||||
@ID | string | 0..1 | Internal ID for the Reservation Status | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value | "protelIO" | ||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to255 | 0..1 | Configured Name for the Reservation Status in the PMS | |||||||||||||||||||||||||||||||||||||||||||
@RPH | string | 0..1 | Numeric value referencing the PMS reservation number. | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:CancellationInfo | 0..1 | Long Text of the Cancellation | ||||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to32 | 0..1 | Code for the Cancellation Status | |||||||||||||||||||||||||||||||||||||||||||
@ID | string | 0..1 | Internal ID for the Cancellation Status | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value | "protelIO" | ||||||||||||||||||||||||||||||||||||||||||
@Type | StringLength1to32 | 0..1 | Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT). | 14 - Cancel | ||||||||||||||||||||||||||||||||||||||||||
@Timestamp | dateTime | 0..1 | Timestamp of the cancellation | |||||||||||||||||||||||||||||||||||||||||||
@User | StringLength1to32 | 0..1 | User who has cancelled the reservation | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | 1..n | |||||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to32 | 0..1 | Name of the TAA | |||||||||||||||||||||||||||||||||||||||||||
@Recurrence | RecurrenceType | 0..1 | Recurrence of the fixed charge | OnPremise will support the following Recurrence:
| ||||||||||||||||||||||||||||||||||||||||||
@From | date | 0..1 | Valid from | |||||||||||||||||||||||||||||||||||||||||||
@To | date | 0..1 | Valid to | |||||||||||||||||||||||||||||||||||||||||||
@Quantity | integer | 0..1 | Quantity of item to book per recurrence | |||||||||||||||||||||||||||||||||||||||||||
@RequestedIndicator | boolean | 0..1 | When true, the service has been requested by the guest. |
| ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:UniqueID | 0..n | |||||||||||||||||||||||||||||||||||||||||||||
@ID | StringLength1to32 | 1 | ID of the FixedCharge | |||||||||||||||||||||||||||||||||||||||||||
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier | "protelIO" | ||||||||||||||||||||||||||||||||||||||||||
@Type | StringLength1to32 | 1 | Type of the identifier | "FixedCharge" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:Item | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
@Code | StringLength1to32 | 0..1 | protel internal Item ID | |||||||||||||||||||||||||||||||||||||||||||
@ItemID | StringLength1to32 | 0..1 | protel internal Item ID | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:Price | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
@SingleAmountAfterTax | decimal | 0..1 | Amount to charge after tax | |||||||||||||||||||||||||||||||||||||||||||
@SingleAmountBeforeTax | decimal | 0..1 | Amount to charge before tax | |||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | StringLength1to32 | 0..1 | Currency of the amount to charge | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:InvoiceText | 0..1 | Display the Invoice Text | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:BookedOnDays | px:BookedOnDay | 0..1 | is used for the Recurrence "FLOATING" to show the Booked Days | ||||||||||||||||||||||||||||||||||||||||||||
@From | date | 0..1 | Start date | |||||||||||||||||||||||||||||||||||||||||||
@To | date | 0..1 | End date | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:UserDefinedFieldExtensions | 0..1 | User defined field information on reservation level | ||||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:UserDefinedFieldExtensions | px:UserDefinedField | 1..n | |||||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to32 | 0..1 | UDF name value | |||||||||||||||||||||||||||||||||||||||||||
@Type | StringLength1to32 | 0..1 | UDF type | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | 0..1 | Define the method of which the confirmations should be delivered | ||||||||||||||||||||||||||||||||||||||||||||
@ConfirmInd | xs: boolean | 0..1 | When true a written confirmation was requested and will be sent. | |||||||||||||||||||||||||||||||||||||||||||
@LanguageID | xs: string | 0..1 | The language in which the confirmation should be provided. | ISO 2 | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | SupplementalData | 0..1 | Additional data that will be sent with the confirmation | ||||||||||||||||||||||||||||||||||||||||||||
@CreatorID | StringLength1to32 | 0..1 | ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. | |||||||||||||||||||||||||||||||||||||||||||
@Name | StringLength1to64 | 0..1 | In many cases the description repeats, this will allow you to define the information that is being sent, typically used when multiple occurrences of Paragraph Type are being sent. | |||||||||||||||||||||||||||||||||||||||||||
@ParagraphNumber | xs:nonNegativeInteger | 0..1 | The sequence number for the paragraph. | Default "1" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | SupplementalData | Text | 1 | Formatted text content. Provides text and indicates whether it is formatted or not | ||||||||||||||||||||||||||||||||||||||||||||
@TextFormat | string | 0..1 | Indicates the format of text used in the description | "PlainText" | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | Email | 0..1 | An email address to which the confirmation should be sent. | IETF specified format | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | TPA_Extensions | px:NotificationExtensions | px:NotificationDetail | px:Template | 0..1 | |||||||||||||||||||||||||||||||||||||||||||||
@Code | string | 1 | Code defined for the confirmation letter to be sent | CNF = Confirmation MOD = Modification CXL = Cancellation | ||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | TPA_Extensions | px:NotificationExtensions | px:NotificationDetail | px:AdditionalItems | 0..1 | Details the list of Bookable packages assigned to the reservation | ||||||||||||||||||||||||||||||||||||||||||||
@Code | string | 1 | Package Code | |||||||||||||||||||||||||||||||||||||||||||
@Description | string | 1 | Package Name | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | TPA_Extensions | px:NotificationExtensions | px:NotificationDetail | px:AdditionalItems | px:Item | 0..1 | Separate section for each separate package | ||||||||||||||||||||||||||||||||||||||||||||
@Code | string | 1 | Package item code | |||||||||||||||||||||||||||||||||||||||||||
@Currency | string | 1 | Package Currency | |||||||||||||||||||||||||||||||||||||||||||
@GuestViewable | xs: boolean | 0..1 | Guest viewable flag | |||||||||||||||||||||||||||||||||||||||||||
@PriceViewable | xs: boolean | 0..1 | Price viewable flag | |||||||||||||||||||||||||||||||||||||||||||
@Quantity | Numeric1to999 | 0..1 | Package quantity | |||||||||||||||||||||||||||||||||||||||||||
@SingleAmountAfterTax | Money | 0..1 | Package Net amount | |||||||||||||||||||||||||||||||||||||||||||
@SingleAmountBeforeTax | Money | 0..1 | Package Gross amount | |||||||||||||||||||||||||||||||||||||||||||
@Frequency | Numeric1to999 | 0..1 | Package occurrence | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | TPA_Extensions | px:NotificationExtensions | px:NotificationDetail | px:InclusiveItems | 0..1 | Details the list of inclusive packages assigned to the booking via the rate code details | ||||||||||||||||||||||||||||||||||||||||||||
@Code | string | 1 | Package Code | |||||||||||||||||||||||||||||||||||||||||||
@Description | string | 1 | Package Name | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | WrittenConfInst | TPA_Extensions | px:NotificationExtensions | px:NotificationDetail | px:InclusiveItems | px:Item | 0..1 | Separate section for each separate package | ||||||||||||||||||||||||||||||||||||||||||||
@Code | string | 1 | Package Item code | |||||||||||||||||||||||||||||||||||||||||||
@Currency | string | 1 | Package Currency | |||||||||||||||||||||||||||||||||||||||||||
@GuestViewable | xs: boolean | 0..1 | Guest viewable flag | |||||||||||||||||||||||||||||||||||||||||||
@PriceViewable | xs: boolean | 0..1 | Price viewable flag | |||||||||||||||||||||||||||||||||||||||||||
@Quantity | Numeric1to999 | 0..1 | Package quantity | |||||||||||||||||||||||||||||||||||||||||||
@SingleAmountAfterTax | Money | 0..1 | Package Net amount | |||||||||||||||||||||||||||||||||||||||||||
@SingleAmountBeforeTax | Money | 0..1 | Package Gross amount | |||||||||||||||||||||||||||||||||||||||||||
@Frequency | Numeric1to999 | 0..1 | Package occurrence | |||||||||||||||||||||||||||||||||||||||||||
OTA_HotelResNotifRS
Element | @Attribute | Type | Num | Description outbound | Comments + Content outbound | pAIR | OnPrem | Content inbound | pAIR | OnPrem (PWS) | |
---|---|---|---|---|---|---|---|---|---|---|
IDS | PWS | |||||||||
OTA_HotelResNotifRS | 1 | This message returns acknowledgement that the reservation has been successfully received, or includes warnings from business processing rules or errors if the request did not succeed. It may optionally include the updated reservation data. | ||||||||
@EchoToken | StringLength1to128 | 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 | StringLength1to64 | 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 | decimal | 0..1 | Version of the message. | |||||||
@PrimaryLangID | language | 0..1 | Default language of the property. | |||||||
@TimeStamp | 0..1 | ISO 8601 encoded timestamp indicating the creation date and time of the message. | 2019-12-30T12:05:28 | |||||||
@ResResponseType | 0..1 | An enumerated attribute that contains the status of the processing of the requested hotel reservations, specified in the request message. |
|
| ||||||
OTA_HotelResNotifRS | POS | Source | RequestorID | 1 | This identifies the system that is sending the reservation. | ||||||||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | Unique ID Type (UIT) Hotel=10 |
| |||||
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | |||||||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” | “protelIO” | |||||
OTA_HotelResNotifRQ | POS | Source | BookingChannel | 0..1 | This element is used to pass the booking source for the reservation. To send secondary booking channel information an additional Source element needs to be sent. | ||||||||
@Primary | boolean | 0..1 | Indicates whether the enumerated booking channel is in the primary means of connectivity used by the source |
| ||||||
@Type | OTA_CodeType BCT | 1 | Indicates the type of booking channel per the Open Travel BCT codes. | |||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | 0..1 | Allows extensions to be added to the OpenTravel specification per trading partner agreement. | ||||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 1 | Used to transport extensions on POS level for the system which initiated the transaction. | ||||||||
OTA_HotelResNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Used to transport extensions on POS level for the property which holds the reservation. | ||||||||
@FiscalDate | date | 0..1 | This attribute transfers the actual date of the PMS system. | yyyy-mm-dd | ||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | 1 | Must be sent for the message to have a meaning. | ||||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | ResGuests | ResGuest | 1..n | A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | ||||||||
@ArrivalTime | time | 0..1 | This represent the time of guests arrival. | |||||||
@DepartureTime | time | 0..1 | This represent the time of guests departure. | |||||||
@PrimaryIndicator | boolean | 0..1 | When true indicates this is the primary guest. |
| ||||||
@ResGuestRPH | RPH_Type | 0..1 | Used to refer to the guest associated with this reservation. | |||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | 0..1 | A collection of Profile objects or Unique IDs of Profiles. | ||||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | 1..n | A collection of Profiles or Unique IDs of Profiles. | ||||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | UniqueID | 0..9 | Identifies the profile to be modified together with the owner of the profile or an id provided by the client. | ||||||||
@ID | StringLength1to32 | 1 | A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||||||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||||||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). | Unique ID Type (UIT) Customer=1 | ||||||
OTA_HotelResNotifRS | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | 1 | Provides detailed information regarding either a company or a customer profile. | ||||||||
OTA_HotelResNotifRS | Success | 1 | An element that is not intended to contain any data. The mere presence of a success element within the response message indicates that the incoming request message was processed successfully. Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors. | ||||||||
OTA_HotelResNotifRS | Errors | 1 | A collection of errors that occurred during the processing of this message. A collection of errors that occurred during the processing of a message. | ||||||||
OTA_HotelResNotifRS | Errors | Error | 1..99 | An error that occurred during the processing of a message. Standard way to indicate that 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. | ||||||||
@Type | OTA_CodeType EWT | 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). | |||||||
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | |||||||
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided." | |||||||
OTA_HotelResNotifRS | Warnings | 1 | Indicates that the recipient of the request message identified one or more business-level warnings/errors, but the message itself was successfully processed. | ||||||||
OTA_HotelResNotifRS | Warnings | Warning | 1..99 | Used in conjunction with the Success element to define a business error. Used when a message has been successfully processed to report any warnings or business errors that occurred. | ||||||||
@Type | OTA_CodeType EWT | 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). | |||||||
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | |||||||
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided." |