Search Transfer Price

The Search Transfer Price provides the client with the ability to search for and price available transfer items through the API.

Example XML Search Transfer Price request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Transfer Price 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>
		<SearchTransferPriceRequest>
			<TransferPickUp>
				<PickUpCityCode>LON</PickUpCityCode>
				<PickUpCode>A</PickUpCode>
				<PickUpPointCode>LCY</PickUpPointCode>
			</TransferPickUp>
			<TransferDropOff>
				<DropOffCityCode>EDI</DropOffCityCode>
				<DropOffCode>H</DropOffCode>
			</TransferDropOff>
			<TransferDate>2004-11-11</TransferDate>
			<NumberOfPassengers>2</NumberOfPassengers>
			<PreferredLanguage>E</PreferredLanguage>
           <IncludeChargeConditions/>
		</SearchTransferPriceRequest>
	</RequestDetails>
</Request>

Table 9. Search Transfer price request.

Source parameters

Please refer to the API Architecture document.

Search Transfer Price attributes/parameters

A Search Transfer Price request can contain attributes/parameters to filter the sightseeing items returned.

The request can contain the following attributes/parameters: 

Parameters

Description

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.

TransferPickUp

Mandatory. Defines the pick up details for the transfer.

TransferDropOff

Mandatory. Defines the drop off details for the transfer.

TransferDate

Mandatory. The date of the transfer.

NumberOfPassengers

Mandatory. This will contain the number of passengers for the transfer. Must be in the range 1 to 99 inclusive.

Preferred Language

 

Mandatory. Specifies the preferred GTA language for the transfer.

Alternate Language

 

Optional. Can specify a second GTA language in case the Transfer is not provided in the preferred language.

IncludeChargeConditions

Optional. If specified the charge conditions will be returned.

 

Attribute

Description

 

DateFormatResponse

 

If set to “true”, the charge conditions will be returned in date format; if not specified the charge conditions will be returned in days prior to arrival format.


Transfer Pick Up parameter

The client specifies the pick up details through the <TransferPickUp> parameter. It is made up of the following: 

Parameters

Description

PickUpCityCode

Mandatory. Specifies the pick up city. 

PickUpCode

Mandatory. Specifies the type of pick up required. Valid codes are returned from the SearchTransferListRequest with ListType=”TransferLocation”.

PickUpPointCode

Optional. Used to further specify the type of pick up and can only be used in conjunction with PickUpCode 'A’; i.e.: if the pick up is an airport where more than one exists in the city, the PickUpPointCode can be used to define the pick up airport.


An example of a <TransferPickUp> element, for pick up at the airport (LCY), is shown below:

<TransferPickUp>
    <PickUpCityCode>LON</PickUpCityCode>
    <PickUpCode>A</PickUpCode>
    <PickUpPointCode>LCY</PickUpPointCode>
</TransferPickUp>

Transfer Drop Off parameter

The client specifies the drop off details through the <TransferDropOff> parameter. It is made up of the following:

Parameters

Description

DropOffCityCode

Optional. Must be specified if the DropOffCityCode differs from the PickUpCityCode. 

DropOffCode

Mandatory. Specifies the type of drop off required. Valid codes are returned from the SearchTransferListRequest with ListType=”TransferLocation”.

DropOffPointCode

Optional. Used to further specify the type of drop off and can only be used in conjunction with DropOffCode 'A’; i.e.: if the drop off is an airport where more than one exists in the city, the DropOffPointCode can be used to define the drop off airport. 


An example of a <TransferDropOff> element, for drop off at the accommodation in Edinburgh, is shown below:

<DropOff>
    <DropOffCityCode>EDI</DropOffCityCode>
    <DropOffCode>H</DropOffCode>
</DropOff>

Example XML Search Transfer Price response

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

<?xml version="1.0" encoding="UTF-8" ?>
<Response ResponseReference="1479_1203_TOKEN">
	<ResponseDetails Language="en">
		<SearchTransferPriceResponse>
			<TransferDetails>
				<Transfer HasExtraInfo="true">
					<City Code="LON"><![CDATA[ London ]]> </City>
					<Item Code="0000001186003"><![CDATA[A/H ]]></Item>
	<PickUpDetails>
