Skip to the content

AddressesByLocalityKey

Finds details of an address within a locality.

Live Demo

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

WSDL
https://webservices.data-8.co.uk/addresscapture.asmx
JSON
https://webservices.data-8.co.uk/AddressCapture/AddressesByLocalityKey.json

Description

Finds details of an address within a locality. The locality to search within is identified by the localityKey parameter, which should be a locality key returned from the LocalitiesByName or LocalitiesByPostcode methods.

The building to find the address for is specified by the building parameter. This should be set to the name of the building or organisation you wish to find.

Note that this should not be a building number; to find addresses using a building number you should first identify the street the building is on using the StreetsByLocalityKey or StreetsByName methods, then use the AddressesByStreetKey method to find the building address.

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.
licence

licence

As the Royal Mail PAF database can be licensed in multiple ways, this parameter indicates under which license you are accessing the data. This must match the variant you have a license or credits for - if you are unsure which option to choose, please contact your account manager

localityKey

localityKey

The identifier of a locality as returned from the LocalitiesByName or LocalitiesByPostcode methods

building

building

The name of the building or organisation to find within the locality

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

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

Contains an array of addresses that match the query. Each address is returned with a Description, which contains a partial, human-readable version of the address, and an ID which can be supplied to the FetchAddress method to get the full details of the address

Live Demo

licence
localityKey
building
options
Name Value
Common Options

Sample Code

Start a Free 14 Day Trial Today

Register below to start a free trial of our services