StreetsByLocalityKey - AddressCapture � Data8 Web Services API Documentation

StreetsByLocalityKey

Finds a list of streets within a town or village that match the requested street name.

Description

Finds a list of streets within a town or village that match the requested street name.

The localityKey indicates the area to search within. This can be obtained from the results of the LocalitiesByName or LocalitiesByPostcode methods.

The street name is assumed to have a wildcard at the end, e.g. "High" will match "High Street".

If null is supplied as the street parameter, all streets in the locality will be returned.

Note that, where a town contains multiple villages, you must supply the localityKey for the correct village in order to find the expected street. If you supply the localityKey that represents only the town without a village, only streets that are found in the town itself (i.e. not in a village within the town) will be included in the results.

If you only know the town name and not whether the street is within a village in that town, you may prefer to use the StreetsByName method, which does not have this limitation.

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/AddressCapture/StreetsByLocalityKey.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/AddressCapture/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/addresscapture.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 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
street	street The name of the street to find within the locality
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.

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.
Results	Results Contains an array of streets that match the query. Each street is returned with a `Description`, which contains a partial, human-readable version of the address, and an `ID` which can be supplied to the `AddressesByStreetKey` method to get the list of addresses on the street

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

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

Credit Usage

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

Sample Code

Request Format

{
  "licence": "WebClickFull",
  "localityKey": "L160862520",
  "street": "High Street",
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Results": [
    {
      "ID": "T159947603",
      "Description": "High Street, Farndon, CHESTER, CH3 "
    },
    {
      "ID": "T160682756",
      "Description": "High Street, Saltney, CHESTER, CH4 "
    },
    {
      "ID": "T160184093",
      "Description": "High Street, Tarvin, CHESTER, CH3 "
    },
    {
      "ID": "T160251142",
      "Description": "High Street, Tattenhall, CHESTER, CH3 "
    }
  ]
}

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

Parameter	Value
Parameters
licence	licence WebServerFullWebClickFullWebClickThoroughfareInternalUserFullInternalUserThoroughfareSmallUserFullSmallUserThoroughfareLookupInternalServerFullInternalServerThoroughfareFreeTrialFreeTrialThoroughfareInternalUserFullAreaInternalUserThoroughfareAreaWebServerThoroughfare
localityKey	localityKey
street	street
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 25 Try It Now!