Search Country

The Search Country provides the client with static data relating to countries held within the GTA system. The API will provide a country name along with the unique code used by GTA to identify the country.

Example XML Search Country request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Country 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>
		<SearchCountryRequest>
			<CountryName><![CDATA[GREE]]></CountryName>
		</SearchCountryRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Country attributes/parameters

A Search Country request can contain optional attributes/parameters to filter the countries returned.  However, if none are specified a request for all countries will be executed.

The request can contain the following optional attributes/parameters: -

Attribute

Description

ISO

 

Used to determine if ISO Codes will be processed.

If “true” or not specified, CountryCode attribute below and the Code returned in the response parameters must be ISO 3166 format, 2 letters.

If “false” the GTA coding will be used.

 

Parameter

Description

CountryName

If specified all countries containing the given characters will be returned.

Note: Country Names are not case sensitive.

CountryCode

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

Example XML Search Country response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200003">
	<ResponseDetails Language="en">
		<SearchCountryResponse>
	    <CountryDetails>
	      <Country Code="GR"><![CDATA[Greece]]></Country>
	      <Country Code="GZ"><![CDATA[Greenland]]></Country>
	    </CountryDetails>
		</SearchCountryResponse>
	</ResponseDetails>
</Response>

Search Country response parameters

A Search Country response will return the following for each country found for the request parameters: -

Parameter

Description

Country

The country name.

In the language requested (if available).

 

Attribute

Description

 

Code

Either the country ISO Code or unique code held by GTA

Docs Navigation