Alternate geographic address Data Model

Domain

The schema is part of the Domain

Description

Data model

A JSON Schema corresponding to this data model can be found here.

The Data model is defined as shown below:

  • href : An URI used to access to the address resource

  • Optional

  • id : Unique identifier of the address

  • Optional

  • name : A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]

  • Optional

  • role : Role of the place, such as: [home delivery], [shop retrieval])

  • Optional

  • city : City that the address is in

  • Optional

  • country : Country that the address is in

  • Optional

  • locality : An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]

  • Optional

  • postcode : descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)

  • Optional

  • stateOrProvince : the State or Province that the address is in

  • Optional

  • streetName : Name of the street or other street type

  • Optional

  • streetNr : Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses

  • Optional

  • streetNrLast : Last number in a range of street numbers allocated to a property

  • Optional

  • streetNrLastSuffix : Last street number suffix for a ranged address

  • Optional

  • streetNrSuffix : the first street number suffix

  • Optional

  • streetSuffix : A modifier denoting a relative direction

  • Optional

  • streetType : alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf

  • Optional

TMForum APIs that use this schema

Taking into consideration the snapshot of 04/02/2020 04:59:16 UTC the list of TMForum Open APIs that uses this schemas is:

Coming soon