Newer
Older
{
"swagger": "2.0",
"info": {
"title": "Location API",
"version": "1.1.1",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence",
"license": {
"name": "ETSI Forge copyright notice",
"url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
}
},
"externalDocs": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "ETSI MEC013 V1.1.1 Location Service API",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf"
},
"host": "127.0.0.1:8081",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"basePath": "/exampleAPI/location/v1",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
{
"name": "zones"
},
{
"name": "users"
},
{
"name": "subscriptions"
}
],
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
90
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
"parameters": {
"Body.UserTrackingSubscription": {
"name": "userTrackingSubscription",
"in": "body",
"description": "User Tracking Subscription",
"required": true,
"schema": {
"$ref": "#/definitions/UserTrackingSubscription"
}
},
"Body.ZonalTrafficSubscription": {
"name": "zonalTrafficSubscription",
"in": "body",
"description": "Zonal Traffic Subscription",
"required": true,
"schema": {
"$ref": "#/definitions/ZonalTrafficSubscription"
}
},
"Body.ZoneStatusSubscription": {
"name": "zoneStatusSubscription",
"in": "body",
"description": "Zone Status Subscription",
"required": true,
"schema": {
"$ref": "#/definitions/ZoneStatusSubscription"
}
},
"Path.AccessPointId": {
"name": "accessPointId",
"in": "path",
"description": "Access Point ID",
"required": true,
"type": "string"
},
"Path.SubscriptionId": {
"name": "subscriptionId",
"in": "path",
"description": "Subscription ID",
"required": true,
"type": "string"
},
"Path.UserId": {
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"type": "string"
},
"Path.ZoneId": {
"name": "zoneId",
"in": "path",
"description": "Zone ID",
"required": true,
"type": "string"
},
"Query.AccessPointId": {
"name": "accessPointId",
"in": "query",
"description": "Identifier of access point, reference \"definitions\" for string format",
"required": false,
"type": "string"
},
"Query.InterestRealm": {
"name": "interestRealm",
"in": "query",
"description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"required": false,
"type": "string"
},
"Query.ZoneId": {
"name": "zoneId",
"in": "query",
"description": "Zone ID",
"required": true,
"type": "string"
}
},
"paths": {
"/zones": {
"get": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"zones"
],
"operationId": "zonesGet",
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
153
154
155
156
157
158
159
160
161
162
163
164
165
"description": "Used to get a list of identifiers for zones authorized for use by the application.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful response to a query regarding the status of a zone",
"schema": {
"properties": {
"zoneList": {
"$ref": "#/definitions/ZoneList"
}
}
},
"examples": {
"application/json": {
"zoneList": {
"zone": [
{
"zoneId": "zone01",
"numberOfAccessPoints": "3",
"numberOfUnserviceableAccessPoints": "1",
"numberOfUsers": "10",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01"
},
{
"zoneId": "zone02",
"numberOfAccessPoints": "12",
"numberOfUnserviceableAccessPoints": "0",
"numberOfUsers": "36",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone02"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/zones"
}
}
}
}
}
}
},
"/zones/{zoneId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"zones"
],
"operationId": "zonesGetById",
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
"description": "Used to get the status of a zone.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful response to a query regarding the status of a zone",
"schema": {
"properties": {
"zoneInfo": {
"$ref": "#/definitions/ZoneInfo"
}
}
},
"examples": {
"application/json": {
"zoneInfo": {
"zoneId": "zone01",
"numberOfAccessPoints": "3",
"numberOfUnserviceableAccessPoints": "1",
"numberOfUsers": "10",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01"
}
}
}
}
}
}
},
"/zones/{zoneId}/accessPoints": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"zones"
],
"operationId": "zonesByIdGetAps",
216
217
218
219
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
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
290
291
"description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Query.InterestRealm"
}
],
"responses": {
"200": {
"description": "Successful response to a query a named set of access point status request",
"schema": {
"properties": {
"accessPointList": {
"$ref": "#/definitions/AccessPointList"
}
}
},
"examples": {
"application/json": {
"accessPointList": {
"zoneId": "zone01",
"accessPoint": [
{
"accessPointId": "001010000000000000000000000000001",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "LA",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap001"
},
{
"accessPointId": "001010000000000000000000000000010",
"locationInfo": {
"latitude": "91.123",
"longitude": "81.123",
"altitude": "12.0",
"accuracy": "1"
},
"connectionType": "Macro",
"operationStatus": "Unserviceable",
"numberOfUsers": "0",
"interestRealm": "DC",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap002"
},
{
"accessPointId": "001010000000000000000000000000011",
"locationInfo": {
"latitude": "93.123",
"longitude": "83.123",
"altitude": "16.0",
"accuracy": "3"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "NJ",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints"
}
}
}
}
}
}
},
"/zones/{zoneId}/accessPoints/{accessPointId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.ZoneId"
},
{
"$ref": "#/parameters/Path.AccessPointId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"zones"
],
"operationId": "zonesByIdGetApsById",
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
342
"description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful response to a query a named set of access point status request",
"schema": {
"properties": {
"accessPointInfo": {
"$ref": "#/definitions/AccessPointInfo"
}
}
},
"examples": {
"application/json": {
"accessPointInfo": {
"accessPointId": "001010000000000000000000000000001",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "LA",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001"
}
}
}
}
}
}
},
"/users": {
"get": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"users"
],
"operationId": "usersGet",
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
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
409
410
411
412
"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Query.ZoneId"
},
{
"$ref": "#/parameters/Query.AccessPointId"
}
],
"responses": {
"200": {
"description": "Successful response to a query users within a zone request",
"schema": {
"properties": {
"userList": {
"$ref": "#/definitions/UserList"
}
}
},
"examples": {
"application/json": {
"userList": {
"user": [
{
"address": "acr:192.0.2.1",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1"
},
{
"address": "acr:192.0.2.2",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.2"
},
{
"address": "acr:192.0.2.3",
"accessPointId": "001010000000000000000000000000010",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.3"
},
{
"address": "acr:192.0.2.4",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone02",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.4"
},
{
"address": "acr:192.0.2.5",
"accessPointId": "001010000000000000000000000000010",
"zoneId": "zone02",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/users"
}
}
}
}
}
}
},
"/users/{userId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.UserId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"users"
],
"operationId": "usersGetById",
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
"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful response to a query users within a zone request",
"schema": {
"properties": {
"userInfo": {
"$ref": "#/definitions/UserInfo"
}
}
},
"examples": {
"application/json": {
"userInfo": {
"address": "acr:192.0.2.1",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"contextLocationInfo": "GroundFloor"
}
}
}
}
}
}
},
"/subscriptions/zonalTraffic": {
"get": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubGet",
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
"description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve zonal traffic subscriptions",
"schema": {
"type": "object",
"properties": {
"notificationSubscriptionList": {
"type": "object",
"properties": {
"zonalTrafficSubscription": {
"type": "array",
"items": {
"$ref": "#/definitions/ZonalTrafficSubscription"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
}
}
},
"examples": {
"application/json": {
"notificationSubscriptionList": {
"zonalTrafficSubscription": [
{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
},
{
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123457"
},
"zoneId": "zone02",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/zonalTraffic"
}
}
}
}
}
},
"post": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubPost",
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
"description": "This operation is used for creating a new subscription to zonal traffic change notification.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.ZonalTrafficSubscription"
}
],
"responses": {
"201": {
"description": "Response to create new zonal traffic subscription",
"schema": {
"properties": {
"zonalTrafficSubscription": {
"$ref": "#/definitions/ZonalTrafficSubscription"
}
}
},
"examples": {
"application/json": {
"zonalTrafficSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
}
}
}
}
}
},
"/subscriptions/zonalTraffic/{subscriptionId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubGetById",
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
"description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve individual zonal traffic subscription",
"schema": {
"properties": {
"zonalTrafficSubscription": {
"$ref": "#/definitions/ZonalTrafficSubscription"
}
}
},
"examples": {
"application/json": {
"zonalTrafficSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
}
}
}
}
},
"put": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubPutById",
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
"description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.ZonalTrafficSubscription"
}
],
"responses": {
"200": {
"description": "Response to update individual zonal traffic subscription",
"schema": {
"properties": {
"zonalTrafficSubscription": {
"$ref": "#/definitions/ZonalTrafficSubscription"
}
}
},
"examples": {
"application/json": {
"zonalTrafficSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
}
}
}
}
},
"delete": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zonalTrafficSubDelById",
"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No content"
}
}
}
},
"/subscriptions/userTracking": {
"get": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubGet",
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
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
725
"description": "This operation is used for retrieving all active subscriptions to user tracking change notifications.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve user tracking subscriptions",
"schema": {
"type": "object",
"properties": {
"notificationSubscriptionList": {
"type": "object",
"properties": {
"userTrackingSubscription": {
"type": "array",
"items": {
"$ref": "#/definitions/UserTrackingSubscription"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
}
}
},
"examples": {
"application/json": {
"notificationSubscriptionList": {
"userTrackingSubscription": [
{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
},
{
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.2",
"userEventCriteria": "Transferring"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking"
}
}
}
}
}
},
"post": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubPost",
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
757
758
759
760
761
762
763
764
765
766
"description": "This operation is used for creating a new subscription to user tracking change notification",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.UserTrackingSubscription"
}
],
"responses": {
"201": {
"description": "Response to create new user tracking subscription",
"schema": {
"properties": {
"userTrackingSubscription": {
"$ref": "#/definitions/UserTrackingSubscription"
}
}
},
"examples": {
"application/json": {
"userTrackingSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
}
}
}
}
}
}
},
"/subscriptions/userTracking/{subscriptionId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubGetById",
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
"description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve individual user tracking subscription",
"schema": {
"properties": {
"userTrackingSubscription": {
"$ref": "#/definitions/UserTrackingSubscription"
}
}
},
"examples": {
"application/json": {
"userTrackingSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
}
}
}
}
}
},
"put": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubPutById",
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
837
838
839
840
841
842
843
844
845
846
847
"description": "This operation is used for updating an individual subscription to user tracking change notification.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.UserTrackingSubscription"
}
],
"responses": {
"200": {
"description": "Response to update individual user tracking subscription",
"schema": {
"properties": {
"userTrackingSubscription": {
"$ref": "#/definitions/UserTrackingSubscription"
}
}
},
"examples": {
"application/json": {
"userTrackingSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
}
}
}
}
}
},
"delete": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "userTrackingSubDelById",
"description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/subscriptions/zonalStatus": {
"get": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zoneStatusGet",
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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
"description": "This operation is used for creating a new subscription to zone status change notification.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve zone status subscriptions",
"schema": {
"type": "object",
"properties": {
"notificationSubscriptionList": {
"type": "object",
"properties": {
"zonalTrafficSubscription": {
"type": "array",
"items": {
"$ref": "#/definitions/ZoneStatusSubscription"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
}
}
},
"examples": {
"application/json": {
"notificationSubscriptionList": {
"zoneStatusSubscription": [
{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
},
{
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123457"
},
"zoneId": "zone02",
"numberOfUsersAPThreshold": "50",
"operationStatus": "Serviceable"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus"
}
}
}
}
}
},
"post": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zoneStatusPost",
932
933
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
"description": "This operation is used for creating a new subscription to zone status change notification.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.ZoneStatusSubscription"
}
],
"responses": {
"201": {
"description": "Response to create new zone status subscription",
"schema": {
"properties": {
"zonalTrafficSubscription": {
"$ref": "#/definitions/ZoneStatusSubscription"
}
}
},
"examples": {
"application/json": {
"zoneStatusSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
}
}
}
}
}
}
},
"/subscriptions/zoneStatus/{subscriptionId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": [
{
"$ref": "#/parameters/Path.SubscriptionId"
}
],
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zoneStatusGetById",
"description": "This operation is used for retrieving an individual subscription to zone status change notification.",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response to retrieve individual zone status subscription",
"schema": {
"properties": {
"zoneStatusSubscription": {
"$ref": "#/definitions/ZoneStatusSubscription"
}
}
},
"examples": {
"application/json": {
"zoneStatusSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"