GetSupportedCountriesAdvanced

Get all countries supported by the PredictiveAddress service

This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.

Changing the hosting country does not affect the data returned by the service. However you may wish to select a particular country based on your data residency requirements or network latency.

JSON

Open API

SOAP

Description

Obtain a list of all the countries currently supported by the PredictiveAddress service.

This method could be useful when populating a country selection drop down.

Credit Usage

Requests to this method do not consume credits, but you must have some PredictiveAddress credits available.

Parameters

The following parameters can be supplied to this method

username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
options	options An array of options that control further details of how this method operates. See the Advanced Options section below for more information.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name	Description
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard
Service-Specific Options
Name	Description
GetCurrentCountry	GetCurrentCountry Use the CountryDetection service to find the current country of the user by IP address.

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored

Countries

Countries

A list of the supported countries. Each item includes:

Name	Description
`DataLevel`	The level of address data available for the country. Available levels: `None`, `Town`, `Street`, `Address` (highest level of coverage).
`ISO2`	The ISO2 code of the country i.e. "US" for the United States or "GB" for the United Kingdom.
`Name`	The full name of the country.
`SupportsGeocoding`	Indicates if searching by physical location is supported in this country.

Live Demo

options

Name	Value
Common Options
ApplicationName
Service-Specific Options
GetCurrentCountry

Sample Code

// NOTE: A Service Reference to the web service must be added to use this sample code.
private void GetSupportedCountriesAdvanced()
{
    // Declare the required options.
    Option GetCurrentCountry = new Option();
    GetCurrentCountry.Name = "GetCurrentCountry";
    GetCurrentCountry.Value = "true";
    // Invoke the web service method.
    PredictiveAddressSoapClient proxy = new PredictiveAddressSoapClient();
    PredictiveAddressCountryResponse results = proxy.GetSupportedCountriesAdvanced("your-username", "your-password", new Option[] {
                GetCurrentCountry});
    // Check that the call succeeded, and show the error message if there was a problem.
    if ((results.Status.Success == false))
    {
        MessageBox.Show(("Error: " + results.Status.ErrorMessage));
    }
    else
    {
        // TODO: Process method results here.
        // Results can be extracted from the following fields:
        // result.Countries
        //   A list of the supported countries. Each item includes:
        //   
        //   <table class="table table-striped">
        //   <tr>
        //   <th>Name</th>
        //   <th>Description</th>
        //   </tr>
        //   <tr>
        //   <td><code>DataLevel</code></td>
        //   <td>The level of address data available for the country. Available levels: `None`, `Town`, `Street`, `Address` (highest level of coverage).</td>
        //   </tr>
        //   <tr>
        //   <td><code>ISO2</code></td>
        //   <td>The ISO2 code of the country i.e. "US" for the United States or "GB" for the United Kingdom.</td>
        //   </tr>
        //   <tr>
        //   <td><code>Name</code></td>
        //   <td>The full name of the country.</td>
        //   </tr>
        //   <tr>
        //   <td><code>SupportsGeocoding</code></td>
        //   <td>Indicates if searching by physical location is supported in this country.</td>
        //   </tr>
        //   </table>
        // result.CurrentCountry
        // result.AdditionalDatasets
    }
}

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function GetSupportedCountriesAdvanced()
{
  $options = array(
    "Option" => array(
      array(
        "Name" => "GetCurrentCountry",
        "Value" => "true"
      )
    )
  );
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "options" => $options
  );
  $client = new SoapClient("https://webservices.data-8.co.uk/PredictiveAddress.asmx?WSDL");
  $result = $client->GetSupportedCountriesAdvanced($params);
  if ($result->GetSupportedCountriesAdvancedResult->Status->Success == 0)
  {
    echo "Error: " . $result->GetSupportedCountriesAdvancedResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->GetSupportedCountriesAdvancedResult->Countries
    //   A list of the supported countries. Each item includes:
    //   
    //   <table class="table table-striped">
    //   <tr>
    //   <th>Name</th>
    //   <th>Description</th>
    //   </tr>
    //   <tr>
    //   <td><code>DataLevel</code></td>
    //   <td>The level of address data available for the country. Available levels: `None`, `Town`, `Street`, `Address` (highest level of coverage).</td>
    //   </tr>
    //   <tr>
    //   <td><code>ISO2</code></td>
    //   <td>The ISO2 code of the country i.e. "US" for the United States or "GB" for the United Kingdom.</td>
    //   </tr>
    //   <tr>
    //   <td><code>Name</code></td>
    //   <td>The full name of the country.</td>
    //   </tr>
    //   <tr>
    //   <td><code>SupportsGeocoding</code></td>
    //   <td>Indicates if searching by physical location is supported in this country.</td>
    //   </tr>
    //   </table>
    //   NOTE: This field contains an array of items, but if it contains only one item,
    //   PHP may not recognise it as an array. To always extract the result of this
    //   field as an array, we recommend you always access it using the
    //   getArrayFromResponse method described at
    //   http://www.php.net/soap_soapclient_soapcall#75797, e.g.
    //   foreach (getArrayFromResponse($result->GetSupportedCountriesAdvancedResult->Countries) as $item)
    //   {
    //     ...
    //   }
    // $result->GetSupportedCountriesAdvancedResult->CurrentCountry
    // $result->GetSupportedCountriesAdvancedResult->AdditionalDatasets
    //   NOTE: This field contains an array of items, but if it contains only one item,
    //   PHP may not recognise it as an array. To always extract the result of this
    //   field as an array, we recommend you always access it using the
    //   getArrayFromResponse method described at
    //   http://www.php.net/soap_soapclient_soapcall#75797, e.g.
    //   foreach (getArrayFromResponse($result->GetSupportedCountriesAdvancedResult->AdditionalDatasets) as $item)
    //   {
    //     ...
    //   }
  }
}

Request Format

{
  "options": {
    "GetCurrentCountry": true
  }
}

Results Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Countries": null,
  "CurrentCountry": null,
  "AdditionalDatasets": null
}

Depending on your chosen authentication method you will need to modify this request slightly: