LocationAPI.yaml 119 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: dateTimeStamp
      required:
      - accessPointId
      - connectionType
      - operationStatus
      - numberOfUsers
      - resourceURL
      type: object
    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
    CallbackReference:
      properties:
        callbackData:
Michel Roy's avatar
Michel Roy committed
2037
          description: Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.
Michel Roy's avatar
Michel Roy committed
2038
2039
2040
2041
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        notificationFormat:
Michel Roy's avatar
Michel Roy committed
2042
          $ref: '#/components/schemas/NotificationFormat'
Michel Roy's avatar
Michel Roy committed
2043
2044
2045
2046
2047
2048
2049
2050
2051
        notifyURL:
          description: Notify Callback URL
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: anyURI
      required:
      - notifyURL
      type: object
    CircleNotificationSubscription:
Michel Roy's avatar
Michel Roy committed
2052
      description: A type containing data for notifications, when the area is defined as a circle.
Michel Roy's avatar
Michel Roy committed
2053
2054
      properties:
        address:
Michel Roy's avatar
Michel Roy committed
2055
          description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
Michel Roy's avatar
Michel Roy committed
2056
2057
2058
2059
2060
2061
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        callbackReference:
Michel Roy's avatar
Michel Roy committed
2062
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2063
2064
2065
2066
2067
2068
        checkImmediate:
          description: Check location immediately after establishing notification.
          type: boolean
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: boolean
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2069
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2070
2071
2072
2073
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        count:
Michel Roy's avatar
Michel Roy committed
2074
          description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
Michel Roy's avatar
Michel Roy committed
2075
2076
2077
2078
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        duration:
Michel Roy's avatar
Michel Roy committed
2079
          description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
Michel Roy's avatar
Michel Roy committed
2080
2081
2082
2083
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        enteringLeavingCriteria:
Michel Roy's avatar
Michel Roy committed
2084
          $ref: '#/components/schemas/EnteringLeavingCriteria'
Michel Roy's avatar
Michel Roy committed
2085
        frequency:
Michel Roy's avatar
Michel Roy committed
2086
          description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
Michel Roy's avatar
Michel Roy committed
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        latitude:
          description: Latitude of center point.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        longitude:
          description: Longitude of center point.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        radius:
          description: Radius circle around center point in meters.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        requester:
Michel Roy's avatar
Michel Roy committed
2116
          description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
Michel Roy's avatar
Michel Roy committed
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        trackingAccuracy:
          description: Number of meters of acceptable error in tracking distance.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
      required:
      - callbackReference
      - address
      - latitude
      - longitude
      - radius
      - trackingAccuracy
      - enteringLeavingCriteria
      - checkImmediate
      - frequency
      type: object
    ConnectionType:
      description: The connection type for the access point
      enum:
      - Femto
      - LTE-femto
      - Smallcell
      - LTE-smallcell
      - Wifi
      - Pico
      - Micro
      - Macro
      - Wimax
      - Unknown
      type: string
    DistanceCriteria:
      enum:
      - AllWithinDistance
      - AnyWithinDistance
      - AllBeyondDistance
      - AnyBeyondDistance
      type: string
    DistanceNotificationSubscription:
Michel Roy's avatar
Michel Roy committed
2164
      description: A type containing data for distance subscription, with reference to other devices.
Michel Roy's avatar
Michel Roy committed
2165
2166
      properties:
        callbackReference:
Michel Roy's avatar
Michel Roy committed
2167
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2168
2169
2170
2171
2172
2173
        checkImmediate:
          description: Check location immediately after establishing notification.
          type: boolean
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: boolean
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2174
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2175
2176
2177
2178
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        count:
Michel Roy's avatar
Michel Roy committed
2179
          description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
Michel Roy's avatar
Michel Roy committed
2180
2181
2182
2183
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        criteria:
Michel Roy's avatar
Michel Roy committed
2184
          $ref: '#/components/schemas/DistanceCriteria'
Michel Roy's avatar
Michel Roy committed
2185
2186
2187
2188
2189
2190
2191
        distance:
          description: Distance between devices that shall be monitored.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
        duration:
Michel Roy's avatar
Michel Roy committed
2192
          description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
Michel Roy's avatar
Michel Roy committed
2193
2194
2195
2196
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        frequency:
Michel Roy's avatar
Michel Roy committed
2197
          description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
