XML Responses - Standard Sub-Elements

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

Response - Booking level sub-elements

The API will return the following as the standard Booking level sub-elements:

Element

Description

BookingReferences

This will contain a list of references that uniquely identify the booking.

BookingCreationDate

The date the booking was created.

BookingDepartureDate

The booking departure date.

BookingName

The booking name.

PassengerEmail

The passenger email address.

BookingPrice

The booking price information. Contains the following attributes:

  • Currency – the ISO currency code of the price information.
  • Gross – the gross price of the booking.
  • Commission – the commission of the booking.
  • Nett – Gross minus Commission.

BookingFee

If any booking fees apply (i.e.: cancellation or amendment fees) they will appear within the BookingFee element.

BookingStatus

The booking status. Contains the following attribute: -

  • Code – the API code for the status.


Response - BookingReferences sub-elements

<BookingReferences>
	<BookingReference ReferenceSource="client">BOOK1002</BookingReference>
<BookingReference ReferenceSource="api">165432 </BookingReference>
</BookingReferences>

For booking responses the BookingReferences will contain at least one reference to uniquely identify the booking (i.e. the APIs booking reference). It will also include the client’s reference if the booking was added through the API using the AddBookingRequest. Each booking reference element can have the following attributes / sub-elements: 

Attribute

Description

ReferenceSource

Specifies whose reference is being used (either the client or API unique reference).

 

Element

Description

BookingReference

The unique booking reference.


Response - 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>

The API will return the PaxNames sub-element containing a list of one or more passengers (the PaxName element). Each PaxName element can have the following attributes / sub-elements: 

Attribute

Description

PaxId

Unique identifier for this passenger.

PaxType

Valid values are “adult” and “child”.

ChildAge

If PaxType=”child”, this will specify the child’s age.

 

Element

Description

PaxName

The name of the passenger.


Response - BookingItems sub-elements

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

For booking responses the API will return a list of one or more booking items within the BookingItems element. The specifics of each booking item must be contained within a BookingItem element (see below).

Attribute

Description

ItemType

Identifies the type of item (i.e. Hotel, Sightseeing etc.).


Response - BookingItem sub-element

<ItemReference>1</ItemReference>
<ItemCity Code="LON"><![CDATA[London]]></ItemCity>
<Item Code="EMP"><![CDATA[5 Emperors Gate]]></Item>
<ItemPrice 
   Commission="19.10" 
   Currency="GBP" 
   Gross="191.00" 
   GrossWithoutDiscount="221.00" 
   IncludedOfferDiscount="30.00"
   Nett="171.90"/>
<Offer Code="DSC"><![CDATA[Discount Night(s)]]></Offer>
<ItemStatus Code="C"><![CDATA[Confirmed]]></ItemStatus>
<ItemConfirmationReference>LL0F013994</ItemConfirmationReference>
<ItemRemarks>
    <ItemRemark Code="LA"><![CDATA[Late Arrival]]></ItemRemark>
</ItemRemarks>
<ItemPayableBy>GTA-USA, New York</ItemPayableBy>
EssentialInformation>
    <Information>
         <Text><![CDATA[No Children permitted.]]></Text>
         <DateRange>
               <FromDate>2008-01-01</FromDate>
               <ToDate>2008-12-31</ToDate>
         </DateRange>
    </Information>
</EssentialInformation>

 

Element

Description

ItemReference

This will contain the reference that uniquely identifies the booking item.

ItemCity

The city name, the Code attribute specifies the GTA city code for the item.

Item

The item name, the Code attribute specifies the GTA code for the item.

ItemPrice

The booking item price information. Contains the following attributes:

  • Commission – the commission of the booking item.
  • Currency – the currency ISO code of the price information.
  • Gross – the gross price of the booking item.
  • GrossWithoutDiscount – the gross price of the booking item without the discount.
  • IncludeOfferDiscount – the offer applied to the item.
  • Nett – Gross minus Commission.

Offer

The offer applied to the booking item. Contains the following attribute:

Code – the code of the offer applied to the booking item.

ItemFee

If any item fees apply (i.e.: cancellation or amendment fees) they will appear within the ItemFee element.

ItemStatus

The booking item status. Contains the following attribute: -

Code – the API code for the status.

ItemConfirmationReference

This is the supplier’s reference. If GTA uses a third party supplier this element might be blank. This element does not denote the booking status. The booking status is returned in the ItemStatus element.

ItemRemarks

The booking item level remarks (if they exist).

ItemPayableBy

The supplier (if other than GTA) through which the booking was made. This information needs to be displayed on your vouchers.

EssentialInformation

The collection of <Information> parameters for the item (if they exist).


One or more booking item will exist for a booking. A booking item can be one of the following: 

HotelItem

Hotel item details.

ApartmentItem

Apartment item details.

SigthseeingItem

Sightseein item details.

TransferItem

Transfer item details.


Response - PaxIds sub-element

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

The API will return a list of PaxId sub-elements for a booking item within the PaxIds element.

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

Element

Description

PaxId

A reference to a PaxId specified within the PaxNames.

Docs Navigation