AutoCompleteTowns - Geocoding • Data8 Web Services API Documentation

AutoCompleteTowns

Gets the full name of a town based off a partial name.

Description

Returns a list of all matching towns based on the entered partial name.

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/Location/AutoCompleteTowns.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/Location/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/location.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.
licence	licence The licence type under which you are accessing the service. If you are not sure which value to pick, please contact your account manager
townName	townName The partial name of the town to lookup
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
SearchAllLocalities	SearchAllLocalities Indicates if all suburbs, villages and other smaller areas should be included in the results (`true`), or only the top-level towns (`false`)
FuzzyMatch	FuzzyMatch Indicates if fuzzy matching will be used (`true`) or if the search text has to match the town name exactly (`false`)
MaxResults	MaxResults The maximum number of suggestions to include in the results. Must be a number between 1 and 100.

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.
Towns	Towns A list of matching UK town names

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.

Towns

A list of matching UK town names

Credit Usage

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

Sample Code

Request Format

{
  "licence": "WebClick",
  "townName": "Ch",
  "options": {
    "SearchAllLocalities": true,
    "FuzzyMatch": true,
    "MaxResults": 10
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Towns": [
    "CHALFONT ST. GILES",
    "CHARD",
    "CHARLEMONT",
    "CHARLESTON",
    "CHARLESTOWN",
    "CHARLESWORTH",
    "CHATHAM",
    "CHATHILL",
    "CHATTERIS",
    "CHEAPSIDE",
    "CHEDDAR",
    "CHELMSFORD",
    "CHELTENHAM",
    "CHEPSTOW",
    "CHERITON",
    "CHERTSEY",
    "CHESHAM",
    "CHESSINGTON",
    "CHESTER",
    "CHESTER LE STREET",
    "CHESTERFIELD",
    "CHICHESTER",
    "CHIGWELL",
    "CHILLATON",
    "CHILTON INDUSTRIAL ESTATE",
    "CHIPPING CAMPDEN",
    "CHIPPING NORTON",
    "CHISLEHURST",
    "CHISWORTH",
    "CHOPPINGTON",
    "CHULMLEIGH",
    "CHURCH LEIGH",
    "CHURCH STRETTON",
    "CHURCHBRIDGE",
    "CHURCHTOWN"
  ]
}

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/Location/AutoCompleteTowns.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
licence	licence WebServerWebClickInternalUserSmallUserLookupInternalServer
townName	townName
Common Options
ApplicationName	ApplicationName
Service-Specific Options
SearchAllLocalities	SearchAllLocalities
FuzzyMatch	FuzzyMatch
MaxResults	MaxResults
Credits Remaining Today: 5 Try It Now!