Address

Validate against: http://json-schema.org/draft-07/schema#

Schema ID: http://schemas.digitallinguistics.io/Address-2.2.0.json

Type: object

Description

A postal Address

Properties

The following properties are defined for this object:

  • Type: type

    Type: string

    Read-only: true

    Description

    The type of object. Must be set to Address.

    This item must have the following value:

    "Address"
  • Street Address: streetAddress

    Type: string

    Description

    The street address, not including apartment or unit number

  • Apartment / Unit Number: apartmentNumber

    Type: string

    Description

    The apartment or unit number, along with any abbreviations, e.g. Apt 20

  • Postal Box Number: postalBoxNumber

    Type: string

    Description

    The postal box number

  • Locality / City: locality

    Type: string

    Description

    The locality or city for this Address

  • Region / State: region

    Type: string

    Description

    The region or state for this Address

  • Country: country

    Type: string

    Description

    The country this address is located in

  • Postal Code: postalCode

    Type: string

    Description

    The postal code for this address (as a string rather than a number)

Additional Properties

Any additional properties must adhere to the following schema:

This schema imposes no restrictions. All values are valid.

Examples

The following are example values for this schema:

  • {
      "locality": "Kisii Town",
      "country": "Kenya"
    }
  • {
      "locality": "Charenton",
      "region": "Louisiana",
      "country": "United States"
    }
  • {
      "apartmentNumber": "B",
      "country": "United States",
      "locality": "New York",
      "postalBoxNumber": "1234",
      "postalCode": "12345-1234",
      "region": "New York",
      "streetAddress": "555 Market St.",
      "type": "Address"
    }