LocationAPI.yaml

        type: string
        example: zone01
      accessPointId:
        description: >-
          Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI
          TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity
          (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3
          digit MNC. The Cell Portion is an optional element
        type: string
        example: '001010000000000000000000000000001'
      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
        format: uint32
        example: '20'
      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
        format: uint32
        example: '12'
      operationStatus:
        description: The operation status of the access point
        type: string
        example: Serviceable
      timestamp:
        description: Indicates the time of day for zonal presence notification.
        type: string
        format: date-time
        example: '2017-01-01T02:51:43Z'
      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.
        type: array
        items:
          required:
            - rel
            - href
          properties:
            rel:
              description: Describes the relationship between the URI and the resource.
              type: object
              format: string
            href:
              description: URI
              type: object
              format: anyURI
        example: >-
          rel="ZonalStatusSubscription"
          href="http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123"
  ZoneStatusSubscription:
    required:
      - callbackReference
      - zoneId
    properties:
      clientCorrelator:
        description: >-
          Uniquely identifies this create subscription request. If there is a
          communication failure during the request, using the same
          clientCorrelator when retrying the request allows the operator to
          avoid creating a duplicate subscription.
        type: string
        example: '0123'
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
      callbackReference:
        required:
          - notifyURL
        properties:
          notifyURL:
            description: The URL of your own listener application.
            type: string
            format: url
            example: 'http://clientApp.example.com/location_notifications/123456'
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      numberOfUsersZoneThreshold:
        description: >-
          Threshold number of users in a zone which if crossed shall cause a
          notification.
        type: integer
        format: uint32
        example: '40'
      numberOfUsersAPThreshold:
        description: >-
          Threshold number of users in an access point which if crossed shall
          cause a notification.
        type: integer
        format: uint32
        example: '20'
      operationStatus:
        description: >-
          List of operation status values to generate notifications for (these
          apply to all access points within a zone).
        type: array
        items:
          description: The operation status of the access point
          type: string
          example: Serviceable