Hotel Item

For bookings the specifics of a hotel item will be contained within the HotelItem sub-element.

Request

HotelItem sub-element

The following gives a list of the attributes and sub-elements allowed for a HotelItem sub-element within a request:

Parameter

Description

AlternativesAllowed

Optional.  True/false indicates when substitute items are allowed. If not present, it will default to false.

This parameter is now redundant since alternative hotels are no longer offered.  Bookings will be rejected if the originally requested property cannot be confirmed regardless of the value.

PeriodOfStay

Mandatory. Specifies the period of stay.

HotelRooms

Mandatory. Specifies one or more HotelRoom elements – which are used to describe the room details and assign passenger details when booking based on Room Type. See HotelRoom definition below.

HotelPaxRoom

Mandatory. Specifies one HotelPaxRoom element – which is used to describe the room details and assign passenger details when booking based on Occupancy. See HotelPaxRoom definition below.


Response

HotelItem sub-element

For a response the API will return the following attributes and sub-elements allowed for a HotelItem sub-element: 

Parameter

Description

PeriodOfStay

Specifies the period of stay.

HotelRooms

Specifies one or more HotelRoom elements – which are used to describe the room details and assign passenger details when booking based on Room Type. See HotelRoom definition below.

HotelPaxRoom

Specify one HotelPaxRoom element – which is used to describe the room details and assign passenger details when booking based on Occupancy. See HotelPaxRoom definition below.

Multiple rooms must be booked under separate <ItemReference> elements.

Meals

Specifies the meal information. See Meals definition below.

PeriodOfStay sub-element

The following gives a list of sub-elements for a PeriodOfStay sub-element: 

Element

Description

CheckInDate

Specifies the date of check in.

CheckOutDate or Duration

Specifies the date of check out OR the Duration of stay


HotelRoom sub-element

The following gives a list of attributes and sub-elements for a HotelRoom sub-element: 

Attribute

Description

Code

Specifies the GTA room code for the hotel.

Id

Specifies the category of room. This is an optional attribute dependant on the client’s Participation Level: -

  • Participation Level – None: Must not be entered
  • Participation Level – 1: Mandatory
  • Participation Level – 2. Mandatory

ExtraBed

Specifies if an extra bed is required. If “true” a child is required in the PaxIds list.

NumberOfExtraBeds

Specifies the number of children accommodated in the room. If specified must be either 1 or 2. Optional if only 1 extra bed is required, compulsory if 2 extra beds are required.

SharingBedding

Specifies if the child shares existing bedding. If “true” the child will be sharing existing bedding. If “false” the child will be provided with an extra bed

NumberOfCots

Specifies the number of infants accommodated in the room. If specified must be either 1 or 2.

 

Element

Description

Description

The room category description.

PaxIds

Specifies the list of one or more passengers for the room. See the PaxIds definition for further details.


HotelPaxRoom sub-element

Attribute

Description

Adults

Specifies the number of adults in the booking item.

Children

Specifies the number of children in the booking item.

Cots

Specifies the number of cots in the booking item.

Id

Specifies the category of room. Occupancy based bookings can be done by clients on Participation Level 2 only and for multiple rooms must be booked under separate <ItemReference> elements.

SharingBedding

Specifies if the child shares existing bedding. If “true” the child will be sharing existing bedding. If “false” the child will be provided with an extra bed

 

Element

Description

Description

The room category description.

PaxIds

Specifies the list of one or more passengers for the room. See the PaxIds definition for further details.


NB
:  When placing a booking for multiple rooms, if one of the rooms cannot be confirmed the whole booking will not be confirmed.

Booking amendments are not supported with this functionality.

Meal sub-element

The following gives a list of sub-elements for a MealBasis sub-element: 

Element

Description

Basis

The meal description. Contains the following attribute: -

  • Code - Specifies the GTA meal code.

Breakfast

The breakfast description. Contains the following attribute: -

  • Code - Specifies the GTA breakfast code.


Charge Conditions parameters

The response will include the charge conditions.

Please refer to the Search Charge Conditions document for the details of these parameters.

Docs Navigation