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",
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
"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"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
}
}
}
}
}
},
"put": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zoneStatusPutById",
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
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
"description": "This operation is used for updating an individual subscription to zone status change notification.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.ZoneStatusSubscription"
}
],
"responses": {
"200": {
"description": "Response to update 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"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
}
}
}
}
}
},
"delete": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"tags": [
"subscriptions"
],
"operationId": "zoneStatusDelById",
1057
1058
1059
1060
1061
1062
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
1096
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
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No content"
}
}
}
}
},
"definitions": {
"AccessPointId": {
"description": "Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element",
"type": "string",
"example": "001010000000000000000000000000001"
},
"AccessPointInfo": {
"description": "A type containing access point information.",
"type": "object",
"required": [
"accessPointId",
"connectionType",
"operationStatus",
"numberOfUsers",
"resourceURL"
],
"properties": {
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"locationInfo": {
"$ref": "#/definitions/LocationInfo"
},
"connectionType": {
"$ref": "#/definitions/ConnectionType"
},
"operationStatus": {
"$ref": "#/definitions/OperationStatus"
},
"numberOfUsers": {
"$ref": "#/definitions/NumberOfUsers"
},
"timezone": {
"$ref": "#/definitions/Timezone"
},
"interestRealm": {
"$ref": "#/definitions/InterestRealm"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"AccessPointList": {
"description": "A type containing list of access points.",
"type": "object",
"required": [
"zoneId",
"resourceURL"
],
"properties": {
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"accessPoint": {
"description": "Collection of the access point information list.",
"type": "array",
"items": {
"$ref": "#/definitions/AccessPointInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"Address": {
"description": "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).",
"type": "string",
"format": "uri",
"example": "acr:192.0.2.1"
},
"AncillaryInfo": {
"description": "Reserved for future use.",
"type": "string"
},
"CallbackData": {
"description": "CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].",
"type": "string",
"example": "1234"
},
"CallbackReference": {
"description": "Notification callback definition.",
"type": "object",
"required": [
"notifyURL"
],
"properties": {
"notifyURL": {
"$ref": "#/definitions/NotifyURL"
}
}
},
"ClientCorrelator": {
"description": "Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.",
"type": "string",
"example": "0123"
},
"ConnectionType": {
"description": "The connection type for the access point",
"type": "string",
"enum": [
"Femto",
"LTE-femto",
"Smallcell",
"LTE-smallcell",
"Wifi",
"Pico",
"Micro",
"Macro",
"Wimax",
"Unknown"
],
1182
1183
1184
1185
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
1226
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
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
"example": "Macro"
},
"ContextLocationInfo": {
"description": "Contextual information of a user location (e.g., aisle, floor, room number, etc.)",
"type": "string",
"example": "GroundFloor"
},
"CurrentAccessPointId": {
"description": "Zone ID",
"type": "string",
"example": "zone01"
},
"Duration": {
"description": "Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
"type": "string",
"example": "0"
},
"InterestRealm": {
"description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type": "string",
"example": "LA"
},
"Link": {
"description": "Link to other resources",
"type": "object",
"required": [
"rel",
"href"
],
"properties": {
"rel": {
"description": "Describes the relationship between the URI and the resource.",
"type": "object",
"format": "string"
},
"href": {
"description": "URI",
"type": "object",
"format": "anyURI"
}
}
},
"LocationInfo": {
"description": "A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.",
"type": "object",
"required": [
"latitude",
"longitude",
"accuracy"
],
"properties": {
"latitude": {
"type": "number",
"format": "float",
"example": "80.123"
},
"longitude": {
"type": "number",
"format": "float",
"example": "70.123"
},
"altitude": {
"type": "number",
"format": "float",
"example": "10.0"
},
"accuracy": {
"type": "integer",
"format": "int32",
"example": "10"
}
}
},
"NotifyURL": {
"description": "The URL of your own listener application.",
"type": "string",
"format": "url",
"example": "http://clientApp.example.com/location_notifications/123456"
},
"NumberOfAccessPoints": {
"description": "The number of access points within the zone",
"type": "integer",
"format": "uint32",
"example": "10"
},
"NumberOfUnserviceableAccessPoints": {
"description": "Number of inoperable access points within the zone.",
"type": "integer",
"format": "uint32",
"example": "9"
},
"NumberOfUsers": {
"description": "The number of users currently on the access point.",
"type": "integer",
"format": "uint32",
"example": "7"
},
"NumberOfUsersAPThreshold": {
"description": "Threshold number of users in an access point which if crossed shall cause a notification.",
"type": "integer",
"format": "uint32",
"example": "20"
},
"NumberOfUsersInAP": {
"description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.",
"type": "integer",
"format": "uint32",
"example": "12"
},
"NumberOfUsersInZone": {
"description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.",
"type": "integer",
"format": "uint32",
"example": "20"
},
"NumberOfUsersZoneThreshold": {
"description": "Threshold number of users in a zone which if crossed shall cause a notification.",
"type": "integer",
"format": "uint32",
"example": "40"
},
"OperationStatus": {
"description": "The operation status of the access point",
"type": "string",
"enum": [
"Serviceable",
"Unserviceable",
"Unknown"
],
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
1342
1343
1344
1345
"example": "Serviceable"
},
"PreviousAccessPointId": {
"description": "Zone ID",
"type": "string",
"example": "zone02"
},
"ResourceURL": {
"description": "Self referring URL.",
"type": "string",
"format": "uri",
"example": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123"
},
"Timestamp": {
"description": "Indicates the time of day for zonal presence notification.",
"type": "string",
"format": "date-time",
"example": "2017-01-01T02:51:43Z"
},
"Timezone": {
"description": "Time zone of access point",
"type": "string",
"format": "date-time",
"example": "2017-01-01T02:51:43Z"
},
"UserEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type": "array",
"items": {
"$ref": "#/definitions/UserEventType"
}
},
"UserEventType": {
"description": "User event",
"type": "string",
"enum": [
"Entering",
"Leaving",
"Transferring"
],
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
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
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
1472
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
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
"example": "Entering"
},
"UserInfo": {
"description": "A type containing user information.",
"type": "object",
"required": [
"address",
"accessPointId",
"zoneId",
"resourceURL"
],
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
},
"locationInfo": {
"$ref": "#/definitions/LocationInfo"
},
"contextLocationInfo": {
"$ref": "#/definitions/ContextLocationInfo"
},
"ancillaryInfo": {
"$ref": "#/definitions/AncillaryInfo"
}
}
},
"UserList": {
"description": "A type containing list of users.",
"type": "object",
"required": [
"resourceURL"
],
"properties": {
"user": {
"description": "Collection of the zone information list.",
"type": "array",
"items": {
"$ref": "#/definitions/UserInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"UserTrackingSubscription": {
"description": "A type containing user tracking subscription.",
"type": "object",
"required": [
"callbackReference",
"address"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"address": {
"$ref": "#/definitions/Address"
},
"userEventCriteria": {
"$ref": "#/definitions/UserEventCriteria"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZonalPresenceNotification": {
"description": "A type containing zonal presence notification",
"type": "object",
"required": [
"zoneId",
"address",
"userEventType",
"currentAccessPointId",
"timestamp"
],
"properties": {
"callbackData": {
"$ref": "#/definitions/CallbackData"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"address": {
"$ref": "#/definitions/Address"
},
"interestRealm": {
"$ref": "#/definitions/InterestRealm"
},
"userEventType": {
"$ref": "#/definitions/UserEventType"
},
"currentAccessPointId": {
"$ref": "#/definitions/CurrentAccessPointId"
},
"previousAccessPointId": {
"$ref": "#/definitions/PreviousAccessPointId"
},
"timestamp": {
"$ref": "#/definitions/Timestamp"
},
"link": {
"description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.",
"type": "array",
"items": {
"$ref": "#/definitions/Link"
},
"example": "rel=\"ZonalTrafficSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123\"/"
}
}
},
"ZonalTrafficSubscription": {
"description": "A type containing zonal traffic subscription",
"type": "object",
"required": [
"callbackReference",
"zoneId"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"interestRealm": {
"description": "Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).",
"type": "array",
"items": {
"$ref": "#/definitions/InterestRealm"
}
},
"userEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type": "array",
"items": {
"$ref": "#/definitions/UserEventType"
}
},
"duration": {
"$ref": "#/definitions/Duration"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneId": {
"description": "Identifier of zone",
"type": "string",
"example": "zone01"
},
"ZoneInfo": {
"description": "A type containing zone information.",
"type": "object",
"required": [
"zoneId",
"numberOfAccessPoints",
"numberOfUnservicableAccessPoints",
"numberOfUsers",
"resourceURL"
],
"properties": {
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"numberOfAccessPoints": {
"$ref": "#/definitions/NumberOfAccessPoints"
},
"numberOfUnservicableAccessPoints": {
"$ref": "#/definitions/NumberOfUnserviceableAccessPoints"
},
"numberOfUsers": {
"$ref": "#/definitions/NumberOfUsers"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneList": {
"description": "Collection of the zone information list.",
"type": "object",
"required": [
"resourceURL"
],
"properties": {
"zone": {
"description": "Collection of the zone information list.",
"type": "array",
"items": {
"$ref": "#/definitions/ZoneInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneStatusNotification": {
"description": "A type containing zone status notification.",
"type": "object",
"required": [
"zoneId",
"timestamp"
],
"properties": {
"callbackData": {
"$ref": "#/definitions/CallbackData"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"numberOfUsersInZone": {
"$ref": "#/definitions/NumberOfUsersInZone"
},
"numberOfUsersInAP": {
"$ref": "#/definitions/NumberOfUsersInAP"
},
"operationStatus": {
"$ref": "#/definitions/OperationStatus"
},
"timestamp": {
"$ref": "#/definitions/Timestamp"
},
"link": {
"description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.",
"type": "array",
"items": {
"$ref": "#/definitions/Link"
},
"example": "rel=\"ZonalStatusSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123\""
}
}
},
"ZoneStatusSubscription": {
"description": "A type containing zone status subscription.",
"type": "object",
"required": [
"callbackReference",
"zoneId"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"numberOfUsersZoneThreshold": {
"$ref": "#/definitions/NumberOfUsersZoneThreshold"
},
"numberOfUsersAPThreshold": {
"$ref": "#/definitions/NumberOfUsersAPThreshold"
},
"operationStatus": {
"description": "List of operation status values to generate notifications for (these apply to all access points within a zone).",
"type": "array",
"items": {
"$ref": "#/definitions/OperationStatus"
}
}
}
}
}
}