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:class/PostalAddressClass
classDiagram
class PostalAddressClass
click PostalAddressClass href "../../classes/PostalAddressClass/"
PostalAddressUKClass <|-- PostalAddressClass
click PostalAddressUKClass href "../../classes/PostalAddressUKClass/"
PostalAddressInternationalClass <|-- PostalAddressClass
click PostalAddressInternationalClass href "../../classes/PostalAddressInternationalClass/"
PostalAddressClass : addressCountry
PostalAddressClass : addressLocality
PostalAddressClass : addressRegion
PostalAddressClass : buildingName
PostalAddressClass : buildingNumber
PostalAddressClass : departmentName
PostalAddressClass : dependentAddressLocality
PostalAddressClass : dependentStreetName
PostalAddressClass : doubleDependentAddressLocality
PostalAddressClass : organisationName
PostalAddressClass : poBoxNumber
PostalAddressClass : postalCode
PostalAddressClass : streetName
PostalAddressClass : subBuildingName
PostalAddressClass : uprn
PostalAddressClass : validFrom
PostalAddressClass : validUntil
Inheritance
- PostalAddressClass [ PostalAddressUKClass PostalAddressInternationalClass]
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| uprn | 0..1 Integer |
The Unique Property Reference Number (UK and Northern Ireland Addresses Only)... | PostalAddressUKClass |
| dependentStreetName | 0..1 String |
In certain places, for example, town centres, there are named thoroughfares/s... | PostalAddressUKClass |
| doubleDependentAddressLocality | 0..1 String |
This is used to distinguish between similar thoroughfares/streets or the same... | PostalAddressUKClass |
| dependentAddressLocality | 0..1 String |
Dependent locality areas define an area within a town | PostalAddressUKClass |
| addressRegion | 0..1 String |
The region in which the locality is, and which is in the country, provided as... | PostalAddressInternationalClass |
| buildingNumber | 0..1 String |
The building number is a number given to a single building or a small group o... | PostalAddressGeneralClass |
| buildingName | 0..1 String |
The building name is a description applied to a single building or a small gr... | PostalAddressGeneralClass |
| poBoxNumber | 0..1 String |
Post Office Box (PO Box) number | PostalAddressGeneralClass |
| organisationName | 0..1 String |
The organisation name is the business name given to a delivery point within a... | PostalAddressGeneralClass |
| departmentName | 0..1 String |
For some organisations, department name is indicated because mail is received... | PostalAddressGeneralClass |
| subBuildingName | 0..1 String |
The sub-building name and/or number are identifiers for subdivisions of prope... | PostalAddressGeneralClass |
| streetName | 0..1 String |
A thoroughfare/street is fundamentally a road, track or named access route, f... | PostalAddressGeneralClass |
| addressLocality | 0..1 String |
The town or city in which the address resides | PostalAddressGeneralClass |
| postalCode | 0..1 String |
A UK postcode is an abbreviated form of address made up of combinations of be... | PostalAddressGeneralClass |
| addressCountry | 0..1 String |
The country | PostalAddressGeneralClass |
| validFrom | 0..1 Date |
ValidityClass | |
| validUntil | 0..1 Date |
ValidityClass |
Usages
| used by | used in | type | used |
|---|---|---|---|
| PersonExtendedMatchingClass | address | range | PostalAddressClass |
| AddressAssertionClass | address | range | PostalAddressClass |
| IdentityCheckSubjectClass | address | range | PostalAddressClass |
See Also
Identifier and Mapping Information
Schema Source
- from schema: https://vocab.account.gov.uk/linkml/credentials-schema
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | di_vocab:PostalAddressClass |
| native | di_vocab:PostalAddressClass |
| close | schema:PostalAddress, adb:Address |
LinkML Source
Direct
name: PostalAddressClass
description: 'Any postal address associated with a user, returned by an Address Lookup
API or by manual data input. <p>JSON schema: [di_vocab:PostalAddress](../json-schemas/PostalAddress.json)</p> '
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/PostalAddress.json
close_mappings:
- schema:PostalAddress
- adb:Address
mixins:
- PostalAddressUKClass
- PostalAddressInternationalClass
Induced
name: PostalAddressClass
description: 'Any postal address associated with a user, returned by an Address Lookup
API or by manual data input. <p>JSON schema: [di_vocab:PostalAddress](../json-schemas/PostalAddress.json)</p> '
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/PostalAddress.json
close_mappings:
- schema:PostalAddress
- adb:Address
mixins:
- PostalAddressUKClass
- PostalAddressInternationalClass
attributes:
uprn:
name: uprn
description: The Unique Property Reference Number (UK and Northern Ireland Addresses
Only) <p>Exact mapping: [adb:uprn](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
exact_mappings:
- adb:uprn
rank: 1000
alias: uprn
owner: PostalAddressClass
domain_of:
- PostalAddressUKClass
range: integer
minimum_value: 1
maximum_value: 999999999999
dependentStreetName:
name: dependentStreetName
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. <p>Close mapping: [adb:dependentThoroughfare](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:dependentThoroughfare
rank: 1000
alias: dependentStreetName
owner: PostalAddressClass
domain_of:
- PostalAddressUKClass
range: string
doubleDependentAddressLocality:
name: doubleDependentAddressLocality
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. <p>Close mapping: [adb:doubleDependentLocality](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:doubleDependentLocality
rank: 1000
alias: doubleDependentAddressLocality
owner: PostalAddressClass
domain_of:
- PostalAddressUKClass
range: string
dependentAddressLocality:
name: dependentAddressLocality
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. <p>Close mapping: [adb:dependentLocality](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:dependentLocality
rank: 1000
alias: dependentAddressLocality
owner: PostalAddressClass
domain_of:
- PostalAddressUKClass
range: string
addressRegion:
name: addressRegion
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. <p>Exact mapping: [schema:addressRegion](https://schema.org/addressRegion)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
exact_mappings:
- schema:addressRegion
rank: 1000
alias: addressRegion
owner: PostalAddressClass
domain_of:
- PostalAddressInternationalClass
range: string
buildingNumber:
name: buildingNumber
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. <b>NOTE - This is a string representation of the building number.</b>
<p>Close mapping: [adb:buildingNumber](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:buildingNumber
rank: 1000
alias: buildingNumber
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
buildingName:
name: buildingName
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). <p>Close
mapping: [adb:buildingName](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:buildingName
rank: 1000
alias: buildingName
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
poBoxNumber:
name: poBoxNumber
description: Post Office Box (PO Box) number. <p>Exact mapping: [adb:poBoxNumber](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
exact_mappings:
- adb:poBoxNumber
rank: 1000
alias: poBoxNumber
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
organisationName:
name: organisationName
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.
<p>Close mapping: [adb:organisationName](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:organisationName
rank: 1000
alias: organisationName
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
departmentName:
name: departmentName
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
<p>Close mapping: [adb:departmentName](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:departmentName
rank: 1000
alias: departmentName
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
subBuildingName:
name: subBuildingName
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). <p>Close
mapping: [adb:subBuildingName](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:subBuildingName
rank: 1000
alias: subBuildingName
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
streetName:
name: streetName
description: A thoroughfare/street is fundamentally a road, track or named access
route, for example, HIGH STREET. <p>Close mapping - [adb:thoroughfare](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:thoroughfare
rank: 1000
alias: streetName
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
addressLocality:
name: addressLocality
description: The town or city in which the address resides. <p>Close mapping:
[adb:postTown](http://www.geoplace.co.uk/addressbase/schema/2.1/addressbase.xsd)</p>
<p>Exact mapping: [schema:addressLocality](https://schema.org/addressLocality)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- adb:postTown
rank: 1000
alias: addressLocality
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
postalCode:
name: postalCode
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. <p>Exact mapping: [schema:postalCode](https://schema.org/postalCode)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
exact_mappings:
- schema:postalCode
rank: 1000
alias: postalCode
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
addressCountry:
name: addressCountry
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. <p>Close mapping: [schema:addressCountry](https://schema.org/addressCountry)</p>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
close_mappings:
- schema:addressCountry
rank: 1000
alias: addressCountry
owner: PostalAddressClass
domain_of:
- PostalAddressGeneralClass
range: string
validFrom:
name: validFrom
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
rank: 1000
slot_uri: schema:validFrom
alias: validFrom
owner: PostalAddressClass
domain_of:
- ValidityClass
- MitigatingCredentialClass
range: date
validUntil:
name: validUntil
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
rank: 1000
slot_uri: schema:validUntil
alias: validUntil
owner: PostalAddressClass
domain_of:
- ValidityClass
range: date