Search Cities in Area

The Search Cities in Area provides the client with static data relating to cities within an area held within the GTA system. The API will provide a list of cities and their corresponding names for the area code provided.

Example XML Search Cities in Area request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Cities in Area 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>
		<SearchCitiesInAreaRequest AreaCode="AMS">
			<CityName><![CDATA[DAM]]></CityName>
		</SearchCitiesInAreaRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search City attributes

A Search Cities in Area request can contain optional attributes/parameters to filter the city list returned.  The following lists the attributes/parameters that can be specified: -

Attribute

Description

AreaCode

Mandatory. Used to return all cities within the specified area

 

Parameter

Description

CityName

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

Note: City Names are not case sensitive.

CityCode

Optional. If specified the city details for the single code will be returned.  N.b. city codes always use GTA coding.

 Example XML Search Cities in Area response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200004">
	<ResponseDetails Language="en">
		<SearchCitiesInAreaResponse AreaCode="AMS">
			<CityDetails>
				<City Code="AMS"><![CDATA[Amsterdam]]></City>
				<City Code="RTM"><![CDATA[Rotterdam]]></City>
			</CityDetails>
		</SearchCitiesInAreaResponse>		
	</ResponseDetails>
</Response>

Search Cities in Area response parameters

The following attributes can form part of the <SearchCitiesInAreaResponse> parameter: -

Attribute

Description

AreaCode

As entered in the request.

The response will then return the following for each city found for the request parameters: -

Parameter

Description

City

The city name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique code held by GTA

 

Docs Navigation