UPRN address matching API: Difference between revisions
Jump to navigation
Jump to search
DavidStables (talk | contribs) (Created page with "The address matching public facing REST API is part of the UPRN address matching service and supports 5 main use cases: # Ascertaining the...") |
DavidStables (talk | contribs) No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
The address matching public facing REST API is part of the | The address matching public facing REST API is part of the UPRN address matching service and supports 5 main use cases: | ||
# Ascertaining the post code of an address | # Ascertaining the post code of an address | ||
| Line 29: | Line 29: | ||
"Building": "equivalent", | "Building": "equivalent", | ||
"Flat": "equivalent"}} | "Flat": "equivalent"}} | ||
</syntaxhighlight> | </syntaxhighlight>The nature of the responses are described in detail in the section on [[UPRN address match application#Match responses|application functionality]]. The API returns the same information as the application UI. | ||
Latest revision as of 08:31, 11 August 2020
The address matching public facing REST API is part of the UPRN address matching service and supports 5 main use cases:
- Ascertaining the post code of an address
- Ascertaining an authoritative (or standard) version of a user entered address, also showing the variations between the standard address and the submitted 'candidate' address
- Obtaining a UPRN from a submitted 'candidate' address
- Obtaining geolocation characteristics from a property location
The API is a simple getUPRN call. The following example shows a response which would be unusual as there is no post code
Candidate : 10 Downing Street, Westminster
{
"Address_format": "good",
"Postcode_quality": "Invalid post code",
"Matched": true,
"UPRN": 100023336956,
"Qualifier": "Equivalent",
"Classification": "RD04",
"Algorithm": "NPOST_1",
"ABPAddress": {
"Number": 10,
"Street": "Downing Street",
"Town": "London",
"Postcode": "SW1A 2AA",
"Organisaton": "PRIME MINISTER & FIRST LORD OF THE TREASURY"},
"Match_pattern": {
"Postcode": "dropped to match",
"Street": "equivalent",
"Number": "equivalent",
"Building": "equivalent",
"Flat": "equivalent"}}
The nature of the responses are described in detail in the section on application functionality. The API returns the same information as the application UI.