Retrieve

Retreive the full address

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

WSDL

https://webservices.data-8.co.uk/PredictiveAddress.asmx

JSON

https://webservices.data-8.co.uk/PredictiveAddress/Retrieve.json

Description

Retrieve the full details of an address returned from a previous call to either the Search or DrillDown endpoints where the container property was set to false.

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 country code in which the address belongs.
id	id The `value` property from the response of previous requests from either the Search or DrillDown methods, when the `container` property was false, 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
FixBuilding	FixBuilding Ensures the building name/number is always placed in the first line
FixPostcode	FixPostcode `true` to ensure the postcode is placed in the last line of the formatted address, or `false` to place it according to the country-specific formatting rules. If you use the `fields` option this is worked out automatically.
FixTownCounty	FixTownCounty `true` to ensure the last two lines of the formatted address are used to hold the town and county, or `false` otherwise. If you use the `fields` option this is worked out automatically.
Formatter	Formatter This option can be set to the name of a pre-defined formatting type that controls how the address is formatted. The following values are allowed: `DefaultFormatter` - This is the standard formatting type as described above. `NoOrganisationFormatter` - This works in the same way as the `DefaultFormatter`, but omits any organisation or departmental information from the address. `PAFStandardFormatter` - This produces an address in the standard format recommended by the Royal Mail for printing addresses on envelopes. It produces formatted addresses containing however many lines are necessary to hold the information stored in each particular address, and does not use any county information.
IncludeAdminArea	IncludeAdminArea For UK addresses, indicates that additional administrative area details should be included in the returned `RawAddress.Location` fields. Specifically, the following fields will be included when this option is set to `true`: `County` `CountyCode` `District` `DistrictCode` `Ward` `WardCode` `Country` Note that not all these fields are available for all addresses. When this option is set, the `Country` field will be set to the name of the nation within the UK that the address is in, i.e. "England", "Scotland", "Wales" or "Northern Ireland". This overrides the `IncludeCountry` option that would otherwise set it to "United Kingdom"
IncludeCountry	IncludeCountry Set to `true` to include ISO2 and full country name in the response
IncludeLocation	IncludeLocation Retrieve geocode information about the address such as `Latitude` and `Longitude` as well as `Easting`, `Northing`, `GridReference` and much more.
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).
IncludeUDPRN	IncludeUDPRN set to `true` to include the UDPRN for any UK addresses. The UDPRN value is stored in the `UniqueReference` property of the response.
IncludeUPRN	IncludeUPRN set to `true` to include the UPRN for UK addresses. This is not available by default - speak to your account manager to enable this option. Cannot be used in conjunction with `IncludeUDPRN` - only one of these options can be specified. The UPRN value is stored in the `UniqueReference` property of the response.
MaxLineLength	MaxLineLength The maximum number of characters per line in the formatted address. Defaults to 255.
MaxLines	MaxLines The number of lines to format the address over. If you use the `fields` option this is worked out automatically, but must be defined explicitly if you use the `selectAddress` option instead.
PreferredLanguage	PreferredLanguage Set this to `cy` to retrieve addresses in Welsh where available, or `en` to prefer English. Addresses are returned in English when this option is not specified.
UnwantedPunctuation	UnwantedPunctuation a string containing any characters that should be excluded from the formatted address.

Results

This method returns an object containing the following fields:

Status

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
Result	Result An object containing full details of a complete address. A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.

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

Result

Result

An object containing full details of a complete address. A formatted version of each address in the array is available in the Address field, and a structured version of the address is available in the RawAddress field.

Live Demo

country

id

options

Name	Value
Common Options
ApplicationName
Service-Specific Options
FixBuilding
FixPostcode
FixTownCounty
Formatter
IncludeAdminArea
IncludeCountry
IncludeLocation
IncludeMR
IncludeNYB
IncludeUDPRN
IncludeUPRN
MaxLineLength
MaxLines
PreferredLanguage
UnwantedPunctuation

Sample Code

