Search Station

The Search Station provides the client with static data relating to stations. The API will provide stations held within the GTA system.

Example XML Search Station request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Station 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>
		<SearchStationRequest>
			<ItemDestination DestinationType="city" DestinationCode="LON" />
		  <StationName><![CDATA[liv]]></StationName>
		</SearchStationRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Station parameters

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

Parameters

Description

ItemDestination

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

StationName

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

Note: Station names are not case sensitive.

StationCode

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

Example XML Search Station response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchStationResponse>
			<StationDetails>
			<StationDetail>
			<City Code="LON"><![CDATA[London]]></City>
		 	<Station Code="LIVE01"><![CDATA[Liverpool Street]]></Station>
			</StationDetail>
			</StationDetails>
		</SearchStationResponse>
	</ResponseDetails>
</Response>

Search Station response parameters

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

 

Station

The station name.

 

Attribute

Description

 

Code

The unique item code held by GTA

 

 

 

Docs Navigation