DrillDown

Drill down further into search results

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

Changing the hosting country does not affect the data returned by the service. However you may wish to select a particular country based on your data residency requirements or network latency.

JSON

Open API

SOAP

Description

The drill down method should be used to further narrow down container level results such as towns or streets etc.

Credit Usage

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

Parameters

The following parameters can be supplied to this method

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-character country code of the search i.e. "GB"
id	id The `value` property from the response of previous requests from either the Search or DrillDown methods should be supplied here.
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.

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
Service-Specific Options
Name	Description
IncludeMR	IncludeMR Includes addresses from the Multiple Residency database in the results (requires additional licensing).
IncludeNYB	IncludeNYB Includes addresses from the Not Yet Built database in the results (requires additional licensing).
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:

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.

Live Demo

country

id

options

Name	Value
Common Options
ApplicationName
Service-Specific Options
IncludeMR
IncludeNYB
PreferredLanguage

Sample Code

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- https://www.data-8.co.uk/ValidationAdmin/AjaxAPIKey -->
<script type="text/javascript" src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key&load=PredictiveAddress">
</script>

<script type="text/javascript">

function DrillDown(country, id) {
  /// <param name="country">string</param>
  /// <param name="id">string</param>
  var predictiveaddress = new data8.predictiveaddress();
  
  predictiveaddress.drilldown(
    country,
    id,
    [
      new data8.option('IncludeMR', 'false'),
      new data8.option('IncludeNYB', 'false'),
      new data8.option('PreferredLanguage', 'en')
    ],
    showDrillDownResult
  );
}

function showDrillDownResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  }
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.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.
    // result.Count
    //   The number of matches found based on the information provided.
    // result.SessionID
    //   A SessionID is also included in the response. This should be included in any subsequent calls to the `Search` endpoint.
  }
}

</script>

// NOTE: A Service Reference to the web service must be added to use this sample code.
private void DrillDown(string country, string id)
{
    // Declare the required options.
    Option IncludeMR = new Option();
    IncludeMR.Name = "IncludeMR";
    IncludeMR.Value = "false";
    Option IncludeNYB = new Option();
    IncludeNYB.Name = "IncludeNYB";
    IncludeNYB.Value = "false";
    Option PreferredLanguage = new Option();
    PreferredLanguage.Name = "PreferredLanguage";
    PreferredLanguage.Value = "en";
    // Invoke the web service method.
    PredictiveAddressSoapClient proxy = new PredictiveAddressSoapClient();
    PredictiveAddressSearchResponse results = proxy.DrillDown("your-username", "your-password", country, id, new Option[] {
                IncludeMR,
                IncludeNYB,
                PreferredLanguage});
    // Check that the call succeeded, and show the error message if there was a problem.
    if ((results.Status.Success == false))
    {
        MessageBox.Show(("Error: " + results.Status.ErrorMessage));
    }
    else
    {
        // TODO: Process method results here.
        // Results can be extracted from the following fields:
        // result.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.
        // result.Count
        //   The number of matches found based on the information provided.
        // result.SessionID
        //   A SessionID is also included in the response. This should be included in any subsequent calls to the `Search` endpoint.
    }
}

'NOTE: A Service Reference to the web service must be added to use this sample code.
Private Sub DrillDown(ByVal country As String, ByVal id As String)
    'Declare the required options.
    Dim IncludeMR As [Option] = New [Option]()
    IncludeMR.Name = "IncludeMR"
    IncludeMR.Value = "false"
    Dim IncludeNYB As [Option] = New [Option]()
    IncludeNYB.Name = "IncludeNYB"
    IncludeNYB.Value = "false"
    Dim PreferredLanguage As [Option] = New [Option]()
    PreferredLanguage.Name = "PreferredLanguage"
    PreferredLanguage.Value = "en"
    'Invoke the web service method.
    Dim proxy As PredictiveAddressSoapClient = New PredictiveAddressSoapClient()
    Dim results As PredictiveAddressSearchResponse = proxy.DrillDown("your-username", "your-password", country, id, New [Option]() {IncludeMR, IncludeNYB, PreferredLanguage})
    'Check that the call succeeded, and show the error message if there was a problem.
    If (results.Status.Success = false) Then
        MessageBox.Show(("Error: " + results.Status.ErrorMessage))
    Else
        'TODO: Process method results here.
        'Results can be extracted from the following fields:
        'result.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.
        'result.Count
        '  The number of matches found based on the information provided.
        'result.SessionID
        '  A SessionID is also included in the response. This should be included in any subsequent calls to the `Search` endpoint.
    End If
End Sub

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function DrillDown($country, $id)
{
  $options = array(
    "Option" => array(
      array(
        "Name" => "IncludeMR",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeNYB",
        "Value" => "false"
      ),
      array(
        "Name" => "PreferredLanguage",
        "Value" => "en"
      )
    )
  );
  $params = array(
    "username" => "your-username",
    "password" => "your-password",
    "country" => $country,
    "id" => $id,
    "options" => $options
  );
  $client = new SoapClient("https://webservices.data-8.co.uk/PredictiveAddress.asmx?WSDL");
  $result = $client->DrillDown($params);
  if ($result->DrillDownResult->Status->Success == 0)
  {
    echo "Error: " . $result->DrillDownResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->DrillDownResult->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.
    //   NOTE: This field contains an array of items, but if it contains only one item,
    //   PHP may not recognise it as an array. To always extract the result of this
    //   field as an array, we recommend you always access it using the
    //   getArrayFromResponse method described at
    //   http://www.php.net/soap_soapclient_soapcall#75797, e.g.
    //   foreach (getArrayFromResponse($result->DrillDownResult->Results) as $item)
    //   {
    //     ...
    //   }
    // $result->DrillDownResult->Count
    //   The number of matches found based on the information provided.
    // $result->DrillDownResult->SessionID
    //   A SessionID is also included in the response. This should be included in any subsequent calls to the `Search` endpoint.
  }
}

Request Format

{
  "country": "GB",
  "id": "T159883986",
  "options": {
    "IncludeMR": false,
    "IncludeNYB": false,
    "PreferredLanguage": "en"
  }
}

Results Format

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

Depending on your chosen authentication method you will need to modify this request slightly: