Skip to content

Class: PostalAddressClass

Any postal address associated with a user, returned by an Address Lookup API or by manual data input.

JSON schema: di_vocab:PostalAddress

URI: di_vocab:PostalAddressClass

img

Uses Mixin

Referenced by Class

Attributes

Mixed in from PostalAddressGeneralClass:

  • buildingNumber 0..1
    • Description: 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. NOTE - This is a string representation of the building number.

      Close mapping: adb:buildingNumber

    • Range: String

Mixed in from PostalAddressGeneralClass:

  • buildingName 0..1
    • Description: 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).

      Close mapping: adb:buildingName

    • Range: String

Mixed in from PostalAddressGeneralClass:

Mixed in from PostalAddressGeneralClass:

  • organisationName 0..1
    • Description: The organisation name is the business name given to a delivery point within a building or small group of buildings. E.g. TOURIST INFORMATION CENTRE This field could also include entries for churches, public houses and libraries.

      Close mapping: adb:organisationName

    • Range: String

Mixed in from PostalAddressGeneralClass:

  • departmentName 0..1
    • Description: For some organisations, department name is indicated because mail is received by subdivisions of the main organisation at distinct delivery points. E.g. Organisation Name - ABC COMMUNICATIONS Department Name - MARKETING DEPARTMENT

      Close mapping: adb:departmentName

    • Range: String

Mixed in from PostalAddressGeneralClass:

  • subBuildingName 0..1
    • Description: The sub-building name and/or number are identifiers for subdivisions of properties. E.g. Sub-building Name - FLAT 3 Building Name - POPLAR COURT Thoroughfare - LONDON ROAD NOTE - If the address is styled as 3 POPLAR COURT, all the text will be shown in the Building Name attribute and the Sub-building Name will be empty. The building number will be shown in this field when it contains a range, decimal or non-numeric character (see Building Number).

      Close mapping: adb:subBuildingName

    • Range: String

Mixed in from PostalAddressGeneralClass:

  • streetName 0..1
    • Description: A thoroughfare/street is fundamentally a road, track or named access route, for example, HIGH STREET.

      Close mapping - adb:thoroughfare

    • Range: String

Mixed in from PostalAddressGeneralClass:

Mixed in from PostalAddressGeneralClass:

  • postalCode 0..1
    • Description: A UK postcode is an abbreviated form of address made up of combinations of between five and seven alphanumeric characters. International postal codes have different formats.

      Exact mapping: schema:postalCode

    • Range: String

Mixed in from PostalAddressGeneralClass:

  • addressCountry 0..1
    • Description: The country. Provided as the two-letter ISO 3166-1 alpha-2 country code, hence this only closely maps rather than exactly maps to schema.org which permits any text.

      Close mapping: schema:addressCountry

    • Range: String

Mixed in from PostalAddressUKClass:

  • uprn 0..1
    • Description: The Unique Property Reference Number (UK and Northern Ireland Addresses Only)

      Exact mapping: adb:uprn

    • Range: Integer

Mixed in from PostalAddressUKClass:

  • dependentStreetName 0..1
    • Description: In certain places, for example, town centres, there are named thoroughfares/streets within other named thoroughfares/streets, 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.

      Close mapping: adb:dependentThoroughfare

    • Range: String

Mixed in from PostalAddressUKClass:

  • doubleDependentAddressLocality 0..1
    • Description: This is used to distinguish between similar thoroughfares/streets or the same thoroughfare/street 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.

      Close mapping: adb:doubleDependentLocality

    • Range: String

Mixed in from PostalAddressUKClass:

  • dependentAddressLocality 0..1
    • Description: Dependent locality areas define an area within a town. These are only necessary to aid differentiation where there are thoroughfares/streets 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.

      Close mapping: adb:dependentLocality

    • Range: String

Mixed in from PostalAddressInternationalClass:

  • addressRegion 0..1
    • Description: The region in which the locality is, and which is in the country, provided as text. For example, California, or another appropriate first-level Administrative division.

      Exact mapping: schema:addressRegion

    • Range: String

Other properties

See also: ../json-schemas/PostalAddress.json
Close Mappings: schema:PostalAddress
adb:Address