Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This technical specification provides detailed technical information about AddressBase Plus Islands. It is targeted at technical users and software developers.
This product was designed to allow current customers of AddressBase Plus to add this product (AddressBase Plus Islands) to their current data holdings. This means there are columns in the schema of this product which will never be populated. These are identified on the appropriate pages throughout this specification document.
This technical specification includes the following sections:
All AddressBase products include the Unique Property Reference Number (UPRN) and are based on same coordinate reference systems.
Please see the General AddressBase information section for additional information that applies across all AddressBase products.
The AddressBase Plus Islands product will be distributed as a comma-separated values (CSV) file or Geography Markup Language (GML) version 3.2. Both of these formats can either be supplied as a full supply or a change-only update (COU) supply.
The CSV supply of AddressBase Plus means:
There will be one record per line in each file.
Fields will be separated by commas.
String fields will be delimited by double quotes.
No comma will be placed at the end of each row in the file.
Records will be terminated by Carriage Return / Line Feed.
Double quotes inside strings will be escaped by doubling.
Where a field has no value in a record, two commas will be placed together in the record (one for the end of the previous field and one for the end of the null field). Where the null field is a text field, double quotes will be included between the two commas, for example:
AddressBase Plus CSV data will be transferred using Unicode encoded in UTF-8. Unicode includes all the characters in ISO-8859-14. Some accented characters are encoded differently.
The transfer will normally be in a single file, but the data can be split into multiple files using volume numbers. Most files will only be split where there are more than one million records.
The header row for the CSV is supplied separately and can be downloaded from the product support pages.
The GML Encoding standard is an Extensible Markup Language (XML) grammar for expressing geographical features. XML schemas are used to define and validate the format and content of GML. The XML specifications that GML is based on are available from the World Wide Web Consortium (W3C) website: http://www.w3.org. More information can be found in the Open Geospatial Consortium (OGC) PDF document, Geography Markup Language v3.2.1: https://portal.ogc.org/files/?artifact_id=20509. The GML 3.2.1 specification provides a set of schemas that define the GML feature constructs and geometric types. These are designed to be used as a basis for building application-specific schemas, which define the data content.
A GML document is described using a GML Schema. The AddressBase Plus Islands schema document (addressbaseplus.xsd) defines the features in AddressBase Plus GML.
It imports the GML 3.2.1 schemas which rely on XML, as defined by W3C at: https://www.w3.org/XML/1998/namespace.html.
The application schema uses the following XML namespaces, for which definitions are available as given here:
Information about Unicode and UTF-8, the character encoding we have chosen, is available on the Unicode Consortium website: http://www.unicode.org/.
Each feature within the AddressBaseSupplySet:FeatureCollection is encapsulated in the following member element according to its feature type:
The UPRN of the feature is provided in the XML attribute of the gml:id:
See Example records > GML for specific GML examples.
Envelope
In the GML supply, you can determine the extent of your supply by the <gml: Envelope>. For example:
| Prefix | Namespace Identifier | Definition Available at |
|---|---|---|
| Member Element | Feature Type |
|---|---|
gml
xsi
Built into XML –
xlink
Xlink – http://www.w3.org/1999/xlink
<abpl:addressMember>
Address
AddressBase Plus Islands will be supplied as non-geographic chunks only. This is a way of dividing up the data into chunks that are supplied in separate volumes, which have a fixed maximum amount of records. The supply is not supplied with any reference to the geographic position of records.
Customers are able to take the AddressBase Plus Islands product as a Full Supply or Change Only Update (COU) supply.
The filename will be constructed as follows:
productName_supply_ccyy-mm-dd_vvv.format
Where:
ProductName is AddressBasePlus_ISL.
supply is defined as FULL or COU.
ccyy-mm-dd is the date the file was generated.
vvv is the volume number of the file.
format is the format of the files received, for example, csv or gml.
For example:
AddressBasePlus_ISL_FULL_2013-05-28_001.gml (GML full supply)
AddressBasePlus_ISL_COU_2013-05-28_001.csv (CSV COU supply)
If the data has been provided in a ZIP file, the filename will be constructed as follows:
productName_supply_ccyy-mm-dd_vvv_format.zip
For example:
AddressBasePlus_ISL_FULL_2013-05-28_001_gml.zip (GML full supply zipped)
AddressBase Plus Islands is available as a Full or Change Only Update supply.
A change-only update (COU) supply of data contains records or files that have changed between product refresh cycles. The primary benefit in supplying data in this way is that data volumes are smaller therefore reducing the amount of data that requires processing when compared to a full supply.
COU data enables a user to identify three types of change:
Deletes (CHANGE_TYPE ‘D’) are objects that have ceased to exist in your area of interest since the last product refresh.
Inserts (CHANGE_TYPE ‘I’) are objects that have been newly inserted into your area of interest since the last product refresh.
Updates (CHANGE_TYPE ‘U’) are objects that have been updated in your area of interest since the last product refresh.
When users are Deleting, Inserting or Updating features it is up to the user to consider their archiving requirements. If deleted records are important to your business requirements you must take appropriate action to archive previous records.
The address of a property or object which is defined as the main/preferred address by the Local Land and Property Gazetteer (LLPG) custodian, Ordnance Survey or Royal Mail.
The following page provides details about the attributes included with this feature, their data types in the different output formats, and other important metadata about them.
The following sub-sections provide details about the attributes included with the Address feature type.
Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey.
Attribute Name: uprn (GML), UPRN (CSV)
Data Type: Integer
Size: 12
Multiplicity: [1]
Source: Contributing Local Authority / Ordnance Survey
Royal Mail’s Unique Delivery Point Reference Number (UDPRN).
Attribute Name: udprn (GML), UDPRN (CSV)
Data Type: Integer
Size: 8
Multiplicity: [0..1]
Source: Royal Mail
Attribute Name: changeType (GML), CHANGE_TYPE (CSV)
Size: 1
Multiplicity: [1]
A code identifying the current state of the property.
Attribute Name: changeType (GML), CHANGE_TYPE (CSV)
Size: 1
Multiplicity: [0..1]
Source: Contributing Local Authority
Date on which the property achieved its current state in the real world.
Attribute Name: stateDate (GML), STATE_DATE (CSV)
Condition: State Date must be present if State is present.
Data Type: Date
Size: 1
Multiplicity: [0..1]
Source: Contributing Local Authority
Classification of the address record.
Attribute Name: class (GML), CLASS (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 6
Multiplicity: [1]
Source: Contributing Local Authority
UPRN of the parent record if a parent child relationship exists.
Attribute Name: class (GML), CLASS (CSV)
Data Type: Integer
Size: 12
Multiplicity: [0..1]
Source: Contributing Local Authority
A value in metres defining the x and y location in accordance with the British National Grid.
Attribute Name: position <<VOIDABLE>>(GML), X_COORDINATE, Y_COORDINATE (CSV)
Condition: X_COORDINATE and Y_COORDINATE (position) must be populated if COUNTRY = ‘M’
Data Type: GM_Point (GML), Float (CSV)
Size: X_COORDINATE (precision, scale) – (8, 2), Y_COORDINATE (precision, scale) – (9, 2)
Multiplicity: [1] (GML), [0..1] (CSV)
Source: Contributing Local Authority/Ordnance Survey
A value defining the Longitude and Latitude location in accordance with the ETRS89 coordinate reference system.
Attribute Name: positionLatLong (GML), LATITUDE, LONGITUDE (CSV)
Data Type: GM_Point (GML), Float (CSV)
Size: LATITUDE (precision, scale) – (9, 7), LONGITUDE (precision, scale) – (8, 7)
Multiplicity: [1]
Source: Ordnance Survey
Representative Point Code. This code is used to reflect positional accuracy.
Attribute Name: rpc (GML), RPC (CSV)
Size: 1
Multiplicity: [1]
Source: Contributing Local Authority
Unique identifier of the LLPG Custodian responsible for the address record creation.
Attribute Name: localCustodianCode (GML), LOCAL_CUSTODIAN_CODE (CSV)
Data Type: Integer
Size: 4
Multiplicity: [1]
The country in which an address record can be found within, determined by the data supply.
Attribute Name: country (GML), COUNTRY (CSV)
Size: 1
Multiplicity: [1]
The date on which the address record was inserted into the database.
Attribute Name: laStartDate (GML), LA_START_DATE (CSV)
Data Type: Date (GML)
Multiplicity: [1]
Source: Contributing Local Authority
The date on which any of the attributes on this record were last changed.
Attribute Name: lastUpdateDate (GML), LAST_UPDATE_DATE (CSV)
Data Type: Date
Multiplicity: [1]
The date on which the record was inserted into the Local Authority database.
Attribute Name: entryDate (GML), ENTRY_DATE (CSV)
Data Type: Date
Multiplicity: [1]
Source: Contributing Local Authority.
The organisation name is the business name given to a delivery point within a building or small group of buildings. For example, ABC COMMUNICATIONS.
This field could also include entries for churches, public houses and libraries.
Attribute Name: rmOrganisationName (GML), RM_ORGANISATION_NAME (CSV)
Condition:
Organisation Name or PO Box Number must be present if Building Name or Building Number are all not present.
RM Organisation Name must be present if Department Name is present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 60
Multiplicity: [0..1]
Source: Royal Mail
Name of current occupier as provided by the Local Authority Custodian.
Attribute Name: laOrganisation (GML), LA_ORGANISATION (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 100
Multiplicity: [0..1]
Source: Contributing Local Authority
For some organisations, department name is indicated because mail is received by subdivisions of the main organisation at distinct delivery points. For example, Organisation Name: ABC COMMUNICATIONS or RM Department Name: MARKETING DEPARTMENT
Attribute Name: departmentName (GML), DEPARTMENT_NAME (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 60
Multiplicity: [0..1]
Source: Royal Mail
Registered legal name of the organisation.
Attribute Name: legaltName (GML), LEGAL_NAME (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 60
Multiplicity: [0..1]
Source: Contributing Local Authority
The sub-building name and/or number are identifiers for subdivisions of properties.
For example:
Sub-building Name: FLAT 3 Building Name: POPLAR COURT Thoroughfare: LONDON ROAD
If the above address is styled 3 POPLAR COURT, all the text will be shown in the Building Name attribute and the Sub-building Name will be empty.
Attribute Name: subBuildingName (GML), SUB_BUILDING_NAME (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 30
Multiplicity: [0..1]
Source: Royal Mail
The building name is a description applied to a single building or a small group of buildings, such as Highfield House. This also includes those building numbers that contain non-numeric characters, such as 44A.
Some descriptive names, when included with the rest of the address, are sufficient to identify the property uniquely and unambiguously, for example, MAGISTRATES COURT.
Sometimes the building name will be a blend of distinctive and descriptive naming, for example, RAILWAY TAVERN (PUBLIC HOUSE) or THE COURT ROYAL (HOTEL).
Attribute Name: buildingName (GML), BUILDING_NAME (CSV)
Condition: Building Name must be present if RM Organisation Name or Building Number or PO Box Number are all not present.
The building number will be shown in this field when it contains a range, decimal or non-numeric character (see Building Number).
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 50
Multiplicity: [0..1]
Source: Royal Mail
The building number is a number given to a single building or a small group of buildings, thus identifying it from its neighbours, for example, 44. Building numbers that contain a range, decimals or non-numeric characters do not appear in this field but will be found in the buildingName or the sub-BuildingName fields.
Attribute Name: buildingNumber (GML), BUILDING_NUMBER (CSV)
Condition: Building Number must be present if Organisation Name or Building Name or PO Box Number are all not present.
Data Type: Integer
Size: 4
Multiplicity: [0..1]
Source: Royal Mail
The number of the secondary addressable object (SAO) or the start of the number range.
Attribute Name: saoStartNumber (GML), SAO_START_NUMBER (CSV)
Condition: If a SAO Start Number is present a PAO Start Number or PAO text must also be present.
Data Type: Integer
Size: 4
Multiplicity: [0..1]
The suffix to the SAO_START_NUMBER.
Attribute Name: saoStartSuffix (GML), SAO_START_SUFFIX (CSV)
Condition: If a SAO Start Suffix is present a SAO Start Number must also be present.
Data Type: CharacterString (GML), char (CSV)
Size: 2
Multiplicity: [0..1]
Source: Contributing Local Authority
The end of the number range for the SAO, where the SAO_START_NUMBER contains the first number in the range.
Attribute Name: saoEndNumber (GML), SAO_END_NUMBER (CSV)
Condition: If SAO End Number is present, a SAO Start Number must also be present.
Data Type: Integer
Size: 4
Multiplicity: [0..1]
Source: Contributing Local Authority
The suffix to the SAO_END_NUMBER.
Attribute Name: saoEndSuffix (GML), SAO_END_SUFFIX (CSV)
Condition: If a SAO End Suffix is present, a SAO End Number must also be present.
Data Type: CharacterString (GML), char (CSV)
Size: 2
Multiplicity: [0..1]
Source: Contributing Local Authority
Describes the SAO, such as ‘Maisonette’ or ‘Flat 1’.
Attribute Name: saoText (GML), SAO_TEXT (CSV)
Condition: If SAO Text is present, a PAO Start Number or PAO Text must also be present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 90
Multiplicity: [0..1]
Source: Contributing Local Authority
Describes the SAO, such as Maisonette, in an alternative language (defined by the value in the ALT_LANGUAGE field).
Attribute Name: altLanguageSAOText (GML), ALT_LANGUAGE_SAO_TEXT (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 90
Multiplicity: [0..1]
Source: Contributing Local Authority
The number of the primary addressable object (PAO) or the start of the number range.
Attribute Name: paoStartNumber (GML), PAO_START_NUMBER (CSV)
Condition: PAO Start Number must be present if PAO Text is not present.
Data Type: Integer
Size: 4
Multiplicity: [0..1]
Source: Contributing Local Authority
The suffix to the PAO_START_NUMBER for example, ‘A’ or ‘B’.
Attribute Name: paoStartSuffix (GML), PAO_START_SUFFIX (CSV)
Condition: If a PAO Start Suffix is present, a PAO Start Number must also be present.
Data Type: CharacterString (GML), char (CSV)
Size: 2
Multiplicity: [0..1]
Source: Contributing Local Authority
The end of the number range for the PAO where the PAO_START_NUMBER contains the first number in the range.
Attribute Name: paoEndNumber (GML), PAO_END_NUMBER (CSV)
Condition: If a PAO End Number is present, a PAO Start Number must also be present.
Data Type: Integer
Size: 4
Multiplicity: [0..1]
Source: Contributing Local Authority
The suffix to the PAO end number, for example ‘A’ or ‘B’.
Attribute Name: paoEndSuffix (GML), PAO_END_SUFFIX (CSV)
Condition: If a PAO End Suffix is present, a PAO End Number must also be present.
Data Type: CharacterString (GML), char (CSV)
Size: 2
Multiplicity: [0..1]
Source: Contributing Local Authority
Name describing the PAO, this is normally a building name such as ‘Harbour View’.
Attribute Name: paoText (GML), PAO_TEXT (CSV)
Condition: PAO Text must be present if PAO Start Number is not present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 90
Multiplicity: [0..1]
Source: Contributing Local Authority
Name describing the PAO, this is normally a building name such as ‘Harbour View’, in an alternative language (defined by the value in the ALT_LANGUAGE field).
Attribute Name: altLanguagePAOText (GML), ALT_LANGUAGE_PAO_TEXT (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 90
Multiplicity: [0..1]
Source: Contributing Local Authority
Unique Street Reference Number (USRN).
Attribute Name: usrn (GML), USRN (CSV)
Data Type: Integer
Size: 8
Multiplicity: [1]
Source: Contributing Local Authority
This field indicates how the item was matched to a Street. 1 is matched manually to the most accessible USRN and 2 is matched spatially to the nearest USRN, which may not be the nearest accessible street.
Attribute Name: usrnMatchIndicator (GML), USRN_MATCH_INDICATOR (CSV)
Size: 1
Multiplicity: [1]
Source: Contributing Local Authority/Ordnance Survey
Third level of geographic area name, for example, to record island names or property groups such as crofts.
Attribute Name: areaName (GML), AREA_NAME (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 40
Multiplicity: [0..1]
Source: Contributing Local Authority
Memorandum of the vertical position of the property.
Attribute Name: level (GML), LEVEL (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 30
Multiplicity: [0..1]
Source: Contributing Local Authority
Whether the local custodian deems the record to be an official depiction of the address or not.
Attribute Name: officialFlag (GML), OFFICIAL_FLAG (CSV)
Size: 1
Multiplicity: [0..1]
Source: Contributing Local Authority
Unique identifier provided by Ordnance Survey.
Attribute Name: osAddressTOID (GML), OS_ADDRESS_TOID (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 20
Multiplicity: [0..1]
Source: Ordnance Survey
The version of the OS Address TOID that the product relates to.
Attribute Name: osAddressTOIDVersion (GML), OS_ADDRESS_TOID_VERSION (CSV)
Condition: OS Address TOID Version must be present if OS Address TOID is present.
Data Type: Integer
Size: 3
Multiplicity: [0..1]
Source: Ordnance Survey
The OS MasterMap Highways Network road link that the addressable object refers to.
Attribute Name: osRoadLinkTOID (GML), OS_ROADLINK_TOID (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 20
Multiplicity: [0..1]
Source: Ordnance Survey
The version of the OS Road Link TOID the product relates to.
Attribute Name: osAddressTOIDVersion (GML), OS_ADDRESS_TOID_VERSION (CSV)
Condition: OS Roadlink TOID Version must be present if OS Road Link TOID is present.
Data Type: Integer
Size: 3
Multiplicity: [0..1]
Source: Ordnance Survey
The OS MasterMap Topography Layer TOID that the addressable object refers to.
Attribute Name: osTopoTOID (GML), OS_TOPO_TOID (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 20
Multiplicity: [0..1]
Source: Ordnance Survey
The version of the OS Topo TOID the product relates to.
Attribute Name: osTopoTOIDVersion (GML), OS_TOPO_TOID_VERSION (CSV)
Condition: OS Topo TOID Version must be present if OS Topo TOID is present.
Data Type: Integer
Size: 3
Multiplicity: [0..1]
Source: Ordnance Survey
The unique reference to the Valuation Office Agency (VOA) council tax record which the addressable object refers to.
Attribute Name: voaCTRecord (GML), VOA_CT_RECORD (CSV)
Data Type: Integer
Size: 50
Multiplicity: [0..1]
Source: Valuation Office Agency
The unique reference to the Valuation Office Agency (VOA) council tax record which the addressable object refers to.
Attribute Name: voaNDRRecord (GML), VOA_NDR_RECORD (CSV)
Data Type: Integer
Size: 50
Multiplicity: [0..1]
Source: Valuation Office Agency
Name of the street the address is allocated within, as given by the local authority.
Attribute Name: streetDescription (GML), STREET_DESCRIPTION (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 100
Multiplicity: [1]
Source: Contributing Local Authority
Name of the street as given by the local authority in an alternative language, (defined by the value in the ALT_LANGUAGE field).
Attribute Name: altLanguageStreetDescription (GML), ALT_LANGUAGE_STREET_DESCRIPTION (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 100
Multiplicity: [0..1]
Source: Contributing Local Authority
In certain places (for example, town centres), there are named thoroughfares within other named thoroughfares (for example, parades of shops on a high street where different parades have their own identity), for example, KINGS PARADE, HIGH STREET and QUEENS PARADE, HIGH STREET.
Attribute Name: dependentThoroughfare (GML), DEPENDENT_THOROUGHFARE (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 80
Multiplicity: [0..1]
Source: Royal Mail
A thoroughfare in AddressBase is fundamentally a road, track or named access route on which there are Royal Mail delivery points, for example, HIGH STREET.
Attribute Name: thoroughfare (GML), THOROUGHFARE (CSV)
Condition: Thoroughfare must be present if dependent thoroughfare is present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 80
Multiplicity: [0..1]
Source: Royal Mail
The Welsh translation of DEPENDENT_THOROUGHFARE.
Attribute Name: welshDependentThoroughfare (GML), WELSH_DEPENDENT_THOROUGHFARE (CSV)
Condition: If a Welsh Dependent Thoroughfare is present, a Welsh Thoroughfare must also be present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 80
Multiplicity: [0..1]
Source: Royal Mail
The Welsh translation of THOROUGHFARE.
Attribute Name: welshThoroughfare (GML), WELSH_THOROUGHFARE (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Multiplicity: [0..1]
Size: 80
Source: Royal Mail
This is used to distinguish between similar thoroughfares or the same thoroughfare within a dependent locality. For example, Millbrook Industrial Estate and Cranford Estate in this situation: BRUNEL WAY, MILLBROOK INDUSTRIAL ESTATE, MILLBROOK, SOUTHAMPTON and BRUNEL WAY, CRANFORD ESTATE, MILLBROOK, SOUTHAMPTON.
Attribute Name: doubleDependentLocality (GML), DOUBLE_DEPENDENT_LOCALITY (CSV)
Condition: If a Double Dependent Locality is present, a Dependent Locality must also be present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Royal Mail
Dependent locality areas define an area within a post town. These are only necessary for postal purposes and are used to aid differentiation where there are thoroughfares of the same name in the same locality. For example, HIGH STREET in SHIRLEY and SWAYTHLING in this situation: HIGH STREET, SHIRLEY, SOUTHAMPTON and HIGH STREET, SWAYTHLING, SOUTHAMPTON.
Attribute Name: dependentLocality (GML), DEPENDENT_LOCALITY (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Royal Mail
A locality defines an area or geographical identifier within a town, village or hamlet.
Attribute Name: locality (GML), LOCALITY (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Contributing Local Authority
The Welsh translation of DEPENDENT_LOCALITY.
Attribute Name: welshDependentLocality (GML), WELSH_DEPENDENT_LOCALITY (CSV)
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Royal Mail
The Welsh translation of Double Dependent Locality.
Attribute Name: welshDoubleDependentLocality (GML), WELSH_DOUBLE_DEPENDENT_LOCALITY (CSV)
Condition: If a Welsh Double Dependent Locality is present, a Welsh Dependent Locality must also be present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Royal Mail
The name of the town the address is within.
Attribute Name: townName (GML), TOWN_NAME (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 30
Multiplicity: [0..1]
Source: Contributing Local Authority
Local Highway Authority name.
Attribute Name: administrativeArea (GML), ADMINISTRATIVE_AREA (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 30
Multiplicity: [1]
Source: Contributing Local Authority
The town or city in which the Royal Mail sorting office is located which services this record. There may be more than one, possibly several, sorting offices in a town or city.
Attribute Name: postTown (GML), POST_TOWN (CSV)
Condition: Post Town must be present if Royal Mail’s Unique Delivery Point Reference Number (UDPRN) is present.
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 35
Multiplicity: [0..1]
Source: Royal Mail
The Welsh translation of post town value.
Attribute Name: welshPostTown (GML), WELSH_POST_TOWN (CSV).
Data Type: LocalisedCharacterString (GML), char (CSV)
Size: 30
Multiplicity: [0..1]
Source: Royal Mail
A postcode is an abbreviated form of address made up of combinations of between five and seven alphanumeric characters. These are used by Royal Mail to help with the automated sorting of mail. A postcode may cover between 1 and 100 addresses.
There are two main components of a postcode, for example, NW6 4DP:
The outward code (or ‘outcode’). The first two–four characters of the postcode constituting the postcode area and the postcode district, for example, NW6. It is the part of the postcode that enables mail to be sent from the accepting office to the correct area for delivery.
The inward code (or ‘incode’). The last three characters of the postcode constituting the postcode sector and the postcode unit, example, 4DP. It is used to sort mail at the local delivery office.
Attribute Name: postcode (GML), POSTCODE (CSV)
Condition: Postcode must be present if Royal Mail’s Unique Delivery Point Reference Number (UDPRN) is present.
Data Type: CharacterString (GML), char (CSV)
Size: 8
Multiplicity: [0..1]
Source: Royal Mail
This field contains the Royal Mail Postcode Address File (PAF) postcode where the local authority address has been matched to PAF, that is, the POSTCODE field. Where a match has not been made, the postcode information is sourced from the local authority in collaboration with Royal Mail. Where the local authority does not hold a current valid postcode, Code-Point with Polygons is used to spatially derive the postcode based on the position of the coordinates.
This field is always assigned the Code-Point with Polygons Postcode for Street Records (Classification “PS”).
This field must be used in conjunction with the RPC field to determine the accuracy of its position.
Attribute Name: postcodeLocator (GML), POSTCODE_LOCATOR (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 8
Multiplicity: [1]
Source: Royal Mail, Contributing Local Authority or Ordnance Survey
Describes the address as a small or large user as defined by Royal Mail.
Attribute Name: postcodeType (GML), POSTCODE_TYPE (CSV)
Condition:
Postcode Type must be present if Royal Mail’s Unique Delivery Point Reference Number (UDPRN) is present.
Postcode Type Code must equal ‘L’ if PO Box Number is present.
Size: 1
Multiplicity: [0..1]
Source: Royal Mail
A two-character code uniquely identifying an individual delivery point within a postcode.
Attribute Name: deliveryPointSuffix (GML), DELIVERY_POINT_SUFFIX (CSV)
Condition: Delivery Point Suffix must be present if Royal Mail’s Unique Delivery Point Reference Number (UDPRN) is present.
Data Type: CharacterString (GML), char (CSV)
Size: 2
Multiplicity: [0..1]
Source: Royal Mail
Identifies addresses which are believed to be capable of receiving mail as defined specifically for the AddressBase product and details their relationship with other AddressBase Postal records.
This field identifies some addresses which the AddressBase product believes to be capable of receiving mail which are not contained within the Royal Mail PAF database, such as flats behind a front door which has a single letter box.
Attribute Name: addressbasePostal (GML), ADDRESSBASE_POSTAL (CSV)
Condition: If AddressBase Postal value is ‘D’, UDPRN must be present.
Size: 1
Multiplicity: [1]
Source: Royal Mail
Post Office Box (PO Box) number.
Attribute Name: poBoxNumber (GML), PO_BOX_NUMBER (CSV)
Condition: Organisation Name or PO Box Number must be present if Building Name or Building Number are all not present.
Data Type: CharacterString (GML), char (CSV)
Size: 6
Multiplicity: [0..1]
Source: Royal Mail
The Ward code for the ward which the address record falls within.
Attribute Name: wardCode (GML), WARD_CODE (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 9
Multiplicity: [0..1]
The Parish code for the Parish which the address record falls within.
Attribute Name: parishCode (GML), PARISH_CODE (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 9
Multiplicity: [0..1]
Date on which the Royal Mail address was loaded into the product database in CCYY-MM-DD format.
This may not be the same time as it enters product.
Attribute Name: rmStartDate (GML), RM_START_DATE (CSV)
Condition: RM Start Date must be present if Royal Mail’s Unique Delivery Point Reference Number (UDPRN) is present.
Data Type: Date
Multiplicity: [0..1]
Source: Royal Mail
This is a count of all the child UPRNs for this record if a parent-child relationship exists.
Attribute Name: multiOccCount (GML), MULTI_OCC_COUNT (CSV)
Data Type: Integer
Size: 4
Multiplicity: [0..1]
Source: Ordnance Survey
This may not be the same time as it enters product.
VOA non-domestic rates primary description code, for example, ‘IF2’.
Attribute Name: voaNDRPDescCode (GML), VOA_NDR_DESC_CODE (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 5
Multiplicity: [0..1]
Source: Valuation Office Agency
This may not be the same time as it enters product.
VOA non-domestic rates special category code, for example, ‘016’.
Attribute Name: voaNDRPScatCode (GML), VOA_NDR_SCAT_CODE (CSV)
Data Type: CharacterString (GML), char (CSV)
Size: 4
Multiplicity: [0..1]
Source: Valuation Office Agency
Field describing the language of the alternative records.
Attribute Name: altLanguage (GML), ALT_LANGUAGE (CSV)
Size: 3
Multiplicity: [0..1]
Source: Contributing Local Authority
AddressBase Plus is structured as a flat file. The data structure in this document is described by means of Unified Modeling Language (UML) class diagrams.
Definition: The address of a property or object which is defined as the main/preferred address by Pointer, Isle of Man Property database, Channel Islands Address File (CAF), Ordnance Survey or Royal Mail.
The diagram below shows the UML model of AddressBase Plus Islands in CSV format; classes from the Ordnance Survey product specification are orange; code lists are blue, and enumerations are green.
Definition: The address of a property or object which is defined as the main/preferred address by Pointer, Isle of Man Property database, Channel Islands Address File (CAF), Ordnance Survey or Royal Mail.
The diagram below shows the UML model of AddressBase Plus Islands in GML; classes from the Ordnance Survey product specification are orange, code lists are blue and enumerations are green.
As the attribute ‘position’ is voidable this is displayed at the bottom of the UML model, but this is not where it will be provided in terms of ordering in the product supply. Please see the attribute tables to confirm the attribute ordering.
The naming of attributes between GML and CSV will be different due to the requirements of the file formats. For convenience, the following table maps the CSV attribute name to the GML attribute name.
| CSV | GML |
|---|
Type of Record Change – please see for more information.
Code List Name:
Code List Name:
The multiplicity of this column differs between the formats because position is VOIDABLE in GML but this functionality is not possible in CSV. Please see UML models in for more.
Code List Name:
Code List Name:
Code List Name:
Code List Name:
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
This column will remain NULL. It is included to make the product compatible with .
Code List Name:
Code List Name:
Code List Name:
UPRN | uprn |
UDPRN | udprn |
CHANGE_TYPE | changeType |
STATE | state |
STATE_DATE | stateDate |
CLASS | class |
PARENT_UPRN | parentUPRN |
X_COORDINATE |
position |
Y_COORDINATE |
LATITUDE |
positionLatLong |
LONGITUDE |
RPC | rpc |
LOCAL_CUSTODIAN_CODE | localCustodianCode |
COUNTRY | country |
LA_START_DATE | laStartDate |
LAST_UPDATE_DATE | lastUpdateDate |
ENTRY_DATE | entryDate |
RM_ORGANISATION_NAME | rmOrganisationName |
LA_ORGANISATION | laOrganisation |
DEPARTMENT_NAME | departmentName |
LEGAL_NAME | legalName |
SUB_BUILDING_NAME | subBuildingName |
BUILDING_NAME | buildingName |
BUILDING_NUMBER | buildingNumber |
SAO_START_NUMBER | saoStartNumber |
SAO_START_SUFFIX | saoStartSuffix |
SAO_END_NUMBER | saoEndNumber |
SAO_END_SUFFIX | saoEndSuffix |
SAO_TEXT | saoText |
ALT_LANGUAGE_SAO_TEXT | altLanguageSAOText |
PAO_START_NUMBER | paoStartNumber |
PAO_START_SUFFIX | paoStartSuffix |
PAO_END_NUMBER | paoEndNumber |
PAO_END_SUFFIX | paoEndSuffix |
PAO_TEXT | paoText |
ALT_LANGUAGE_PAO_TEXT | altLanguagePAOText |
USRN | usrn |
USRN_MATCH_INDICATOR | usrnMatchIndicator |
AREA_NAME | areaName |
LEVEL | level |
OFFICIAL_FLAG | officialFlag |
OS_ADDRESS_TOID | osAddressTOID |
OS_ADDRESS_TOID_VERSION | osAddressTOIDVersion |
OS_ROADLINK_TOID | osRoadLinkTOID |
OS_ROADLINK_TOID_VERSION | osRoadLinkTOIDVersion |
OS_TOPO_TOID | osTopoTOID |
OS_TOPO_TOID_VERSION | osTopoTOIDVersion |
VOA_CT_RECORD | voaCTRecord |
VOA_NDR_RECORD | voaNDRRecord |
STREET_DESCRIPTION | streetDescription |
ALT_LANGUAGE_STREET_DESCRIPTION | altLanguageStreetDescription |
DEPENDENT_THOROUGHFARE | dependentThoroughfare |
THOROUGHFARE | thoroughfare |
WELSH_DEPENDENT_THOROUGHFARE | welshDependentThoroughfare |
WELSH_THOROUGHFARE | welshThoroughfare |
DOUBLE_DEPENDENT_LOCALITY | doubleDependentLocality |
DEPENDENT_LOCALITY | dependentLocality |
LOCALITY | Locality |
WELSH_DEPENDENT_LOCALITY | welshDependentLocality |
WELSH_DOUBLE_DEPENDENT_LOCALITY | welshDoubleDependentLocality |
TOWN_NAME | townName |
ADMINISTRATIVE_AREA | administrativeArea |
POST_TOWN | postTown |
WELSH_POST_TOWN | welshPostTown |
POSTCODE | postcode |
POSTCODE_LOCATOR | postcodeLocator |
POSTCODE_TYPE | postcodeType |
DELIVERY_POINT_SUFFIX | deliveryPointSuffix |
ADDRESSBASE_POSTAL | addressbasePostal |
PO_BOX_NUMBER | poBoxNumber |
WARD_CODE | wardCode |
PARISH_CODE | parishCode |
RM_START_DATE | rmStartDate |
MULTI_OCC_COUNT | multiOccCount |
VOA_NDR_P_DESC_CODE | voaNDRPDescCode |
VOA_NDR_SCAT_CODE | voaNDRScatCode |
ALT_LANGUAGE | altLanguage |
This page describes the features (one for CSV and two for GML) which make up the AddressBase Plus product, giving detailed information about each attribute.
The name of the attribute and what it is describing.
A condition associated with this attribute (Optional).
The nature of the attribute, for example a numeric value or a code list value.
Describes how many times this element is expected to be populated in the data. An attribute may be optional or mandatory within the AddressBase Plus product. These are denoted by:
‘1’ there must be a value.
‘0..1’ population is optional but a maximum of one attribute will be returned.
These values may be used in combination.
This feature is formally known as the GML feature collection and is used to define a collection of features.
This is not supplied as part of the CSV supply. Please see the model overviews in AddressBase Plus structure for more information.
The following sub-sections provide details about the attributes included with this feature, their data types in the different output formats, and other important metadata about them.
Time the data was extracted from the database.
Attribute Name: queryTime (GML), Not provided (CSV)
Data Type: DateTime
Multiplicity: [1]
This attribute is only provided as part of a Change Only Update (COU) supply. It will not be provided if you take a Full Supply.
The date given as part of a change-only query.
Attribute Name: queryChangeSinceDate (GML), Not provided (CSV)
Data Type: Date
Multiplicity: [0..1]
A code list or enumeration is a controlled set of values which can be used to populate a specific column. The code list and enumeration UML models associated with AddressBase Plus Islands can be found below, with their appropriate descriptions.