Michel Roy's avatar
Michel Roy committed
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        monitoredAddress:
Michel Roy's avatar
Michel Roy committed
2209
          description: Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
Michel Roy's avatar
Michel Roy committed
2210
2211
2212
2213
2214
2215
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        referenceAddress:
Michel Roy's avatar
Michel Roy committed
2216
          description: Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
Michel Roy's avatar
Michel Roy committed
2217
2218
2219
2220
2221
2222
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: anyURI
        requester:
Michel Roy's avatar
Michel Roy committed
2223
          description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
Michel Roy's avatar
Michel Roy committed
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        trackingAccuracy:
          description: Number of meters of acceptable error in tracking distance.
          format: float
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: float
      required:
      - callbackReference
      - monitoredAddress
      - distance
      - trackingAccuracy
      - criteria
      - checkImmediate
      - frequency
      type: object
    EnteringLeavingCriteria:
      enum:
      - Entering
      - Leaving
      type: string
    Link:
      description: Link to other resources
      properties:
        href:
          description: URI
          format: anyURI
          type: string
        rel:
          description: Describes the relationship between the URI and the resource.
          type: string
      required:
      - rel
      - href
      type: object
    LocationInfo:
      properties:
        accuracy:
Michel Roy's avatar
Michel Roy committed
2269
          description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
Michel Roy's avatar
Michel Roy committed
2270
2271
2272
2273
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        accuracyAltitude:
Michel Roy's avatar
Michel Roy committed
2274
          description: Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4
Michel Roy's avatar
Michel Roy committed
2275
2276
2277
2278
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        accuracySemiMinor:
Michel Roy's avatar
Michel Roy committed
2279
          description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
Michel Roy's avatar
Michel Roy committed
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
          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:
Michel Roy's avatar
Michel Roy committed
2290
          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
Michel Roy's avatar
Michel Roy committed
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
          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:
Michel Roy's avatar
Michel Roy committed
2305
          description: "Location latitude, expressed in the range -90\xB0 to +90\xB0. Cardinality greater than one only if \"shape\" equals 7."
Michel Roy's avatar
Michel Roy committed
2306
2307
2308
2309
2310
2311
2312
2313
          items:
            format: float
            type: number
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Float
        longitude:
Michel Roy's avatar
Michel Roy committed
2314
          description: "Location longitude, expressed in the range -180\xB0 to +180\xB0. Cardinality greater than one only if \"shape\" equals 7."
Michel Roy's avatar
Michel Roy committed
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
          items:
            format: float
            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:
Michel Roy's avatar
Michel Roy committed
2328
          description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6"
Michel Roy's avatar
Michel Roy committed
2329
2330
2331
2332
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        shape:
Michel Roy's avatar
Michel Roy committed
2333
2334
          description: 'Shape information, as detailed in [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
          type: integer
Michel Roy's avatar
Michel Roy committed
2335
2336
2337
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
        timestamp:
Michel Roy's avatar
Michel Roy committed
2338
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
2339
2340
2341
2342
2343
2344
        uncertaintyRadius:
          description: Present only if "shape" equals 6
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        velocity:
Michel Roy's avatar
Michel Roy committed
2345
          description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]."
Michel Roy's avatar
Michel Roy committed
2346
2347
          properties:
            bearing:
Michel Roy's avatar
Michel Roy committed
2348
              description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
Michel Roy's avatar
Michel Roy committed
2349
2350
2351
2352
2353
2354
2355
2356
2357
              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:
Michel Roy's avatar
Michel Roy committed
2358
              description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4
Michel Roy's avatar
Michel Roy committed
2359
2360
2361
2362
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: UnsignedInt
            velocityType:
Michel Roy's avatar
Michel Roy committed
2363
2364
              description: 'Velocity information, as detailed in [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
              type: integer
Michel Roy's avatar
Michel Roy committed
2365
2366
2367
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Enum_inlined
            verticalSpeed:
Michel Roy's avatar
Michel Roy committed
2368
              description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4
Michel Roy's avatar
Michel Roy committed
2369
2370
2371
2372
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: Int
            verticalUncertainty:
Michel Roy's avatar
Michel Roy committed
2373
              description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4
