Skip to content

Latest commit

 

History

History
709 lines (372 loc) · 14.2 KB

address.schema.md

File metadata and controls

709 lines (372 loc) · 14.2 KB

Postal address Schema

https://ns.adobe.com/xdm/common/address

A postal address. Address could relate to a person's home, work, or preferred store location.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stabilizing No Forbidden Permitted common/address.schema.json

Schema Hierarchy

  • Postal address https://ns.adobe.com/xdm/common/address

Postal address Example

{
  "@id": "https://data.adobe.io/entities/address/123",
  "xdm:primary": false,
  "xdm:street1": "345 Park Ave",
  "xdm:city": "San Jose",
  "xdm:stateProvince": "US-CA",
  "xdm:postalCode": "95110",
  "xdm:country": "United States",
  "xdm:countryCode": "US",
  "schema:latitude": 37.3382,
  "schema:longitude": 121.8863,
  "xdm:status": "active",
  "xdm:lastVerifiedDate": "2018-01-02"
}

Postal address Properties

Property Type Required Default Defined by
@id string Optional Geo Coordinates
repo:createDate string Optional Audit trail
repo:modifyDate string Optional Audit trail
schema:description string Optional Geo Coordinates
schema:elevation number Optional Geo Coordinates
schema:latitude number Optional Geo Coordinates
schema:longitude number Optional Geo Coordinates
xdm:city string Optional Geo
xdm:country string Optional Postal address (this schema)
xdm:countryCode string Optional Geo
xdm:createdByBatchID string Optional Audit trail
xdm:dmaID integer Optional Geo
xdm:label string Optional Postal address (this schema)
xdm:lastVerifiedDate string Optional Postal address (this schema)
xdm:modifiedByBatchID string Optional Audit trail
xdm:msaID integer Optional Geo
xdm:postOfficeBox string Optional Postal address (this schema)
xdm:postalCode string Optional Geo
xdm:primary boolean Optional Postal address (this schema)
xdm:region string Optional Postal address (this schema)
xdm:repositoryCreatedBy string Optional Audit trail
xdm:repositoryLastModifiedBy string Optional Audit trail
xdm:stateProvince string Optional Geo
xdm:status string Optional "active" Postal address (this schema)
xdm:statusReason string Optional Postal address (this schema)
xdm:street1 string Optional Postal address (this schema)
xdm:street2 string Optional Postal address (this schema)
xdm:street3 string Optional Postal address (this schema)
xdm:street4 string Optional Postal address (this schema)
* any Additional this schema allows additional properties

@id

Coordinates ID

The unique identifier of the coordinates.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

repo:createDate Type

string

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:modifyDate

The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:modifyDate

repo:modifyDate Type

string

repo:modifyDate Example

"2004-10-23T12:00:00-06:00"

schema:description

Description

A description of what the coordinates identify.

schema:description

schema:description Type

string

schema:elevation

Elevation

The specific elevation of the defined coordinate. The value conforms to the WGS84 datum and is measured in meters.

schema:elevation

schema:elevation Type

number

schema:latitude

Latitude

The signed vertical coordinate of a geographic point.

schema:latitude

schema:latitude Type

number

  • minimum value: -90
  • maximum value: 90

schema:longitude

Longitude

The signed horizontal coordinate of a geographic point.

schema:longitude

schema:longitude Type

number

  • minimum value: -180
  • maximum value: 180

xdm:city

City

The name of the city.

xdm:city

  • is optional
  • type: string
  • defined in Geo

xdm:city Type

string

xdm:country

Country

The name of the government-administered territory. Other than xdm:countryCode, this is a free-form field that can have the country name in any language.

xdm:country

  • is optional
  • type: string
  • defined in this schema

xdm:country Type

string

xdm:countryCode

Country code

The two-character ISO 3166-1 alpha-2 code for the country.

xdm:countryCode

  • is optional
  • type: string
  • defined in Geo

xdm:countryCode Type

string

All instances must conform to this regular expression (test examples here):

^[A-Z]{2}$

xdm:createdByBatchID

Created by batch identifier

The dataset files in Catalog which has been originating the creation of the record.

xdm:createdByBatchID

xdm:createdByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:dmaID

Designated market area

The Nielsen media research designated market area.

xdm:dmaID

  • is optional
  • type: integer
  • defined in Geo

xdm:dmaID Type

integer

xdm:label

Label

Free form name of the address.

xdm:label

  • is optional
  • type: string
  • defined in this schema

xdm:label Type

string

xdm:lastVerifiedDate

Last verified date

The date that the address was last verified as still associated to the person.

xdm:lastVerifiedDate

  • is optional
  • type: string
  • defined in this schema

xdm:lastVerifiedDate Type

string

xdm:modifiedByBatchID

Modified by batch identifier

The last dataset files in Catalog which has modified the record. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

xdm:modifiedByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:msaID

Metropolitan statistical area

The metropolitan statistical area in the United States where the observation occurred.

xdm:msaID

  • is optional
  • type: integer
  • defined in Geo

xdm:msaID Type

integer

xdm:postOfficeBox

Post office box

Post office box of the address.

xdm:postOfficeBox

  • is optional
  • type: string
  • defined in this schema

xdm:postOfficeBox Type

string

  • maximum length: 20 characters

xdm:postalCode

Postal code

The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.

xdm:postalCode

  • is optional
  • type: string
  • defined in Geo

xdm:postalCode Type

string

xdm:primary

Primary

Primary address indicator. A profile can have only one primary address at a given point of time.

xdm:primary

  • is optional
  • type: boolean
  • defined in this schema

xdm:primary Type

boolean

xdm:region

Region

The region, county, or district portion of the address.

xdm:region

  • is optional
  • type: string
  • defined in this schema

xdm:region Type

string

xdm:repositoryCreatedBy

Created by user identifier

User ID of who created the record.

xdm:repositoryCreatedBy

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by user identifier

User ID of who last modified the record. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

xdm:repositoryLastModifiedBy Type

string

xdm:stateProvince

State or province

The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.

xdm:stateProvince

  • is optional
  • type: string
  • defined in Geo

xdm:stateProvince Type

string

All instances must conform to this regular expression

([A-Z]{2}-[A-Z0-9]{1,3}|)

xdm:stateProvince Examples

"US-CA"
"DE-BB"
"JP-13"

xdm:status

Status

An indication as to the ability to use the address.

xdm:status

  • is optional
  • type: string
  • default: "active"
  • defined in this schema

xdm:status Type

string

xdm:status Known Values

Value Description
active Active
incomplete Incomplete
pending_verification Pending verification
blacklisted Blacklisted
blocked Blocked

xdm:statusReason

Status reason

A description of the current status.

xdm:statusReason

  • is optional
  • type: string
  • defined in this schema

xdm:statusReason Type

string

xdm:street1

Street 1

Primary street level information, apartment number, street number, and street name.

xdm:street1

  • is optional
  • type: string
  • defined in this schema

xdm:street1 Type

string

xdm:street2

Street 2

Optional street information second line.

xdm:street2

  • is optional
  • type: string
  • defined in this schema

xdm:street2 Type

string

xdm:street3

Street 3

Optional street information third line.

xdm:street3

  • is optional
  • type: string
  • defined in this schema

xdm:street3 Type

string

xdm:street4

Street 4

Optional street information fourth line.

xdm:street4

  • is optional
  • type: string
  • defined in this schema

xdm:street4 Type

string