Search Transfer List

The Search Transfer List provides the client with static data relating to variety of list types within the GTA system. The API will provide a description and code each list member for the given list type.

Example XML Search Transfer List request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Transfer List 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>
		<SearchTransferListRequest ListType="TransferLocation">
		</SearchTransferListRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Transfer List parameters

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

Attribute

Description

ListType

Mandatory. Used to return all descriptions for the specified list type (e.g. “TransferLocation”).

 

Parameters

Description

Description

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

Note: Names are not case sensitive.

Code

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

 Example XML Search Transfer List response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchTransferListResponse ListType="location">
			<ListDetails>
				<Description Code="A"><![CDATA[Airport]]></Description>
				<Description Code="H"><![CDATA[Accommodation]]></Description>
				<Description Code="P"><![CDATA[Port]]></Description>
				<Description Code="S"><![CDATA[Station]]></Description>
				<Description Code="O"><![CDATA[Other]]></Description>
			</ListDetails>
		</SearchTransferListResponse>
	</ResponseDetails>
</Response>

Search Transfer List response parameters

A Search Transfer List response will return the following for each item found for the request parameters: -

Attribute

Description

ListType

The specified list type.

 

Parameter

Description

Description

The list item name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique code held by GTA

 Other Transfer List types

The Transfer List types allowed through the API are user controlled through Control Function maintenance (using Function Group XML_LSTTYP).  API types are shown below: -

  • Vehicle
  • TransferLocation

Docs Navigation