Newer
Older
contact:
url: https://forge.etsi.org/rep/mec/gs013-location-api
title: ETSI GS MEC 013 - Location API
version: 2.1.1
description: The ETSI MEC ISG MEC013 WLAN Access Information API described using OpenAPI.
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
externalDocs:
description: ETSI MEC013 V2.1.1 Location API
url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.01.01_60/gs_mec013v020101p.pdf'
servers:
- url: 'https://localhost/location/v2'
tags:
- name: 'location'
summary: 'UE Distance Lookup of a specific UE'
description: 'UE Distance Lookup between terminals or a terminal and a location'
operationId: distanceGET
parameters:
- $ref: '#/components/parameters/Query.Requester'
- $ref: '#/components/parameters/Query.AddressMandatory'
- $ref: '#/components/parameters/Query.Latitude'
- $ref: '#/components/parameters/Query.Longitude'
responses:
'200':
description: 'Successful response to a distance request'
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: 'UE Location Lookup of a specific UE or group of UEs'
description: 'UE Location Lookup of a specific UE or group of UEs'
operationId: usersGET
parameters:
- $ref: '#/components/parameters/Query.ZoneId'
- $ref: '#/components/parameters/Query.AccessPointId'
- $ref: '#/components/parameters/Query.Address'
responses:
'200':
description: 'Successful response to users request'
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"
/queries/zones:
get:
tags:
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
summary: 'Zones information Lookup'
description: 'Used to get a list of identifiers for zones authorized for use by the application.'
operationId: zonesGET
responses:
'200':
description: 'Successful response to zones request'
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"
/queries/zones/{zoneId}:
get:
tags:
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
summary: 'Zones information Lookup'
description: 'Used to get the information for an authorized zone for use by the application.'
operationId: zonesGetById
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
responses:
'200':
description: 'Successful response to an access point Id request'
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:
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
summary: 'Radio Node Location Lookup'
description: 'Radio Node Location Lookup to retrieve a list of radio nodes associated to a zone.'
operationId: apGET
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Query.InterestRealm'
responses:
'200':
description: 'Successful response to an access point Id request'
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:
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
summary: 'Radio Node Location Lookup'
description: 'Radio Node Location Lookup to retrieve a radio node associated to a zone.'
operationId: apByIdGET
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Path.AccessPointId'
responses:
'200':
description: 'Successful response to an access point Id request'
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'
/subscriptions/area/circle:
get:
tags:
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
summary: 'Retrieves all active subscriptions to area change notifications'
description: 'This operation is used for retrieving all active subscriptions to area change notifications.'
operationId: areaCircleSubListGET
responses:
'200':
description: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
circleNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle'
post:
tags:
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
summary: 'Creates a subscription for area change notification'
description: 'Creates a subscription to the Location Service for an area change notification.'
operationId: areaCircleSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
example:
circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
example:
circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/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'
callbacks:
notification:
'{$request.body#/circleNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: circleNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
example:
subscriptionNotification:
enteringLeavingCriteria: 'Entering'
isFinalNotification: false,
rel: CircleNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123'
terminalLocation:
address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/area/circle/{subscriptionId}:
get:
tags:
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: areaCircleSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- circleNotificationSubscription
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
example:
circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/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:
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: areaCircleSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
example:
circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
example:
circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/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:
summary: 'Cancel a subscription'
description: 'Method to delete a subscription.'
operationId: areaCircleSubDELETE
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: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
distanceNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance'
post:
tags:
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: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
example:
distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
example:
distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/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'
callbacks:
notification:
'{$request.body#/distanceNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: distanceNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
example:
subscriptionNotification:
distanceCriteria: 'AllWithinDistance'
isFinalNotification: false,
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
rel: DistanceNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'
terminalLocation:
- address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
- address: 'acr:10.0.0.2'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86301
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: "subscriptions"
/subscriptions/distance/{subscriptionId}:
get:
tags:
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: distanceSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- distanceNotificationSubscription
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
example:
distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/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:
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: distanceSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
example:
distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
example:
distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/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:
summary: 'Cancel a subscription'
description: 'Method to delete a 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'
/subscriptions/periodic:
get:
tags:
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
summary: 'Retrieves all active subscriptions to periodic notifications'
description: 'This operation is used for retrieving all active subscriptions to periodic notifications.'
operationId: periodicSubListGET
responses:
'200':
description: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
periodicNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic'
post:
tags:
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
summary: 'Creates a subscription for periodic notification'
description: 'Creates a subscription to the Location Service for a periodic notification.'
operationId: periodicSubPOST
requestBody:
description: Subscription to be created
required: true
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
example:
periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
example:
periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/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'
callbacks:
notification:
'{$request.body#/periodicNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: periodicNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
example:
subscriptionNotification:
isFinalNotification: false,
rel: PeriodicNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123'
terminalLocation:
address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/periodic/{subscriptionId}:
get:
tags:
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: periodicSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- periodicNotificationSubscription
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
example:
periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/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:
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: periodicSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
example:
periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
example:
periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/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:
summary: 'Cancel a subscription'
description: 'Method to delete a subscription.'
operationId: periodicSubDELETE
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/userTracking:
get:
tags:
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
summary: 'Retrieves all active subscriptions to user tracking notifications'
description: 'This operation is used for retrieving all active subscriptions to user tracking notifications.'
operationId: userTrackingSubListGET
responses:
'200':
description: "Response to retrieve user tracking subscriptions"
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
userTrackingSubscription:
- clientCorrelator: '0123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123'
callbackReference:
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:192.0.2.1'
userEventCriteria: ["Transferring"]
- clientCorrelator: '0124'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124'
callbackReference:
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:192.0.2.2'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking'
post:
tags:
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
summary: 'Creates a subscription for user tracking notification'
description: 'Creates a subscription to the Location Service for user tracking change notification.'
operationId: userTrackingSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription'
example:
userTrackingSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"]
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription'
example:
userTrackingSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
'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#/userTrackingSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: userTrackingNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
zonalPresenceNotification:
$ref: '#/components/schemas/ZonalPresenceNotification'
example:
zonalPresenceNotification:
clientCorrelator: '0123'
zoneId: 'zone01'
address: 'acr:10.0.0.1'
userEventType: 'Transferring'
currentAccessPointId: 'ap2'
previousAccessPointId: 'ap1'
seconds: 1483231138
nanoseconds: 0
link:
rel: UserTrackingSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/userTracking/{subscriptionId}:
get:
tags:
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: userTrackingSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- userTrackingSubscription
properties:
userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription'
example:
userTrackingSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
'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:
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: userTrackingSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription'
example:
userTrackingSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription'
example:
userTrackingSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
'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 subscription'
description: 'Method to delete a subscription.'
operationId: userTrackingSubDELETE
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/zonalTraffic:
get:
tags:
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
summary: 'Retrieves all active subscriptions to zonal traffic notifications'
description: 'This operation is used for retrieving all active subscriptions to zonal traffic change notifications.'
operationId: zonalTrafficSubListGET
responses:
'200':
description: 'Response to retrieve zonal traffic subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
zonalTrafficSubscription:
- clientCorrelator: '0123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123'
callbackReference:
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
- clientCorrelator: '0124'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124'
callbackReference:
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
zoneId: 'zone02'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic'
post:
tags:
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
summary: 'Creates a subscription for zonal traffic notification'
description: 'Creates a subscription to the Location Service for zonal traffic change notification.'
operationId: zonalTrafficSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription'
example:
zonalTrafficSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription'
example:
zonalTrafficSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
'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#/zonalTrafficSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: zonalTrafficNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
zonalPresenceNotification:
$ref: '#/components/schemas/ZonalPresenceNotification'
example:
zonalPresenceNotification:
clientCorrelator: '0123'
zoneId: 'zone01'
address: 'acr:10.0.0.1'
userEventType: 'Transferring'
currentAccessPointId: 'ap2'
previousAccessPointId: 'ap1'
seconds: 1483231138
nanoseconds: 0
link:
rel: ZonalTrafficSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/zonalTraffic/{subscriptionId}:
get:
tags:
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- zonalTrafficSubscription
properties:
zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription'
example:
zonalTrafficSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
'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:
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: zonalTrafficSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription'
example:
zonalTrafiicSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription'
example:
zonalTrafficSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
'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 subscription'
description: 'Method to delete a subscription.'
operationId: zonalTrafficSubDELETE
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/zoneStatus:
get:
tags:
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
summary: 'Retrieves all active subscriptions to zone status notifications'
description: 'This operation is used for retrieving all active subscriptions to zone status change notifications.'
operationId: zoneStatusSubListGET
responses:
'200':
description: 'Response to retrieve zone status subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
example:
notificationSubscriptionList:
zoneStatusSubscription:
- clientCorrelator: '0123'
resourceURL: 'http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123'
callbackReference:
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus'
post:
tags:
summary: 'Creates a subscription for zone status notification'
description: 'Creates a subscription to the Location Service for zone status change notification.'
operationId: zoneStatusSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
example:
zoneStatusSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
example:
zoneStatusSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
'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#/zoneStatusSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: zoneStatusNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
zoneStatusNotification:
$ref: '#/components/schemas/ZoneStatusNotification'
example:
zoneStatusNotification:
clientCorrelator: '0123'
zoneId: 'zone01'
accessPointId: 'poa1'
operationStatus: 'Serviceable'
numberOfUsersInZone: '20'
numberOfUsersInAP: '12'
seconds: 1483231138
nanoseconds: 0
link:
rel: ZoneStatusSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/zoneStatus/{subscriptionId}:
get:
tags:
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: zoneStatusSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- zoneStatusSubscription
properties:
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
example:
zoneStatusSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
'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 subscription information'
description: 'Updates a subscription.'
operationId: zoneStatusSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
example:
zoneStatusSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription'
example:
zoneStatusSubscription:
clientCorrelator: '0123'
callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01'
numberOfUsersZoneThreshold: 500
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
'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:
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
summary: 'Cancel a subscription'
description: 'Method to delete a subscription.'
operationId: zoneStatusSubDELETE
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:
200:
description: 'OK'
204:
description: 'No Content'
400:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
401:
description: 'Unauthorized : used when the client did not submit credentials.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
1822
1823
1824
1825
1826
1827
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
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
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
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/json:
schema:
type: object
required:
- problemDetails
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
404:
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
406:
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
412:
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:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
414:
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:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
415:
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
422:
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:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
example:
application/problem+json:
ProblemDetails:
type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
title: Too many targets
status: '422'
detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc
429:
description: 'Too Many Requests : used when a rate limiter has triggered.'
content:
application/json:
schema:
type: object
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
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
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: 'address of users (e.g. "sip" URI, "tel" URI, "acr" URI)'
required: false
schema:
type: array
items:
type: string
x-exportParamName: Address
Query.AddressMandatory:
name: address
in: query
description: 'address of users (e.g. "sip" URI, "tel" URI, "acr" URI)'
required: true
schema:
type: array
items:
type: string
x-exportParamName: AddressMandatory
Query.InterestRealm:
name: interestRealm
in: query
description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).'
required: false
schema:
type: string
x-exportParamName: InterestRealm
Query.Latitude:
name: latitude
in: query
description: Latitude geo position
required: false
schema:
type: number
format: float
x-exportParamName: Latitude
Query.Longitude:
name: longitude
in: query
description: Longitude geo position
required: false
schema:
type: number
format: float
x-exportParamName: Longitude
Query.Requester:
name: requester
in: query
description: Entity that is requesting the information
required: false
schema:
type: string
x-exportParamName: Requester
Query.ZoneId:
name: zoneId
in: query
description: Identifier of zone
required: false
schema:
type: array
items:
type: string
x-exportParamName: ZoneId
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:
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
timezone:
description: Time zone of access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: dateTimeStamp
required:
- accessPointId
- connectionType
- operationStatus
- numberOfUsers
- resourceURL
type: object
AccessPointList:
description: A type containing list of access points.
properties:
accessPoint:
description: Collection of the access point information list.
items:
$ref: '#/components/schemas/AccessPointInfo'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: AccessPointInfo
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- zoneId
- resourceURL
type: object
CallbackReference:
properties:
callbackData:
description: Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
notificationFormat:
notifyURL:
description: Notify Callback URL
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: anyURI
required:
- notifyURL
type: object
CircleNotificationSubscription:
description: A type containing data for notifications, when the area is defined as a circle.
description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: anyURI
callbackReference:
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-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.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
count:
description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
enteringLeavingCriteria:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
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
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
latitude:
description: Latitude of center point.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
longitude:
description: Longitude of center point.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
radius:
description: Radius circle around center point in meters.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
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
2195
2196
2197
2198
2199
2200
2201
2202
2203
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
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
required:
- callbackReference
- address
- latitude
- longitude
- radius
- trackingAccuracy
- enteringLeavingCriteria
- checkImmediate
- frequency
type: object
ConnectionType:
description: The connection type for the access point
enum:
- Femto
- LTE-femto
- Smallcell
- LTE-smallcell
- Wifi
- Pico
- Micro
- Macro
- Wimax
- Unknown
type: string
DistanceCriteria:
enum:
- AllWithinDistance
- AnyWithinDistance
- AllBeyondDistance
- AnyBeyondDistance
type: string
DistanceNotificationSubscription:
description: A type containing data for distance subscription, with reference to other devices.
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-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.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
count:
description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
criteria:
distance:
description: Distance between devices that shall be monitored.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
frequency:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
monitoredAddress:
description: Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: anyURI
referenceAddress:
description: Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: anyURI
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
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
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
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
required:
- callbackReference
- monitoredAddress
- distance
- trackingAccuracy
- criteria
- checkImmediate
- frequency
type: object
EnteringLeavingCriteria:
enum:
- Entering
- Leaving
type: string
Link:
description: Link to other resources
properties:
href:
description: URI
format: anyURI
type: string
rel:
description: Describes the relationship between the URI and the resource.
type: string
required:
- rel
- href
type: object
LocationInfo:
properties:
accuracy:
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracyAltitude:
description: Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracySemiMinor:
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
format: float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
confidence:
description: Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if "shape" equals 1, 4 or 6
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:
format: float
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:
format: float
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: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
timestamp:
uncertaintyRadius:
description: Present only if "shape" equals 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
velocity:
description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]."
description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
type: integer
x-etsi-mec-cardinality: '1'
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: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
verticalSpeed:
description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4
