Search Recommended Item

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

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

The Search Recommended Item provides the client with static data relating to any recommended items for various periods and properties. The API will provide a list of these recommended items held within the GTA system.

Example XML Search Recommended Item request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Recommended 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>
    <SearchRecommendedItemRequest ItemType="hotel" >
      <ItemDestination DestinationType="City" DestinationCode="LON" />
      <Nationality>de</Nationality>
      <TravelDates>
         <FromDate>2007-03-20</FromDate>
         <ToDate>2007-03-28</ToDate>
      </TravelDates>
    </SearchRecommendedItemRequest >   
  </RequestDetails>
</Request>

 Source parameters

Please refer to the API Architecture document.

Search Recommended Item attributes/parameters

A Search Recommended 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. Currently only “hotel” and “sightseeing” are available.

 

Parameter

Description

ItemDestination

Optional. Used to filter by destination.

 

Attribute

Description

 

DestinationType

Used to determine if the search is made by city or area

 

DestinationCode

Used to determine the unique GTA city or area code.

 

Parameter

Description

Nationality

ISO 3166 format, 2 letters

Optional. Used to determine the country of residence of the passenger.

TravelDates

Optional. Used to specify the travel dates (see below for further details).

Travel Dates Parameters

A Travel Date element can contain the following parameters: -

Parameter

Description

FromDate

FromDate – the start date of the travel date range.

ToDate

ToDate – the end date of the travel date range.

Example XML Search Recommended Item response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="REF_123456-1147434504577">
   <ResponseDetails Language="en">
       <SearchRecommendedItemResponse>
          <RecommendedItemDetails>   
             <City Code="LON"><![CDATA[London]]></City>
             <Item Code="ABB"><![CDATA[Abbey Court]]></Item>
             <Nationality>**</Nationality>
             <TravelDates>
                <FromDate>2007-03-20</FromDate>
                <ToDate>2007-03-28</ToDate>
             </TravelDates>
          </RecommendedItemDetails>
       </SearchRecommendedItemResponse>
    </ResponseDetails>
</Response>

Search Recommended Item response parameters

A Search Recommended Hotel Item response will return the following for each item found for the request parameters: -

Parameter

Description

RecommendedItemDetails

A list of one or several recommended item details

Recommended Item Details parameters

A recommended item detail element can contain the following parameters: -

Parameter

Description

City

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

 

Attribute

Description

 

Code

The unique city code held by GTA.

 

Parameter

Description

Item

The item name.

 

Attribute

Description

 

Code

The item code held by GTA.

 

Parameter

Description

 

Nationality

The code for the passenger nationality the recommended item is valid for. Will default to ‘**’ if it is valid for all passenger nationalities.

 

TravelDates

Specifies the travel dates applicable to the recommended item (see below for further details).

Travel Dates Parameters

A Travel Date element can contain the following parameters: -

Parameter

Description

FromDate

FromDate – the start date of the travel date range.

ToDate

ToDate – the end date of the travel date range.

Docs Navigation