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 V2.2.1 Location API",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.02.01_60/gs_mec013v020201p.pdf"
"url": "https://localhost/location/v2"
}
],
"tags": [
{
"name": "location"
}
],
"paths": {
"/queries/distance": {
"get": {
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
"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": {
91
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
"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": {
146
147
148
149
150
151
152
153
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
186
187
188
"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": {
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
"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": {
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
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
"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": {
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
"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": {
"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"
}
},
"examples": [
{
"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"
}
"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"
}
},
"examples": [
{
"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"
}
},
"examples": [
{
"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"
}
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
}
}
}
},
"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"
}
},
"examples": [
{
"subscriptionNotification": {
"enteringLeavingCriteria": "Entering",
"isFinalNotification": "false,",
"link": {
"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,
"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": {
"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"
}
},
"examples": [
{
"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"
}
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
}
}
}
},
"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": {
"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"
}
},
"examples": [
{
"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"
}
},
"examples": [
{
"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"
}
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
}
}
}
},
"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": {
726
727
728
729
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
"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": {
"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"
}
},
"examples": [
{
"notificationSubscriptionList": {
"distanceNotificationSubscription": [
{
"clientCorrelator": "0123",
"callbackReference": {
"callbackData": "1234",
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"monitoredAddress": [
"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"
}
"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"
}
},
"examples": [
{
"distanceNotificationSubscription": {
"clientCorrelator": "0123",
"callbackReference": {
"callbackData": "1234",
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"monitoredAddress": ["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"
}
},
"examples": [
{
"distanceNotificationSubscription": {
"clientCorrelator": "0123",
"callbackReference": {
"callbackData": "1234",
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"monitoredAddress": ["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"
}
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
}
}
}
},
"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"
}
},
"examples": [
{
"subscriptionNotification": {
"distanceCriteria": "AllWithinDistance",
"isFinalNotification": "false,",
"link": {
"rel": "DistanceNotificationSubscription",
"href": "http://meAppServer.example.com/location/v2/subscriptions/distance/sub123"
"terminalLocation": [
{
"address": "acr:10.0.0.1",
"currentLocation": {
"accuracy": 100,
"altitude": 1001,
"latitude": -80.86302,
"longitude": 41.277306,
"timestamp": {
"seconds": 1483231138,
"nanoSeconds\"": 0
}
},
"locationRetrievalStatus": "Retrieved"
{
"address": "acr:10.0.0.2",
"currentLocation": {
"accuracy": 100,
"altitude": 1001,
"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": {
"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"
}
},