description:Upon success, a response body containing the list of user location information is returned.
content:
application/json:
schema:
type:object
properties:
terminalDistance:
$ref:'#/components/schemas/TerminalDistance'
UserList:
$ref:'#/components/schemas/UserList'
'400':
$ref:'#/components/responses/400'
'401':
@@ -49,28 +45,188 @@ paths:
$ref:'#/components/responses/406'
'429':
$ref:'#/components/responses/429'
x-swagger-router-controller:'queries'
/queries/users:
/subscriptions/users:
get:
summary:Retrieves information about the subscriptions for the requestor.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
description:The POST method is used to create a new subscription to UE location notifications. Upon success, the response contains entity body describing the created subscription.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Updates a subscription information.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Delete a subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
description:Upon success, a response body containing the access point information is returned.
content:
application/json:
schema:
type:object
properties:
accessPointInfo:
AccessPointInfo:
$ref:'#/components/schemas/AccessPointInfo'
'400':
$ref:'#/components/responses/400'
@@ -213,35 +407,39 @@ paths:
$ref:'#/components/responses/406'
'429':
$ref:'#/components/responses/429'
x-swagger-router-controller:'queries'
/subscriptions/area:
parameters:
-name:zoneId
in:path
required:true
description:The unique identifier of the zoneId.
schema:
type:string
-name:accessPointId
in:path
required:true
description:The unique identifier of the accessPointId.
schema:
type:string
/subscriptions/zones:
get:
summary:Retrieves all active subscriptions to zone notifications.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
summary:Creates a subscription to zone notifications.
description:The POST method is used to create a new subscription to zone notifications. Upon success, the response contains entity body describing the created subscription.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Updates a zone subscription information.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Cancel a zone subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
/queries/distance:
get:
summary:UE Distance Lookup of a specific UE.
description:The GET method is used to query information about distance from a user to a location or between two users.
operationId:QueriesDistanceGET
tags:
-queries
parameters:
-$ref:'#/components/parameters/Query.address2'
-$ref:'#/components/parameters/Query.location'
responses:
'200':
description:Upon success, a response body containing the list of distance information is returned.
content:
application/json:
schema:
type:object
properties:
TerminalDistance:
$ref:'#/components/schemas/TerminalDistance'
'400':
$ref:'#/components/responses/400'
'401':
$ref:'#/components/responses/401'
'403':
$ref:'#/components/responses/403'
'404':
$ref:'#/components/responses/404'
'406':
$ref:'#/components/responses/406'
'429':
$ref:'#/components/responses/429'
/subscriptions/distance:
get:
summary:Retrieves all active subscriptions to distance change notifications.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
summary:Creates a subscription for distance change notification.
description:The POST method is used to create a new subscription to user distance notifications. Upon success, the response contains entity body describing the created subscription.
summary:Retrieve user distance subscription information.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Updates a user distance subscription information.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Cancel a subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
/subscriptions/area:
get:
summary:Retrieves information about the subscriptions for this requestor.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
summary:Creates subscription to area notifications.
description:The POST method is used to create a new subscription to area notifications. Upon success, the response contains entity body describing the created subscription.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Updates a subscription information.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Cancel a subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
description:A type containing access point information.
properties:
accessPointId:
description:Identifier of access point.
type:string
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:string
connectionType:
$ref:'#/components/schemas/ConnectionType'
interestRealm:
description:Interest realm of access point.
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:string
locationInfo:
$ref:'#/components/schemas/LocationInfo'
numberOfUsers:
description:Number of users currently on the access point.
type:integer
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:integer
operationStatus:
$ref:'#/components/schemas/OperationStatus'
resourceURL:
description:Self referring URL
type:string
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:anyURI
timezone:
description:Time zone of access point.
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:dateTimeStamp
required:
-accessPointId
-connectionType
-operationStatus
-numberOfUsers
-resourceURL
type:object
OperationStatus:
description:An enumeration defining the operations status of an access point.
enum:
-Serviceable
-Unserviceable
-Unknown
type:string
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
ConnectionType:
description:This enumeration represents the connection type of an access point
enum:
-LTE
-Wifi
-Wimax
-5G NR
-UNKNOWN
type:string
LocationInfo:
properties:
accuracy:
description:Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6.
type:integer
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:UnsignedInt
accuracyAltitude:
description:Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4.
type:integer
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:UnsignedInt
accuracySemiMinor:
description:Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6.
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:
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.
description:Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4.
type:integer
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:Int
verticalUncertainty:
description:Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4.
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)
NotificationSubscriptionList:
description:This type contains a list of subscriptions.
properties:
resourceURL:
$ref:'#/components/schemas/LinkType'
subscription:
items:
$ref:'#/components/schemas/Subscription'
type:array
required:
-resourceURL
type:object
x-etsi-ref:6.3.3
ProblemDetails:
properties:
detail:
description:A human-readable explanation specific to this occurrence of the problem
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
instance:
description:A URI reference that identifies the specific occurrence of the problem
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:
description:A URI reference according to IETF RFC 3986 that identifies the problem type
format:uri
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:URI
type:object
TerminalDistance:
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.
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:
description:Distance from terminal to a location or between two terminals specified in meters
type:integer
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:integer
timestamp:
$ref:'#/components/schemas/TimeStamp'
required:
-distance
type:object
TerminalLocation:
description:A type containing device address, retrieval status and location information.
properties:
address:
description:Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
type:string
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:anyURI
currentLocation:
$ref:'#/components/schemas/LocationInfo'
errorInformation:
$ref:'#/components/schemas/ServiceError'
locationRetrievalStatus:
$ref:'#/components/schemas/RetrievalStatus'
required:
-address
-locationRetrievalStatus
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:
description:Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1
zoneId:
description:Identifier of zone
type:string
x-etsi-mec-cardinality:1
x-etsi-mec-origin-type:string
variables:
description:Variables to substitute into text string
accessPoint:
description:Collection of the access point information list.
description:Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
format:uri
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:AnyURI
AccessPointId:
description:The identity of the access point the user is currently on, see note 1.
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
zoneId:
description:The identity of the zone the user is currently within, see note 1.
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
resourceURL:
description:Self-referring URL, see note 1.
accessPointId:
description:Identifier of access point.
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:AnyURI
timestamp:
$ref:'#/components/schemas/TimeStamp'
locationInfo:
$ref:'#/components/schemas/LocationInfo'
civicInfo:
$ref:'#/components/schemas/CivicAddress'
ancillaryInfo:
description:Reserved for future use.
description:The coordinates of the access point.
connectionType:
$ref:'#/components/schemas/ConnectionType'
description:Connection type of access point.
operationStatus:
$ref:'#/components/schemas/OperationStatus'
description:Operation status of access point.
numberOfUsers:
description:Number of users currently on the access point.
type:integer
timezone:
description:Time zone of access point.
type:string
interestRealm:
description:Interest realm of access point.
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
relativeLocationInfo:
$ref:'#/components/schemas/RelativeLocationInfo'
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
ZoneInfo:
description:A type containing zone information.
type:object
required:
-zoneId
-numberOfAccessPoints
-numberOfUnserviceableAccessPoints
-numberOfUsers
-resourceURL
properties:
zoneId:
description:Identifier of zone
type:string
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.
type:object
required:
-resourceURL
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.
type:array
items:
$ref:'#/components/schemas/ZoneInfo'
type:array
resourceURL:
description:Self referring URL
type:string
TerminalDistance:
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.
type:object
required:
-resourceURL
-distance
properties:
accuracy:
description:Accuracy of the provided distance in meters
type:integer
distance:
description:Distance from terminal to a location or between two terminals specified in meters
type:integer
timestamp:
$ref:'#/components/schemas/TimeStamp'
description:Date and time that location from which distance is calculated was collected.
DistanceCriteria:
type:string
enum:
-AllWithinDistance = 'All monitored devices are within the specified distance'
-AnyWithinDistance = 'Any of monitored devices gets within the specified distance'
-AllBeyondDistance = 'All monitored devices are beyond the specified distance'
-AnyBeyondDistance = 'Any of monitored devices gets beyond the specified distance'
TerminalLocation:
description:A type containing device address, retrieval status and location information.
type:object
ZoneStatusNotification:
required:
-address
-locationRetrievalStatus
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.
address:
description:Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
notificationType:
description:Shall be set to "ZoneStatusNotification".
locationRetrievalStatus:
$ref:'#/components/schemas/RetrievalStatus'
description:Status of retrieval for this terminal address.
currentLocation:
$ref:'#/components/schemas/LocationInfo'
description:Location of terminal.
errorInformation:
$ref:'#/components/schemas/ServiceError'
description:This is the reason for error.
RetrievalStatus:
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.
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
format:uri
messageId:
description:Message identifier, either with prefix SVC or with prefix POL
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.
text:
description:Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1
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
variables:
description:Variables to substitute into text string
type:array
x-etsi-mec-cardinality:0..N
x-etsi-mec-origin-type:OperationStatus
reportingCtrl:
# description': Provides parameters that ctrl the reporting.
description:Shall be set to "ZoneStatusSubscription".
items:
type:string
UserInfo:
x-etsi-ref:6.2.2
type:object
properties:
address:
description:Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
type:string
format:uri
AccessPointId:
description:The identity of the access point the user is currently on, see note 1.
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.
description:The identity of the zone the user is currently within, see note 1.
type:string
resourceURL:
description:Self-referring URL, see note 1. This shall be only included in the procedure of UE Location Lookup.
type:string
format:uri
timeStamp:
description:Date and time that location was collected.
$ref:'#/components/schemas/TimeStamp'
locationInfo:
description:The geographical coordinates where the user is.
$ref:'#/components/schemas/LocationInfo'
civicInfo:
description:Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 3.
$ref:'#/components/schemas/CivicAddress'
ancillaryInfo:
description:Reserved for future use.
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
relativeLocationInfo:
description:The relative location in a reference system.
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
format:uri
subscriptionType:
description:Shall be set to "UserLocationEventSubscription".
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.
description:Shall be set to "UserLocationEventSubscription".
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.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
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:String
format:uri
userEventPara:
# description': Requirements for user event reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': UserEventPara
description:Requirements for user event reporting.
$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.
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
format:uri
subscriptionType:
description:Shall be set to "UserLocationPeriodicSubscription".
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'
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
type:string
format:uri
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
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.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
address:
description:Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor.
type:string
format:uri
periodicEventInfo:
description:Information for periodic event reporting. See note 3.
$ref:'#/components/schemas/PeriodicEventInfo'
expiryDeadline:
description:The expiration time of the subscription determined by the UE Location Subscribe Service.
description:Shall be set to "ZoneLocationEventSubscription".
type:string
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
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
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.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
zoneId:
description:Identifier of zone (e.g. zone001) to monitor.
type:string
addressList:
description:List of the users to be monitored. If not present, all the users need to be monitored.
type:array
minItems:0
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.
description:Shall be set to "ZoneStatusSubscription".
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.
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
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.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
zoneId:
description:Identifier of zone (e.g. zone001) to monitor.
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
upperNumberOfUsersZoneThreshold:
description:Threshold number of users in a zone which if crossed upward shall cause a notification.
type:integer
lowerNumberOfUsersZoneThreshold:
description:Threshold number of users in a zone which if crossed downward shall cause a notification.
type:integer
upperNumberOfUsersAPThreshold:
description:Threshold number of users in an access point which if crossed upward shall cause a notification.
type:integer
lowerNumberOfUsersAPThreshold:
description:Threshold number of users in an access point which if crossed downward shall cause a notification.
type:integer
operationStatus:
description:List of operation status values to generate notifications for (these apply to all access points within a zone). See note 3.
type:array
minItems:0
items:
$ref:'#/components/schemas/OperationStatus'
reportingCtrl:
description:Provides parameters that ctrl the reporting.
$ref:'#/components/schemas/ReportingCtrl'
expiryDeadline:
description:The expiration time of the subscription determined by the Zone Status Service.
description:Shall be set to "UserAreaSubscription".
type:string
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
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
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.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
areaDefine:
description:The parameters describing the area to subscribe.
$ref:'#/components/schemas/AreaInfo'
addressList:
description:'Listoftheuserstobemonitored.'
type:array
minItems:1
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.
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'
expiryDeadline:
description:The expiration time of the subscription determined by the UE Area Subscribe Service.
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
format:uri
subscriptionType:
description:Shall be set to "UserDistanceSubscription".
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.
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.
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. 'sip' URI, 'tel' URI, 'acr' URI). Reference to a group could be provided here if supported by implementation.
description:Shall be set to "UserDistanceSubscription".
minItems:1
items:
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
format:uri
distance:
description:Distance between users that shall be monitored. The unit is meter.
type:number
format:float
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'
format:float
criteria:
description:Indicates whether the notification should occur when the geographical relationship between monitored and referenced users' changes. See note 3.
$ref:'#/components/schemas/DistanceCriteria'
checkImmediate:
description:Check location immediately after establishing notification.
type:boolean
reportingCtrl:
description:Provides parameters that ctrl the reporting.
$ref:'#/components/schemas/ReportingCtrl'
expiryDeadline:
description:The expiration time of the subscription determined by the UE Distance Subscribe Service.
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.
$ref:'#/components/schemas/OperationStatus'
zoneId:
description:'Theidentityofthezone.'
type:string
accessPointId:
description:Identifier of an access point (e.g. ap01). Shall be included when userNumEvent related with access point or operationStatus is included.
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.