GeographicAddress

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf622-product-ordering-geographic-address-schema.json",
  "title": "GeographicAddress",
  "description": "GeographicAddress schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Place"
    },
    {
      "type": "object",
      "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress",
      "properties": {
        "city": {
          "type": "string",
          "description": "City that the address is in"
        },
        "country": {
          "type": "string",
          "description": "Country that the address is in"
        },
        "locality": {
          "type": "string",
          "description": "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]"
        },
        "postcode": {
          "type": "string",
          "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)"
        },
        "stateOrProvince": {
          "type": "string",
          "description": "the State or Province that the address is in"
        },
        "streetName": {
          "type": "string",
          "description": "Name of the street or other street type"
        },
        "streetNr": {
          "type": "string",
          "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses"
        },
        "streetNrLast": {
          "type": "string",
          "description": "Last number in a range of street numbers allocated to a property"
        },
        "streetNrLastSuffix": {
          "type": "string",
          "description": "Last street number suffix for a ranged address"
        },
        "streetNrSuffix": {
          "type": "string",
          "description": "the first street number suffix"
        },
        "streetSuffix": {
          "type": "string",
          "description": "A modifier denoting a relative direction"
        },
        "streetType": {
          "type": "string",
          "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf "
        },
        "countryCode": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/StandardIdentifier"
          },
          "description": "Country codes are short alphabetic or numeric geographical codes (geocodes) developed to represent countries and dependent areas, for use in data processing and communications. Several different systems have been developed to do this. The term country code frequently refers to ISO 3166-1 alpha-2 or international dialing codes, the E.164 country calling codes."
        },
        "externalIdentifier": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ExternalIdentifier"
          }
        },
        "geographicLocation": {
          "$ref": "#/components/schemas/GeographicLocationRefOrValue"
        },
        "geographicSubAddress": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/GeographicSubAddress"
          }
        },
        "geographicAddressType": {
          "type": "string",
          "description": "Classification of the address, e.g., residential, industrial "
        }
      }
    }
  ]
}