Michel Roy's avatar
Michel Roy committed
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
              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)
      required:
      - latitude
      - longitude
      - shape
      type: object
      x-etsi-ref: 6.5.3
    NotificationFormat:
      enum:
      - XML
      - JSON
      type: string
    NotificationSubscriptionList:
      properties:
        circleNotificationSubscription:
Michel Roy's avatar
Michel Roy committed
2398
          description: Collection of CircleNotificationSubscription elements, see note 2.
Michel Roy's avatar
Michel Roy committed
2399
2400
2401
2402
2403
2404
2405
          items:
            $ref: '#/components/schemas/CircleNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: CircleNotificationSubscription
        distanceNotificationSubscription:
Michel Roy's avatar
Michel Roy committed
2406
          description: Collection of DistanceNotificationSubscription elements, see note 2.
Michel Roy's avatar
Michel Roy committed
2407
2408
2409
2410
2411
2412
2413
          items:
            $ref: '#/components/schemas/DistanceNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: DistanceNotificationSubscription
        periodicNotificationSubscription:
Michel Roy's avatar
Michel Roy committed
2414
          description: Collection of PeriodicNotificationSubscription elements, see note 2.
Michel Roy's avatar
Michel Roy committed
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
          items:
            $ref: '#/components/schemas/PeriodicNotificationSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: PeriodicNotificationSubscription
        resourceURL:
          description: Self-referring URL, see note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: AnyURI
        userTrackingSubscription:
          description: Collection of UserTrackingSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/UserTrackingSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: UserTrackingSubscription
        zonalTrafficSubscription:
          description: Collection of ZonalTrafficSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/ZonalTrafficSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: ZonalTrafficSubscription
        zoneStatusSubscription:
          description: Collection of ZoneStatusSubscription elements, see note 1.
          items:
            $ref: '#/components/schemas/ZoneStatusSubscription'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0.. N
          x-etsi-mec-origin-type: ZoneStatusSubscription
      required:
      - resourceURL
      type: object
Michel Roy's avatar
Michel Roy committed
2454
      x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.8.\nNOTE 2: \tAs specified in [6], clause 5.2.2.7."
Michel Roy's avatar
Michel Roy committed
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
      x-etsi-ref: 6.3.3
    OperationStatus:
      enum:
      - Serviceable
      - Unserviceable
      - Unknown
      type: string
    PeriodicNotificationSubscription:
      description: A type containing data for periodic subscription.
      properties:
        address:
Michel Roy's avatar
Michel Roy committed
2466
          description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
Michel Roy's avatar
Michel Roy committed
2467
2468
2469
2470
2471
2472
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: anyURI
        callbackReference:
Michel Roy's avatar
Michel Roy committed
2473
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2474
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2475
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2476
2477
2478
2479
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        duration:
Michel Roy's avatar
Michel Roy committed
2480
          description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
Michel Roy's avatar
Michel Roy committed
2481
2482
2483
2484
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: int
        frequency:
Michel Roy's avatar
Michel Roy committed
2485
          description: Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.
Michel Roy's avatar
Michel Roy committed
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        requestedAccuracy:
          description: Accuracy of the provided distance in meters.
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: int
        requester:
Michel Roy's avatar
Michel Roy committed
2502
          description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
Michel Roy's avatar
Michel Roy committed
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        resourceURL:
          description: Self referring URL
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
      required:
      - callbackReference
      - address
      - requestedAccuracy
      - frequency
      type: object
    ProblemDetails:
      properties:
        detail:
Michel Roy's avatar
Michel Roy committed
2520
          description: A human-readable explanation specific to this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
2521
2522
2523
2524
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
Michel Roy's avatar
Michel Roy committed
2525
          description: A URI reference that identifies the specific occurrence of the problem
Michel Roy's avatar
Michel Roy committed
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
Michel Roy's avatar
Michel Roy committed
2542
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Michel Roy's avatar
Michel Roy committed
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    RetrievalStatus:
      enum:
      - Retrieved
      - NotRetrieved
      - Error
      type: string
    ServiceError:
      description: used to indicate a notification termination or cancellation.
      properties:
        messageId:
          description: Message identifier, either with prefix SVC or with prefix POL
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: string
        text:
Michel Roy's avatar
Michel Roy committed
2563
          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
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
          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
      type: object
    SubscriptionCancellationNotification:
      description: A type containing the subscription cancellation notification.
      properties:
        address:
          description: Address of terminal if the error applies to an individual terminal.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: anyURI
        callbackData:
Michel Roy's avatar
Michel Roy committed
2587
          description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
Michel Roy's avatar
Michel Roy committed
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
          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 the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        reason:
Michel Roy's avatar
Michel Roy committed
2599
          $ref: '#/components/schemas/ServiceError'
Michel Roy's avatar
Michel Roy committed
2600
2601
2602
2603
2604
2605
2606
      required:
      - terminalLocation
      type: object
    SubscriptionNotification:
      description: A type containing the notification subscription.
      properties:
        callbackData:
Michel Roy's avatar
Michel Roy committed
2607
          description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
Michel Roy's avatar
Michel Roy committed
2608
2609
2610
2611
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        distanceCriteria:
Michel Roy's avatar
Michel Roy committed
2612
          $ref: '#/components/schemas/DistanceCriteria'
Michel Roy's avatar
Michel Roy committed
2613
        enteringLeavingCriteria:
Michel Roy's avatar
Michel Roy committed
2614
          $ref: '#/components/schemas/EnteringLeavingCriteria'
Michel Roy's avatar
Michel Roy committed
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
        isFinalNotification:
          description: Set to true if it is a final notification about location change.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: boolean
        link:
          description: Link to other resources that are in relationship with the resource.
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        terminalLocation:
          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
      required:
      - terminalLocation
      type: object
    TerminalDistance:
Michel Roy's avatar
Michel Roy committed
2638
      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.
Michel Roy's avatar
Michel Roy committed
2639
2640
2641
2642
2643
2644
2645
      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:
Michel Roy's avatar
Michel Roy committed
2646
          description: Distance from terminal to a location or between two terminals specified in meters
Michel Roy's avatar
Michel Roy committed
2647
2648
2649
2650
          type: integer
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: integer
        timestamp:
Michel Roy's avatar
Michel Roy committed
2651
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
2652
2653
2654
2655
      required:
      - distance
      type: object
    TerminalLocation:
Michel Roy's avatar
Michel Roy committed
2656
      description: A type containing device address, retrieval status and location information.
Michel Roy's avatar
Michel Roy committed
2657
2658
      properties:
        address:
Michel Roy's avatar
Michel Roy committed
2659
          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
2660
2661
2662
2663
          type: string
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: anyURI
        currentLocation:
Michel Roy's avatar
Michel Roy committed
2664
          $ref: '#/components/schemas/LocationInfo'
Michel Roy's avatar
Michel Roy committed
2665
        errorInformation:
Michel Roy's avatar
Michel Roy committed
2666
          $ref: '#/components/schemas/ServiceError'
Michel Roy's avatar
Michel Roy committed
2667
        locationRetrievalStatus:
Michel Roy's avatar
Michel Roy committed
2668
          $ref: '#/components/schemas/RetrievalStatus'
Michel Roy's avatar
Michel Roy committed
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
      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:
          description: 'The nanoseconds part of the time. Time is defined as
            Unix-time since January 1, 1970, 00:00:00 UTC.'
Michel Roy's avatar
Michel Roy committed
2685
          format: uint32
Michel Roy's avatar
Michel Roy committed
2686
          type: integer
Michel Roy's avatar
Michel Roy committed
2687
2688
2689
2690
2691
          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.'
Michel Roy's avatar
Michel Roy committed
2692
          format: uint32
Michel Roy's avatar
Michel Roy committed
2693
          type: integer
Michel Roy's avatar
Michel Roy committed
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
          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:
Michel Roy's avatar
Michel Roy committed
2710
          description: The identity of the access point the user is currently on, see note 1.
Michel Roy's avatar
Michel Roy committed
2711
2712
2713
2714
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        address:
Michel Roy's avatar
Michel Roy committed
2715
          description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
Michel Roy's avatar
Michel Roy committed
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
          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:
Michel Roy's avatar
Michel Roy committed
2726
          description: Contextual information of a user location (e.g. aisle, floor, room number, etc.).
Michel Roy's avatar
Michel Roy committed
2727
2728
2729
2730
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        locationInfo:
Michel Roy's avatar
Michel Roy committed
2731
          $ref: '#/components/schemas/LocationInfo'