// NOTE: A Service Reference to the web service must be added to use this sample code.
private void Retrieve(string country, string id)
{
    // Declare the required options.
    Option FixBuilding = new Option();
    FixBuilding.Name = "FixBuilding";
    FixBuilding.Value = "false";
    Option FixPostcode = new Option();
    FixPostcode.Name = "FixPostcode";
    FixPostcode.Value = "false";
    Option FixTownCounty = new Option();
    FixTownCounty.Name = "FixTownCounty";
    FixTownCounty.Value = "false";
    Option Formatter = new Option();
    Formatter.Name = "Formatter";
    Formatter.Value = "DefaultFormatter";
    Option IncludeAdminArea = new Option();
    IncludeAdminArea.Name = "IncludeAdminArea";
    IncludeAdminArea.Value = "false";
    Option IncludeCountry = new Option();
    IncludeCountry.Name = "IncludeCountry";
    IncludeCountry.Value = "false";
    Option IncludeLocation = new Option();
    IncludeLocation.Name = "IncludeLocation";
    IncludeLocation.Value = "true";
    Option IncludeMR = new Option();
    IncludeMR.Name = "IncludeMR";
    IncludeMR.Value = "false";
    Option IncludeNYB = new Option();
    IncludeNYB.Name = "IncludeNYB";
    IncludeNYB.Value = "false";
    Option IncludeUDPRN = new Option();
    IncludeUDPRN.Name = "IncludeUDPRN";
    IncludeUDPRN.Value = "false";
    Option IncludeUPRN = new Option();
    IncludeUPRN.Name = "IncludeUPRN";
    IncludeUPRN.Value = "false";
    Option MaxLineLength = new Option();
    MaxLineLength.Name = "MaxLineLength";
    MaxLineLength.Value = "255";
    Option MaxLines = new Option();
    MaxLines.Name = "MaxLines";
    MaxLines.Value = "6";
    Option PreferredLanguage = new Option();
    PreferredLanguage.Name = "PreferredLanguage";
    PreferredLanguage.Value = "en";
    Option UnwantedPunctuation = new Option();
    UnwantedPunctuation.Name = "UnwantedPunctuation";
    UnwantedPunctuation.Value = "";
    // Invoke the web service method.
    PredictiveAddressSoapClient proxy = new PredictiveAddressSoapClient();
    PredictiveAddressRetrieveResponse results = proxy.Retrieve("your-username", "your-password", country, id, new Option[] {
                FixBuilding,
                FixPostcode,
                FixTownCounty,
                Formatter,
                IncludeAdminArea,
                IncludeCountry,
                IncludeLocation,
                IncludeMR,
                IncludeNYB,
                IncludeUDPRN,
                IncludeUPRN,
                MaxLineLength,
                MaxLines,
                PreferredLanguage,
                UnwantedPunctuation});
    // 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.Result
        //   The full details of the requested address
    }
}

