Newer
Older
Walter Featherstone
committed
swagger: '2.0'
info:
title: Location API
version: 1.1.1
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: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
Walter Featherstone
committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
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
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
145
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
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
342
343
344
345
346
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
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
523
524
525
526
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
565
566
567
568
569
570
571
572
573
574
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
607
608
609
610
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
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
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
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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
928
929
930
931
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
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
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
externalDocs:
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'
basePath: /exampleAPI/location/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: zones
- name: users
- name: subscriptions
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:
tags:
- zones
operationId: zonesGet
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}':
parameters:
- $ref: '#/parameters/Path.ZoneId'
get:
tags:
- zones
operationId: zonesGetById
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':
parameters:
- $ref: '#/parameters/Path.ZoneId'
get:
tags:
- zones
operationId: zonesByIdGetAps
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}':
parameters:
- $ref: '#/parameters/Path.ZoneId'
- $ref: '#/parameters/Path.AccessPointId'
get:
tags:
- zones
operationId: zonesByIdGetApsById
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:
tags:
- users
operationId: usersGet
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}':
parameters:
- $ref: '#/parameters/Path.UserId'
get:
tags:
- users
operationId: usersGetById
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:
tags:
- subscriptions
operationId: zonalTrafficSubGet
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:
tags:
- subscriptions
operationId: zonalTrafficSubPost
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}':
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
tags:
- subscriptions
operationId: zonalTrafficSubGetById
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:
tags:
- subscriptions
operationId: zonalTrafficSubPutById
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:
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:
tags:
- subscriptions
operationId: userTrackingSubGet
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:
tags:
- subscriptions
operationId: userTrackingSubPost
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}':
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
tags:
- subscriptions
operationId: userTrackingSubGetById
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:
tags:
- subscriptions
operationId: userTrackingSubPutById
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:
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:
tags:
- subscriptions
operationId: zoneStatusGet
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:
tags:
- subscriptions
operationId: zoneStatusPost
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}':
parameters:
- $ref: '#/parameters/Path.SubscriptionId'
get:
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'
zoneId: zone01
numberOfUsersZoneThreshold: '500'
operationStatus: Serviceable
put:
tags:
- subscriptions
operationId: zoneStatusPutById
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:
tags:
- subscriptions
operationId: zoneStatusDelById
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
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
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
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'