Streets

Search

When Jadu searches for streets, it will send a GET request to the configured street_lookup.search_path URI. This is expected to respond with a JSON representation listing any streets matching the value given in place of the {term} placeholder.

The search should be case-insensitive as Jadu will not guarantee the case of the argument’s value.

If there are no matching streets, an empty list should be returned.

For a successful request, the JSON response should contain the following:

Each street record within the array must be structured as follows:

Street Record

Fields that are required must be present and not empty or the street record will be ignored. Complete records in the result set will still be processed successfully.

The identifier should be a unique value that represents the street record for the entirety of its lifetime. In most cases this would be the same as the USRN however Jadu recognise that some systems use alternative identifiers so have provided the flexibility to use a different value. The identifier will be used when fetching a single street (see below).

Example request:

GET /address-finder/street/search/merus%20court

Example response:

{
    "streets": [
        {
            "identifier": "2802454",
            "usrn": "2802454",
            "street_name": "MERUS COURT",
            "town": "BRAUNSTONE TOWN",
            "locality": "MERIDIAN BUSINESS PARK"
        },
        {
            ...
        }
    ]
}

Fetch street

When Jadu needs to fetch a single street record, it will send a GET request to the configured street_lookup.fetch_path URI.

This is expected to respond with a body containing a JSON representation of a single street that has the identifier matching the one provided in place of the {identifier} placeholder.

If no matching street is available, an HTTP 404 Not Found response should be returned.

When successful, the returned JSON object should contain the full street record as detailed above.

Example request:

GET /address-finder/street/fetch/2802454

Example response:

{
    "street": {
        "identifier": "2802454",
        "usrn": "2802454",
        "street_name": "MERUS COURT",
        "town": "BRAUNSTONE TOWN",
        "locality": "MERIDIAN BUSINESS PARK"
    }
}