Geocode - TelephoneGeocoding • Data8 Web Services API Documentation

Geocode

Obtains the approximate location of a UK landline telephone number.

Description

Returns a list of possible locations for a UK landline telephone number, sorted with the most likely location first.

Each location in the returned list consists of a postcode sector (everything apart from the last two letters, e.g. CH2 4), the probability that the telephone number lies within this postcode sector as a number from 0 - 100, and a list of postal areas associated with that postcode.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/TelephoneGeocoding/Geocode.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/TelephoneGeocoding/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/telephonegeocoding.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.
number	number The telephone number to geocode
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.

Results

This method returns an object containing the following fields:

Name Description

Status

Name	Description
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.
Results	Results A list of matching locations that could contain the supplied telephone number, and their associated details. Each result in the list contains the following properties: `PostcodeSector` - the postcode sector that may contain the supplied telephone number `Probability` - the percentage probability that this is the correct result `Locations` - a list of the locations that are part of this postcode sector
Confidence	Confidence Indicates the confidence level in the results

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.

Results

A list of matching locations that could contain the supplied telephone number, and their associated details.

Each result in the list contains the following properties:

PostcodeSector - the postcode sector that may contain the supplied telephone number
Probability - the percentage probability that this is the correct result
Locations - a list of the locations that are part of this postcode sector

Confidence

Indicates the confidence level in the results

Credit Usage

Each request to this method consumes 1 TelephoneGeocoding credit.

Sample Code

Request Format

{
  "number": "01513554555",
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Results": null,
  "Confidence": 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/TelephoneGeocoding/Geocode.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
number	number
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!