The application programmer interface (API) provides a web method to lookup a label and find any associated URIs for a given URI type. Mandatory parameters are provided in the web method path and optional parameters in the query string.

Mapping type, label, and format are mandatory parameters. Partial matching and organisation are optional parameters.

The data in the URI should be encoded and is not case-sensitive. For example: for Kensington and Chelsea use Kensington%20and%20Chelsea

The format of the URI is /api/mappingtypes/{mappingtype}/labels/{label}/{format}?partial=true&organisation={organisation}

1. Mapping type

The mapping type is the type of URI the label refers to. The Id or the name can be used.

Id Name URI stub
1 Local authority
2 Service
3 Statistical geography
6 Planning classification
13 Licence entertainment type
14 Licence status
15 Licence applicant type
16 CIPFA objective category
17 Neighbourhood area type
18 Neighbourhood area

2. Label

The text you wish to translate to a URI.

3. Format


4. Partial

Set to true to match partial labels, so lamb would match Lambeth. Set to false or omit to only match whole words.

5. Organisation

The label of the organisation you wish to get the mappings for. Omit to use default (all). Set to official to get official mappings only.

Examples - find the service for public toilets