Skip to content
LocationAPI.json 152 KiB
Newer Older
Michel Roy's avatar
Michel Roy committed
            "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"],
Michel Roy's avatar
Michel Roy committed
        "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": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/OperationStatus"
Michel Roy's avatar
Michel Roy committed
          },
          "timestamp": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/TimeStamp"
Michel Roy's avatar
Michel Roy committed
          },
          "zoneId": {
            "description": "Identifier of zone",
            "type": "string",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "string"
          }
        },
        "required": ["zoneId", "timestamp"],
Michel Roy's avatar
Michel Roy committed
        "type": "object"
      },
      "ZoneStatusSubscription": {
        "description": "A type containing zone status subscription.",
        "properties": {
          "callbackReference": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/CallbackReference"
Michel Roy's avatar
Michel Roy committed
          },
          "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"],
Michel Roy's avatar
Michel Roy committed
        "type": "object"
      }
    }
  }