diff --git a/Auto_Generated_OAS_Outputs/gs_mec013v030101p.yaml b/Auto_Generated_OAS_Outputs/gs_mec013v030101p.yaml
index 0b5515039d00ae826c0dc9aa8ec065830a2e073f..9f54fe81a8048fa0e5d7127263874b3f1d472248 100644
--- a/Auto_Generated_OAS_Outputs/gs_mec013v030101p.yaml
+++ b/Auto_Generated_OAS_Outputs/gs_mec013v030101p.yaml
@@ -13,7 +13,7 @@ paths:
/queries/users:
get:
description: The GET method is used to query location information about a specific UE or a group of UEs.
- operationId: usersGET
+ operationId: QueriesUsersGET
tags:
- queries
parameters:
@@ -45,7 +45,7 @@ paths:
/subscriptions/users:
get:
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.
- operationId: usersGET
+ operationId: SubscriptionsUsersGET
tags:
- subscriptions
parameters:
@@ -75,7 +75,7 @@ paths:
$ref: '#/components/responses/429'
post:
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.
- operationId: usersPOST
+ operationId: SubscriptionsUsersPOST
tags:
- subscriptions
requestBody:
@@ -126,26 +126,33 @@ paths:
$ref: '#/components/responses/429'
callbacks:
notification:
- post:
- summary: Callback POST used to send a notification
- description: Subscription notification
- operationId: notificationPOST
- requestBody:
+ '{$request.body#/callbackUri}':
+ post:
+ summary: Callback POST used to send a notification
description: Subscription notification
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- subscriptionNotification:
- oneOf:
- - $ref: '#/components/schemas/UserLocationEventSubscription'
- - $ref: '#/components/schemas/UserLocationPeriodicSubscription'
+ operationId: notificationPOST
+ requestBody:
+ description: Subscription notification
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ subscriptionNotification:
+ oneOf:
+ - $ref: '#/components/schemas/UserLocationEventSubscription'
+ - $ref: '#/components/schemas/UserLocationPeriodicSubscription'
+ responses:
+ '204':
+ description: No content
+ '404':
+ description: Not found
+ parameters: []
/subscriptions/users/{subscriptionId}:
get:
description: The GET method is used to query the information about a specific access point under a zone.
- operationId: usersByIdGET
+ operationId: SubscriptionsUsersGETSubscriptionid
tags:
- subscriptions
responses:
@@ -170,9 +177,16 @@ paths:
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
put:
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.
- operationId: usersByIdPUT
+ operationId: SubscriptionsUsersPUTSubscriptionid
tags:
- subscriptions
requestBody:
@@ -218,9 +232,16 @@ paths:
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
delete:
description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
- operationId: usersByIdDELETE
+ operationId: SubscriptionsUsersDELETESubscriptionid
tags:
- subscriptions
responses:
@@ -234,10 +255,17 @@ paths:
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
/subscriptions/zones:
get:
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.
- operationId: zonesGET
+ operationId: SubscriptionsZonesGET
tags:
- subscriptions
parameters:
@@ -267,7 +295,7 @@ paths:
$ref: '#/components/responses/429'
post:
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.
- operationId: zonesPOST
+ operationId: SubscriptionsZonesPOST
tags:
- subscriptions
requestBody:
@@ -318,26 +346,33 @@ paths:
$ref: '#/components/responses/429'
callbacks:
notification:
- post:
- summary: Callback POST used to send a notification
- description: Subscription notification
- operationId: notificationPOST
- requestBody:
+ '{$request.body#/callbackUri}':
+ post:
+ summary: Callback POST used to send a notification
description: Subscription notification
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- subscriptionNotification:
- oneOf:
- - $ref: '#/components/schemas/ZoneLocationEventSubscription'
- - $ref: '#/components/schemas/ZoneStatusSubscription'
+ operationId: notificationPOST
+ requestBody:
+ description: Subscription notification
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ subscriptionNotification:
+ oneOf:
+ - $ref: '#/components/schemas/ZoneLocationEventSubscription'
+ - $ref: '#/components/schemas/ZoneStatusSubscription'
+ responses:
+ '204':
+ description: No content
+ '404':
+ description: Not found
+ parameters: []
/subscriptions/zones/{subscriptionId}:
get:
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.
- operationId: zonesByIdGET
+ operationId: SubscriptionsZonesGETSubscriptionid
tags:
- subscriptions
responses:
@@ -366,9 +401,16 @@ paths:
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
put:
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.
- operationId: zonesByIdPUT
+ operationId: SubscriptionsZonesPUTSubscriptionid
tags:
- subscriptions
requestBody:
@@ -414,9 +456,16 @@ paths:
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
delete:
description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
- operationId: zonesByIdDELETE
+ operationId: SubscriptionsZonesDELETESubscriptionid
tags:
- subscriptions
responses:
@@ -430,10 +479,17 @@ paths:
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
/queries/distance:
get:
description: The GET method is used to query information about distance from a user to a location or between two users.
- operationId: distanceGET
+ operationId: QueriesDistanceGET
tags:
- queries
parameters:
@@ -464,7 +520,7 @@ paths:
/subscriptions/distance:
get:
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.
- operationId: distanceGET
+ operationId: SubscriptionsDistanceGET
tags:
- subscriptions
responses:
@@ -489,9 +545,10 @@ paths:
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
+ parameters: []
post:
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.
- operationId: distancePOST
+ operationId: SubscriptionsDistancePOST
tags:
- subscriptions
requestBody:
@@ -538,24 +595,31 @@ paths:
$ref: '#/components/responses/429'
callbacks:
notification:
- post:
- summary: Callback POST used to send a notification
- description: Subscription notification
- operationId: notificationPOST
- requestBody:
+ '{$request.body#/callbackUri}':
+ post:
+ summary: Callback POST used to send a notification
description: Subscription notification
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- subscriptionNotification:
- $ref: '#/components/schemas/UserDistanceSubscription'
+ operationId: notificationPOST
+ requestBody:
+ description: Subscription notification
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ subscriptionNotification:
+ $ref: '#/components/schemas/UserDistanceSubscription'
+ responses:
+ '204':
+ description: No content
+ '404':
+ description: Not found
+ parameters: []
/subscriptions/distance/{subscriptionId}:
get:
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.
- operationId: distanceByIdGET
+ operationId: SubscriptionsDistanceGETSubscriptionid
tags:
- subscriptions
responses:
@@ -582,9 +646,16 @@ paths:
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
put:
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.
- operationId: distanceByIdPUT
+ operationId: SubscriptionsDistancePUTSubscriptionid
tags:
- subscriptions
requestBody:
@@ -626,9 +697,16 @@ paths:
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
delete:
description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
- operationId: distanceByIdDELETE
+ operationId: SubscriptionsDistanceDELETESubscriptionid
tags:
- subscriptions
responses:
@@ -642,10 +720,17 @@ paths:
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
/subscriptions/area:
get:
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.
- operationId: areaGET
+ operationId: SubscriptionsAreaGET
tags:
- subscriptions
parameters:
@@ -674,7 +759,7 @@ paths:
$ref: '#/components/responses/429'
post:
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.
- operationId: areaPOST
+ operationId: SubscriptionsAreaPOST
tags:
- subscriptions
requestBody:
@@ -721,24 +806,31 @@ paths:
$ref: '#/components/responses/429'
callbacks:
notification:
- post:
- summary: Callback POST used to send a notification
- description: Subscription notification
- operationId: notificationPOST
- requestBody:
+ '{$request.body#/callbackUri}':
+ post:
+ summary: Callback POST used to send a notification
description: Subscription notification
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- subscriptionNotification:
- $ref: '#/components/schemas/UserAreaNotification'
+ operationId: notificationPOST
+ requestBody:
+ description: Subscription notification
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ subscriptionNotification:
+ $ref: '#/components/schemas/UserAreaNotification'
+ responses:
+ '204':
+ description: No content
+ '404':
+ description: Not found
+ parameters: []
/subscriptions/area/{subscriptionId}:
get:
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.
- operationId: areaByIdGET
+ operationId: SubscriptionsAreaGETSubscriptionid
tags:
- subscriptions
responses:
@@ -763,9 +855,16 @@ paths:
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
put:
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.
- operationId: areaByIdPUT
+ operationId: SubscriptionsAreaPUTSubscriptionid
tags:
- subscriptions
requestBody:
@@ -807,9 +906,16 @@ paths:
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
delete:
description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
- operationId: areaByIdDELETE
+ operationId: SubscriptionsAreaDELETESubscriptionid
tags:
- subscriptions
responses:
@@ -823,6 +929,13 @@ paths:
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
+ parameters:
+ - name: subscriptionId
+ in: path
+ required: true
+ description: The unique identifier of the subscriptionId.
+ schema:
+ type: string
components:
schemas:
ProblemDetails:
@@ -832,68 +945,44 @@ components:
type: string
format: uri
description: A URI reference according to IETF RFC 3986 that identifies the problem type
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: URI
title:
type: string
description: A short, human-readable summary of the problem type
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: String
status:
type: integer
format: uint32
description: The HTTP status code for this occurrence of the problem
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: Uint32
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: String
instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: URI
LocationInfo1_:
properties:
accuracy:
type: integer
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
accuracyAltitude:
type: integer
description: Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
accuracySemiMinor:
type: integer
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
type: number
format: float
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: Float
confidence:
type: integer
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
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
includedAngle:
type: integer
description: Present only if "shape" equals 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
innerRadius:
type: integer
description: Present only if "shape" equals 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0. Cardinality greater than one only if \"shape\" equals 7."
type: array
@@ -901,8 +990,6 @@ components:
type: number
format: float
minItems: 1
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: Float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0. Cardinality greater than one only if \"shape\" equals 7."
type: array
@@ -910,70 +997,47 @@ components:
type: number
format: float
minItems: 1
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: Float
offsetAngle:
type: integer
description: Present only if "shape" equals 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
orientationMajorAxis:
type: integer
description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6"
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
shape:
description: 'Shape information, as detailed in [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
type: integer
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: Enum_inlined
uncertaintyRadius:
type: integer
description: Present only if "shape" equals 6
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
velocity:
description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]."
properties:
bearing:
type: integer
description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: UnsignedInt
horizontalSpeed:
type: integer
description: Horizontal speed, expressed in km/h and defined in [14].
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: UnsignedInt
uncertainty:
type: integer
description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
velocityType:
description: 'Velocity information, as detailed in [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
type: integer
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: Enum_inlined
verticalSpeed:
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:
type: integer
- description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: UnsignedInt
+ description: Vertical uncertainty, as defined in [14]. Present only
required:
- velocityType
- bearing
- horizontalSpeed
type: object
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: Structure (inlined)
timestamp:
$ref: '#/components/schemas/TimeStamp'
+ description: Date and time that location was collected.
required:
- latitude
- longitude
@@ -985,38 +1049,28 @@ components:
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
address:
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
ancillaryInfo:
description: Reserved for future use.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: String
contextLocationInfo:
description: Contextual information of a user location (e.g. aisle, floor, room number, etc.).
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: String
locationInfo:
$ref: '#/components/schemas/LocationInfo'
+ description: The geographical coordinates where the user is, see note 2.
resourceURL:
description: Self-referring URL, see note 1.
type: string
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: String
timestamp:
$ref: '#/components/schemas/TimeStamp'
+ description: Date and time that location was collected.
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
required:
- address
- accessPointId
@@ -1034,15 +1088,12 @@ components:
notifyURL:
description: Notify Callback URL
type: string
- x-etsi-mec-cardinality: '1'
- x-etsi-mec-origin-type: anyURI
callbackData:
description: Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
notificationFormat:
$ref: '#/components/schemas/NotificationFormat'
+ description: Application can specify format of the resource representation in notifications that are related to this subscription. The choice is between {XML, JSON}
UserTrackingSubscription:
description: A type containing user tracking subscription.
type: object
@@ -1053,27 +1104,17 @@ components:
clientCorrelator:
type: string
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
callbackReference:
$ref: '#/components/schemas/CallbackReference'
- address:
- type: string
- description: Address of user (e.g. "sip" URI, "tel" URI, "acr" URI) to monitor
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: anyURI
+ description: Notification callback definition
userEventCriteria:
type: array
items:
$ref: '#/components/schemas/UserEventType'
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.
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: UserEventType
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
ZonalPresenceNotification:
description: A type containing zonal presence notification
type: object
@@ -1087,44 +1128,32 @@ components:
callbackData:
description: CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
zoneId:
description: Identifier of zone
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
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: anyURI
interestRealm:
description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
userEventType:
$ref: '#/components/schemas/UserEventType'
+ description: User Event.
currentAccessPointId:
description: Identifier of access point.
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
previousAccessPointId:
description: Identifier of access point.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
timestamp:
$ref: '#/components/schemas/TimeStamp'
+ description: Indicates the time of the day for zonal presence notification.
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:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
UserEventType:
type: string
enum:
@@ -1155,34 +1184,26 @@ components:
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.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
callbackReference:
$ref: '#/components/schemas/CallbackReference'
+ description: Notification callback definition
zoneId:
description: Identifier of zone
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
interestRealm:
description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
type: array
items:
type: string
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: string
userEventCriteria:
$ref: '#/components/schemas/UserEventType'
+ 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.
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: integer
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: unsignedInt
resourceURL:
type: string
description: Self referring URL
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
OperationStatus:
type: string
enum:
@@ -1195,79 +1216,56 @@ components:
properties:
subscriptionType:
description: Shall be set to "ZoneStatusSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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."
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links'
zoneId:
description: Identifier of zone (e.g. zone001) to monitor.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
upperNumberOfUsersZoneThreshold:
description: Threshold number of users in a zone which if crossed upward shall cause a notification.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
lowerNumberOfUsersZoneThreshold:
description: Threshold number of users in a zone which if crossed downward shall cause a notification.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
upperNumberOfUsersAPThreshold:
description: Threshold number of users in an access point which if crossed upward shall cause a notification.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
lowerNumberOfUsersAPThreshold:
description: Threshold number of users in an access point which if crossed downward shall cause a notification.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
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.
- x-etsi-mec-origin-type: OperationStatus
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
$ref: '#/components/schemas/OperationStatus'
reportingCtrl:
- # description': Provides parameters that ctrl the reporting.
+ description: Provides parameters that ctrl the reporting.
$ref: '#/components/schemas/ReportingCtrl'
- # x-etsi-mec-origin-type': ReportingCtrl
- # x-etsi-mec-cardinality': 0..1
+ type: object
expiryDeadline:
- # description': The expiration time of the subscription determined by the Zone Status Service.
+ description: The expiration time of the subscription determined by the Zone Status Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- zoneId
- 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."
+ description: "|-\n 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."
PeriodicEventInfo:
x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.2.24."
LocationEventType:
@@ -1298,14 +1296,11 @@ components:
properties:
notificationType:
description: Shall be set to "ZoneStatusNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
userNumEvent:
type: integer
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:
@@ -1319,22 +1314,15 @@ components:
4 = UNDER_AP_LOWER_THD.'
enum:
- SEE_DESCRIPTION
- x-etsi-mec-origin-type: Enum(inlined)
- x-etsi-mec-cardinality: 0..1
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: 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.
$ref: '#/components/schemas/OperationStatus'
- # x-etsi-mec-origin-type': OperationStatus
- # x-etsi-mec-cardinality': 0..1
+ type: object
zoneId:
description: 'The identity of the zone. '
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
_links:
$ref: '#/components/schemas/_links3'
@@ -1342,23 +1330,19 @@ components:
- notificationType
- zoneId
- _links
- x-etsi-notes: "NOTE:\tAs specified in [5], clause 5.2.3.2."
+ description: "|-\n NOTE:\tAs specified in [5], clause 5.2.3.2."
UserList:
x-etsi-ref: 6.2.5
type: object
properties:
user:
description: 'Collection of the user location information list. '
- x-etsi-mec-origin-type: UserInfo
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
$ref: '#/components/schemas/UserInfo'
resourceURL:
description: Self referring URL. This shall be only included in the procedure of UE Location Lookup.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..1
type: string
format: uri
AccessPointList:
@@ -1371,20 +1355,14 @@ components:
zoneId:
description: Identifier of zone
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
accessPoint:
description: Collection of the access point information list.
type: array
items:
$ref: '#/components/schemas/AccessPointInfo'
- 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
ConnectionType:
description: The connection type for the access point
type: string
@@ -1412,34 +1390,27 @@ components:
accessPointId:
description: Identifier of access point.
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
locationInfo:
$ref: '#/components/schemas/LocationInfo'
+ 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
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: integer
timezone:
description: Time zone of access point.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: dateTimeStamp
interestRealm:
description: Interest realm of access point.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: anyURI
ZoneInfo:
description: A type containing zone information.
type: object
@@ -1453,28 +1424,18 @@ components:
zoneId:
description: Identifier of zone
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-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
ZoneList:
description: A type containing a list of zones.
type: object
@@ -1489,8 +1450,6 @@ components:
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: anyURI
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
@@ -1500,15 +1459,12 @@ components:
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'
+ description: Date and time that location from which distance is calculated was collected.
CircleNotificationSubscription:
description: A type containing data for notifications, when the area is defined as a circle.
type: object
@@ -1526,80 +1482,56 @@ components:
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.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
link:
description: Link to other resources that are in relationship with the resource.
type: array
items:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
callbackReference:
$ref: '#/components/schemas/CallbackReference'
+ description: Notification callback definition
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
address:
description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
type: array
items:
type: string
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: anyURI
latitude:
description: Latitude of center point.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
longitude:
description: Longitude of center point.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
radius:
description: Radius circle around center point in meters.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
enteringLeavingCriteria:
$ref: '#/components/schemas/EnteringLeavingCriteria'
+ description: Indicates whether the notification should occur when the terminal enters or leaves the target area.
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: boolean
frequency:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
type: integer
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: int
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
type: integer
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: int
count:
description: Maximum number of notifications per individual address. 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: int
PeriodicNotificationSubscription:
description: A type containing data for periodic subscription.
type: object
@@ -1612,49 +1544,34 @@ components:
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.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
link:
description: Link to other resources that are in relationship with the resource.
type: array
items:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
callbackReference:
$ref: '#/components/schemas/CallbackReference'
+ description: Notification callback definition
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
address:
description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
type: array
items:
type: string
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: anyURI
requestedAccuracy:
description: Accuracy of the provided distance in meters.
type: integer
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: int
frequency:
description: Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.
type: integer
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: int
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
type: integer
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: int
DistanceNotificationSubscription:
description: A type containing data for distance subscription, with reference to other devices.
type: object
@@ -1670,75 +1587,53 @@ components:
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.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
link:
description: Link to other resources that are in relationship with the resource.
type: array
items:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
callbackReference:
$ref: '#/components/schemas/CallbackReference'
+ description: Notification callback definition
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
referenceAddress:
description: Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
type: array
items:
type: string
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: anyURI
monitoredAddress:
description: Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
type: array
items:
type: string
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: anyURI
distance:
description: Distance between devices that shall be monitored.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
type: number
format: float
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: float
criteria:
$ref: '#/components/schemas/DistanceCriteria'
+ description: Indicates whether the notification should occur when the geographical relationship between monitored and referenced devices changes.
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: boolean
frequency:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
type: integer
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: int
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (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."
type: integer
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: int
count:
description: Maximum number of notifications per individual address. 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: int
EnteringLeavingCriteria:
type: string
enum:
@@ -1765,31 +1660,25 @@ components:
callbackData:
description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
terminalLocation:
description: Collection of the terminal locations.
type: array
items:
$ref: '#/components/schemas/TerminalLocation'
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: TerminalLocation
enteringLeavingCriteria:
$ref: '#/components/schemas/EnteringLeavingCriteria'
+ description: Indicates whether the notification was caused by the terminal entering or leaving the target area.
distanceCriteria:
$ref: '#/components/schemas/DistanceCriteria'
+ description: Indicates which distance criteria that caused the notification.
isFinalNotification:
description: Set to true if it is a final notification about location change.
type: boolean
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: boolean
link:
description: Link to other resources that are in relationship with the resource.
type: array
items:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
SubscriptionCancellationNotification:
description: A type containing the subscription cancellation notification.
type: object
@@ -1799,22 +1688,17 @@ components:
callbackData:
description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: string
address:
description: Address of terminal if the error applies to an individual terminal.
type: string
- x-etsi-mec-cardinality: 0..1
- x-etsi-mec-origin-type: anyURI
reason:
$ref: '#/components/schemas/ServiceError'
+ description: Reason notification is being discontinued.
link:
description: Link to other resources that are in relationship with the resource.
type: array
items:
$ref: '#/components/schemas/Link'
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-type: Link
TerminalLocation:
description: A type containing device address, retrieval status and location information.
type: object
@@ -1825,21 +1709,20 @@ components:
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
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.
TerminalLocationList:
description: Collection of the terminal locations.
type: array
items:
$ref: '#/components/schemas/TerminalLocation'
- x-etsi-mec-cardinality: 1..N
- x-etsi-mec-origin-type: TerminalLocation
RetrievalStatus:
type: string
enum:
@@ -1856,93 +1739,70 @@ components:
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
type: string
- x-etsi-mec-cardinality: 1
- x-etsi-mec-origin-type: string
variables:
description: Variables to substitute into text string
type: array
items:
type: string
- x-etsi-mec-cardinality: 0..N
- x-etsi-mec-origin-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.
- x-etsi-mec-origin-type: AnyURI
- x-etsi-mec-cardinality: '1'
type: string
format: uri
AccessPointId:
description: The identity of the access point the user is currently on, see note 1.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
zoneId:
description: The identity of the zone the user is currently within, see note 1.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
resourceURL:
description: Self-referring URL, see note 1. This shall be only included in the procedure of UE Location Lookup.
- x-etsi-mec-origin-type: AnyURI
- x-etsi-mec-cardinality: 0..1
type: string
format: uri
timeStamp:
- # description': Date and time that location was collected.
+ description: Date and time that location was collected.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': '1'
+ type: object
locationInfo:
- # description': The geographical coordinates where the user is.
+ description: The geographical coordinates where the user is.
$ref: '#/components/schemas/LocationInfo'
- # x-etsi-mec-origin-type': LocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
civicInfo:
- # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 3.
+ description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 3.
$ref: '#/components/schemas/CivicAddress'
- # x-etsi-mec-origin-type': CivicAddress
- # x-etsi-mec-cardinality': 0..1
+ type: object
ancillaryInfo:
description: Reserved for future use.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
relativeLocationInfo:
- # description': The relative location in a reference system.
+ description: The relative location in a reference system.
$ref: '#/components/schemas/RelativeLocationInfo'
- # x-etsi-mec-origin-type': RelativeLocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- address
- AccessPointId
- zoneId
- timeStamp
- x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2:\tVoid.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.14."
+ description: "|-\n NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2:\tVoid.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.14."
RelativeLocationInfo:
x-etsi-ref: 6.2.3
type: object
properties:
mapInfo:
- # description': Indicates a map corresponding to a location area.
+ description: Indicates a map corresponding to a location area.
$ref: '#/components/schemas/MapInfo'
- # x-etsi-mec-origin-type': MapInfo
- # x-etsi-mec-cardinality': '1'
+ type: object
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.'
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
Y:
@@ -1950,8 +1810,6 @@ components:
Positive value represents northing from origin.'
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
Z:
@@ -1959,8 +1817,6 @@ components:
Positive value represents height above origin.'
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: 0..1
type: number
format: float
required:
@@ -1973,15 +1829,11 @@ components:
properties:
mapId:
description: 'Indicates the ID of the map. '
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
origin:
$ref: '#/components/schemas/Origin'
ancillaryMapInfo:
description: Ancillary map information may be used to convert coordinates between different coordinate systems.
- x-etsi-mec-origin-type: Not_specified
- x-etsi-mec-cardinality: 0..1
type: object
required:
- mapId
@@ -1994,167 +1846,125 @@ components:
items:
$ref: '#/components/schemas/Subscription'
resourceURL:
- # description': Self-referring URL.
+ description: Self-referring URL.
$ref: '#/components/schemas/LinkType'
- # x-etsi-mec-origin-type': LinkType
- # x-etsi-mec-cardinality': '1'
+ type: object
required:
- resourceURL
- x-etsi-notes: "NOTE 1:\tVoid.\nNOTE 2:\tVoid."
+ description: "|-\n NOTE 1:\tVoid.\nNOTE 2:\tVoid."
UserLocationEventSubscription:
x-etsi-ref: 6.3.4
type: object
properties:
subscriptionType:
description: Shall be set to "UserLocationEventSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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."
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links'
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: uri
userEventPara:
- # description': Requirements for user event reporting.
+ description: Requirements for user event reporting.
$ref: '#/components/schemas/UserEventPara'
- # x-etsi-mec-origin-type': UserEventPara
- # x-etsi-mec-cardinality': 0..1
+ type: object
locationEventCriteria:
description: 'List of user event values to generate notifications for (these apply to address specified). '
- x-etsi-mec-origin-type: LocationEventType
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
$ref: '#/components/schemas/LocationEventType'
expiryDeadline:
- # description': The expiration time of the subscription determined by the UE Location Subscribe Service.
+ description: The expiration time of the subscription determined by the UE Location Subscribe Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- address
- 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."
+ description: "|-\n 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."
UserLocationPeriodicSubscription:
x-etsi-ref: 6.3.5
type: object
properties:
subscriptionType:
description: Shall be set to "UserLocationPeriodicSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: "URI exposed by the client on which to receive notifications via HTTP. See note\_1."
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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.
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links'
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: uri
periodicEventInfo:
- # description': Information for periodic event reporting. See note 3.
+ description: Information for periodic event reporting. See note 3.
$ref: '#/components/schemas/PeriodicEventInfo'
- # x-etsi-mec-origin-type': PeriodicEventInfo
- # x-etsi-mec-cardinality': '1'
+ type: object
expiryDeadline:
- # description': The expiration time of the subscription determined by the UE Location Subscribe Service.
+ description: The expiration time of the subscription determined by the UE Location Subscribe Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- address
- periodicEventInfo
- 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."
+ description: "|-\n 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."
ZoneLocationEventSubscription:
x-etsi-ref: 6.3.6
type: object
properties:
subscriptionType:
description: Shall be set to "ZoneLocationEventSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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."
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links'
zoneId:
description: Identifier of zone (e.g. zone001) to monitor.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
addressList:
description: List of the users to be monitored. If not present, all the users need to be monitored.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..N
type: array
format: uri
minItems: 0
@@ -2162,67 +1972,51 @@ components:
$ref: '#/components/schemas/Uri'
locationEventCriteria:
description: 'List of user event values to generate notifications for. '
- x-etsi-mec-origin-type: LocationEventType
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
$ref: '#/components/schemas/LocationEventType'
reportingCtrl:
- # description': Provides parameters that ctrl the reporting.
+ description: Provides parameters that ctrl the reporting.
$ref: '#/components/schemas/ReportingCtrl'
- # x-etsi-mec-origin-type': ReportingCtrl
- # x-etsi-mec-cardinality': 0..1
+ type: object
expiryDeadline:
- # description': The expiration time of the subscription determined by the Zone Location Event Service.
+ description: The expiration time of the subscription determined by the Zone Location Event Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- zoneId
- 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."
+ description: "|-\n 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."
UserAreaSubscription:
x-etsi-ref: 6.3.8
type: object
properties:
subscriptionType:
description: Shall be set to "UserAreaSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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."
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links'
areaDefine:
- # description': The parameters describing the area to subscribe.
+ description: The parameters describing the area to subscribe.
$ref: '#/components/schemas/AreaInfo'
- # x-etsi-mec-origin-type': AreaInfo
- # x-etsi-mec-cardinality': '1'
+ type: object
addressList:
description: 'List of the users to be monitored. '
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 1..N
type: array
format: uri
minItems: 1
@@ -2230,75 +2024,56 @@ components:
$ref: '#/components/schemas/Uri'
trackingAccuracy:
description: Number of meters of acceptable error.
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
locationEventCriteria:
description: 'List of user event values to generate notifications for (these apply to address specified). '
- x-etsi-mec-origin-type: LocationEventType
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
$ref: '#/components/schemas/LocationEventType'
reportingCtrl:
- # description': Provides parameters that ctrl the reporting.
+ description: Provides parameters that ctrl the reporting.
$ref: '#/components/schemas/ReportingCtrl'
- # x-etsi-mec-origin-type': ReportingCtrl
- # x-etsi-mec-cardinality': 0..1
+ type: object
reportingLocationReq:
description: This IE shall be set to true if a location estimate is required for each event report.
- x-etsi-mec-origin-type: boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
expiryDeadline:
- # description': The expiration time of the subscription determined by the UE Area Subscribe Service.
+ description: The expiration time of the subscription determined by the UE Area Subscribe Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- areaDefine
- addressList
- trackingAccuracy
- 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."
+ description: "|-\n 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."
UserDistanceSubscription:
x-etsi-ref: 6.3.9
type: object
properties:
subscriptionType:
description: Shall be set to "UserDistanceSubscription".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
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.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..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.
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
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: 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'
- # x-etsi-mec-origin-type': WebsockNotifConfig
- # x-etsi-mec-cardinality': 0..1
+ type: object
_links:
$ref: '#/components/schemas/_links1'
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., 'sip' URI, 'tel' URI, 'acr' URI). Reference to a group could be provided here if supported by implementation.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..N
type: array
format: uri
minItems: 0
@@ -2310,8 +2085,6 @@ components:
If the ReferenceAddress is specified, then the distance between each monitored user and reference user(s) will be monitored.
If 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.'
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 1..N
type: array
format: uri
minItems: 1
@@ -2319,36 +2092,27 @@ components:
$ref: '#/components/schemas/Uri'
distance:
description: Distance between users that shall be monitored. The unit is meter.
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
criteria:
- # description': Indicates whether the notification should occur when the geographical relationship between monitored and referenced users' changes. See note 3.
+ description: Indicates whether the notification should occur when the geographical relationship between monitored and referenced users' changes. See note 3.
$ref: '#/components/schemas/DistanceCriteria'
- # x-etsi-mec-origin-type': DistanceCriteria
- # x-etsi-mec-cardinality': '1'
+ type: object
checkImmediate:
- # description': Check location immediately after establishing notification.
+ description: Check location immediately after establishing notification.
type: boolean
- # x-etsi-mec-origin-type': Bool
- # x-etsi-mec-cardinality': '1'
reportingCtrl:
- # description': Provides parameters that ctrl the reporting.
+ description: Provides parameters that ctrl the reporting.
$ref: '#/components/schemas/ReportingCtrl'
- # x-etsi-mec-origin-type': ReportingCtrl
- # x-etsi-mec-cardinality': 0..1
+ type: object
expiryDeadline:
- # description': The expiration time of the subscription determined by the UE Distance Subscribe Service.
+ description: The expiration time of the subscription determined by the UE Distance Subscribe Service.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
required:
- subscriptionType
- monitoredAddress
@@ -2356,15 +2120,13 @@ components:
- trackingAccuracy
- criteria
- checkImmediate
- 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."
+ description: "|-\n 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."
TestNotification:
x-etsi-ref: 6.4.3
type: object
properties:
notificationType:
description: Shall be set to "TestNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
_links:
$ref: '#/components/schemas/_links2'
@@ -2377,49 +2139,36 @@ components:
properties:
notificationType:
description: Shall be set to "UserLocationEventNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..1
type: string
format: uri
userLocationEvent:
- # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
+ description: The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
$ref: '#/components/schemas/LocationEventType'
- # x-etsi-mec-origin-type': LocationEventType
- # x-etsi-mec-cardinality': '1'
+ type: object
locationInfo:
- # description': The geographical coordinates where the user is. See note 3.
+ description: The geographical coordinates where the user is. See note 3.
$ref: '#/components/schemas/LocationInfo'
- # x-etsi-mec-origin-type': LocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
civicInfo:
- # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1 and note 3.
+ description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1 and note 3.
$ref: '#/components/schemas/CivicAddress'
- # x-etsi-mec-origin-type': CivicAddress
- # x-etsi-mec-cardinality': 0..1
+ type: object
relativeLocationInfo:
- # description': The relative location in a reference system. See note 3.
+ description: The relative location in a reference system. See note 3.
$ref: '#/components/schemas/RelativeLocationInfo'
- # x-etsi-mec-origin-type': RelativeLocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
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."
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
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."
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
_links:
$ref: '#/components/schemas/_links3'
@@ -2427,61 +2176,46 @@ components:
- notificationType
- userLocationEvent
- _links
- 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."
+ description: "|-\n 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."
UserLocationPeriodicNotification:
x-etsi-ref: 6.4.5
type: object
properties:
notificationType:
description: Shall be set to "UserLocationPeriodicNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..1
type: string
format: uri
result:
- # description': The result of Localization. See note 3.
+ description: The result of Localization. See note 3.
$ref: '#/components/schemas/NotificationResult'
- # x-etsi-mec-origin-type': NotificationResult
- # x-etsi-mec-cardinality': '1'
+ type: object
locationInfo:
- # description': The geographical coordinates where the user is.
+ description: The geographical coordinates where the user is.
$ref: '#/components/schemas/LocationInfo'
- # x-etsi-mec-origin-type': LocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
civicInfo:
- # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1.
+ description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1.
$ref: '#/components/schemas/CivicAddress'
- # x-etsi-mec-origin-type': CivicAddress
- # x-etsi-mec-cardinality': 0..1
+ type: object
relativeLocationInfo:
- # description': The relative location in a reference system.
+ description: The relative location in a reference system.
$ref: '#/components/schemas/RelativeLocationInfo'
- # x-etsi-mec-origin-type': RelativeLocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
zoneId:
description: "The identity of the zone that the user is currently within. \nSee note 2."
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
accessPointId:
description: "The identity of the access point that the user is currently within. \nSee note 2."
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
isFinalNotification:
description: Shall be set to true if it is a final notification.
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
_links:
$ref: '#/components/schemas/_links3'
@@ -2489,36 +2223,28 @@ components:
- notificationType
- result
- _links
- 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."
+ description: "|-\n 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."
ZoneLocationEventNotification:
x-etsi-ref: 6.4.6
type: object
properties:
notificationType:
description: Shall be set to "ZoneLocationEventNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: uri
userLocationEvent:
- # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT".
+ description: The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT".
$ref: '#/components/schemas/LocationEventType'
- # x-etsi-mec-origin-type': LocationEventType
- # x-etsi-mec-cardinality': '1'
+ type: object
zoneId:
description: 'The identity of the zone. '
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
_links:
$ref: '#/components/schemas/_links3'
@@ -2534,40 +2260,31 @@ components:
properties:
notificationType:
description: Shall be set to "UserAreaNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: uri
locationInfo:
- # description': The geographical coordinates where the user is. See note 2.
+ description: The geographical coordinates where the user is. See note 2.
$ref: '#/components/schemas/LocationInfo'
- # x-etsi-mec-origin-type': LocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
civicInfo:
- # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1 and note 2.
+ description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1 and note 2.
$ref: '#/components/schemas/CivicAddress'
- # x-etsi-mec-origin-type': CivicAddress
- # x-etsi-mec-cardinality': 0..1
+ type: object
relativeLocationInfo:
- # description': The relative location in a reference system. See note 2.
+ description: The relative location in a reference system. See note 2.
$ref: '#/components/schemas/RelativeLocationInfo'
- # x-etsi-mec-origin-type': RelativeLocationInfo
- # x-etsi-mec-cardinality': 0..1
+ type: object
userLocationEvent:
- # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
+ description: The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
$ref: '#/components/schemas/LocationEventType'
- # x-etsi-mec-origin-type': LocationEventType
- # x-etsi-mec-cardinality': '1'
+ type: object
_links:
$ref: '#/components/schemas/_links3'
required:
@@ -2575,31 +2292,26 @@ components:
- address
- userLocationEvent
- _links
- 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."
+ description: "|-\n 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."
UserDistanceNotification:
x-etsi-ref: 6.4.9
type: object
properties:
notificationType:
description: Shall be set to "UserDistanceNotification".
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
timeStamp:
- # description': Time stamp.
+ description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
- # x-etsi-mec-origin-type': TimeStamp
- # x-etsi-mec-cardinality': 0..1
+ type: object
monitoredUsers:
- # description': Indicates the location information related to monitored users.
+ description: Indicates the location information related to monitored users.
$ref: '#/components/schemas/UserList'
- # x-etsi-mec-origin-type': UserList
- # x-etsi-mec-cardinality': '1'
+ type: object
distanceEvent:
- # description': Indicates the distance event triggering the notification. See note.
+ description: Indicates the distance event triggering the notification. See note.
$ref: '#/components/schemas/DistanceCriteria'
- # x-etsi-mec-origin-type': DistanceCriteria
- # x-etsi-mec-cardinality': '1'
+ type: object
_links:
$ref: '#/components/schemas/_links3'
required:
@@ -2607,7 +2319,7 @@ components:
- monitoredUsers
- distanceEvent
- _links
- x-etsi-notes: "NOTE:\tAs specified in [6], clause 5.2.3.2."
+ description: "|-\n NOTE:\tAs specified in [6], clause 5.2.3.2."
TimeStamp:
x-etsi-ref: 6.5.2
type: object
@@ -2616,16 +2328,12 @@ components:
description: 'The seconds part of the time. Time is defined as
Unix-time since January 1, 1970, 00:00:00 UTC.'
- x-etsi-mec-origin-type: Uint32
- x-etsi-mec-cardinality: '1'
type: integer
format: uint32
nanoSeconds:
description: 'The nanoseconds part of the time. Time is defined as
Unix-time since January 1, 1970, 00:00:00 UTC.'
- x-etsi-mec-origin-type: Uint32
- x-etsi-mec-cardinality: '1'
type: integer
format: uint32
required:
@@ -2637,72 +2345,42 @@ components:
properties:
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0. Cardinality greater than one only if \"shape\" equals 7."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: 1..N
- type: array
+ type: number
format: float
- minItems: 1
- items:
- type: float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0. Cardinality greater than one only if \"shape\" equals 7."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: 1..N
- type: array
+ type: number
format: float
- minItems: 1
- items:
- type: float
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: 0..1
type: number
format: float
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.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
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.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
accuracyAltitude:
description: Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
orientationMajorAxis:
description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6."
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
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.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
innerRadius:
description: Present only if "shape" equals 6.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
uncertaintyRadius:
description: Present only if "shape" equals 6.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
offsetAngle:
description: Present only if "shape" equals 6.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
includedAngle:
description: Present only if "shape" equals 6.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
shape:
type: integer
@@ -2723,8 +2401,6 @@ components:
7 = polygon'
enum:
- SEE_DESCRIPTION
- x-etsi-mec-origin-type: Enum_inlined
- x-etsi-mec-cardinality: '1'
velocity:
$ref: '#/components/schemas/Velocity'
required:
@@ -2737,14 +2413,10 @@ components:
properties:
websocketUri:
description: Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: 0..1
type: string
format: uri
requestWebsocketUri:
description: Set to true by the service consumer to indicate that Websocket delivery is requested.
- x-etsi-mec-origin-type: Boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
UserEventPara:
x-etsi-ref: 6.5.5
@@ -2752,46 +2424,33 @@ components:
properties:
reportingLocationReq:
description: This IE shall be set to true if a location estimate is required for each event report.
- x-etsi-mec-origin-type: boolean
- x-etsi-mec-cardinality: 0..1
type: boolean
accessPointList:
description: One or more access points forming a monitoring area that could be any shape. See note 1.
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..N
type: array
minItems: 0
items:
type: string
zoneId:
description: "Identifier of zone (e.g. zone001) to monitor. See note\_1."
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: 0..1
type: string
occurrenceInfo:
- # description': One time only report indication. See note 2.
+ description: One time only report indication. See note 2.
$ref: '#/components/schemas/OccurrenceInfo'
- # x-etsi-mec-origin-type': OccurrenceInfo
- # x-etsi-mec-cardinality': 0..1
- 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."
+ type: object
+ description: "|-\n NOTE 1:\tOnly one of accessPointList and zoneId may be present.\nNOTE 2:\tAs specified in [17], clause 6.1.6.3.16."
ReportingCtrl:
x-etsi-ref: 6.5.6
type: object
properties:
minimumInterval:
description: Minimum interval between reports in case frequently reporting. Unit is second.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
maximumFrequency:
description: Maximum frequency (in seconds) of notifications per subscription.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
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.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
AreaInfo:
x-etsi-ref: 6.5.7
@@ -2806,20 +2465,14 @@ components:
2 = POLYGON.'
enum:
- SEE_DESCRIPTION
- x-etsi-mec-origin-type: Enum(inlined)
- x-etsi-mec-cardinality: '1'
points:
description: Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON.
- x-etsi-mec-origin-type: Point
- x-etsi-mec-cardinality: 1..N
type: array
minItems: 1
items:
$ref: '#/components/schemas/Point'
radius:
description: Shall be present if the shape is CIRCLE.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
required:
- shape
@@ -2830,14 +2483,10 @@ components:
properties:
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
required:
@@ -2849,34 +2498,24 @@ components:
properties:
href:
description: URI referring to a resource.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: uri
required:
- href
Origin:
description: Indicates the location of the map origin in the local Cartesian coordinate system.
- x-etsi-mec-origin-type: Structure(inlined)
- x-etsi-mec-cardinality: 0..1
type: object
properties:
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: '1'
type: number
format: float
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
- x-etsi-mec-origin-type: Float
- x-etsi-mec-cardinality: 0..1
type: number
format: float
required:
@@ -2884,81 +2523,61 @@ components:
- longitude
Subscription:
description: ''
- x-etsi-mec-origin-type: Structure (inlined)
- x-etsi-mec-cardinality: 0..N
type: object
minItems: 0
properties:
href:
description: The URI referring to the subscription.
- x-etsi-mec-origin-type: Uri
- x-etsi-mec-cardinality: '1'
type: string
format: 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\""
- x-etsi-mec-origin-type: String
- x-etsi-mec-cardinality: '1'
type: string
required:
- href
- subscriptionType
_links:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
- x-etsi-mec-origin-type: Structure (inlined)
- x-etsi-mec-cardinality: 0..1
type: object
properties:
self:
- # description': Self-referring URI. The URI shall be unique within the UE Location Subscribe as it acts as an ID for the subscription.
+ description: Self-referring URI. The URI shall be unique within the UE Location Subscribe as it acts as an ID for the subscription.
$ref: '#/components/schemas/LinkType'
- # x-etsi-mec-origin-type': LinkType
- # x-etsi-mec-cardinality': '1'
+ type: object
required:
- self
_links1:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
- x-etsi-mec-origin-type: Structure (inlined)
- x-etsi-mec-cardinality: 0..1
type: object
properties:
self:
- # description': Self-referring URI. The URI shall be unique within the User Distance Subscribe as it acts as an ID for the subscription.
+ description: Self-referring URI. The URI shall be unique within the User Distance Subscribe as it acts as an ID for the subscription.
$ref: '#/components/schemas/LinkType'
- # x-etsi-mec-origin-type': LinkType
- # x-etsi-mec-cardinality': '1'
+ type: object
required:
- self
_links2:
description: 'Hyperlink related to the resource. '
- x-etsi-mec-origin-type: Structure (inlined)
- x-etsi-mec-cardinality: '1'
type: object
properties:
subscription:
- # description': URI identifying the subscription for the test notification.
+ description: URI identifying the subscription for the test notification.
$ref: '#/components/schemas/LinkType'
- # x-etsi-mec-origin-type': LinkType
- # x-etsi-mec-cardinality': '1'
+ type: object
required:
- subscription
_links3:
description: Object containing hyperlinks related to the resource.
- x-etsi-mec-origin-type: Structure(inlined)
- x-etsi-mec-cardinality: '1'
type: object
properties:
subscription:
- # description': A link to the related subscription.
+ description: A link to the related subscription.
$ref: '#/components/schemas/LinkType'
- # x-etsi-mec-origin-type': LinkType
- # x-etsi-mec-cardinality': '1'
+ type: object
required:
- subscription
Velocity:
description: Structure with attributes relating to the target entity's velocity, as defined in [14].
- x-etsi-mec-origin-type: Structure (inlined)
- x-etsi-mec-cardinality: 0..1
type: object
properties:
velocityType:
@@ -2974,32 +2593,20 @@ components:
4 = Horizontal_Vertical_Uncert'
enum:
- SEE_DESCRIPTION
- x-etsi-mec-origin-type: Enum_inlined
- x-etsi-mec-cardinality: '1'
bearing:
description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: '1'
type: integer
horizontalSpeed:
description: Horizontal speed, expressed in km/h and defined in [14].
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: '1'
type: integer
uncertainty:
description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
verticalSpeed:
description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4.
- x-etsi-mec-origin-type: Int
- x-etsi-mec-cardinality: 0..1
type: integer
verticalUncertainty:
description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4.
- x-etsi-mec-origin-type: UnsignedInt
- x-etsi-mec-cardinality: 0..1
type: integer
required:
- velocityType
@@ -3068,7 +2675,6 @@ components:
Query.Zoneid:
description: Identifier of zone (e.g. zone001).
name: zoneid
- cardinality: 0..N
in: query
required: false
x-exportParamName: Query.Zoneid
@@ -3079,7 +2685,6 @@ components:
Query.Accesspointid:
description: Identifier of access point (e.g. 001010000000000000000000000000001).
name: accesspointid
- cardinality: 0..N
in: query
required: false
x-exportParamName: Query.Accesspointid
@@ -3090,14 +2695,13 @@ components:
Query.Address:
description: Address of users (e.g. 'sip' URI, 'tel' URI, 'acr' URI). See note.
name: address
- cardinality: 0..N
in: query
required: false
x-exportParamName: Query.Address
schema:
type: array
items:
- type: anyuri
+ type: string
Query.Subscription_type:
description: 'Query parameter to filter on a specific subscription type. Permitted values:
@@ -3105,7 +2709,6 @@ components:
periodic.'
name: subscription_type
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Subscription_type
@@ -3114,12 +2717,11 @@ components:
Query.Address1:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
name: address
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Address1
schema:
- type: uri
+ type: string
Query.Subscription_type1:
description: 'Query parameter to filter on a specific subscription type. Permitted values:
@@ -3127,7 +2729,6 @@ components:
status.'
name: subscription_type
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Subscription_type1
@@ -3136,7 +2737,6 @@ components:
Query.Zoneid1:
description: The identity of the zone. .
name: zoneid
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Zoneid1
@@ -3145,16 +2745,16 @@ components:
Query.Address2:
description: "One or two addresses of user to check.\nThe second \"address\" parameter shall not be included when the distance between a user and a location is requested. \nThe second \"address\" parameter shall be included when a location is not provided."
name: address
- cardinality: 1..2
in: query
required: true
x-exportParamName: Query.Address2
schema:
- type: array (uri)
+ type: array
+ items:
+ type: string
Query.Location:
description: Shall not be included when the distance between two terminals is requested.
name: location
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Location
@@ -3165,7 +2765,6 @@ components:
event.'
name: subscription_type
- cardinality: 0..1
in: query
required: false
x-exportParamName: Query.Subscription_type2