XML Responses

The API will return XML responses in a common form as described in the API Architecture document. 

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="123456" ResponseSequence="1">
  <ResponseDetails Language="en">
    <SearchBookingResponse>
++++ response booking details
    </SearchBookingResponse>
  </ResponseDetails>
</Response>

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

Valid sub-elements within the ResponseDetails element are: -

For booking level requests: -

  • BookingResponse
  • SearchBookingResponse

For booking item level requests: -

  • BookingResponse
  • SearchBookingItemResponse

SearchBookingResponse

The API will generate a SearchBookingResponse for each successful SearchBookingRequest.

The API will format the XML Response to include the following sub elements:

Element

Description

SearchCriteria

The search criteria used for the search request.

Bookings

A list of bookings that satisfy the search criteria.


BookingResponse

The API will generate a BookingResponse for bookings and booking items where a change of booking or booking item data occurs.

SearchBookingItemResponse

The API will generate a SearchBookingItemResponse for each successful SearchBookingItemRequest.

The API will format the XML Response to include the following sub elements: 

Element

Description

SearchCriteria

The search criteria used for the search request.

BookingItems

A list of booking items that satisfies the search criteria.

 

 

 

Docs Navigation