AddressesByStreetKey - AddressCapture � Data8 Web Services API Documentation

AddressesByStreetKey

Finds details of an address within a street.

Description

Finds details of an address within a street. The street to search within is identified by the streetKey parameter, which should be a street key returned from the StreetsByLocalityKey or StreetsByName 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. If null is supplied for this parameter, all buildings on the street will be returned.

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/AddressesByStreetKey.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
streetKey	streetKey The identifier of a street as returned from the `StreetsByLocalityKey` or `StreetsByName` methods
building	building The name of the building or organisation to find within the street
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 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

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

Credit Usage

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

Sample Code

Request Format

{
  "licence": "WebClickFull",
  "streetKey": "T160051488",
  "building": "4",
  "options": {}
}

Response Format

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

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/AddressesByStreetKey.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
streetKey	streetKey
building	building
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 25 Try It Now!