Search - PredictiveAddress • Data8 Web Services API Documentation

Search

Search for a partial address in our many data sources.

Description

Begin an address search by passing the entered partial address to our service. The response will contain any matches found for the information within our many data sources.

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/Search.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.
country	country The ISO-2 country code in which the address belongs.
search	search The partial address entered by the user.
telephoneNumber	telephoneNumber An optional parameter, the telephone number associated with the address can be supplied.
session	session The session id that was received in the previous response. This improves efficiency and lookup speeds. This should be included in any subsequent calls to the Search endpoint.
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.
Dataset Options
Note: Each additional dataset requires additional licensing. If you attempt to use a dataset which your account is not licensed for an error will be returned. Please speak to your account manager to enable additional datasets.
IncludeMR	IncludeMR Includes addresses from the UK Multiple Residency database, e.g. multiple flats behind a single letter box, university halls of residence
IncludeNYB	IncludeNYB Includes addresses from the UK Not Yet Built database, e.g. houses currently being developed
Service Specific Options
PreferredLanguage	PreferredLanguage Set this to the ISO 639-1 code of the language to retrieve the address in where possible. For example, specify `cy` to retrieve addresses in Welsh, or `en` to prefer English. Not all languages are available for all addresses.

Results

This method returns an object containing the following fields:

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 possible matches. Each one has the following properties: `label` - the value to show to the user. `value` - a unique identifier for the match that can be supplied to the `DrillDown` or `Retrieve` endpoints. `container` - indicates if this match is a container for other addresses (e.g. a town, street etc.). If this is `true`, the `value` should be supplied to the `DrillDown` endpoint to get the details of the addresses in the container record. If it is `false`, the `value` should be supplied to the `Retrieve` endpoint to get the full details of the address.
Count	Count The number of matches found based on the information provided.
SessionID	SessionID A `SessionID` is also included in the response. This should be included in any subsequent calls to the `Search` endpoint.

Credit Usage

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

Sample Code

Request Format

{
  "country": "GB",
  "search": "Stanney Mill",
  "telephoneNumber": "",
  "session": "",
  "options": {
    "PreferredLanguage": null
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Results": null,
  "Count": null,
  "SessionID": "en"
}

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