Newer
Older
contact:
url: https://forge.etsi.org/rep/mec/gs013-location-api
description: The ETSI MEC ISG MEC013 Location API described using OpenAPI.
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
externalDocs:
description: ETSI MEC013 V3.1.1 Location API
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/03.01.01_60/gs_mec013v030101p.pdf'
summary: 'Query information about distance from a user to a location or between two users'
description: 'The GET method is used to query information about distance from a user to a location or between two users.'
- $ref: '#/components/parameters/Query.Address'
- $ref: '#/components/parameters/Query.Location'
description: 'Upon success, a response body containing the list of distance information is returned.'
content:
application/json:
schema:
type: object
properties:
terminalDistance:
$ref: '#/components/schemas/TerminalDistance'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/queries/users:
get:
summary: 'Query location information about a specific UE or a group of Ues'
description: 'The GET method is used to query location information about a specific UE or a group of Ues.'
operationId: usersGET
parameters:
- $ref: '#/components/parameters/Query.ZoneId'
- $ref: '#/components/parameters/Query.AccessPointId'
- $ref: '#/components/parameters/Query.Address_3'
description: 'Upon success, a response body containing the list of user location information is returned.'
content:
application/json:
schema:
type: object
properties:
userList:
$ref: '#/components/schemas/UserList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
summary: 'Query the information about one or more specific zones or a list of zones.'
description: 'The GET method is used to query the information about one or more specific zones or a list of zones.'
parameters:
- $ref: '#/components/parameters/Query.ZoneId'
description: 'Upon success, a response body containing the list of zone information is returned.'
content:
application/json:
schema:
type: object
properties:
zoneList:
$ref: '#/components/schemas/ZoneList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
summary: 'Query information about a specific zone'
description: 'The GET method is used to query the information about a specific zone.'
operationId: zoneGetById
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
responses:
'200':
description: 'Upon success, a response body containing the zone information is returned.'
content:
application/json:
schema:
type: object
properties:
zoneInfo:
$ref: '#/components/schemas/ZoneInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/queries/zones/{zoneId}/accessPoints:
get:
tags:
summary: 'Query information about a specific access point or a list of access points under a zone'
description: 'The GET method is used to query the information about a specific access point or a list of access points under a zone.'
operationId: accessPointsGET
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Query.AccessPointId'
description: 'Upon success, a response body containing the list of access point information is returned.'
content:
application/json:
schema:
type: object
properties:
accessPointList:
$ref: '#/components/schemas/AccessPointList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/queries/zones/{zoneId}/accessPoints/{accessPointId}:
get:
tags:
summary: 'Query information about a specific access point under a zone.'
description: 'The GET method is used to query the information about a specific access point under a zone.'
operationId: accessPointGetById
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Path.AccessPointId'
responses:
'200':
description: 'Upon success, a response body containing the access point information is returned.'
content:
application/json:
schema:
type: object
properties:
accessPointInfo:
$ref: '#/components/schemas/AccessPointInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
summary: 'Retrieves information about the subscriptions for this requestor.'
description: 'The GET method is used to request information about the subscriptions for this requestor.'
operationId: areaSubListGET
parameters:
- $ref: '#/components/parameters/Query.Subscription_type'
description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned."
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
subscription:
- href: 'http://meAppServer.example.com/location/v2/subscriptions/area/subscription123'
subscriptionType: 'UserAreaSubscription'
resourceURL:
href: 'http://meAppServer.example.com/location/v2/subscriptions/area'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
summary: 'Creates subscription to area notifications.'
description: 'The POST method is used to create a new subscription to area notifications.'
operationId: areaSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
userAreaSubscription:
$ref: '#/components/schemas/UserAreaSubscription'
- userAreaSubscription:
subscriptionType: 'userAreaSubscription'
callbackReference: 'http://my.callback.com/area_notification/some-id'
_links:
self:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
areaDefine:
shape: 1
points:
- latitude: -80.86302
longitude: 41.277306
radius:
addressList:
- acr:10.0.0.1
- acr:10.0.0.2
trackingAccuracy: 10.99
expiryDeadline:
seconds: 1973507343
nanoSeconds": 0
description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field.'
content:
application/json:
schema:
type: object
properties:
userAreaSubscription:
$ref: '#/components/schemas/UserAreaSubscription'
- userAreaSubscription:
subscriptionType: 'userAreaSubscription'
callbackReference: 'http://my.callback.com/area_notification/some-id'
_links:
self:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
areaDefine:
shape: 1
points:
- latitude: -80.86302
longitude: 41.277306
radius:
addressList:
- acr:10.0.0.1
- acr:10.0.0.2
trackingAccuracy: 10.99
expiryDeadline:
seconds: 1973507343
nanoSeconds": 0
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/userAreaSubscription.callbackReference}':
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: areaNotificationPOST
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
userAreaNotification:
$ref: '#/components/schemas/UserAreaNotification'
- userAreaNotification:
notificationType: 'UserAreaNotification'
timestamp:
seconds: 1673507343
nanoSeconds": 0
address: 'acr:10.0.0.1'
userLocationEvent: 'ENTERING_AREA_EVENT'
_links:
subscription:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/area/{subscriptionId}:
description: 'The GET method is used to retrieve information about this subscription.'
operationId: areaSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the specific zone subscription is returned.'
content:
application/json:
schema:
type: object
required:
userAreaNotification:
$ref: '#/components/schemas/UserAreaNotification'
notificationType: 'UserAreaNotification'
userLocationEvent: 'ENTERING_AREA_EVENT'
_links:
subscription:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
description: 'The PUT method is used to update the existing subscription.'
operationId: areaSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
userAreaNotification:
$ref: '#/components/schemas/UserAreaNotification'
notificationType: 'UserAreaNotification'
userLocationEvent: 'ENTERING_AREA_EVENT'
_links:
subscription:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated subscription is returned.'
content:
application/json:
schema:
type: object
properties:
userAreaNotification:
$ref: '#/components/schemas/UserAreaNotification'
- userAreaNotification:
notificationType: 'UserAreaNotification'
userLocationEvent: 'ENTERING_AREA_EVENT'
_links:
subscription:
href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
description: 'The DELETE method is used to cancel the existing subscription.'
operationId: areaSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
/subscriptions/distance:
get:
tags:
summary: 'Retrieves all active subscriptions to distance change notifications'
description: 'This operation is used for retrieving all active subscriptions to a distance change notifications.'
operationId: distanceSubListGET
responses:
'200':
description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned."
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
subscription:
- href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
subscriptionType: 'UserDistanceSubscription'
resourceURL:
href: 'http://meAppServer.example.com/location/v2/subscriptions/distance'
summary: 'Creates a subscription for distance change notification'
description: 'Creates a subscription to the Location Service for a distance change notification.'
operationId: distanceSubPOST
requestBody:
description: 'The POST method is used to create a new subscription to user distance notifications.'
required: true
content:
application/json:
schema:
type: object
properties:
userDistanceSubscription:
$ref: '#/components/schemas/UserDistanceSubscription'
- userDistanceSubscription:
subscriptionType: 'UserDistanceSubscription'
callbackReference: 'http://my.callback.com/user-distance/some-id'
referenceAddress:
- 'acr:10.0.0.3'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
criteria: 'AllWithinDistance'
checkImmediate: true
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
userDistanceSubscription:
$ref: '#/components/schemas/UserDistanceSubscription'
- userDistanceSubscription:
subscriptionType: 'UserDistanceSubscription'
callbackReference: 'http://my.callback.com/user-distance/some-id'
referenceAddress:
- 'acr:10.0.0.3'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
criteria: 'AllWithinDistance'
checkImmediate: true
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/userDistanceSubscription.callbackReference}':
description: 'Notification from Location service, content based user distance subscription type'
description: 'User Distance Notification'
required: true
content:
application/json:
schema:
type: object
properties:
userDistanceNotification:
$ref: '#/components/schemas/UserDistanceNotification'
- userDistanceNotification:
notificationType: 'UserDistanceNotification'
timestamp:
seconds: 1673507343
nanoSeconds": 0
monitoredUsers:
- user:
address: 'acr:10.0.0.1'
accessPointId: '001010000000000000000000000000001'
zoneId: 'zone01'
resourceURL: 'http://meAppServer.example.com/location/v3/queries/users'
distanceEvent: 'AllWithinDistance'
_links:
subscription:
href: 'http://meAppServer.example.com/location/v3/subscriptions/distance/subscription123'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/distance/{subscriptionId}:
get:
tags:
summary: 'Retrieve user distance subscription information'
description: 'The GET method is used to retrieve information about user distance subscription subscription.'
operationId: distanceSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the specific distance event subscription is returned.'
content:
application/json:
schema:
type: object
required:
- UserDistanceSubscription
userDistanceSubscription:
$ref: '#/components/schemas/UserDistanceSubscription'
- userDistanceSubscription:
subscriptionType: 'UserDistanceSubscription'
callbackReference: 'http://my.callback.com/user-distance/some-id'
referenceAddress:
- 'acr:10.0.0.3'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
criteria: 'AllWithinDistance'
checkImmediate: true
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
summary: 'Updates a user distance subscription information'
description: 'The PUT method is used to update the existing user distance subscription.'
operationId: distanceSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
userDistanceSubscription:
$ref: '#/components/schemas/UserDistanceSubscription'
- userDistanceSubscription:
subscriptionType: 'UserDistanceSubscription'
callbackReference: 'http://my.callback.com/user-distance/some-id'
referenceAddress:
- 'acr:10.0.0.3'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
criteria: 'AllWithinDistance'
checkImmediate: true
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated subscription is returned.'
content:
application/json:
schema:
type: object
properties:
userDistanceSubscription:
$ref: '#/components/schemas/UserDistanceSubscription'
- userDistanceSubscription:
subscriptionType: 'UserDistanceSubscription'
callbackReference: 'http://my.callback.com/user-distance/some-id'
referenceAddress:
- 'acr:10.0.0.3'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
criteria: 'AllWithinDistance'
checkImmediate: true
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
description: 'The DELETE method is used to cancel the existing subscription.'
operationId: distanceSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
summary: 'Retrieves information about the subscriptions for the requestor'
description: 'The GET method is used to request information about the subscriptions for the requestor. '
operationId: userSubListGET
parameters:
- $ref: '#/components/parameters/Query.Subscription_type_2'
- $ref: '#/components/parameters/Query.Address_2'
description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned."
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
subscription:
- href: 'http://meAppServer.example.com/location/v2/subscriptions/users/subscription123'
subscriptionType: 'UserLocationEventSubscription'
- href: 'http://meAppServer.example.com/location/v2/subscriptions/users/subscription456'
subscriptionType: 'UserLocationPeriodicSubscription'
resourceURL:
href: 'http://meAppServer.example.com/location/v2/subscriptions/users'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
post:
tags:
summary: 'Create subscription to UE location notifications.'
description: 'The POST method is used to create a new subscription to UE location notifications.'
operationId: userSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
userLocationEventSubscription:
$ref: '#/components/schemas/UserLocationEventSubscription'
userLocationPeriodicSubscription:
$ref: '#/components/schemas/UserLocationPeriodicSubscription'
- userLocationEventSubscription:
subscriptionType: 'UserLocationEventSubscription'
callbackReference: 'http://my.callback.com/user-location-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
description: 'Indicates successful subscription creation.'
content:
application/json:
schema:
type: object
properties:
userLocationEventSubscription:
$ref: '#/components/schemas/UserLocationEventSubscription'
userLocationPeriodicSubscription:
$ref: '#/components/schemas/UserLocationPeriodicSubscription'
- userLocationEventSubscription:
subscriptionType: 'UserLocationEventSubscription'
callbackReference: 'http://my.callback.com/user-location-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/userLocationEventSubscription.callbackReference}':
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: userNotificationPOST
description: 'User LocationEvent Notification'
required: true
content:
application/json:
schema:
type: object
properties:
userLocationEventNotification:
$ref: '#/components/schemas/UserLocationEventNotification'
userLocationPeriodicNotification:
$ref: '#/components/schemas/UserLocationEventNotification'
- userLocationEventNotification:
notificationType: 'UserLocationEventNotification'
address: 'acr:10.0.0.1'
userLocationEvent: 'ENTERING_AREA_EVENT'
zoneId: 'zone01'
accessPointId: '001010000000000000000000000000001'
_links:
subscription:
href: "http://meAppServer.example.com/location/v3/subscriptions/user/subscription123"
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/users/{subscriptionId}:
description: 'The GET method is used to retrieve information about this subscription. '
operationId: userSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the specific Location event subscription is returned.'
content:
application/json:
schema:
type: object
required:
- UserLocationEventSubscription
userLocationEventSubscription:
$ref: '#/components/schemas/UserLocationEventSubscription'
userLocationPeriodicSubscription:
$ref: '#/components/schemas/UserLocationPeriodicSubscription'
- userLocationEventSubscription:
subscriptionType: 'UserLocationEventSubscription'
callbackReference: 'http://my.callback.com/user-location-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
description: 'The PUT method is used to update the existing subscription.'
operationId: userSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
userLocationEventSubscription:
$ref: '#/components/schemas/UserLocationEventSubscription'
userLocationPeriodicSubscription:
$ref: '#/components/schemas/UserLocationPeriodicSubscription'
- userLocationEventSubscription:
subscriptionType: 'UserLocationEventSubscription'
callbackReference: 'http://my.callback.com/user-location-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated subscription is returned. '
content:
application/json:
schema:
type: object
properties:
userLocationEventSubscription:
$ref: '#/components/schemas/UserLocationEventSubscription'
userLocationPeriodicSubscription:
$ref: '#/components/schemas/UserLocationPeriodicSubscription'
- userLocationEventSubscription:
subscriptionType: 'UserLocationEventSubscription'
callbackReference: 'http://my.callback.com/user-location-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
description: 'The DELETE method is used to cancel the existing subscription.'
operationId: userSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
summary: 'Retrieves all active subscriptions to zone notifications'
description: 'This operation is used for retrieving all active subscriptions to zone notifications.'
operationId: zoneSubListGET
parameters:
- $ref: '#/components/parameters/Query.Subscription_type_3'
- $ref: '#/components/parameters/Query.ZoneId_2'
description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned."
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
subscription:
- href: 'http://meAppServer.example.com/location/v2/subscriptions/zones/subscription123'
subscriptionType: 'ZoneLocationEventSubscription'
- href: 'http://meAppServer.example.com/location/v2/subscriptions/zones/subscription456'
subscriptionType: 'ZoneStatusSubscription'
resourceURL:
href: 'http://meAppServer.example.com/location/v2/subscriptions/zones'
summary: 'Creates a subscription to zone notifications'
description: 'The POST method is used to create a new subscription to zone notifications.'
operationId: zoneSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
zoneLocationEventSubscription:
$ref: '#/components/schemas/ZoneLocationEventSubscription'
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
- zoneLocationEventSubscription:
subscriptionType: 'ZoneLocationEventSubscription'
callbackReference: 'http://my.callback.com/zone-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
expiryDeadline":
seconds: 1977836800
nanoseconds": 0
description: 'Indicates successful resource creation'
content:
application/json:
schema:
type: object
properties:
zoneLocationEventSubscription:
$ref: '#/components/schemas/ZoneLocationEventSubscription'
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
- zoneLocationEventSubscription:
subscriptionType: 'ZoneLocationEventSubscription'
callbackReference: 'http://my.callback.com/zone-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
expiryDeadline":
seconds: 1977836800
nanoseconds": 0
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/zoneLocationEventSubscription.callbackReference}':
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: zoneNotificationPOST
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
zoneLocationEventNotification:
$ref: '#/components/schemas/ZoneLocationEventNotification'
zoneStatusNotification:
$ref: '#/components/schemas/ZoneStatusNotification'
- zoneLocationEventNotification:
notificationType: 'ZoneLocationEventNotification'
address: 'acr:10.0.0.1'
zoneId: 'zone01'
_links:
subscription:
href: "http://meAppServer.example.com/location/v3/subscriptions/zone/subscription123"
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/zones/{subscriptionId}:
summary: 'Retrieve zone subscription information'
description: 'The GET method is used to retrieve information about zone subscription. '
operationId: zoneSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the specific zone subscription is returned.'
content:
application/json:
schema:
type: object
required:
- zoneLocationEventSubscription
- zoneStatusSubscription
zoneLocationEventSubscription:
$ref: '#/components/schemas/ZoneLocationEventSubscription'
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
- zoneLocationEventSubscription:
subscriptionType: 'ZoneLocationEventSubscription'
callbackReference: 'http://my.callback.com/zone-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
expiryDeadline":
seconds: 1977836800
nanoseconds": 0
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
summary: 'Updates a zone subscription information'
description: 'The PUT method is used to update the existing zone subscription.'
operationId: zoneSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
zoneLocationEventSubscription:
$ref: '#/components/schemas/ZoneLocationEventSubscription'
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
- zoneLocationEventSubscription:
subscriptionType: 'ZoneLocationEventSubscription'
callbackReference: 'http://my.callback.com/zone-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
expiryDeadline":
seconds: 1977836800
nanoseconds": 0
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated subscription is returned.'
content:
application/json:
schema:
type: object
properties:
zoneLocationEventSubscription:
$ref: '#/components/schemas/ZoneLocationEventSubscription'
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
- zoneLocationEventSubscription:
subscriptionType: 'ZoneLocationEventSubscription'
callbackReference: 'http://my.callback.com/zone-notification/some-id'
locationEventCriteria:
- ENTERING_AREA_EVENT
expiryDeadline":
seconds: 1977836800
nanoseconds": 0
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
summary: 'Cancel a zone subscription'
description: 'The DELETE method is used to cancel the existing zone subscription.'
operationId: zoneSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
components:
responses:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content:
description: 'Unauthorized : used when the client did not submit credentials.'
content:
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content:
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content:
description:
'Precondition failed : used when a condition has failed during conditional requests, e.g. when
using ETags to avoid write conflicts when using PUT'
content:
description:
'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
longer than the server is willing or able to process.'
content:
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
content:
description:
'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
error condition can also occur if the capabilities required by the request are not supported.'
content:
description: 'Too Many Requests : used when a rate limiter has triggered.'
content:
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
parameters:
Path.AccessPointId:
name: accessPointId
in: path
description: 'Identifier of access Point'
required: true
schema:
type: string
x-exportParamName: AccessPointId
Path.SubscrId:
name: subscriptionId
in: path
description: 'Subscription Identifier, specifically the "self" returned in the subscription request'
required: true
schema:
type: string
format: uri
x-exportParamName: SubscriptionId
Path.ZoneId:
name: zoneId
in: path
description: 'Indentifier of zone'
required: true
schema:
type: string
x-exportParamName: ZoneId
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
Query.Subscription_type:
name: subscription_type
in: query
description: "Query parameter to filter on a specific subscription type. Permitted values:
event"
required: false
schema:
type: string
x-exportParamName: Subscription_type
Query.Subscription_type_2:
name: subscription_type
in: query
description: "Query parameter to filter on a specific subscription type. Permitted values:
-event
-periodic"
required: false
schema:
type: string
x-exportParamName: Subscription_type_2
Query.Subscription_type_3:
name: subscription_type
in: query
description: "Query parameter to filter on a specific subscription type. Permitted values:
-event
-status"
required: false
schema:
type: string
x-exportParamName: Subscription_type_3
Query.AccessPointId:
name: accessPointId
in: query
description: Identifier of access point
required: false
schema:
type: array
items:
type: string
x-exportParamName: AccessPointId
Query.Address:
name: address
in: query
description: One or two addresses of user to check.
The second "address" parameter shall not be included when the distance between a user and a location is requested.
The second "address" parameter shall be included when a location is not provided.
required: false
schema:
type: array
items:
type: string
x-exportParamName: Address
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
x-exportParamName: Address_2
Query.Address_3:
name: address
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI).
type: array
items:
type: string
x-exportParamName: Address_3
Query.Location:
name: location
description: Shall not be included when the distance between two terminals is requested.
type: object
properties:
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
x-exportParamName: Location
Query.ZoneId:
name: zoneId
in: query
description: Identifier of zone
required: false
schema:
type: array
items:
type: string
x-exportParamName: ZoneId
Query.ZoneId_2:
name: zoneId
in: query
description: The identity of the zone
required: false
schema:
type: string
x-exportParamName: ZoneId_2
schemas:
AccessPointInfo:
description: A type containing access point information.
properties:
accessPointId:
description: Identifier of access point.
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
connectionType:
interestRealm:
description: Interest realm of access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
locationInfo:
numberOfUsers:
description: Number of users currently on the access point.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: integer
operationStatus:
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
timezone:
description: Time zone of access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: dateTimeStamp
required:
- accessPointId
- connectionType
- operationStatus
- numberOfUsers
- resourceURL
OperationStatus:
description: An enumeration defining the operations status of an access point.
enum:
- Serviceable
- Unserviceable
- Unknown
type: string
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
AccessPointList:
description: A type containing list of access points.
properties:
accessPoint:
description: Collection of the access point information list.
items:
$ref: '#/components/schemas/AccessPointInfo'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: AccessPointInfo
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
ConnectionType:
description: This enumeration represents the connection type of an access point
enum:
- LTE
- Wifi
- Wimax
- 5G NR
- UNKNOWN
type: string
LocationInfo:
accuracy:
description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracyAltitude:
description: Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracySemiMinor:
description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
format: float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
confidence:
description: Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if "shape" equals 1, 4 or 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
includedAngle:
description: Present only if "shape" equals 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
innerRadius:
description: Present only if "shape" equals 6.
type: integer
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."
items:
type: number
minItems: 1
type: array
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."
items:
type: number
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Float
offsetAngle:
description: Present only if "shape" equals 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
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."
type: integer
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:
1 = Ellipsoid_Arc
2 = ellipsoid_Point
3 = ellipsoid_Point_Altitude
4 = ellipsoid_Point_Altitude_Uncert_Ellipsoid
5 = ellipsoid_Point_Uncert_Circle
6 = ellipsoid_Point_Uncert_Ellipse
7 = polygon'
enum:
- SEE_DESCRIPTION
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
uncertaintyRadius:
description: Present only if "shape" equals 6.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
velocity:
$ref: '#/components/schemas/Velocity'
- latitude
- longitude
- shape
Velocity:
description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]."
bearing:
description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
type: integer
x-etsi-mec-origin-type: UnsignedInt
horizontalSpeed:
description: Horizontal speed, expressed in km/h and defined in [14].
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: UnsignedInt
uncertainty:
description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4.
type: integer
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:
1 = Horizontal
2 = Horizontal_Vertical
3 = Horizontal_Uncert
4 = Horizontal_Vertical_Uncert'
enum:
- SEE_DESCRIPTION
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:
description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4.
type: integer
x-etsi-mec-origin-type: UnsignedInt
- velocityType
- bearing
- horizontalSpeed
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Structure (inlined)
NotificationSubscriptionList:
description: This type contains a list of subscriptions.
properties:
resourceURL:
$ref: '#/components/schemas/LinkType'
subscription:
items:
$ref: '#/components/schemas/Subscription'
type: array
required:
- resourceURL
type: object
x-etsi-ref: 6.3.3
description: A human-readable explanation specific to this occurrence of the problem
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
instance:
description: A URI reference that identifies the specific occurrence of the problem
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
status:
description: The HTTP status code for this occurrence of the problem
format: uint32
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
title:
description: A short, human-readable summary of the problem type
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
type:
description: A URI reference according to IETF RFC 3986 that identifies the problem type
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
type: object
description: A type containing information about the distance from a terminal to a location or between two terminals, in addition the accuracy and a timestamp of the information are provided.
properties:
accuracy:
description: Accuracy of the provided distance in meters
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: integer
distance:
description: Distance from terminal to a location or between two terminals specified in meters
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: integer
timestamp:
description: A type containing device address, retrieval status and location information.
description: Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
currentLocation:
- address
- locationRetrievalStatus
RetrievalStatus:
enum:
- Retrieved
- NotRetrieved
- Error
type: string
ServiceError:
description: Used to indicate a notification termination or cancellation.
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
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
items:
type: string
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: string
required:
- messageId
- text
type: object
TimeStamp:
properties:
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-cardinality: '1'
x-etsi-mec-origin-type: Uint32
seconds:
description: 'The seconds part of the time. Time is defined as
Unix-time since January 1, 1970, 00:00:00 UTC.'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
required:
description: This type represents the information related to a user attached to an access point
associated to the MEC host, such access point is in scope of the Location Service instance.
required:
- address
- accessPointId
- zoneId
- resourceURL
- timestamp
type: object
x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified in [5], clause 5.2.2.5."
x-etsi-ref: 6.2.2
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: AnyURI
AccessPointId:
description: The identity of the access point the user is currently on, see note 1.
x-etsi-mec-cardinality: '1'
zoneId:
description: The identity of the zone the user is currently within, see note 1.
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
resourceURL:
description: Self-referring URL, see note 1.
type: string
x-etsi-mec-cardinality: '1'
locationInfo:
$ref: '#/components/schemas/LocationInfo'
civicInfo:
$ref: '#/components/schemas/CivicAddress'
ancillaryInfo:
description: Reserved for future use.
x-etsi-mec-cardinality: 0..1
relativeLocationInfo:
$ref: '#/components/schemas/RelativeLocationInfo'
UserList:
description: A type containing list of users.
properties:
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
user:
description: Collection of the zone information list.
items:
$ref: '#/components/schemas/UserInfo'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: UserInfo
required:
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
ZoneInfo:
description: A type containing zone information.
properties:
numberOfAccessPoints:
description: The number of access points within the zone
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
numberOfUnserviceableAccessPoints:
description: Number of inoperable access points within the zone.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
numberOfUsers:
description: The number of users currently on the access point.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- zoneId
- numberOfAccessPoints
- numberOfUnserviceableAccessPoints
- numberOfUsers
- resourceURL
ZoneList:
description: A type containing a list of zones.
properties:
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zone:
description: Collection of the zone information list.
items:
$ref: '#/components/schemas/ZoneInfo'
type: array
required:
_links:
$ref: '#/components/schemas/_links'
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
notificationType:
description: Shall be set to "ZoneStatusNotification".
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
# description': Shall be present when ZoneStatusSubscription includes operationStatus and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': OperationStatus
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
userNumEvent:
description: 'Shall be present when ZoneStatusSubscription includes upperNumberOfUsersZoneThreshold, lowerNumberOfUsersZoneThreshold, upperNumberOfUsersAPThreshold or lowerNumberOfUsersAPThreshold, and the number of users in a zone or an access point crosses the threshold defined in the subscription:
1 = OVER_ZONE_UPPER_THD.
2 = UNDER_ZONE_LOWER_THD.
3 = OVER_AP_UPPER_THD.
4 = UNDER_AP_LOWER_THD.'
enum:
- SEE_DESCRIPTION
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Enum(inlined)
description: 'The identity of the zone. '
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
- notificationType
- zoneId
- _links
x-etsi-notes: "NOTE:\tAs specified in [5], clause 5.2.3.2."
x-etsi-ref: 6.4.7
_links:
$ref: '#/components/schemas/_links'
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
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
expiryDeadline:
# description': The expiration time of the subscription determined by the Zone Status Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
lowerNumberOfUsersAPThreshold:
description: Threshold number of users in an access point which if crossed downward shall cause a notification
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
lowerNumberOfUsersZoneThreshold:
description: Threshold number of users in a zone which if crossed downward shall cause a notification
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
description: List of operation status values to generate notifications for (these apply to all access points within a zone). See note 3.
items:
$ref: '#/components/schemas/OperationStatus'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: OperationStatus
reportingCtrl:
# description': Provides parameters that ctrl the reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': ReportingCtrl
$ref: '#/components/schemas/ReportingCtrl'
requestTestNotification:
description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "ZoneStatusSubscription".
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
upperNumberOfUsersAPThreshold:
description: Threshold number of users in an access point which if crossed upward shall cause a notification.
type: integer
x-etsi-mec-origin-type: UnsignedInt
upperNumberOfUsersZoneThreshold:
description: Threshold number of users in a zone which if crossed upward shall cause a notification.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
description: Identifier of zone (e.g. zone001) to monitor.
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
- subscriptionType
- zoneId
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [5], clause 5.2.3.2."
x-etsi-ref: 6.3.7
RelativeLocationInfo:
properties:
X:
description: 'Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system.
Positive value represents easting from origin.'
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
Y:
description: 'Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system.
Positive value represents northing from origin.'
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
Z:
description: 'Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3DPoint.
Positive value represents height above origin.'
format: float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
mapInfo:
$ref: '#/components/schemas/MapInfo'
required:
- mapInfo
- 'X'
- 'Y'
type: object
x-etsi-ref: 6.2.3
MapInfo:
properties:
ancillaryMapInfo:
description: Ancillary map information may be used to convert coordinates between different coordinate systems.
type: object
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Not_specified
mapId:
description: 'Indicates the ID of the map. '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
origin:
$ref: '#/components/schemas/Origin'
required:
- mapId
type: object
x-etsi-ref: 6.2.4
Origin:
description: Indicates the location of the map origin in the local Cartesian coordinate system.
properties:
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
format: float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
required:
- latitude
- longitude
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Structure(inlined)
Subscription:
description: ''
minItems: 0
properties:
href:
description: The URI referring to the subscription.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
subscriptionType:
description: "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses\_6.3.4, 6.3.5, 6.3.6, 6.3.7 6.3.8 and 6.3.9:\n\"UserLocationEventSubscription\"\n\"UserLocationPeriodicSubscription\"\n\"ZoneLocationEventSubscription\"\n\"ZoneStatusSubscription\"\n\"UserAreaSubscription\"\n\"UserDistanceSubscription\""
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- href
- subscriptionType
type: object
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Structure (inlined)
LinkType:
properties:
href:
description: URI referring to a resource.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
required:
- href
type: object
x-etsi-ref: 6.7.2
UserLocationEventSubscription:
properties:
_links:
$ref: '#/components/schemas/_links'
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI) to monitor."
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
expiryDeadline:
# description': The expiration time of the subscription determined by the UE Location Subscribe Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
locationEventCriteria:
description: 'List of user event values to generate notifications for (these apply to address specified). '
items:
$ref: '#/components/schemas/LocationEventType'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(LocationEventType)
requestTestNotification:
description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "UserLocationEventSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
userEventPara:
# description': Requirements for user event reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': UserEventPara
$ref: '#/components/schemas/UserEventPara'
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
required:
- subscriptionType
- address
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
x-etsi-ref: 6.3.4
UserLocationPeriodicSubscription:
properties:
_links:
$ref: '#/components/schemas/_links'
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI) to monitor."
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
expiryDeadline:
# description': The expiration time of the subscription determined by the UE Location Subscribe Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
periodicEventInfo:
# description': Information for periodic event reporting. See note 3.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': PeriodicEventInfo
$ref: '#/components/schemas/PeriodicEventInfo'
requestTestNotification:
description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "UserLocationPeriodicSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
required:
- subscriptionType
- address
- periodicEventInfo
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.24."
x-etsi-ref: 6.3.5
PeriodicEventInfo:
description: "NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds)
for compatibility with OMA MLP and RLP."
type: object
required:
- reportingAmount
- reportingInterval
properties:
reportingAmount:
description: Number of event reports
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: ReportingAmount
reportingInterval:
description: Interval of event reports
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: reportingInterval
ZoneLocationEventSubscription:
properties:
_links:
$ref: '#/components/schemas/_links'
addressList:
description: List of the users to be monitored. If not present, all the users need to be monitored.
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(Uri)
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
expiryDeadline:
# description': The expiration time of the subscription determined by the Zone Location Event Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
locationEventCriteria:
description: 'List of user event values to generate notifications for. '
items:
$ref: '#/components/schemas/LocationEventType'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(LocationEventType)
reportingCtrl:
# description': Provides parameters that ctrl the reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': ReportingCtrl
$ref: '#/components/schemas/ReportingCtrl'
requestTestNotification:
description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "ZoneLocationEventSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
zoneId:
description: Identifier of zone (e.g. zone001) to monitor.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- subscriptionType
- zoneId
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
x-etsi-ref: 6.3.6
UserAreaSubscription:
properties:
_links:
$ref: '#/components/schemas/_links'
addressList:
description: 'List of the users to be monitored. '
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Array(Uri)
areaDefine:
# description': The parameters describing the area to subscribe.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': AreaInfo
$ref: '#/components/schemas/AreaInfo'
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
expiryDeadline:
# description': The expiration time of the subscription determined by the UE Area Subscribe Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
locationEventCriteria:
description: 'List of user event values to generate notifications for (these apply to address specified). '
items:
$ref: '#/components/schemas/LocationEventType'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(LocationEventType)
reportingCtrl:
# description': Provides parameters that ctrl the reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': ReportingCtrl
$ref: '#/components/schemas/ReportingCtrl'
reportingLocationReq:
description: This IE shall be set to true if a location estimate is required for each event report.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: boolean
requestTestNotification:
description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "UserAreaSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
trackingAccuracy:
description: Number of meters of acceptable error.
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
required:
- subscriptionType
- areaDefine
- addressList
- trackingAccuracy
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it."
x-etsi-ref: 6.3.8
UserDistanceSubscription:
properties:
_links:
$ref: '#/components/schemas/_links'
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
checkImmediate:
# description': Check location immediately after establishing notification.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Bool
type: boolean
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. See note 2.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
criteria:
# description': "Indicates whether the notification should occur when the geographical relationship between monitored and referenced users\u2019 changes. See note 3."
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': DistanceCriteria
$ref: '#/components/schemas/DistanceCriteria'
distance:
description: Distance between users that shall be monitored. The unit is meter.
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
expiryDeadline:
# description': The expiration time of the subscription determined by the UE Distance Subscribe Service.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
monitoredAddress:
description: "Contains addresses of users to monitor (e.g., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI). Reference to a group could be provided here if supported by implementation.\nIf the ReferenceAddress is specified, then the distance between each monitored user and reference user(s) will be monitored.\nIf the ReferenceAddress is not present, then the distance between each pair of the monitored users will be monitored. Note that in that case there shall be at least two addresses specified here."
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Array(Uri)
referenceAddress:
description: "If specified, indicates address of each user that will be used as reference users from which the distances towards monitored users indicated in the Addresses will be monitored (e.g., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI). Reference to a group could be provided here if supported by implementation."
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(Uri)
reportingCtrl:
# description': Provides parameters that ctrl the reporting.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': ReportingCtrl
$ref: '#/components/schemas/ReportingCtrl'
requestTestNotification:
description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [4], clause 6.12a."
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
subscriptionType:
description: Shall be set to "UserDistanceSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
websockNotifConfig:
# description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
required:
- subscriptionType
- monitoredAddress
- distance
- trackingAccuracy
- criteria
- checkImmediate
type: object
x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [6], clause 5.2.3.2."
x-etsi-ref: 6.3.9
DistanceCriteria:
description: An enumeration, defining the distance criteria between devices.
enum:
- AllWithinDistance
- AnyWithinDistance
- AllBeyondDistance
- AnyBeyondDistance
type: string
UserDistanceNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
distanceEvent:
# description': Indicates the distance event triggering the notification. See note.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': DistanceCriteria
$ref: '#/components/schemas/DistanceCriteria'
monitoredUsers:
# description': Indicates the location information related to monitored users.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': UserList
$ref: '#/components/schemas/UserList'
notificationType:
description: Shall be set to "UserDistanceNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- notificationType
- monitoredUsers
- distanceEvent
- _links
type: object
x-etsi-notes: "NOTE:\tAs specified in [6], clause 5.2.3.2."
x-etsi-ref: 6.4.9
UserLocationEventNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
accessPointId:
description: "The identity of the access point.\nFor the events of \"ENTERING_AREA_EVENT\", it indicates the access point that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it indicates the access point that the user used to be within.\nSee note 2."
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
civicInfo:
# description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 3.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CivicAddress
$ref: '#/components/schemas/CivicAddress'
locationInfo:
# description': The geographical coordinates where the user is. See note 3.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LocationInfo
$ref: '#/components/schemas/LocationInfo'
notificationType:
description: Shall be set to "UserLocationEventNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
relativeLocationInfo:
# description': The relative location in a reference system. See note 3.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': RelativeLocationInfo
$ref: '#/components/schemas/RelativeLocationInfo'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
userLocationEvent:
# description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT"..
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LocationEventType
$ref: '#/components/schemas/LocationEventType'
zoneId:
description: "The identity of the zone. \nFor the events of \"ENTERING_AREA_EVENT\", it is the zone that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it is the zone that the user used to be within.\nSee note 2."
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
required:
- notificationType
- userLocationEvent
- _links
type: object
x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserLocationEventSubscription."
x-etsi-ref: 6.4.4
UserLocationPeriodicNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
accessPointId:
description: "The identity of the access point that the user is currently within. \nSee note 2."
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
civicInfo:
# description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CivicAddress
$ref: '#/components/schemas/CivicAddress'
isFinalNotification:
description: Shall be set to true if it is a final notification.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
locationInfo:
# description': The geographical coordinates where the user is.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LocationInfo
$ref: '#/components/schemas/LocationInfo'
notificationType:
description: Shall be set to "UserLocationPeriodicNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
relativeLocationInfo:
# description': The relative location in a reference system.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': RelativeLocationInfo
$ref: '#/components/schemas/RelativeLocationInfo'
result:
# description': The result of Localization. See note 3.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': NotificationResult
$ref: '#/components/schemas/NotificationResult'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
zoneId:
description: "The identity of the zone that the user is currently within. \nSee note 2."
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
required:
- notificationType
- result
- _links
type: object
x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tIf the result is SUCCESS, at least one of locationInfo, civicInfo and relativeLocationInfo shall be present."
x-etsi-ref: 6.4.5
ZoneLocationEventNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
notificationType:
description: Shall be set to "ZoneLocationEventNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
userLocationEvent:
# description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT".
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LocationEventType
$ref: '#/components/schemas/LocationEventType'
zoneId:
description: 'The identity of the zone. '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- notificationType
- address
- userLocationEvent
- zoneId
- _links
type: object
x-etsi-ref: 6.4.6
UserAreaNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
address:
description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)."
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uri
civicInfo:
# description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 2.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CivicAddress
$ref: '#/components/schemas/CivicAddress'
locationInfo:
# description': The geographical coordinates where the user is. See note 2.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LocationInfo
$ref: '#/components/schemas/LocationInfo'
notificationType:
description: Shall be set to "UserAreaNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
relativeLocationInfo:
# description': The relative location in a reference system. See note 2.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': RelativeLocationInfo
$ref: '#/components/schemas/RelativeLocationInfo'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
userLocationEvent:
# description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LocationEventType
$ref: '#/components/schemas/LocationEventType'
required:
- notificationType
- address
- userLocationEvent
- _links
type: object
x-etsi-notes: "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserAreaSubscription."
x-etsi-ref: 6.4.8
AreaInfo:
properties:
points:
description: Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON.
items:
$ref: '#/components/schemas/Point'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Array(Point)
radius:
description: Shall be present if the shape is CIRCLE.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
shape:
description: 'The shape of the area monitored:
1 = CIRCLE.
2 = POLYGON'
enum:
- SEE_DESCRIPTION
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum(inlined)
required:
- shape
- points
type: object
x-etsi-ref: 6.5.7
Point:
properties:
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0."
format: float
type: number
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Float
required:
- latitude
- longitude
type: object
x-etsi-ref: 6.5.8
ReportingCtrl:
properties:
maximumCount:
description: Maximum number of notifications. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
maximumFrequency:
description: Maximum frequency (in seconds) of notifications per subscription.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
minimumInterval:
description: Minimum interval between reports in case frequently reporting. Unit is second.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
type: object
x-etsi-ref: 6.5.6
_links:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
properties:
self:
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Structure (inlined)
UserEventPara:
properties:
accessPointList:
description: One or more access points forming a monitoring area that could be any shape. See note 1.
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Array(String)
occurrenceInfo:
# description': One time only report indication. See note 2.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': OccurrenceInfo
$ref: '#/components/schemas/OccurrenceInfo'
reportingLocationReq:
description: This IE shall be set to true if a location estimate is required for each event report.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: boolean
zoneId:
description: "Identifier of zone (e.g. zone001) to monitor. See note\_1."
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
type: object
x-etsi-notes: "NOTE 1:\tOnly one of accessPointList and zoneId may be present.\nNOTE 2:\tAs specified in [17], clause 6.1.6.3.16."
x-etsi-ref: 6.5.5
WebsockNotifConfig:
properties:
requestWebsocketUri:
description: Set to true by the service consumer to indicate that Websocket delivery is requested.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Boolean
websocketUri:
description: Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uri
type: object
x-etsi-ref: 6.5.4
TestNotification:
properties:
_links:
$ref: '#/components/schemas/_links'
notificationType:
description: Shall be set to "TestNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- notificationType
- _links
type: object
x-etsi-ref: 6.4.3
LocationEventType:
description: This type represents specified event types for UE location report.
enum:
- ENTERING_AREA_EVENT
- LEAVING_AREA_EVENT
type: string
NotificationResult:
description: This enumeration represents the result of a localization associated with a notification
enum:
- SUCCESS
- ABNORMAL
type: string
OccurrenceInfo:
description: The enumeration OccurrenceInfo indicates whether event reporting is one time.
enum:
- ONE_TIME_EVENT
- MULTIPLE_TIME_EVENT
type: string
CivicAddress:
description: Indicates a Civic address
type: object
required:
- country
properties:
country:
description: The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: String
A1:
description: National subdivisions (state, canton, region, province, prefecture)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
A2:
description: County, parish, gun (JP), district (IN)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
A3:
description: City, township, shi (JP)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
A4:
description: City division, borough, city district, ward, chou (JP)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
A5:
description: Neighbourhood, block
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
A6:
description: Group of streets below the neighbourhood level
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
PRD:
description: Leading street direction
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
POD:
description: Trailing street suffix
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
STS:
description: Street suffix or type
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
HNO:
description: House number
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
HNS:
description: House number suffix
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
LMK:
description: Landmark or vanity address
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
LOC:
description: Additional location information
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
NAM:
description: Name (residence and office occupant)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
PC:
description: Postal/zip code
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
BLD:
description: Building (structure)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
UNIT:
description: Unit (apartment, suite)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
FLR:
description: Floor
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
ROOM:
description: Room
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
PLC:
description: Place-type
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
PCN:
description: Postal community name
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
POBOX:
description: Post office box (P.O. box)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
ADDCODE:
description: Additional code
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
SEAT:
description: Seat (desk, cubicle, workstation)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
RD:
description: Primary road or street
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
RDSEC:
description: Road clause
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
RDBR:
description: Road branch
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
RDSUBBR:
description: Road sub-branch
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
PRM:
description: Road pre-modifier
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
POM:
description: Road post-modifier
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
usageRules:
description: When present, this IE shall carry the value of "usagerules" Element of the PIDL-LO XML document, with UTF-8 encoding.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
method:
description: When present, this IE shall contain the method token, carried by the "method" Element of the PIDLLO XML document.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
providedBy:
description: When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String