LocationAPI.json

          },
          "errorInformation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceError"
              }
            ],
            "description": "This is the reason for error.",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "ServiceError"
          },
          "locationRetrievalStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RetrievalStatus"
              }
            ],
            "description": "Status of retrieval for this terminal address.",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "RetrievalStatus"
          }
        },
        "required": [
          "address",
          "locationRetrievalStatus"
        ],
        "type": "object"
      },
      "TerminalLocationList": {
        "description": "Collection of the terminal locations.",
        "items": {
          "$ref": "#/components/schemas/TerminalLocation"
        },
        "type": "array",
        "x-etsi-mec-cardinality": "1..N",
        "x-etsi-mec-origin-type": "TerminalLocation"
      },
      "TimeStamp": {
        "properties": {
          "nanoSeconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "seconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          }
        },
        "required": [
          "seconds",
          "nanoSeconds"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.2"
      },
      "UserEventType": {
        "enum": [
          "Entering",
          "Leaving",
          "Transferring"
        ],
        "type": "string"
      },
      "UserInfo": {
        "properties": {
          "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"
          },
          "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"
          },
          "ancillaryInfo": {
            "description": "Reserved for future use.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "contextLocationInfo": {
            "description": "Contextual information of a user location (e.g. aisle, floor, room number, etc.).",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "locationInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LocationInfo"
              }
            ],
            "description": "The geographical coordinates where the user is, see note 2.",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "LocationInfo"
          },
          "resourceURL": {
            "description": "Self-referring URL, see note 1.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "timestamp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeStamp"
              }
            ],
            "description": "Date and time that location was collected.",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "TimeStamp"
          },
          "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"
          }
        },
        "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"
      },
      "UserList": {
        "description": "A type containing list of users.",
        "properties": {
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "user": {
            "description": "Collection of the zone information list.",
            "items": {
              "$ref": "#/components/schemas/UserInfo"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UserInfo"
          }
        },
        "required": [
          "resourceURL"
        ],
        "type": "object"
      },
      "UserTrackingSubscription": {
        "description": "A type containing user tracking subscription.",
        "properties": {
          "address": {
            "description": "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "callbackReference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallbackReference"
              }
            ],
            "description": "Notification callback definition",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "CallbackReference"
          },
          "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.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "anyURI"
          },
          "userEventCriteria": {
            "description": "List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.",
            "items": {
              "$ref": "#/components/schemas/UserEventType"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UserEventType"
          }
        },
        "required": [
          "callbackReference",
          "address"
        ],
        "type": "object"
      },
      "VirtualNetworkInterfaceRequirements": {
        "type": "string"
      },
      "ZonalPresenceNotification": {
        "description": "A type containing zonal presence notification",
        "properties": {
          "address": {
            "description": "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "anyURI"
          },
          "callbackData": {
            "description": "CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "currentAccessPointId": {
            "description": "Identifier of access point.",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          },
          "interestRealm": {
            "description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "link": {
            "description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification",
            "items": {
              "$ref": "#/components/schemas/Link"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Link"
          },
          "previousAccessPointId": {
            "description": "Identifier of access point.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "timestamp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeStamp"
              }
            ],
            "description": "Indicates the time of the day for zonal presence notification.",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "TimeStamp"
          },
          "userEventType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserEventType"
              }
            ],
            "description": "User Event.",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "UserEventType"
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": [
          "zoneId",
          "address",
          "userEventType",
          "currentAccessPointId",
          "timestamp"
        ],
        "type": "object"
      },
      "ZonalTrafficSubscription": {
        "description": "A type containing zonal traffic subscription",
        "properties": {
          "callbackReference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallbackReference"
              }
            ],
            "description": "Notification callback definition",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "CallbackReference"
          },
          "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.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "duration": {
            "description": "Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the   period of time for which the subscription will still be valid.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "unsignedInt"
          },
          "interestRealm": {
            "description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
            "items": {
              "type": "string"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "string"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "anyURI"
          },
          "userEventCriteria": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserEventType"
              }
            ],
            "description": "List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UserEventType"
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": [
          "callbackReference",
          "zoneId"
        ],
        "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",
            "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",
            "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": {
        "description": "A type containing zone status notification.",
        "properties": {
          "accessPointId": {
            "description": "Identifier of an access point.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "callbackData": {
            "description": "CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "link": {
            "description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification",
            "items": {
              "$ref": "#/components/schemas/Link"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Link"
          },
          "numberOfUsersInAP": {
            "description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "unsignedInt"
          },
          "numberOfUsersInZone": {
            "description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "unsignedInt"
          },
          "operationStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OperationStatus"
              }
            ],
            "description": "This element shall be present when ZoneStatusSubscription includes operationStatus element and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription.",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "OperationStatus"
          },
          "timestamp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeStamp"
              }
            ],
            "description": "Indicates the timeof day for zone status notification.",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "TimeStamp"
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": [
          "zoneId",
          "timestamp"
        ],
        "type": "object"
      },
      "ZoneStatusSubscription": {
        "description": "A type containing zone status subscription.",
        "properties": {
          "callbackReference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallbackReference"
              }
            ],
            "description": "Notification callback definition",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          },
          "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.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "string"
          },
          "numberOfUsersAPThreshold": {
            "description": "Threshold number of users in an access point which if crossed shall cause a notification",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "unsignedInt"
          },
          "numberOfUsersZoneThreshold": {
            "description": "Threshold number of users in a zone which if crossed shall cause a notification",
            "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).",
            "items": {
              "$ref": "#/components/schemas/OperationStatus"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "OperationStatus"
          },
          "resourceURL": {
            "description": "Self referring URL",
            "type": "string",
            "x-etsi-mec-cardinality": "0..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": [
          "callbackReference",
          "zoneId"
        ],
        "type": "object"
      }
    }
  }
}