Michel Roy's avatar
Michel Roy committed
2732
2733
2734
2735
2736
2737
        resourceURL:
          description: Self-referring URL, see note 1.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timestamp:
Michel Roy's avatar
Michel Roy committed
2738
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
2739
        zoneId:
Michel Roy's avatar
Michel Roy committed
2740
          description: The identity of the zone the user is currently within, see note 1.
Michel Roy's avatar
Michel Roy committed
2741
2742
2743
2744
2745
2746
2747
2748
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - address
      - accessPointId
      - zoneId
      - resourceURL
Michel Roy's avatar
Michel Roy committed
2749
      - timestamp
Michel Roy's avatar
Michel Roy committed
2750
      type: object
Michel Roy's avatar
Michel Roy committed
2751
      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."
Michel Roy's avatar
Michel Roy committed
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
      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:
Michel Roy's avatar
Michel Roy committed
2780
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2781
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2782
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2783
2784
2785
2786
2787
2788
2789
2790
2791
          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:
Michel Roy's avatar
Michel Roy committed
2792
          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.
Michel Roy's avatar
Michel Roy committed
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
          items:
            $ref: '#/components/schemas/UserEventType'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UserEventType
      required:
      - callbackReference
      - address
      type: object
    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:
Michel Roy's avatar
Michel Roy committed
2811
          description: CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].
Michel Roy's avatar
Michel Roy committed
2812
2813
2814
2815
2816
2817
2818
2819
2820
          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:
Michel Roy's avatar
Michel Roy committed
2821
          description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
Michel Roy's avatar
Michel Roy committed
2822
2823
2824
2825
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        link:
Michel Roy's avatar
Michel Roy committed
2826
          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
Michel Roy's avatar
Michel Roy committed
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
          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:
Michel Roy's avatar
Michel Roy committed
2838
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
2839
        userEventType:
Michel Roy's avatar
Michel Roy committed
2840
          $ref: '#/components/schemas/UserEventType'
Michel Roy's avatar
Michel Roy committed
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
        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:
Michel Roy's avatar
Michel Roy committed
2857
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2858
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2859
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2860
2861
2862
2863
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        duration:
Michel Roy's avatar
Michel Roy committed
2864
          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.
Michel Roy's avatar
Michel Roy committed
2865
2866
2867
2868
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: unsignedInt
        interestRealm:
Michel Roy's avatar
Michel Roy committed
2869
          description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
Michel Roy's avatar
Michel Roy committed
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
          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:
Michel Roy's avatar
Michel Roy committed
2881
2882
2883
2884
          description: List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier 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
Michel Roy's avatar
Michel Roy committed
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
          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:
Michel Roy's avatar
Michel Roy committed
2956
          description: CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].
Michel Roy's avatar
Michel Roy committed
2957
2958
2959
2960
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        link:
Michel Roy's avatar
Michel Roy committed
2961
          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
Michel Roy's avatar
Michel Roy committed
2962
2963
2964
2965
2966
2967
          items:
            $ref: '#/components/schemas/Link'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Link
        numberOfUsersInAP:
Michel Roy's avatar
Michel Roy committed
2968
          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.
Michel Roy's avatar
Michel Roy committed
2969
2970
2971
2972
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: unsignedInt
        numberOfUsersInZone:
Michel Roy's avatar
Michel Roy committed
2973
          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.
Michel Roy's avatar
Michel Roy committed
2974
2975
2976
2977
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: unsignedInt
        operationStatus:
Michel Roy's avatar
Michel Roy committed
2978
          $ref: '#/components/schemas/OperationStatus'
Michel Roy's avatar
Michel Roy committed
2979
        timestamp:
Michel Roy's avatar
Michel Roy committed
2980
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
        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:
Michel Roy's avatar
Michel Roy committed
2994
          $ref: '#/components/schemas/CallbackReference'
Michel Roy's avatar
Michel Roy committed
2995
        clientCorrelator:
Michel Roy's avatar
Michel Roy committed
2996
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
Michel Roy's avatar
Michel Roy committed
2997
2998
2999
3000
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        numberOfUsersAPThreshold:
For faster browsing, not all history is shown. View entire blame