Search Hotel Availability

This module is being phased out and will no longer be supported in our new platform

All requests will need to be sent in a SYNCHRONOUS mode; any requests send in an     ASYNCHRONOUS mode will return an error.

The Search Hotel Availability provides the client with the ability to search for available hotel rooms through the API.

Please note that this request is not available for newly set up clients.

Example XML Search Hotel Availability request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Hotel Availability Request.

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
	<Source>
		<RequestorID Client="1479" EMailAddress="client@net.com" Password="xxx" />
		<RequestorPreferences Language="en" Currency="GBP" Country="GB">
			<RequestMode>SYNCHRONOUS</RequestMode>
		</RequestorPreferences>
	</Source>
	<RequestDetails>
		<SearchHotelAvailabilityRequest>
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ImmediateConfirmationOnly />
			<PeriodOfStay>
				<CheckInDate>2005-03-11</CheckInDate>
				<Duration>14</Duration>
			</PeriodOfStay>
			<Rooms>
				<Room 
                   Code="TB" 
                   NumberOfRooms="1" 
                   NumberOfCots="2" 
                   ExtraBed="true" 
                   NumberOfExtraBeds="2" />
			</Rooms>
			<StarRating MinimumRating="true">3</StarRating>
			<LocationCode>G1</LocationCode>
			<FacilityCodes>
				<FacilityCode>*SO</FacilityCode>
				<FacilityCode>*TE</FacilityCode>
			</FacilityCodes>
		</SearchHotelAvailabilityRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Hotel Availability attributes/parameters

A Search Hotel Availability request can contain attributes/parameters to filter the hotels returned.

The request can contain the following attributes/parameters:

Parameters

Description

ItemDestination

Mandatory. Used to return all items within the specified destination type (“area” or “city”) and destination code.

ImmediateConfirmationOnly

Optional. If present the response will contain results available only for immediate confirmation.

ItemName

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

Note: Item names are not case sensitive.

ItemCode

Optional. If specified the details for the single code will be returned.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

Rooms

Mandatory. A list of the requested hotel rooms, with information on the number of rooms, the number of cots and whether any extra beds are required for each of the rooms specified. Please see below for further details.

StarRating

Optional. Defines the star rating of the hotel. A match or a minimum value can be specified.

LocationCode

Optional. Used to return all items within the specified location code.

FacilityCodes

Optional. A list of <FacilityCode> elements specifying requested facilities at the hotel, e.g. swimming pool, tennis courts etc.


Rooms parameter

The client can request a number of rooms through the <Rooms> element. The latter is made up of a list of <Room> sub-elements, one element for each different requested room type.

An example of a <Room> element for one double room with one cot and two extra beds is shown below:

<Rooms>
    <Room
        Code = "DB"
        NumberOfRooms = "1"
        NumberOfCots = "1"
        ExtraBed = "true"
        NumberOfExtraBeds = "2"/>
</Rooms>

 

Parameter

Description

HotelRoom

Mandatory. The parameter that contains the details for each requested room type/code.

 

Attribute

Description

 

Code

Mandatory. The unique room code held by GTA.

 

ExtraBed

Optional. If “true” a child will be accommodate in the room.

 

NumberOfCots

Optional. Specifies the number of cots requested.

 

NumberOfExtraBeds

Optional. Specifies the number of extra beds requested.

 

NumberOfRooms

Optional. Specifies the number of rooms requested. If not specified will default to ‘1’.


Example XML Search Hotel Availability response

The XML message below gives a sample of that given by the API in response to a Search Hotel Availability Request.       

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<ResponseDetails Language="en">
		<SearchHotelAvailabilityResponse>
			<HotelDetails>
				<Hotel>
					<City Code="AMS"><![CDATA[ Amsterdam ]]></City>
					<Item Code="CAN"><![CDATA[ Canal Crown ]]></Item>
					<RoomAvailability>
					<Availability>
					<DateRange>
						<FromDate>2005-03-11</FromDate>
						<ToDate>2005-03-15</ToDate>
					</DateRange>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
					</Availability>
					<Availability>
					<DateRange>
						<FromDate>2005-03-16</FromDate>
						<ToDate>2005-03-16</ToDate>
					</DateRange>
				<Confirmation Code="CL"><![CDATA[Closed]]></Confirmation>
					</Availability>
					<Availability>
					<DateRange>
						<FromDate>2005-03-17</FromDate>
						<ToDate>2005-03-21</ToDate>
					</DateRange>
				<Confirmation Code="OR"><![CDATA[On Request]]></Confirmation>
					</Availability>
					</RoomAvailability>
				</Hotel>
			</HotelDetails>
		</SearchHotelAvailabilityResponse>
	</ResponseDetails>
</Response>

Search Hotel Availability response parameters

The <HotelDetails> element can have zero or more <Hotel> sub-elements. Each <Hotel> element can have the following attributes/parameters: 

Parameter

Description

City

The city name in the language requested (if available).

 

Attribute

Description

 

Code

The unique city code held by GTA

 

Item

The item name.

 

Attribute

Description

 

Code

The unique item code held by GTA

 

RoomAvailability

Describes the availability within date range(s).


RoomAvailability parameters

The <RoomAvailability> element can have one or more <Availability> sub-elements. Each <Availability> element can have the following attributes/parameters:

DateRange

The date range for the availability.

 

FromDate

The start date for the hotel availability

 

ToDate

The end date for the hotel availability

Confirmation

Whether the hotel is available immediately, on request or closed for the date range.

 

 

 

 

 

 

 

 

 


Docs Navigation