LocationAPI.yaml 119 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
          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
          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
          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
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: unsignedInt
        numberOfUsersInZone:
Michel Roy's avatar
Michel Roy committed
          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
          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
      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:
Michel Roy's avatar
Michel Roy committed
          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
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        numberOfUsersAPThreshold:
Michel Roy's avatar
Michel Roy committed
          description: Threshold number of users in an access point which if crossed 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
        numberOfUsersZoneThreshold:
Michel Roy's avatar
Michel Roy committed
          description: Threshold number of users in a zone which if crossed 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:
Michel Roy's avatar
Michel Roy committed
          description: List of operation status values to generate notifications for (these apply to all access points within a zone).
Michel Roy's avatar
Michel Roy committed
          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