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"?>
<RequestorID Client="123456" EMailAddress="" Password="clientPassword" />
    <RequestorPreferences Language="en">

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: -





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.





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

Note: Country Names are not case sensitive.


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">
	      <Country Code="GR"><![CDATA[Greece]]></Country>
	      <Country Code="GZ"><![CDATA[Greenland]]></Country>

Search Country response parameters

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




The country name.

In the language requested (if available).






Either the country ISO Code or unique code held by GTA

Docs Navigation