Search Location

This module has now been phased out and will no longer be supported. 

The Search Location provides the client with static data relating to locations held within the GTA system. The API will provide a location name and city code along with the unique code used by GTA to identify the location.

Example XML Search Location request

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

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
		<SearchRoomTypeRequest />
	</RequestDetails>
</Request>

 Source parameters

Please refer to the API Architecture document.

Search Location attributes/parameters

A Search Location request can contain optional attributes/parameters to filter the locations returned.  The following lists the attributes/parameters that can be specified: -

Attribute

Description

CityCode

Optional. Used to return all locations within the specified city or if not specified the generic locations alone will be returned (e.g. city, airport, etc.) N.B. if a city is specified, the generic locations will be returned along with any specific to that city which obviates the need to issue a separate request for the generic locations.

 

Parameter

Description

LocationName

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

Note: Location Names are not case sensitive.

LocationCode

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

Example XML Search Location response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200002">
	<ResponseDetails Language="en">
		<SearchRoomTypeResponse>
			<RoomTypeDetails>
				<RoomType Code="DB"><![CDATA[Double]]></RoomType>
				<RoomType Code="Q"><![CDATA[Quad]]></RoomType>
				<RoomType Code="SB"><![CDATA[Single]]></RoomType>
				<RoomType Code="TR"><![CDATA[Triple]]></RoomType>
				<RoomType Code="TS"><![CDATA[Twin for sole use]]></RoomType>
				<RoomType Code="TB"><![CDATA[Twin]]></RoomType>
			</RoomTypeDetails>
		</SearchRoomTypeResponse>
	</ResponseDetails>
</Response>

 Search Location response parameters

A Search Location response will return the following for each location found for the request parameters: -

Parameter

Description

Location

The location name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique location code held by GTA

 

Docs Navigation