LocationAPI.yaml

    ZoneStatusNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        accessPointId:
          description: Identifier of an access point (e.g. ap01). Shall be included when userNumEvent related with access point or operationStatus is included.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ZoneStatusNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        operationStatus:
          # description': Shall be present when ZoneStatusSubscription includes operationStatus and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': OperationStatus
          $ref: '#/components/schemas/OperationStatus'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        userNumEvent:
          description: 'Shall be present when ZoneStatusSubscription includes upperNumberOfUsersZoneThreshold, lowerNumberOfUsersZoneThreshold, upperNumberOfUsersAPThreshold or lowerNumberOfUsersAPThreshold, and the number of users in a zone or an access point crosses the threshold defined in the subscription:
            1 = OVER_ZONE_UPPER_THD.
            2 = UNDER_ZONE_LOWER_THD.
            3 = OVER_AP_UPPER_THD.
            4 = UNDER_AP_LOWER_THD.'
          enum:
            - 1
            - 2
            - 3
            - 4
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Enum(inlined)
        zoneId:
          description: 'The identity of the zone. '
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - notificationType
      - zoneId
      - _links
      type: object
      x-etsi-notes: "NOTE:\tAs specified in [5], clause 5.2.3.2."
      x-etsi-ref: 6.4.7

    ZoneStatusSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        expiryDeadline:
          # description': The expiration time of the subscription determined by the Zone Status Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        lowerNumberOfUsersAPThreshold:
          description: Threshold number of users in an access point which if crossed downward shall cause a notification
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        lowerNumberOfUsersZoneThreshold:
          description: Threshold number of users in a zone which if crossed downward shall cause a notification
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        operationStatus:
          description: List of operation status values to generate notifications for (these apply to all access points within a zone). See note 3.
          items:
            $ref: '#/components/schemas/OperationStatus'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: OperationStatus
        reportingCtrl:
          # description': Provides parameters that ctrl the reporting.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ReportingCtrl
          $ref: '#/components/schemas/ReportingCtrl'
        requestTestNotification:
          description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "ZoneStatusSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        upperNumberOfUsersAPThreshold:
          description: Threshold number of users in an access point which if crossed upward shall cause a notification.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        upperNumberOfUsersZoneThreshold:
          description: Threshold number of users in a zone which if crossed upward shall cause a notification.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
        zoneId:
          description: Identifier of zone (e.g. zone001) to monitor.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - zoneId
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [5], clause 5.2.3.2."
      x-etsi-ref: 6.3.7
    
    RelativeLocationInfo:
      properties:
        X:
          description: 'Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system.
            Positive value represents easting from origin.'
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        Y:
          description: 'Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system.
            Positive value represents northing from origin.'
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        Z:
          description: 'Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3DPoint.
            Positive value represents height above origin.'
          format: float
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
        mapInfo:
          $ref: '#/components/schemas/MapInfo'
      required:
      - mapInfo
      - 'X'
      - 'Y'
      type: object
      x-etsi-ref: 6.2.3

    MapInfo:
      properties:
        ancillaryMapInfo:
          description: Ancillary map information may be used to convert coordinates between different coordinate systems.
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Not_specified
        mapId:
          description: 'Indicates the ID of the map. '
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        origin:
          $ref: '#/components/schemas/Origin'
      required:
      - mapId
      type: object
      x-etsi-ref: 6.2.4

    Origin:
      description: Indicates the location of the map origin in the local Cartesian coordinate system.
      properties:
        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
        latitude:
          description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        longitude:
          description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
      required:
      - latitude
      - longitude
      type: object
      x-etsi-mec-cardinality: 0..1
      x-etsi-mec-origin-type: Structure(inlined)

    Subscription:
      description: ''
      minItems: 0
      properties:
        href:
          description: The URI referring to the subscription.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
        subscriptionType:
          description: "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses\_6.3.4, 6.3.5, 6.3.6, 6.3.7 6.3.8 and 6.3.9:\n\"UserLocationEventSubscription\"\n\"UserLocationPeriodicSubscription\"\n\"ZoneLocationEventSubscription\"\n\"ZoneStatusSubscription\"\n\"UserAreaSubscription\"\n\"UserDistanceSubscription\""
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - href
      - subscriptionType
      type: object
      x-etsi-mec-cardinality: 0..N
      x-etsi-mec-origin-type: Structure (inlined)
    
    LinkType:
      properties:
        href:
          description: URI referring to a resource.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
      required:
      - href
      type: object
      x-etsi-ref: 6.7.2

    UserLocationEventSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI) to monitor."
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        expiryDeadline:
          # description': The expiration time of the subscription determined by the UE Location Subscribe Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        locationEventCriteria:
          description: 'List of user event values to generate notifications for (these apply to address specified). '
          items:
            $ref: '#/components/schemas/LocationEventType'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(LocationEventType)
        requestTestNotification:
          description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "UserLocationEventSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        userEventPara:
          # description': Requirements for user event reporting.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': UserEventPara
          $ref: '#/components/schemas/UserEventPara'
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
      - subscriptionType
      - address
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
      x-etsi-ref: 6.3.4
    
    UserLocationPeriodicSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI) to monitor."
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        expiryDeadline:
          # description': The expiration time of the subscription determined by the UE Location Subscribe Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        periodicEventInfo:
          # description': Information for periodic event reporting. See note 3.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': PeriodicEventInfo
          $ref: '#/components/schemas/PeriodicEventInfo'
        requestTestNotification:
          description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "UserLocationPeriodicSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
      - subscriptionType
      - address
      - periodicEventInfo
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.24."
      x-etsi-ref: 6.3.5
    
    PeriodicEventInfo:
      description: "NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds)
        for compatibility with OMA MLP and RLP." 
      type: object
      required:
        - reportingAmount
        - reportingInterval
      properties:
        reportingAmount:
          description: Number of event reports 
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: ReportingAmount
        reportingInterval:
          description: Interval of event reports
          type: number
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: reportingInterval

    ZoneLocationEventSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        addressList:
          description: List of the users to be monitored. If not present, all the users need to be monitored.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(Uri)
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        expiryDeadline:
          # description': The expiration time of the subscription determined by the Zone Location Event Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        locationEventCriteria:
          description: 'List of user event values to generate notifications for. '
          items:
            $ref: '#/components/schemas/LocationEventType'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(LocationEventType)
        reportingCtrl:
          # description': Provides parameters that ctrl the reporting.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ReportingCtrl
          $ref: '#/components/schemas/ReportingCtrl'
        requestTestNotification:
          description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "ZoneLocationEventSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
        zoneId:
          description: Identifier of zone (e.g. zone001) to monitor.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - zoneId
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
      x-etsi-ref: 6.3.6
    
    UserAreaSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        addressList:
          description: 'List of the users to be monitored. '
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Array(Uri)
        areaDefine:
          # description': The parameters describing the area to subscribe.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': AreaInfo
          $ref: '#/components/schemas/AreaInfo'
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        expiryDeadline:
          # description': The expiration time of the subscription determined by the UE Area Subscribe Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        locationEventCriteria:
          description: 'List of user event values to generate notifications for (these apply to address specified). '
          items:
            $ref: '#/components/schemas/LocationEventType'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(LocationEventType)
        reportingCtrl:
          # description': Provides parameters that ctrl the reporting.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ReportingCtrl
          $ref: '#/components/schemas/ReportingCtrl'
        reportingLocationReq:
          description: This IE shall be set to true if a location estimate is required for each event report.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: boolean
        requestTestNotification:
          description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "UserAreaSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        trackingAccuracy:
          description: Number of meters of acceptable error.
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
      - subscriptionType
      - areaDefine
      - addressList
      - trackingAccuracy
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
      x-etsi-ref: 6.3.8
    
    UserDistanceSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        checkImmediate:
          # description': Check location immediately after establishing notification.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Bool
          type: boolean
        clientCorrelator:
          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        criteria:
          # description': "Indicates whether the notification should occur when the geographical relationship between monitored and referenced users\u2019 changes. See note 3."
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': DistanceCriteria
          $ref: '#/components/schemas/DistanceCriteria'
        distance:
          description: Distance between users that shall be monitored. The unit is meter.
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        expiryDeadline:
          # description': The expiration time of the subscription determined by the UE Distance Subscribe Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        monitoredAddress:
          description: "Contains addresses of users to monitor (e.g., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI). Reference to a group could be provided here if supported by implementation.\nIf the ReferenceAddress is specified, then the distance between each monitored user and reference user(s) will be monitored.\nIf the ReferenceAddress is not present, then the distance between each pair of the monitored users will be monitored. Note that in that case there shall be at least two addresses specified here."
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Array(Uri)
        referenceAddress:
          description: "If specified, indicates address of each user that will be used as reference users from which the distances towards monitored users indicated in the Addresses will be monitored (e.g., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI). Reference to a group could be provided here if supported by implementation."
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(Uri)
        reportingCtrl:
          # description': Provides parameters that ctrl the reporting.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ReportingCtrl
          $ref: '#/components/schemas/ReportingCtrl'
        requestTestNotification:
          description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        subscriptionType:
          description: Shall be set to "UserDistanceSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        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
        websockNotifConfig:
          # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WebsockNotifConfig
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
      - subscriptionType
      - monitoredAddress
      - distance
      - trackingAccuracy
      - criteria
      - checkImmediate
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [6], clause 5.2.3.2."
      x-etsi-ref: 6.3.9
    
    DistanceCriteria:
      description: An enumeration, defining the distance criteria between devices.
      enum:
        - AllWithinDistance
        - AnyWithinDistance
        - AllBeyondDistance
        - AnyBeyondDistance
      type: string

    UserDistanceNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        distanceEvent:
          # description': Indicates the distance event triggering the notification. See note.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': DistanceCriteria
          $ref: '#/components/schemas/DistanceCriteria'
        monitoredUsers:
          # description': Indicates the location information related to monitored users.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': UserList
          $ref: '#/components/schemas/UserList'
        notificationType:
          description: Shall be set to "UserDistanceNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - notificationType
      - monitoredUsers
      - distanceEvent
      - _links
      type: object
      x-etsi-notes: "NOTE:\tAs specified in [6], clause 5.2.3.2."
      x-etsi-ref: 6.4.9

    UserLocationEventNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        accessPointId:
          description: "The identity of the access point.\nFor the events of \"ENTERING_AREA_EVENT\", it indicates the access point that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it indicates the access point that the user used to be within.\nSee note 2."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        civicInfo:
          # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 3.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CivicAddress
          $ref: '#/components/schemas/CivicAddress'
        locationInfo:
          # description': The geographical coordinates where the user is. See note 3.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        notificationType:
          description: Shall be set to "UserLocationEventNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        relativeLocationInfo:
          # description': The relative location in a reference system. See note 3.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': RelativeLocationInfo
          $ref: '#/components/schemas/RelativeLocationInfo'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        userLocationEvent:
          # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT"..
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationEventType
          $ref: '#/components/schemas/LocationEventType'
        zoneId:
          description: "The identity of the zone. \nFor the events of \"ENTERING_AREA_EVENT\", it is the zone that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it is the zone that the user used to be within.\nSee note 2."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - notificationType
      - userLocationEvent
      - _links
      type: object
      x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserLocationEventSubscription."
      x-etsi-ref: 6.4.4
    
    UserLocationPeriodicNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        accessPointId:
          description: "The identity of the access point that the user is currently within. \nSee note 2."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
        civicInfo:
          # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CivicAddress
          $ref: '#/components/schemas/CivicAddress'
        isFinalNotification:
          description: Shall be set to true if it is a final notification.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        locationInfo:
          # description': The geographical coordinates where the user is.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        notificationType:
          description: Shall be set to "UserLocationPeriodicNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        relativeLocationInfo:
          # description': The relative location in a reference system.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': RelativeLocationInfo
          $ref: '#/components/schemas/RelativeLocationInfo'
        result:
          # description': The result of Localization. See note 3.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': NotificationResult
          $ref: '#/components/schemas/NotificationResult'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        zoneId:
          description: "The identity of the zone that the user is currently within. \nSee note 2."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - notificationType
      - result
      - _links
      type: object
      x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tIf the result is SUCCESS, at least one of locationInfo, civicInfo and relativeLocationInfo shall be present."
      x-etsi-ref: 6.4.5
    
    ZoneLocationEventNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
        notificationType:
          description: Shall be set to "ZoneLocationEventNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        userLocationEvent:
          # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT".
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationEventType
          $ref: '#/components/schemas/LocationEventType'
        zoneId:
          description: 'The identity of the zone. '
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - notificationType
      - address
      - userLocationEvent
      - zoneId
      - _links
      type: object
      x-etsi-ref: 6.4.6
    
    UserAreaNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        address:
          description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uri
        civicInfo:
          # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 2.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CivicAddress
          $ref: '#/components/schemas/CivicAddress'
        locationInfo:
          # description': The geographical coordinates where the user is. See note 2.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        notificationType:
          description: Shall be set to "UserAreaNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        relativeLocationInfo:
          # description': The relative location in a reference system. See note 2.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': RelativeLocationInfo
          $ref: '#/components/schemas/RelativeLocationInfo'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        userLocationEvent:
          # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationEventType
          $ref: '#/components/schemas/LocationEventType'
      required:
      - notificationType
      - address
      - userLocationEvent
      - _links
      type: object
      x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserAreaSubscription."
      x-etsi-ref: 6.4.8

    AreaInfo:
      properties:
        points:
          description: Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON.
          items:
            $ref: '#/components/schemas/Point'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Array(Point)
        radius:
          description: Shall be present if the shape is CIRCLE.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        shape:
          description: 'The shape of the area monitored:
            1 = CIRCLE.
            2 = POLYGON'
          enum:
            - 1
            - 2
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum(inlined)
      required:
      - shape
      - points
      type: object
      x-etsi-ref: 6.5.7

    Point:
      properties:
        latitude:
          description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
        longitude:
          description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
          format: float
          type: number
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Float
      required:
      - latitude
      - longitude
      type: object
      x-etsi-ref: 6.5.8

    ReportingCtrl:
      properties:
        maximumCount:
          description: Maximum number of notifications. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        maximumFrequency:
          description: Maximum frequency (in seconds) of notifications per subscription.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
        minimumInterval:
          description: Minimum interval between reports in case frequently reporting. Unit is second.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: UnsignedInt
      type: object
      x-etsi-ref: 6.5.6

    _links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      required:
      - self
      type: object
      x-etsi-mec-cardinality: 0..1
      x-etsi-mec-origin-type: Structure (inlined)

    UserEventPara:
      properties:
        accessPointList:
          description: One or more access points forming a monitoring area that could be any shape. See note 1.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array(String)
        occurrenceInfo:
          # description': One time only report indication. See note 2.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': OccurrenceInfo
          $ref: '#/components/schemas/OccurrenceInfo'
        reportingLocationReq:
          description: This IE shall be set to true if a location estimate is required for each event report.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: boolean
        zoneId:
          description: "Identifier of zone (e.g. zone001) to monitor. See note\_1."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-notes: "NOTE 1:\tOnly one of accessPointList and zoneId may be present.\nNOTE 2:\tAs specified in [17], clause 6.1.6.3.16."
      x-etsi-ref: 6.5.5

    WebsockNotifConfig:
      properties:
        requestWebsocketUri:
          description: Set to true by the service consumer to indicate that Websocket delivery is requested.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        websocketUri:
          description: Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uri
      type: object
      x-etsi-ref: 6.5.4

    TestNotification:
      properties:
        _links:
          $ref: '#/components/schemas/_links'
        notificationType: