Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

Element | @Attribute

Num

Description/Contents

Origin | Value

OTA_HotelResNotifRQ

1

Root element of the message.

 

@EchoToken

0..1

As per OTA Specifications.

 

@ResStatus

1

Of all the enumerations listed by OpenTravel Alliance, the one recommended by HTNG for this message should be: “Commit”

 

@Version

1

Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG to be able to use the same message.

1.00

@TimeStamp

1

Time of the transaction.

Date and time of message creation

OTA_HotelResNotifRQ / POS / Source / RequestorID

1

This identifies the system which is the reservation.

 

 

@Type

 

1

Type attribute uses the OpenTravel Alliance code list UIT and ID is used for the name or ID of the requestor. For example, type 22 – ERSP (Electronic reservation service provider) and ID: TrustCRS.

From CRS: “22”

To CRS: Not mapped

@ID

1

The ID used will be agreed by the partners and remain the same the messages.

From CRS: “CRS”

To CRS: Not mapped

OTA_HotelResNotifRQ / POS / Source / BookingChannel

1..2

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.

From PMS: 1 element

To PMS: Process primary element only.

See below

@Type

1

Type is mandatory in OTA and indicates the type of booking channel. Refers to OTA code list BCT (Booking C )

  1. Global distribution system (GDS) (GDS)

  2. Alternative distribution system (ADS)

  3. Sales and catering system (SCS)

  4. Property management system (PMS)

  5. Central reservation system (CRS)

  6. Tour operator system (TOS) Internet

 

@Primary 

1

Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent. 

Map only the Primary 

OTA_HotelResNotifRQ/ POS / Source / BookingChannel /Company Name 

0

The name of the booking source. 

 

@Code 

0..1 

Code is optional and can be used to transfer the code of the Booking such code is a recognized industry standard – the name, however, should always be sent as well as the code. 

 

OTA_HotelResNotifRQ / HotelReservations / HotelReservation 

1

Must be sent for the message to have meaning. 

 

@CreatorID 

1

The CreatorID is the identifier of the Reservation Clerk or, in its absence, the office that created the reservation. 

 

 

@CreateDateTime 

1

This is the date when the reservation was first made. 

Reservation Date, Time 

@ResStatus 

0..1 

Indicates the status of the reservation. 

Valid values are dependent on the roles: 

 Reservation Server

  • Reserved 

  • Waitlisted 

Reservation Bk 

  • Reserved 

  • Waitlisted 

  • In-house 

From PMS: If transaction subtype is “CANCEL” or “DELETE”, send “Cancelled”, if subtype is “NOSHOW”, send “No- show”, ifsubtype is “CHKIN”, send “In-house”, if subtype is “CHKOUT” send “Checked-out”, otherwise send “Reserved”. 

To PMS: Ignored because “Cancelled” – duplicates the previous Cancellation status given by the ResStatus attribute in the first element of the document, and “Reserved” – is Anything that is not cancelled 

OTA_HotelResNotifRQ / HotelReservations / HotelReservation / UniqueID 

1

The unique ID is the product of the which sent the messages. For the message is generated by the this field would contain the PMS confirmation number; if the system is a CRS, the CRS confirmation number. 

 

@Type 

1

Type is assigned codes from the UIT (Unique ID Type) code list. If the originator is a CRS, the recommended value for this message is 14 – Reservation.
If the originator is a PMS, the recommended value for this message would be 10 – Hotel.

From PMS: “10” for PMS 

To PMS: Expect “14” for CRS 

 @ID  

 1  

 ID ID is the actual confirmation number.  

To PMS: Source Res Number  

From PMS: Source Reservation Number, which is 7 digits or less for e4W, 8 digits for HMS OR by option e4W/e4N long number, which is 11 digits long.  

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation /  RoomStays / RoomStay

 1..n  

 One One instance of RoomStay per Room booked.  

   

 @MarketCode  

 0..1  

 This This is the code that relates to the being sold and may be needed by the PMS for tracking purposes.

Market Segment  

 @SourceOfBusiness  

 0..1  

 Used Used to specify where the business from; e.g., radio, newspaper ad, or it be a referring property.  

Source of Business  

 @PromotionCode  

 0..1  

 This This is the promotion code indicating, instance, a specific marketing not the rate code

Not mapped  

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans  

 0..1  

 The The RatePlans element is not required can be sent to give further details on rates booked in this reservation.

   

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan

 1..n  

 The The RatePlan to be booked  

   

 @RatePlanCode  

 1  

 This This is the code of the rate booked.  

   

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation /
RoomStays / RoomStay / RatePlans / RatePlan / RatePlanInclusions

 1  

 Defines Defines charges that are included in rate plan.

