Geocode
Obtains the approximate location of a UK landline telephone number
To connect to this service you'll need to use one of these endpoints:
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.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
number | number The telephone number to geocode |
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 |
Results
This method returns an object containing the following fields:
Status |
Status 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:
|
Confidence | Confidence Indicates the confidence level in the results |