Class: PostalAddressGeneralClass
An abstract class containing common elements of a postal address. Attributes have a close mapping to either or both Ordnance Survey AddressBase and schema.org. This class should not be used directly. Lower-level classes are used to generate schema for UK or international addresses.
JSON schema: di_vocab:PostalAddress
URI: di_vocab:PostalAddressGeneralClass
Uses Mixin
- mixin: ValidityClass
Children
- PostalAddressInternationalClass - An international postal address associated with a user, returned by an Address Lookup API or by manual data input.
JSON schema: di_vocab:PostalAddressInternationalClass
Examples
- Building Number
- Building Number and Organisation Name
- Building Name and Number and Organisation Name
- PO Box Number
Close mapping: adb:Address
Close mapping: schema:PostalAddress
- PostalAddressUKClass - A UK postal address associated with a user, returned by an Address Lookup API or by manual data input.
JSON schema: di_vocab:PostalAddressUK
Examples
- Building Number
- Building Name with UPRN
- Building Name without UPRN
- Building Number with Building Name
- Building Number with Dependent Address Locality
- Sub Building Name with Building Name
- Sub Building Name with Building Number
Close mapping: adb:Address
Close mapping: schema:PostalAddress
Referenced by Class
Attributes
Own
- 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
- 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.
- 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
- 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).
- poBoxNumber 0..1
- Description: Post Office Box (PO Box) number.
Exact mapping: adb:poBoxNumber
- Range: String
- Description: Post Office Box (PO Box) number.
- 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
- 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.
- 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
- 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
- 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
- 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).
- 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
- Description: A thoroughfare/street is fundamentally a road, track or named access route, for example, HIGH STREET.
- addressLocality 0..1
- Description: The town or city in which the address resides.
Close mapping: adb:postTown
Exact mapping: schema:addressLocality
- Range: String
- Description: The town or city in which the address resides.
- 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
- 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.
- 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
- 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.
Mixed in from ValidityClass:
Mixed in from ValidityClass:
- validUntil 0..1
- Range: Date
Other properties
| See also: | ../json-schemas/PostalAddress.json | |
| Close Mappings: | schema:PostalAddress | |
| adb:Address |