XML Requests - Standard Sub-Elements

This section describes the standard sub-elements that appear in the different types of booking request.

Request - BookingReference element

<BookingReference>BOOK1002</BookingReference>

For booking requests the BookingReference must contain a reference to uniquely identify the booking to the API. Each booking reference element can have the following attributes / sub-elements:

Element

Description

BookingReference

Mandatory. The unique booking reference. Can be up to 30 characters long.


Request - PaxNames sub-elements

<PaxNames>
	<PaxName PaxId="1"><![CDATA[Mr John Doe]]></PaxName>
	<PaxName PaxId="2"><![CDATA[Mrs Sarah Doe]]></PaxName>
<PaxName PaxId="3" PaxType="child" ChildAge="11"><![CDATA[Master Jim Doe]]></PaxName>
</PaxNames>

For booking requests the PaxNames must contain a list of one or more passengers (but no more than 9). Each passenger must be contained within a PaxName element, which can have the following attributes / sub-elements:

Attribute

Description

PaxId

Mandatory. This is a unique identifier for this passenger within the booking. Any subsequent reference to this passenger will be by the assigned PaxId.

PaxType

Optional. If not specified will default to “adult”. Valid values are “adult” and “child”.

ChildAge

Must be specified if PaxType=”child” is specified. Can have a value between 2 and 18 inclusive.

 

Element

Description

PaxName

Mandatory. The name of the passenger.  Maximum 50 characters long.


Request - BookingItems sub-elements

<BookingItems>
	<BookingItem ItemType="hotel">
++++ hotel item 1 details
	</BookingItem>
</BookingItems>

For booking requests the BookingItems must contain a list of one or more booking items. Each booking item must be contained within a BookingItem element (see below).

Request - BookingItem sub-element

Attribute

Description

ItemType

Mandatory when a new item is being added otherwise it will be ignored. Identifies the type of item being processed (i.e. apartment, hotel, sightseeing or transfer).

ExpectedPrice

Optional. This will contain the value at which the item is expected to be confirmed (this would be the rate returned in the <SearchHotelPriceResponse> or the <SearchHotelPricePaxResponse>).

The following rules apply:

  • can only be added to the <AddBookingRequest> and the <AddBookingItemRequest>;
  • can be used both, for booking requests based on room type and pax numbers;
  • can only be used on participation levels 1 and 2; if entered on participation level 0 it will be ignored;
  • can only be added to requests for hotel items;
  • can only be added to requests for single item bookings; if entered in a request for multi items the attribute will be ignored;
  • if the price at which our system can confirm the item is the same or lower than the value entered, the booking will be processed;
  • if the price at which our system can confirm the item is higher than the value entered in this attribute, an error will be returned;
  • values have to be entered in the same format as they are being returned in the <SearchHotelPriceResponse> or the <SearchHotelPricePaxResponse>; if decimal places are entered where they are not expected the ExpectedPrice attribute will be completely ignored and booking will be confirmed at any available price.
<ItemReference>1</ItemReference>
<ItemCity Code="LON"/>
<Item Code="EMP"/>
<ItemRemarks>
	<ItemRemark Code="LA"/>
</ItemRemarks>
<HotelItem>
++++ hotel item details
</HotelItem>

For booking requests the BookingItem can contain the following list of sub-elements:

Element

Description

ItemReference

Mandatory. This will contain the reference to uniquely identify the booking item (any value between 1 and 900).

ItemCity

Mandatory when a new item is being added otherwise it will be ignored. The Code attribute specifies the GTA city code for the item.

Item

Mandatory when a new item is being added otherwise it will be ignored. The Code attribute specifies the GTA code for the item. GTA uses item codes that are unique only in conjunction with the city codes.

ItemRemarks

Optional. Each ItemRemark will consist of: -

  • A Code attribute.
  • OR Free format text

This facility is configurable for client, item type, and remark  type combinations.


A booking item can be one of the following: 

HotelItem

Hotel item details

ApartmentItem

Apartment item details

SightseeingItem

Sightseeing item details

TransferItem

Transfer item details.


Request - PaxIds sub-element

<PaxIds>
	<PaxId>1</PaxId>
	<PaxId>2</PaxId>
	<PaxId>3</PaxId>
</PaxIds>

To assign passengers to a specific booking item, the PaxIds sub-element will be included within the corresponding booking item.

The PaxIds must contain at least one PaxId sub-element. 

Element

Description

PaxId

Mandatory. Must be a reference to a PaxId specified within the PaxNames within this request or previous request for the booking.


Request - ItemReferences sub-element

<ItemReferences>
	<ItemReference>1</ItemReference>
	<ItemReference>2</ItemReference>
</ItemReferences>

To cancel a specific booking item, the ItemReferences sub-element will be included within the CancelBookingItemRequest

The ItemReferences must contain at least one ItemReference sub-element. 

Element

Description

ItemReference

Mandatory. Must be an item number matching one on the specified booking.

 

Docs Navigation