Not mapped  

 @TaxInclusive  

 1  

 BooleanBoolean. Defines if the rate booked is tax inclusive or not.  

Not mapped  

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate

 1..n  

 One One instance of RoomRate per room/rate 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   

From CRS: At least 1.  

To CRS: Must have at least 1. 

 @RatePlanCategory  

 0..1  

 This This is the category or segment to the rate being booked belongs

 Not mapped  

 @RoomTypeCode  

 1  

 This This is the room type code booked in reservation.

   

 @InvBlockCode  

 0..1  

 If If the room booked is part of a block block code or suitable default string by the implementing partners should transferred in this field.

 Group number if group reservation  

 @NumberOfUnits  

 1  

 This This is the number of rooms booked for room type code listed in the RoomTypeCode attribute. In the case of shared reservations, value will always be "1".

   

 @RatePlanCode  

 1  

 This This is the rate booked for the room code listed in the RoomTypeCode attribute.

   

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomRates / RoomRate / Rates / Rate

 1..n  

 At At least one instance of Rate per Rate plan. Multiple instances of the Rate element must be sent if rate changes to the booking.

 1 or more, depending on number of Rate elements.

 @RateTimeUnit  

 1  

 The The RateTimeUnit is an enumeration of time units upon which the rate amount is based (e.g., daily, weekly, single rate for full stay)  

 Must be “DAY”  

 @EffectiveDate  

 1  

 The The Effective date attribute indicates  starting date of when a specific rate is applied. This is needed when during stay there are some rate changes and therefore, one instance of the Base element applies to part of the stay and
another instance of the Base element
applies to another part of the stay. The
effective date here refers to the
Base that is passed in this instance of
element.

 Start Date  

 @ExpireDate  

 1  

 The The Expire date indicates the day the specific value of the rate is changed another value.  

 End Date  

 @UnitMultiplier  

 1  

 UnitMultiplier UnitMultiplier is the number of RateTimeUnits that the rate amount is based upon (e.g., rate for one day in case of nightly rates).  

 Ignored  

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomRates / RoomRate / Rates / Rate / Base  

 1  

 Mandatory Mandatory in both Open Travel Alliance and HTNG if an instance of RoomRate is passed.  

   

 @CurrencyCode  

 1  

 CurrencyCode CurrencyCode used ISO 4217 codes indicate the currency of the rate that is being booked.

   

 @AmountBeforeTax  

 1  

 AmountBeforeTax AmountBeforeTax if available can be for each @NumberOfGuests.

   

 @AmountAfterTax  

 0..1  

 AmountAfterTax AmountAfterTax is Mandatory for each @NumberOfGuests.

 Not mapped 

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base / Taxes

 0..1  

   

 Not mapped 

 @Amount  

 0..1  

 Total Total Amount of Taxes applied to the booking.

   

   

 @CurrencyCode  

 0..1  

 Currency Currency of the total Amount of Taxes  

   

 OTAOTA_HotelResNotifRQ /  HotelReservations /
HotelReservation /
RoomStays / RoomStay /
RoomRates / RoomRate
Rates / Rate / Base / Taxes /
Tax

 0..99  

   

 Not mapped 

 @Type  

 0..1  

The Type attribute is an enumeration indicate whether the tax is “inclusive”, “exclusive”, or “cumulative”.

   

 @Code  

 0..1  

The Code attribute refers to OTA list (fee tax type) and is used to indicate specific tax or fee that is being transferred.

   

 @Amount  

 0..1  

Amount of the specific tax/fee transferred.  

   

 @CurrencyCode  

 0..1  

Currency for the amount of the tax/fee transferred.

   

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / GuestCounts

 1  

Contains the guest counts of the booking.  

   

 @IsPerRoom  

 0..1  

Indicates that the guest count on a per room basis.  

 Always send “true” 

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / GuestCounts / GuestCount  

 1..n  

Contains the type and number of guests included in the reservation.

   

 @AgeQualifyingCode  

 1  

The two codes used from the OTA code list are:

8-Child, 10-Adult.

“8” = Child  

“10” = Adult

 @Count  

 1  

Count will include the number and will repeated for each Type of guest.

   

 OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / TimeSpan

 1  

These are the in and out date of the booking.

   

 @Start  

 1  

 Check in date.  

 Arrival Date  

 @End  

 1  

 Check out date.  

 Departure Date  

OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee

0..5

Guarantee provided with the reservation.

 

OTA_HotelResRQ Message Sample

...