GET locality

A lookup call to get all available localities and comparable localities, including their ID and description. The call will allow a single ID to be given in order to limit results to the specific locality.

When accessed via a GET request this API method will return a list of all available localities.

INPUT

As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.

parameter type description
id int (optional) a locality id to restrict results to

OUTPUT - JSON sample

If accessing GET /api/locality?id=28 the following JSON would be returned:


{
    "data": [
        {
            "locality_id": "28",
            "locality_code": "Aintree Rail Station",
            "comparable_locality_id": "4805",
            "comparable_locality_code": "Manchester Airport Rail Station"
        }
    ]
}

A "data" element that contains an array of localities