Search Item

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

The Search Item provides the client with static data relating to apartment, hotel and sightseeing items held within the GTA system. The API will provide an item description along with the unique code used by GTA to identify the item.

Example XML Search Item request

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

<?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>
		<SearchItemRequest ItemType="hotel">
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ItemName>AP</ItemName>
		</SearchItemRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Item attributes/parameters

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

Attribute

Description

ItemType

Mandatory. Identifies the type of item being processed. Must be one of “apartment”, “hotel” or “sightseeing” or “transfer”

 

Parameters

Description

ItemDestination

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

LocationCode

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

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. GTA uses item codes that are unique only in conjunction with the city co

Example XML Search Item response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchItemResponse ItemType="hotel">
			<ItemDetails>
				<ItemDetail>
					<City Code="AMS"><![CDATA[Amsterdam]]></City>
				 	<Item Code="APP"><![CDATA[Apple Inn]]></Item>
				 	<LocationDetails>
					  <Location Code="G1"><![CDATA[Central]]></Location>
			      <Location Code="G3"><![CDATA[Station]]></Location>
			      <Location Code="04"><![CDATA[Museumsplein/Leidesplein]]></Location>
				 	</LocationDetails>
				</ItemDetail>
				<ItemDetail>
					<City Code="AMS"><![CDATA[Amsterdam]]></City>
				 	<Item Code="MER3"><![CDATA[Meridien Apollo]]></Item>
				 	<LocationDetails>
				 	 	<Location Code="G2"><![CDATA[Central]]></Location>
				 	</LocationDetails>
				</ItemDetail>
			</ItemDetails>
		</SearchItemResponse>
	</ResponseDetails>
</Response>

Search Item response parameters

Attribute

Description

ItemType

Identifies the type of item being processed. Will be “apartment”, “hotel” , “sightseeing” or “transfer”.

A Search Item response will return the following for each item found for the request 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, unique only in conjunction with the city code.

 

LocationDetails

A list of locations held for the item (see below).

LocationDetails parameters

Location

The location name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique location code held by GTA

Docs Navigation