Skip to content
LocationAPI.json 148 KiB
Newer Older
Michel Roy's avatar
Michel Roy committed
        }
      },
      "406": {
        "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "412": {
        "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "415": {
        "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "422": {
        "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      }
    },
    "parameters": {
      "Path.AccessPointId": {
        "name": "accessPointId",
        "in": "path",
        "description": "Identifier of access Point",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "AccessPointId"
      },
      "Path.SubscrId": {
        "name": "subscriptionId",
        "in": "path",
        "description": "Subscription Identifier, specifically the \"self\" returned in the subscription request",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uri"
        },
        "x-exportParamName": "SubscriptionId"
      },
      "Path.ZoneId": {
        "name": "zoneId",
        "in": "path",
        "description": "Indentifier of zone",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "ZoneId"
      },
      "Query.Subscription_type": {
        "name": "subscription_type",
Michel Roy's avatar
Michel Roy committed
        "in": "query",
        "description": "Query parameter to filter on a specific subscription type. Permitted values: event",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
        "x-exportParamName": "Subscription_type"
      "Query.Subscription_type_2": {
        "name": "subscription_type",
        "in": "query",
        "description": "Query parameter to filter on a specific subscription type. Permitted values: -event -periodic",
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "Subscription_type_2"
      },
      "Query.Subscription_type_3": {
        "name": "subscription_type",
        "in": "query",
        "description": "Query parameter to filter on a specific subscription type. Permitted values: -event -status",
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "Subscription_type_3"
      },
      "Query.AccessPointId": {
        "name": "accessPointId",
Michel Roy's avatar
Michel Roy committed
        "in": "query",
        "description": "Identifier of access point",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "AccessPointId"
      "Query.Address": {
Michel Roy's avatar
Michel Roy committed
        "name": "address",
        "in": "query",
        "description": "One or two addresses of user to check. The second \"address\" parameter shall not be included when the distance between a user and a location is requested. The second \"address\" parameter shall be included when a location is not provided.",
        "required": false,
Michel Roy's avatar
Michel Roy committed
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "Address"
      "Query.Address_2": {
        "name": "address",
Michel Roy's avatar
Michel Roy committed
        "in": "query",
        "description": "Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "Address_2"
      "Query.Address_3": {
        "name": "address",
Michel Roy's avatar
Michel Roy committed
        "in": "query",
        "description": "Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        "x-exportParamName": "Address_3"
      "Query.Location": {
        "name": "location",
Michel Roy's avatar
Michel Roy committed
        "in": "query",
        "description": "Shall not be included when the distance between two terminals is requested.",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
          "type": "object",
          "properties": {
            "latitude": {
              "description": "Location latitude, expressed in the range -90° to +90°.",
              "format": "float",
              "type": "number",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Float"
            },
            "longitude": {
              "description": "Location longitude, expressed in the range -180° to +180°.",
              "format": "float",
              "type": "number",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Float"
            }
          }
        "x-exportParamName": "Location"
Michel Roy's avatar
Michel Roy committed
      },
      "Query.ZoneId": {
        "name": "zoneId",
        "in": "query",
        "description": "Identifier of zone",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "ZoneId"
      },
      "Query.ZoneId_2": {
        "name": "zoneId",
        "in": "query",
        "description": "The identity of the zone",
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "ZoneId_2"
Michel Roy's avatar
Michel Roy committed
      }
    },
    "schemas": {
      "AccessPointInfo": {
        "description": "A type containing access point information.",
        "properties": {
          "accessPointId": {
            "description": "Identifier of access point.",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          },
          "connectionType": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ConnectionType"
Michel Roy's avatar
Michel Roy committed
          },
          "interestRealm": {
            "description": "Interest realm of access point.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "numberOfUsers": {
            "description": "Number of users currently on the access point.",
            "type": "integer",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "integer"
          },
          "operationStatus": {
            "$ref": "#/components/schemas/OperationStatus"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "timezone": {
            "description": "Time zone of access point.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "dateTimeStamp"
          }
        },
        "required": [
          "accessPointId",
          "connectionType",
          "operationStatus",
          "numberOfUsers",
          "resourceURL"
        ],
        "type": "object"
      },
      "OperationStatus": {
        "description": "An enumeration defining the operations status of an access point.",
        "enum": ["Serviceable", "Unserviceable", "Unknown"],
        "type": "string"
      },
      "AccessPointList": {
        "description": "A type containing list of access points.",
        "properties": {
          "accessPoint": {
            "description": "Collection of the access point information list.",
            "items": {
              "$ref": "#/components/schemas/AccessPointInfo"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "AccessPointInfo"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": ["zoneId", "resourceURL"],
        "type": "object"
      },
      "ConnectionType": {
        "description": "This enumeration represents the connection type of an access point",
        "enum": ["LTE", "Wifi", "Wimax", "5G NR", "UNKNOWN"],
        "type": "string"
      },
      "LocationInfo": {
        "properties": {
          "accuracy": {
            "description": "Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "accuracyAltitude": {
            "description": "Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 3 or 4.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "accuracySemiMinor": {
            "description": "Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "altitude": {
            "description": "Location altitude relative to the WGS84 ellipsoid surface.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Float"
          },
          "confidence": {
            "description": "Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if \"shape\" equals 1, 4 or 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "includedAngle": {
            "description": "Present only if \"shape\" equals 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "innerRadius": {
            "description": "Present only if \"shape\" equals 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "latitude": {
            "description": "Location latitude, expressed in the range -90° to +90°. Cardinality greater than one only if \"shape\" equals 7.",
            "format": "float",
            "items": {
              "type": "number"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "Float"
          },
          "longitude": {
            "description": "Location longitude, expressed in the range -180° to +180°. Cardinality greater than one only if \"shape\" equals 7.",
            "format": "float",
            "items": {
              "type": "number"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "Float"
          },
          "offsetAngle": {
            "description": "Present only if \"shape\" equals 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "orientationMajorAxis": {
            "description": "Angle of orientation of the major axis, expressed in the range 0° to 180°, as defined in [14]. Present only if \"shape\" equals 4 or 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "shape": {
            "description": "Shape information, as detailed in [14], associated with the reported location coordinate: 1 = Ellipsoid_Arc 2 = ellipsoid_Point 3 = ellipsoid_Point_Altitude 4 = ellipsoid_Point_Altitude_Uncert_Ellipsoid 5 = ellipsoid_Point_Uncert_Circle 6 = ellipsoid_Point_Uncert_Ellipse 7 = polygon",
            "enum": ["SEE_DESCRIPTION"],
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum_inlined"
          },
          "uncertaintyRadius": {
            "description": "Present only if \"shape\" equals 6.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "velocity": {
            "$ref": "#/components/schemas/Velocity"
          }
        },
        "required": ["latitude", "longitude", "shape"],
        "type": "object",
        "x-etsi-ref": "6.5.3"
      },
      "Velocity": {
        "description": "Structure with attributes relating to the target entity’s velocity, as defined in [14].",
        "properties": {
          "bearing": {
            "description": "Bearing, expressed in the range 0° to 360°, as defined in [14].",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "horizontalSpeed": {
            "description": "Horizontal speed, expressed in km/h and defined in [14].",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "uncertainty": {
            "description": "Horizontal uncertainty, as defined in [14]. Present only if \"velocityType\" equals 3 or 4.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          },
          "velocityType": {
            "description": "Velocity information, as detailed in [14], associated with the reported location coordinate: 1 = Horizontal 2 = Horizontal_Vertical 3 = Horizontal_Uncert 4 = Horizontal_Vertical_Uncert",
            "enum": ["SEE_DESCRIPTION"],
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum_inlined"
          },
          "verticalSpeed": {
            "description": "Vertical speed, expressed in km/h and defined in [14]. Present only if \"velocityType\" equals 2 or 4.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Int"
          },
          "verticalUncertainty": {
            "description": "Vertical uncertainty, as defined in [14]. Present only if \"velocityType\" equals 4.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          }
        },
        "required": ["velocityType", "bearing", "horizontalSpeed"],
        "type": "object",
        "x-etsi-mec-cardinality": "0..1",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
      "NotificationSubscriptionList": {
        "description": "This type contains a list of subscriptions.",
        "properties": {
          "resourceURL": {
            "$ref": "#/components/schemas/LinkType"
          },
          "subscription": {
            "items": {
              "$ref": "#/components/schemas/Subscription"
            },
            "type": "array"
          }
        },
        "required": ["resourceURL"],
        "type": "object",
        "x-etsi-ref": "6.3.3"
      },
      "TerminalDistance": {
        "description": "A type containing information about the distance from a terminal to a location or between two terminals, in addition the accuracy and a timestamp of the information are provided.",
        "properties": {
          "accuracy": {
            "description": "Accuracy of the provided distance in meters",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "integer"
          "distance": {
            "description": "Distance from terminal to a location or between two terminals specified in meters",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "integer"
          },
          "timestamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
        },
        "required": ["distance"],
        "type": "object"
      },
      "TerminalLocation": {
        "description": "A type containing device address, retrieval status and location information.",
        "properties": {
          "address": {
            "description": "Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "currentLocation": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "errorInformation": {
            "$ref": "#/components/schemas/ServiceError"
          },
          "locationRetrievalStatus": {
            "$ref": "#/components/schemas/RetrievalStatus"
        "required": ["address", "locationRetrievalStatus"],
Michel Roy's avatar
Michel Roy committed
        "type": "object"
      },
      "RetrievalStatus": {
        "enum": ["Retrieved", "NotRetrieved", "Error"],
        "type": "string"
      },
      "ServiceError": {
        "description": "Used to indicate a notification termination or cancellation.",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "messageId": {
            "description": "Message identifier, either with prefix SVC or with prefix POL",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          "text": {
            "description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          },
          "variables": {
            "description": "Variables to substitute into text string",
            "items": {
              "type": "string"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "string"
        "required": ["messageId", "text"],
Michel Roy's avatar
Michel Roy committed
        "type": "object"
      },
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "nanoSeconds": {
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          "seconds": {
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "format": "uint32",
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
        "required": ["seconds", "nanoSeconds"],
        "type": "object",
        "x-etsi-ref": "6.5.2"
      "UserInfo": {
        "description": "This type represents the information related to a user attached to an access point associated to the MEC host, such access point is in scope of the Location Service instance.",
        "required": [
          "address",
          "accessPointId",
          "zoneId",
          "resourceURL",
          "timestamp"
        ],
        "type": "object",
        "x-etsi-notes": "NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified in [5], clause 5.2.2.5.",
        "x-etsi-ref": "6.2.2",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "address": {
            "description": "Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "AnyURI"
          "AccessPointId": {
            "description": "The identity of the access point the user is currently on, see note 1.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          "zoneId": {
            "description": "The identity of the zone the user is currently within, see note 1.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          "resourceURL": {
            "description": "Self-referring URL, see note 1.",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "AnyURI"
          "timestamp": {
            "$ref": "#/components/schemas/TimeStamp"
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          "civicInfo": {
            "$ref": "#/components/schemas/CivicAddress"
          "ancillaryInfo": {
            "description": "Reserved for future use.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          "relativeLocationInfo": {
            "$ref": "#/components/schemas/RelativeLocationInfo"
          }
        }
      },
      "UserList": {
        "description": "A type containing list of users.",
        "properties": {
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          "user": {
            "description": "Collection of the zone information list.",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/UserInfo"
Michel Roy's avatar
Michel Roy committed
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UserInfo"
          }
        },
        "required": ["resourceURL"],
        "type": "object"
      },
      "ZoneInfo": {
        "description": "A type containing zone information.",
        "properties": {
          "numberOfAccessPoints": {
            "description": "The number of access points within the zone",
            "type": "integer",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "unsignedInt"
          "numberOfUnserviceableAccessPoints": {
            "description": "Number of inoperable access points within the zone.",
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "unsignedInt"
          "numberOfUsers": {
            "description": "The number of users currently on the access point.",
            "type": "integer",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "unsignedInt"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": [
          "zoneId",
          "numberOfAccessPoints",
          "numberOfUnserviceableAccessPoints",
          "numberOfUsers",
          "resourceURL"
        ],
        "type": "object"
      },
      "ZoneList": {
        "description": "A type containing a list of zones.",
        "properties": {
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "zone": {
            "description": "Collection of the zone information list.",
            "items": {
              "$ref": "#/components/schemas/ZoneInfo"
            },
            "type": "array"
          }
        },
        "required": ["resourceURL"],
        "type": "object"
      },
      "ZoneStatusNotification": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/_links"
          "accessPointId": {
            "description": "Identifier of an access point (e.g. ap01). Shall be included when userNumEvent related with access point or operationStatus is included.",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          "notificationType": {
            "description": "Shall be set to \"ZoneStatusNotification\".",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "operationStatus": {
            "$ref": "#/components/schemas/OperationStatus"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "userNumEvent": {
            "description": "Shall be present when ZoneStatusSubscription includes upperNumberOfUsersZoneThreshold, lowerNumberOfUsersZoneThreshold, upperNumberOfUsersAPThreshold or lowerNumberOfUsersAPThreshold, and the number of users in a zone or an access point crosses the threshold defined in the subscription: 1 = OVER_ZONE_UPPER_THD. 2 = UNDER_ZONE_LOWER_THD. 3 = OVER_AP_UPPER_THD. 4 = UNDER_AP_LOWER_THD.",
            "enum": ["SEE_DESCRIPTION"],
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Enum(inlined)"
          "zoneId": {
            "description": "The identity of the zone. ",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
        "required": ["notificationType", "zoneId", "_links"],
        "type": "object",
        "x-etsi-notes": "NOTE:\tAs specified in [5], clause 5.2.3.2.",
        "x-etsi-ref": "6.4.7"
      "ZoneStatusSubscription": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/_links"
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
            "format": "uri",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
          "clientCorrelator": {
            "description": "A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          "lowerNumberOfUsersAPThreshold": {
            "description": "Threshold number of users in an access point which if crossed downward shall cause a notification",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          "lowerNumberOfUsersZoneThreshold": {
            "description": "Threshold number of users in a zone which if crossed downward shall cause a notification",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          "operationStatus": {
            "description": "List of operation status values to generate notifications for (these apply to all access points within a zone). See note 3.",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/OperationStatus"
Michel Roy's avatar
Michel Roy committed
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "OperationStatus"
          "reportingCtrl": {
            "$ref": "#/components/schemas/ReportingCtrl"
          "requestTestNotification": {
            "description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Boolean"
          "subscriptionType": {
            "description": "Shall be set to \"ZoneStatusSubscription\".",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "upperNumberOfUsersAPThreshold": {
            "description": "Threshold number of users in an access point which if crossed upward shall cause a notification.",
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          "upperNumberOfUsersZoneThreshold": {
            "description": "Threshold number of users in a zone which if crossed upward shall cause a notification.",
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "UnsignedInt"
          "websockNotifConfig": {
            "$ref": "#/components/schemas/WebsockNotifConfig"
          },
          "zoneId": {
            "description": "Identifier of zone (e.g. zone001) to monitor.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
        "required": ["subscriptionType", "zoneId"],
        "type": "object",
        "x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [5], clause 5.2.3.2.",
        "x-etsi-ref": "6.3.7"
      "RelativeLocationInfo": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "X": {
            "description": "Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system. Positive value represents easting from origin.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Float"
          "Y": {
            "description": "Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system. Positive value represents northing from origin.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Float"
          },
          "Z": {
            "description": "Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3DPoint. Positive value represents height above origin.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Float"
          },
          "mapInfo": {
            "$ref": "#/components/schemas/MapInfo"
        "required": ["mapInfo", "X", "Y"],
        "type": "object",
        "x-etsi-ref": "6.2.3"
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "ancillaryMapInfo": {
            "description": "Ancillary map information may be used to convert coordinates between different coordinate systems.",
            "type": "object",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Not_specified"
          "mapId": {
            "description": "Indicates the ID of the map. ",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          "origin": {
            "$ref": "#/components/schemas/Origin"
          }
        },
        "required": ["mapId"],
        "type": "object",
        "x-etsi-ref": "6.2.4"
      },
      "Origin": {
        "description": "Indicates the location of the map origin in the local Cartesian coordinate system.",
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "altitude": {
            "description": "Location altitude relative to the WGS84 ellipsoid surface.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Float"
          },
          "latitude": {
            "description": "Location latitude, expressed in the range -90° to +90°.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Float"
          "longitude": {
            "description": "Location longitude, expressed in the range -180° to +180°.",
            "format": "float",
            "type": "number",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Float"
          }
        },
        "required": ["latitude", "longitude"],
        "type": "object",
        "x-etsi-mec-cardinality": "0..1",
        "x-etsi-mec-origin-type": "Structure(inlined)"
      },
      "Subscription": {
        "description": "",
        "minItems": 0,
        "properties": {
          "href": {
            "description": "The URI referring to the subscription.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uri"
          },
          "subscriptionType": {
            "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses 6.3.4, 6.3.5, 6.3.6, 6.3.7 6.3.8 and 6.3.9:\n\"UserLocationEventSubscription\"\n\"UserLocationPeriodicSubscription\"\n\"ZoneLocationEventSubscription\"\n\"ZoneStatusSubscription\"\n\"UserAreaSubscription\"\n\"UserDistanceSubscription\"",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": ["href", "subscriptionType"],
        "type": "object",
        "x-etsi-mec-cardinality": "0..N",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
      "LinkType": {
        "properties": {
          "href": {
            "description": "URI referring to a resource.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uri"
          }
        },
        "required": ["href"],
        "type": "object",
        "x-etsi-ref": "6.7.2"
      },
      "UserLocationEventSubscription": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/_links"
          },
          "address": {
            "description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI) to monitor.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uri"
          },
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
            "format": "uri",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
          "clientCorrelator": {
            "description": "A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "locationEventCriteria": {
            "description": "List of user event values to generate notifications for (these apply to address specified). ",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/LocationEventType"
Michel Roy's avatar
Michel Roy committed
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Array(LocationEventType)"
          },
          "requestTestNotification": {
            "description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "subscriptionType": {