Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Description

UniqueId 

The Unique Property Reference Number (UPRN) from Address Base

Parent

The Unique Street Reference Number (USRN) from Address Base for the street the address is located on.

DisplayName 

The formatted address string.  Display name includes a <b> HTML element to highlight the input search term.

Type 

The type of address.

X

The Easting in British National Grid coordinates

The Northing in British National Grid coordinates

Rank 

The accuracy of the match.  The higher the higher the percentage match of output string to input string

Name

The formatted address string.

Zoom

A zoom level.  This can be ignored (as it is included for historic reasons) and for the national search which will always return 100.

BS7666 fields

Standard BS7666 fields are also returned with the results:

  • bs7666_organisation

  • bs7666_sao_text

  • bs7666_sao_start_number

  • bs7666_sao_start_suffix

  • bs7666_sao_end_number

  • bs7666_sao_end_suffix

  • bs7666_pao_text

  • bs7666_pao_start_number

  • bs7666_pao_start_suffix

  • bs7666_pao_end_number

  • bs7666_pao_end_suffix

  • bs7666_street_description

  • bs7666_locality

  • bs7666_town_name

  • bs7666_administrative_area

  • bs7666_postcode_locator

  • bs7666_saon

  • bs7666_paon

  • bs7666_primary_classification_description

  • bs7666_primary_classification_code

  • bs7666_secondary_classification_description

  • bs7666_secondary_classification_code

  • bs7666_tertiary_classification_description

  • bs7666_tertiary_classification_code

  • bs7666_quaternary_classification_description

  • bs7666_quaternary_classification_code

  • (non-bs7666) local_custodian_code

  • (non-bs7666) authority

Other Examples

Using Postcode

...