GetSupportedCountriesAdvanced - PredictiveAddress • Data8 Web Services API Documentation

GetSupportedCountriesAdvanced

Get all countries supported by the PredictiveAddress service.

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.

Endpoint URLs

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

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/PredictiveAddress/GetSupportedCountriesAdvanced.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/PredictiveAddress/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/PredictiveAddress.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
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.

Name	Description
Common Options
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
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:

Name Description

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

A list of the supported countries. Each item includes:

Value	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.

CurrentCountry

If the GetCurrentCountry was set to true, this will contain the country details for the country detected by the CountryDetection service.

Credit Usage

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

Sample Code

Request Format

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

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

API Key

Post the request to
https://webservices.data-8.co.uk/PredictiveAddress/GetSupportedCountriesAdvanced.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.