'NOTE: A Service Reference to the web service must be added to use this sample code.
Private Sub Retrieve(ByVal country As String, ByVal id As String)
    'Declare the required options.
    Dim FixBuilding As [Option] = New [Option]()
    FixBuilding.Name = "FixBuilding"
    FixBuilding.Value = "false"
    Dim FixPostcode As [Option] = New [Option]()
    FixPostcode.Name = "FixPostcode"
    FixPostcode.Value = "false"
    Dim FixTownCounty As [Option] = New [Option]()
    FixTownCounty.Name = "FixTownCounty"
    FixTownCounty.Value = "false"
    Dim Formatter As [Option] = New [Option]()
    Formatter.Name = "Formatter"
    Formatter.Value = "DefaultFormatter"
    Dim IncludeAdminArea As [Option] = New [Option]()
    IncludeAdminArea.Name = "IncludeAdminArea"
    IncludeAdminArea.Value = "false"
    Dim IncludeCountry As [Option] = New [Option]()
    IncludeCountry.Name = "IncludeCountry"
    IncludeCountry.Value = "false"
    Dim IncludeLocation As [Option] = New [Option]()
    IncludeLocation.Name = "IncludeLocation"
    IncludeLocation.Value = "true"
    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 IncludeUDPRN As [Option] = New [Option]()
    IncludeUDPRN.Name = "IncludeUDPRN"
    IncludeUDPRN.Value = "false"
    Dim IncludeUPRN As [Option] = New [Option]()
    IncludeUPRN.Name = "IncludeUPRN"
    IncludeUPRN.Value = "false"
    Dim MaxLineLength As [Option] = New [Option]()
    MaxLineLength.Name = "MaxLineLength"
    MaxLineLength.Value = "255"
    Dim MaxLines As [Option] = New [Option]()
    MaxLines.Name = "MaxLines"
    MaxLines.Value = "6"
    Dim PreferredLanguage As [Option] = New [Option]()
    PreferredLanguage.Name = "PreferredLanguage"
    PreferredLanguage.Value = "en"
    Dim UnwantedPunctuation As [Option] = New [Option]()
    UnwantedPunctuation.Name = "UnwantedPunctuation"
    UnwantedPunctuation.Value = ""
    'Invoke the web service method.
    Dim proxy As PredictiveAddressSoapClient = New PredictiveAddressSoapClient()
    Dim results As PredictiveAddressRetrieveResponse = proxy.Retrieve("your-username", "your-password", country, id, New [Option]() {FixBuilding, FixPostcode, FixTownCounty, Formatter, IncludeAdminArea, IncludeCountry, IncludeLocation, IncludeMR, IncludeNYB, IncludeUDPRN, IncludeUPRN, MaxLineLength, MaxLines, PreferredLanguage, UnwantedPunctuation})
    '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.Result
        '  The full details of the requested address
    End If
End Sub

// NOTE: The php_soap.dll extension must be enabled in the php.ini file.
function Retrieve($country, $id)
{
  $options = array(
    "Option" => array(
      array(
        "Name" => "FixBuilding",
        "Value" => "false"
      ),
      array(
        "Name" => "FixPostcode",
        "Value" => "false"
      ),
      array(
        "Name" => "FixTownCounty",
        "Value" => "false"
      ),
      array(
        "Name" => "Formatter",
        "Value" => "DefaultFormatter"
      ),
      array(
        "Name" => "IncludeAdminArea",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeCountry",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeLocation",
        "Value" => "true"
      ),
      array(
        "Name" => "IncludeMR",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeNYB",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeUDPRN",
        "Value" => "false"
      ),
      array(
        "Name" => "IncludeUPRN",
        "Value" => "false"
      ),
      array(
        "Name" => "MaxLineLength",
        "Value" => "255"
      ),
      array(
        "Name" => "MaxLines",
        "Value" => "6"
      ),
      array(
        "Name" => "PreferredLanguage",
        "Value" => "en"
      ),
      array(
        "Name" => "UnwantedPunctuation",
        "Value" => ""
      )
    )
  );
  $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->Retrieve($params);
  if ($result->RetrieveResult->Status->Success == 0)
  {
    echo "Error: " . $result->RetrieveResult->Status->ErrorMessage;
  }
  else
  {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // $result->RetrieveResult->Result
    //   The full details of the requested address
  }
}

Request Format

{
  "country": "GB",
  "id": "PChT7czv4i9nVSZqB4VpYBjQ",
  "options": {
    "FixBuilding": false,
    "FixPostcode": false,
    "FixTownCounty": false,
    "Formatter": "DefaultFormatter",
    "IncludeAdminArea": false,
    "IncludeCountry": false,
    "IncludeLocation": true,
    "IncludeMR": false,
    "IncludeNYB": false,
    "IncludeUDPRN": false,
    "IncludeUPRN": false,
    "MaxLineLength": 255,
    "MaxLines": 6,
    "PreferredLanguage": "en",
    "UnwantedPunctuation": ""
  }
}

Results Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": null
}

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

Start a Free 14 Day Trial Today

Register below to start a free trial of our services

Let's get started