LocationAPI.yaml

                        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
          examples:
            application/json:
              zoneStatusSubscription:
                clientCorrelator: '0123'
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123
                callbackReference:
                  notifyURL: 'http://clientApp.example.com/location_notifications/123456'
                zoneId: zone01
                numberOfUsersZoneThreshold: '500'
                operationStatus: Serviceable
    put:
      description: >-
        This operation is used for updating an individual subscription to zone
        status change notification.
      produces:
        - application/json
      parameters:
        - name: subscriptionId
          in: path
          description: Subscription ID
          required: true
          type: string
        - name: zoneStatusSubscription
          in: body
          description: Zone Status Subscription
          required: true
          schema:
            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
      responses:
        '200':
          description: Response to update individual zone status subscription
          schema:
            properties:
              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
          examples:
            application/json:
              zoneStatusSubscription:
                clientCorrelator: '0123'
                resourceURL: >-
                  http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123
                callbackReference:
                  notifyURL: 'http://clientApp.example.com/location_notifications/123456'
                zoneId: zone01
                numberOfUsersZoneThreshold: '500'
                operationStatus: Serviceable
definitions:
  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'
  AccessPointInfo:
    required:
      - accessPointId
      - connectionType
      - operationStatus
      - numberOfUsers
      - resourceURL
    properties:
      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'
      locationInfo:
        description: >-
          A type containing location information with latitude, longitude and
          altitude, in addition the accuracy of the information are provided.
        type: object
        required:
          - latitude
          - longitude
          - accuracy
        properties:
          latitude:
            type: number
            format: float
            example: '80.123'
          longitude:
            type: number
            format: float
            example: '70.123'
          altitude:
            type: number
            format: float
            example: '10.0'
          accuracy:
            type: integer
            format: int32
            example: '10'
      connectionType:
        description: The connection type for the access point
        type: string
        example: Macro
      operationStatus:
        description: The operation status of the access point
        type: string
        example: Serviceable
      numberOfUsers:
        description: The number of users currently on the access point.
        type: integer
        format: uint32
        example: '7'
      timezone:
        description: Time zone of access point
        type: string
        format: date-time
        example: '2017-01-01T02:51:43Z'
      interestRealm:
        description: >-
          Interest realm of access point (e.g. geographical area, a type of
          industry etc.).
        type: string
        example: LA
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  AccessPointList:
    required:
      - zoneId
      - resourceURL
    properties:
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      accessPoint:
        description: Collection of the access point information list.
        type: array
        items:
          required:
            - accessPointId
            - connectionType
            - operationStatus
            - numberOfUsers
            - resourceURL
          properties:
            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'
            locationInfo:
              description: >-
                A type containing location information with latitude, longitude
                and altitude, in addition the accuracy of the information are
                provided.
              type: object
              required:
                - latitude
                - longitude
                - accuracy
              properties:
                latitude:
                  type: number
                  format: float
                  example: '80.123'
                longitude:
                  type: number
                  format: float
                  example: '70.123'
                altitude:
                  type: number
                  format: float
                  example: '10.0'
                accuracy:
                  type: integer
                  format: int32
                  example: '10'
            connectionType:
              description: The connection type for the access point
              type: string
              example: Macro
            operationStatus:
              description: The operation status of the access point
              type: string
              example: Serviceable
            numberOfUsers:
              description: The number of users currently on the access point.
              type: integer
              format: uint32
              example: '7'
            timezone:
              description: Time zone of access point
              type: string
              format: date-time
              example: '2017-01-01T02:51:43Z'
            interestRealm:
              description: >-
                Interest realm of access point (e.g. geographical area, a type
                of industry etc.).
              type: string
              example: LA
            resourceURL:
              description: Self referring URL.
              type: string
              format: uri
              example: >-
                http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  Address:
    description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
    type: string
    format: uri
    example: 'acr:192.0.2.1'
  AncillaryInfo:
    required:
      - address
    properties:
      address:
        description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
        type: string
        format: uri
        example: 'acr:192.0.2.1'
  CallbackData:
    description: >-
      CallBackData if passed by the application during the associated
      ZonalTrafficSubscription and UserTrackingSubscription operation. See
      [REST_NetAPI_Common].
    type: string
    example: '1234'
  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'
  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'
  ConnectionType:
    description: The connection type for the access point
    type: string
    example: Macro
  ContextLocationInfo:
    description: >-
      Contextual information of a user location (e.g., aisle, floor, room
      number, etc.)
    type: string
    example: GroundFoor
  CurrentAccessPointId:
    description: Zone ID
    type: string
    example: zone01
  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: string
    example: '0'
  InterestRealm:
    description: >-
      Interest realm of access point (e.g. geographical area, a type of industry
      etc.).
    type: string
    example: LA
  Link:
    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
  LocationInfo:
    description: >-
      A type containing location information with latitude, longitude and
      altitude, in addition the accuracy of the information are provided.
    type: object
    required:
      - latitude
      - longitude
      - accuracy
    properties:
      latitude:
        type: number
        format: float
        example: '80.123'
      longitude:
        type: number
        format: float
        example: '70.123'
      altitude:
        type: number
        format: float
        example: '10.0'
      accuracy:
        type: integer
        format: int32
        example: '10'
  NotifyURL:
    description: The URL of your own listener application.
    type: string
    format: url
    example: 'http://clientApp.example.com/location_notifications/123456'
  NumberOfAccessPoints:
    description: The number of access points within the zone
    type: integer
    format: uint32
    example: '10'
  NumberOfUnserviceableAccessPoints:
    description: Number of inoperable access points within the zone.
    type: integer
    format: uint32
    example: '9'
  NumberOfUsers:
    description: The number of users currently on the access point.
    type: integer
    format: uint32
    example: '7'
  NumberOfUsersAPThreshold:
    description: >-
      Threshold number of users in an access point which if crossed shall cause
      a notification.
    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'
  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'
  NumberOfUsersZoneThreshold:
    description: >-
      Threshold number of users in a zone which if crossed shall cause a
      notification.
    type: integer
    format: uint32
    example: '40'
  OperationStatus:
    description: The operation status of the access point
    type: string
    example: Serviceable
  PreviousAccessPointId:
    description: Zone ID
    type: string
    example: zone02
  ResourceURL:
    description: Self referring URL.
    type: string
    format: uri
    example: >-
      http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  Timestamp:
    description: Indicates the time of day for zonal presence notification.
    type: string
    format: date-time
    example: '2017-01-01T02:51:43Z'
  Timezone:
    description: Time zone of access point
    type: string
    format: date-time
    example: '2017-01-01T02:51:43Z'
  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.
    type: array
    items:
      description: User event
      type: string
      example: Entering
  UserEventType:
    description: User event
    type: string
    example: Entering
  UserInfo:
    required:
      - address
      - accessPointId
      - zoneId
      - resourceURL
    properties:
      address:
        description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
        type: string
        format: uri
        example: 'acr:192.0.2.1'
      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'
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
      locationInfo:
        description: >-
          A type containing location information with latitude, longitude and
          altitude, in addition the accuracy of the information are provided.
        type: object
        required:
          - latitude
          - longitude
          - accuracy
        properties:
          latitude:
            type: number
            format: float
            example: '80.123'
          longitude:
            type: number
            format: float
            example: '70.123'
          altitude:
            type: number
            format: float
            example: '10.0'
          accuracy:
            type: integer
            format: int32
            example: '10'
      contextLocationInfo:
        description: >-
          Contextual information of a user location (e.g., aisle, floor, room
          number, etc.)
        type: string
        example: GroundFoor
      ancillaryInfo:
        required:
          - address
        properties:
          address:
            description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
            type: string
            format: uri
            example: 'acr:192.0.2.1'
  UserList:
    description: A type containing list of users.
    required:
      - resourceURL
    properties:
      user:
        description: Collection of the zone information list.
        type: array
        items:
          required:
            - address
            - accessPointId
            - zoneId
            - resourceURL
          properties:
            address:
              description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
              type: string
              format: uri
              example: 'acr:192.0.2.1'
            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'
            zoneId:
              description: Identifier of zone
              type: string
              example: zone01
            resourceURL:
              description: Self referring URL.
              type: string
              format: uri
              example: >-
                http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
            locationInfo:
              description: >-
                A type containing location information with latitude, longitude
                and altitude, in addition the accuracy of the information are
                provided.
              type: object
              required:
                - latitude
                - longitude
                - accuracy
              properties:
                latitude:
                  type: number
                  format: float
                  example: '80.123'
                longitude:
                  type: number
                  format: float
                  example: '70.123'
                altitude:
                  type: number
                  format: float
                  example: '10.0'
                accuracy:
                  type: integer
                  format: int32
                  example: '10'
            contextLocationInfo:
              description: >-
                Contextual information of a user location (e.g., aisle, floor,
                room number, etc.)
              type: string
              example: GroundFoor
            ancillaryInfo:
              required:
                - address
              properties:
                address:
                  description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
                  type: string
                  format: uri
                  example: 'acr:192.0.2.1'
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  UserTrackingSubscription:
    required:
      - callbackReference
      - address
    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'
      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'
      address:
        description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
        type: string
        format: uri
        example: 'acr:192.0.2.1'
      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.
        type: array
        items:
          description: User event
          type: string
          example: Entering
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  ZonalPresenceNotification:
    required:
      - zoneId
      - address
      - userEventType
      - currentAccessPointId
      - timestamp
    properties:
      callbackData:
        description: >-
          CallBackData if passed by the application during the associated
          ZonalTrafficSubscription and UserTrackingSubscription operation. See
          [REST_NetAPI_Common].
        type: string
        example: '1234'
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      address:
        description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI).'
        type: string
        format: uri
        example: 'acr:192.0.2.1'
      interestRealm:
        description: >-
          Interest realm of access point (e.g. geographical area, a type of
          industry etc.).
        type: string
        example: LA
      userEventType:
        description: User event
        type: string
        example: Entering
      currentAccessPointId:
        description: Zone ID
        type: string
        example: zone01
      previousAccessPointId:
        description: Zone ID
        type: string
        example: zone02
      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="ZonalTrafficSubscription"
          href="http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123"/
  ZonalTrafficSubscription:
    description: A type containing zonal traffic subscription
    type: object
    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'
      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
      interestRealm:
        description: >-
          Interest realms of access points within a zone (e.g. geographical
          area, a type of industry etc.).
        type: array
        items:
          description: >-
            Interest realm of access point (e.g. geographical area, a type of
            industry etc.).
          type: string
          example: LA
      userEventCriteria:
        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.
        type: array
        items:
          description: User event
          type: string
          example: Entering
      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: string
        example: '0'
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  ZoneId:
    description: Identifier of zone
    type: string
    example: zone01
  ZoneInfo:
    description: A type containing zone information.
    required:
      - zoneId
      - numberOfAccessPoints
      - numberOfUnservicableAccessPoints
      - numberOfUsers
      - resourceURL
    properties:
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      numberOfAccessPoints:
        description: The number of access points within the zone
        type: integer
        format: uint32
        example: '10'
      numberOfUnservicableAccessPoints:
        description: Number of inoperable access points within the zone.
        type: integer
        format: uint32
        example: '9'
      numberOfUsers:
        description: The number of users currently on the access point.
        type: integer
        format: uint32
        example: '7'
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  ZoneList:
    description: Collection of the zone information list.
    required:
      - resourceURL
    properties:
      zone:
        description: Collection of the zone information list.
        type: array
        items:
          description: A type containing zone information.
          required:
            - zoneId
            - numberOfAccessPoints
            - numberOfUnservicableAccessPoints
            - numberOfUsers
            - resourceURL
          properties:
            zoneId:
              description: Identifier of zone
              type: string
              example: zone01
            numberOfAccessPoints:
              description: The number of access points within the zone
              type: integer
              format: uint32
              example: '10'
            numberOfUnservicableAccessPoints:
              description: Number of inoperable access points within the zone.
              type: integer
              format: uint32
              example: '9'
            numberOfUsers:
              description: The number of users currently on the access point.
              type: integer
              format: uint32
              example: '7'
            resourceURL:
              description: Self referring URL.
              type: string
              format: uri
              example: >-
                http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
      resourceURL:
        description: Self referring URL.
        type: string
        format: uri
        example: >-
          http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
  ZoneStatusNotification:
    required:
      - zoneId
      - timestamp
    properties:
      callbackData:
        description: >-
          CallBackData if passed by the application during the associated
          ZonalTrafficSubscription and UserTrackingSubscription operation. See
          [REST_NetAPI_Common].
        type: string
        example: '1234'
      zoneId:
        description: Identifier of zone
        type: string
        example: zone01
      accessPointId:
        description: >-