Search Link

The Search Link provides the client with static data relating to links to other information for an item, such as maps and images. The API will provide links held within the GTA system.

Example XML Search Link request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Link 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>
		<SearchLinkRequest ItemType="hotel" LinkType="image">
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ItemCode>APP</ItemCode>
		</SearchLinkRequest>
	</RequestDetails>
</Request>

 Source parameters

Please refer to the API Architecture document.

Search Link attributes/parameters

A Search Item request can contain optional attributes/parameters to filter the links 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”.

LinkType

Optional. Used to specify a single link type group. Must be one of “image”, “map”, “flash” or “richmedia”

 

Parameters

Description

ItemDestination

Mandatory. Used to return all items within the specified destination type (“area” or “city”) and destination 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.

Example XML Search Link response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchLinkResponse ItemType="hotel">
			<LinkDetails>
			<LinkDetail>
			<City Code="AMS"><![CDATA[Amsterdam]]></City>
		 	<Item Code="APP"><![CDATA[Apple Inn]]></Item>
			<Links>
				<MapLinks>
<MapLink><![CDATA[http://maps-dynamic.imageserver.com/maps.asp?SITEID=8&CTY=AMS&PANITM=APP&COID=2&CAT=HOT]]></MapLink>
<MapPageLink><![CDATA[http://interface.gta-travel.com/gtaxml/
IMapLink.jsp?prov=3&cty=AMS&itm=APP&typ=HH]]></MapPageLink>
				</MapLinks>
				<ImageLinks>
				 	<ImageLink Height="214" Width="360">
				 	  <Text><![CDATA[Exterior]]></Text>
<ThumbNail><![CDATA[ http://images.test.imageserver.com/HH/Nonchainth/amsapp01.jpg]]></ThumbNail>
<Image><![CDATA[ http://images.test.imageserver.com/HH/Nonchain/amsapp01.jpg]]></Image>
				 	</ImageLink>
				 	<ImageLink Height="229" Width="360">
				 	  <Text><![CDATA[Restaurant]]></Text>
<ThumbNail><![CDATA[ http://images.test.imageserver.com/HH/Nonchainth/amsapp02.jpg]]>
</ThumbNail>
<Image><![CDATA[ http://images.test.imageserver.com/HH/Nonchain/amsapp02.jpg]]></Image>
				 	</ImageLink>
				 	<ImageLink Height="231" Width="360">
				 	  <Text><![CDATA[Bedroom]]></Text>
<ThumbNail><![CDATA[ http://images.test.imageserver.com/HH/Nonchainth/amsapp03.jpg]]></ThumbNail>
<Image><![CDATA[ http://images.test.imageserver.com/HH/Nonchain/amsapp03.jpg]]></Image>
				 	</ImageLink>
				</ImageLinks>
             <RichMediaLinks>
			                 <RichMediaLink>http://vfmii.com/exc/aspquery?command=invoke&amp;ipid=BOS-BAC1&amp;ids=77381</RichMediaLink>
   		                   </RichMediaLinks>
			<Links>
			</LinkDetail>
			</LinkDetails>
		</SearchLinkResponse>
	</ResponseDetails>
</Response>

Search Link response parameters

Attribute

Description

ItemType

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

A Search Link 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

 

Links

The collection of link types for the search.

Links parameters

A Links parameter can contain the following link types: -

Parameter

Description

MapLinks

A collection of map links.

ImageLinks

A collection of image links.

FlashLinks

A collection of flash links.

RichMediaLinks

A collection of richmedia links.

MeetingPointFlashLinks

A collection of meeting point flash links.

MeetingPointMapLinks

A collection of meeting point map links.

MapLinks parameters

Parameter

Description

MapLink

The link to a map for the search item.

MapPageLink

The link to a map for the search item.

N.B.: We currently offer the option to choose a map from two different providers. After 14th May 2008 only the maps provided under the <MapPageLink> parameter will be available.

ImageLinks parameters

Parameter

Description

ImageLink

The link to an image for the search item.

 

Attribute

Description

 

Height

The image height.

 

Width

The image width.

 Sub-parameters: -

Parameter

Description

Text

The text associated with the image.

ThumbNail

The link to the thumbnail image.

Image

The link to the full image.

FlashLinks parameters

Parameter

Description

FlashLink

The link to a flash presentation for the search item.

RichMediaLinks parameters

Parameter

Description

RichMediaLink

The link to a richmedia for the search item.

 MeetingPointFlashLinks parameters

Parameter

Description

MeetingPointFlashLink

The link to a meeting point flash presentation for the search item.

 MeetingPointMapLinks parameters

Parameter

Description

MeetingPointMapLink

The link to a meeting point map for the search item.

Docs Navigation