TM Forum · Schema

GeographicLocation

GeographicLocation schema from TM Forum API

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tmf622-product-ordering-geographic-location-schema.json Raw ↑
{
  "$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-location-schema.json",
  "title": "GeographicLocation",
  "description": "GeographicLocation schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Place"
    },
    {
      "type": "object",
      "description": "A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of the geographic location"
        },
        "href": {
          "type": "string",
          "description": "An URI used to access to the geographic location resource"
        },
        "@type": {
          "type": "string",
          "enum": [
            "GeoJsonPoint",
            "GeoJsonMultiPoint",
            "GeoJsonLineString",
            "GeoJsonMultiLineString",
            "GeoJsonPolygon"
          ],
          "description": "The name of the GeoJSON structure used in the geometry attribute"
        },
        "bbox": {
          "type": "array",
          "description": "A bounding box array that contains the geometry. The axes order follows the axes order of the geometry",
          "items": {
            "type": "number"
          }
        }
      }
    }
  ]
}