<PickUp Code="A"><![CDATA[Airport]]></PickUp>
<Airport Code="LCY"><![CDATA[London city airport]]></Airport>
	</PickUpDetails>
	<DropOffDetails>
<DropOff Code="H"><![CDATA[Accommodation]]></PickUp>
<City Code="EDI"><![CDATA[Edinburgh]]></City>
	</DropOffDetails>
<ApproximateTransferTime Time="6.30"><![CDATA[6 hour 30 Minutes ]]></ApproximateTransferTime
<TransferVehicles>
	<TransferVehicle>
<Vehicle Code="SA" MaximumPassengers="2" MaximumLuggage="2" ><![CDATA[Saloon]]></Vehicle>
	<Language Code="E"><![CDATA[English]]></Language>
	<ItemPrice Currency="GBP">46.50</ItemPrice>
<Confirmation Code="OR"><![CDATA[On Request]]></Confirmation>
</TransferVehicle>
<TransferVehicle>
<Vehicle Code="MI" MaximumPassengers="6" MaximumLuggage="6" ><![CDATA[Minibus]]></Vehicle>
				<ItemPrice Currency="GBP">65.50</ItemPrice>
				<Confirmation Code="OR"><![CDATA[On Request]]></Confirmation>
</TransferVehicle>
</TransferVehicles>
<TransferConditions>
<TransferCondition>IMPORTANT: All infants and children must ride in an age and size appropriate child safety seat or booster seat. Customers are responsible for providing their own safety seats.</TransferCondition>
</TransferConditions>
</Transfer>
			</TransferDetails>
		</SearchTransferPriceResponse>
	</ResponseDetails>
</Response>

Table 10. Search transfer price response.

Search Transfer Price response parameters

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

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasIdeas

If set to 'true' there are sightseeing ideas (Links) available for the item that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

 

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasIdeas

If set to 'true' there are sightseeing ideas (Links) available for the item that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

 

Item

The item name.

 

Attribute

Description

 

Code

The unique item code held by GTA

 

PickUpDetails

The pick up details.

DropOffDetails

The drop off details.

OutOfHoursSupplements

Out of hours supplement details. (See below for details).

ApproximateTransferTime

The approximate time for the transfer.

TransferVehicles

A list of <TransferVehicle> elements describing available vehicles, pricing and availability of the transfer item.

TransferConditions              

Contains a TransferCondition parameter.

TransferCondition

Returns important conditions which apply to infants and children seats.


PickUpDetails parameters

Parameters

Description

PickUp

The pick up name in the language requested (if available).

 

Attribute

Description

 

Code

The GTA pick up code.

City,

Area or

Airport

Depending on the type of pick up, a city, area or airport name will be output in the language requested (if available).

 

Attribute

Description

 

Code

The GTA code associated with the name.

 

DropOffDetails parameters

Parameters

Description

DropOff

The drop off name in the language requested (if available).

 

Attribute

Description

 

Code

The GTA drop off code.

 

AllowForCheckInTime

The time that should be allowed for check  in at the drop off point.

City,

Area or

Airport

Depending on the type of drop off, a city, area or airport name will be output in the language requested (if available).

 

Attribute

Description

 

Code

The GTA code associated with the name.

 

OutOfHoursSupplements parameters

Parameters

Description

OutOfHoursSupplement

Out of hours supplement details.

FromTime

ToTime

The time range for which the supplement applies.

Supplement

The supplement percentage.

 

TransferVehicles parameters

Elements

Description

TransferVehicle

List of vehicles available for a particular item.

Vehicle

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

 

Attribute

Description

 

Code

The GTA vehicle code

 

MaximumPassengers

The maximum passengers for the vehicle.

 

MaximumLuggage

The maximum luggage for the vehicle.

ItemPrice

The total price of the transfer item, as per the request.

 

Currency

Currency code in which the item has been priced.

Confirmation

Whether the item is available immediately or on request.

 

Code

Specifies whether the item is available or on request.


Charge Conditions parameters

If the parameter <IncludeChargeConditions/> has been specified in the <SearchTransferPriceRequest> the response will include the charge conditions.

Please refer to the Search Charge Conditions document for the details of these parameters.


Docs Navigation