XML Requests

Booking XML requests must be in a form recognised by the API, if they are not they will be rejected and a corresponding XML error message returned.

As described in the API Architecture document each message must be formed as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Request>
    <Source>
        <RequestorID
            Client = "123456"
            EMailAddress = "clientName@client.co.uk"
            Password = "clientPassword"/>
        <RequestorPreferences>
            <RequestMode>ASYNCHRONOUS</RequestMode>
            <ResponseURL>/ProcessResponse/GetXML</ResponseURL>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <AddBookingRequest>++++ booking 1 parameters</AddBookingRequest>
    </RequestDetails>
</Request>

This section will describe the sub-elements that are allowed within the RequestDetails element for bookings. Please also refer to the following section for a detailed description of common request elements.

Valid sub-elements within the RequestDetails element are: -

For booking level requests: 

  • AddBookingRequest
  • ModifyBookingRequest
  • CancelBookingRequest
  • SearchBookingRequest

For booking item level requests: 

  • AddBookingItemRequest
  • ModifyBookingItemRequest
  • CancelBookingItemRequest
  • SearchBookingItemRequest

AddBookingRequest

This request is used to add new bookings through the API.  Each add booking request element can have the following attributes / sub-elements: 

Parameter

Description

Currency

Optional. This will contain an ISO currency code to apply to the booking.  If present will override any customer/request level currency code.

BookingName

Optional.  This will contain the name of the booking, if omitted the booking name will be the first pax name in the pax list.

BookingReference

Mandatory. This will contain a client reference to uniquely identify the booking.

AgentReference

Optional.  This element contains the agent reference. It does not have to be unique. This can be printed on the invoices.

BookingDepartureDate

Optional. The date when your client is departing from your country; usually the same as the first arrival or tour date of a booking. When a new booking is being added the departure date can be specified. If it is not it will default to the earliest date of any booking item.

AgentReference

Optional.  This element contains the agent reference. It does not have to be unique. This can be printed on the invoices.

PassengerEmail

Optional. This will contain the passenger email address. If added, an email with the voucher will be sent to the email address provided.

PaxNames

Mandatory. This element contains the passenger names linked to the booking.

BookingItems

Mandatory. This element contains all items linked to the booking.


ModifyBookingRequest

This request is used to modify existing booking header data through the API.  Each modify booking request element can have the following attributes / sub-elements:

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): 

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

AgentReference

Optional.  This element contains the agent reference. If present will overwrite the existing value.

BookingDepartureDate

Optional. Will overwrite the existing value, when a valid date is present.

PassengerEmail

Optional. This will contain the passenger email address. If added, an email with the voucher will be sent to the email address provided.

PaxNames

Optional. This element contains the passenger names linked to the booking.  When present will add new pax and modify existing pax names.


CancelBookingRequest

This request will be used to cancel an existing booking through the API – all items linked to the booking will also be cancelled. The following sub elements must be specified: 

Element

Description

BookingReference

Mandatory. This will contain a reference to uniquely identify the booking.

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): 

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.


SearchBookingRequest

This request will be used to retrieve a list of bookings through the API for given search criteria. The results may consist of none, one or more bookings. One or more of the following sub-elements must be specified: 

Element

Description

BookingReference

Optional. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.
  • “agent” – the Agent reference for the booking.

BookingDateRange

Optional. A FromDate and ToDate can be specified to limit the booking returned. If either date is specified, the DateType must also be specified.

 

DateType

Values allowed: -

  • “departure” – date range applies to booking departure date.
  • “creation” - date range applies to booking creation.e date. the unique GTA reference.

BookingStatusCode

Optional. Only bookings with the specified booking status code will be returned.

BookingName

Optional. If specified all bookings containing the given characters will be returned.

Note: Booking Names are not case sensitive.

EchoSearchCriteria

Optional. Specifies that the search criteria will be echoed back on the search response. Default is “false”.


AddBookingItemRequest

This request will be used to add booking items to an existing booking.  One or more of the following sub-elements must be specified:

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

BookingItems

Mandatory. This element contains all items linked to the booking.

 

ModifyBookingItemRequest

This request will be used to modify booking items on an existing booking.  One or more of the following sub-elements must be specified: 

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

BookingItems

Mandatory. This element contains all items to be modified within the booking


CancelBookingItemRequest

This request will be used to cancel booking items on an existing booking.  One or more of the following sub-elements must be specified: 

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

Although both can be used, we recommend you use “client”.

ItemReferences

Mandatory. This element contains the items to be cancelled within the booking


SearchBookingItemRequest

This request will be used to retrieve a list of bookings items for a booking through the API for given search criteria. The results may consist of none, one or more booking items. One or more of the following sub-elements must be specified: 

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

ItemStatusCode

Optional.  Booking item status to match.

ItemReference

Optional. Only the booking item with the specified item reference will be returned.

Docs Navigation