Newer
Older
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
},
"title": "ETSI GS MEC 028 - WLAN Access Information API",
"description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"externalDocs": {
"description": "ETSI MEC028 V2.2.1 WLAN Information API",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf"
"url": "https://localhost/wai/v2"
}
],
"tags": [
{
"name": "wai"
}
],
"paths": {
"/queries/ap/ap_information": {
"get": {
"tags": [
],
"summary": "Retrieve information on existing Access Points",
"description": "Queries information about existing WLAN Access Points",
"operationId": "apInfoGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.Filter"
},
{
"$ref": "#/components/parameters/Query.AllFields"
},
{
"$ref": "#/components/parameters/Query.Fields"
},
{
"$ref": "#/components/parameters/Query.ExcludeFields"
},
{
"$ref": "#/components/parameters/Query.ExcludeDefault"
}
],
"responses": {
"200": {
"description": "Successful response to ap_info request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApInfo"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/queries/sta/sta_information": {
"get": {
"tags": [
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
],
"summary": "Retrieve information on existing Stations",
"description": "Queries information about existing WLAN stations",
"operationId": "staInfoGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.Filter"
},
{
"$ref": "#/components/parameters/Query.AllFields"
},
{
"$ref": "#/components/parameters/Query.Fields"
},
{
"$ref": "#/components/parameters/Query.ExcludeFields"
},
{
"$ref": "#/components/parameters/Query.ExcludeDefault"
}
],
"responses": {
"200": {
"description": "Successful response to sta_info request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StaInfo"
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
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
],
"summary": "Retrieve information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications",
"operationId": "subscriptionLinkList_subscriptionsGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.SubscriptionType"
}
],
"responses": {
"200": {
"description": "Response body contains the list of links to requestors subscriptions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions"
}
},
"subscription": [
{
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
}
},
"callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id",
"subscriptionType": "AssocStaSubscription"
}
]
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
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"post": {
"tags": [
],
"summary": "Create a new subscription",
"description": "Creates a new subscription to WLAN Access Information notifications",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "Subscription to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
}
},
"responses": {
"201": {
"description": "Successful subscription response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
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
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"callbacks": {
"notification": {
"{$request.body#/callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "Notification from WAIS, content based on subscription type",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineNotification"
},
"example": {
"notificationType": "AssocStaNotification",
"timeStamp": {
"seconds": 1977836800,
"nanoseconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
],
"aid": "1122",
}
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
],
"summary": "Retrieve information on current specific subscription",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsGET",
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Subscription information regarding subscription notifications",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
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
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": [
],
"summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsPUT",
"requestBody": {
"description": "Subscription to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "AssocStaSubscription",
"callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1",
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
"expiryDeadline": {
"seconds": 1977836800,
"nanoSeconds": 0
},
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Successful subscription modification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
"_links": {
"self": {
"href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
},
"callbackReference": "http://my.callback.com/wai/some-id",
"apId": {
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
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
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
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
],
"summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsDELETE",
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
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
},
"/measurements": {
"get": {
"tags": [
"wai"
],
"summary": "Retrieve information on measurements configuration",
"description": "Queries information on measurements configuration",
"operationId": "measurementLinkList_measurementsGET",
"responses": {
"200": {
"description": "Response body contains the list of links to requestors measurement configurations.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfigLinkList"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements"
}
},
"measurementConfig": [
{
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123",
"measurementId": "myId1"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"post": {
"tags": [
"wai"
],
"summary": "Create a new measurement configuration",
"description": "Creates a new measurement configuration",
"operationId": "measurementsPOST",
"requestBody": {
"description": "Measurement configuration information",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"responses": {
"201": {
"description": "Successful measurement configuration response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/measurements/{measurementConfigId}": {
"get": {
"tags": [
"wai"
],
"summary": "Retrieve information on an existing measurement configuration",
"description": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsGET",
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"200": {
"description": "Measurement configuration information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": [
"wai"
],
"summary": "Modify an existing measurement configuration",
"description": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsPUT",
"requestBody": {
"description": "Measurement configuration to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"200": {
"description": "Successful measurement configuration modification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
"wai"
],
"summary": "Cancel a measurement configuration",
"description": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsDELETE",
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"application/problem+json": {
"type": "https://meAppServer.example.com/wai/v2/probs/too-many targets",
"title": "Too many targets",
"status": "422",
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"parameters": {
"Path.subscrId": {
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"self\" returned in the subscription request",
"required": true,
"schema": {
"type": "string",
"format": "uri"
}
},
"Path.measurementConfigId": {
"name": "measurementConfigId",
"in": "path",
"description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request",
"required": true,
"schema": {
"type": "string",
"format": "uri"
}
},
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
"Query.Filter": {
"name": "filter",
"in": "query",
"description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .",
"required": false,
"schema": {
"type": "string"
}
},
"Query.AllFields": {
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "string"
}
},
"Query.Fields": {
"name": "fields",
"in": "query",
"description": "Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.ExcludeFields": {
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.ExcludeDefault": {
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.SubscriptionType": {
"name": "subscription_type",
"in": "query",
"description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.",
"required": false,
"schema": {
"type": "string"
}
}
},
"schemas": {
"ApAssociated": {
"properties": {
"assocId": {
"description": "Unique number which identifies a particular association between the station and Access Point.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"bssid": {
"description": "Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ipAddress": {
"description": "IPv4 or IPv6 address allocated for the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
},
"ssid": {
"description": "Service Set Identifier to identify logical networks.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
],
"type": "object",
"x-etsi-ref": "6.5.12"
},
"ApIdentity": {
"properties": {
"bssid": {
"description": "Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ipAddress": {
"description": "IPv4 or IPv6 address allocated for the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"ssid": {
"description": "Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
],
"type": "object",
"x-etsi-ref": "6.5.3"
},
"ApInfo": {
"properties": {
"apId": {
},
"channel": {
"description": "Channel configured for the Access Point.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"extBssLoad": {
"oBssLoad": {
"$ref": "#/components/schemas/OBssLoad"
},
}
},
"required": [
"apId"
],
"type": "object",
"x-etsi-ref": "6.2.2"
},
"ApLocation": {
"properties": {
"civicLocation": {
}
},
"type": "object",
"x-etsi-ref": "6.5.9"
},
"AssocStaNotification": {
"properties": {
"apId": {
},
"notificationType": {
"description": "Shall be set to \"AssocStaNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"staId": {
"description": "Identifier(s) to uniquely specify the client station(s) associated.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaIdentity"
},
"timeStamp": {
}
},
"required": [
"notificationType",
"apId"
],
"type": "object",
"x-etsi-ref": "6.4.2"
},
"AssocStaSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"apId": {
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
"notificationEvent": {
"description": "Set for trigger-based event notification reporting. ",
"properties": {
"threshold": {
"description": "Number of connected stations threshold for trigger-based event reporting.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"trigger": {
"description": "Trigger for the notification:\n1 = Notification issued when the number of connected stations is greater than or equal to the threshold.\n2 = Notification issued when the number of connected stations is less than or equal to the threshold.",
"enum": [
1,
2
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum (inline)"
}
},
"required": [
"trigger",
"threshold"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inline)"
},
"notificationPeriod": {
"description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"AssocStaSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": [
"subscriptionType",
"apId"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tAssocStaSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied.",
"antennaId": {
"description": "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"bssid": {
"description": "Indicates the BSSID of the BSS for which a beacon report has been received.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"description": "Channel number where the beacon was received.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
},
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this Beacon Report.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"operatingClass": {
"description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
"parentTsf": {
"description": "The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received.",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"rcpi": {
"description": "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"reportedFrameInfo": {
"$ref": "#/components/schemas/ReportedBeaconFrameInfo"
},
"rsni": {
"description": "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"ssid": {
"description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is received.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"staId": {
}
},
"required": [
"measurementId",
"operatingClass",
"channel",
"reportedFrameInfo",
"bssid"
],
"type": "object",
"x-etsi-ref": "6.5.27"
},
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
"BeaconReportingConfig": {
"properties": {
"reportingCondition": {
"description": "Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = measured RCPI level is greater than the threshold.\n2 = measured RCPI level is less than the threshold.\n3 = measured RSNI level is greater than the threshold.\n4 = measured RSNI level is less than the threshold.\n5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI.\n6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI.\n7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI.\n8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI.\n9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI.\n10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"threshold": {
"description": "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"reportingCondition",
"threshold"
],
"type": "object",
"x-etsi-ref": "6.5.28"
},
"beaconReportingConf": {
"$ref": "#/components/schemas/BeaconReportingConfig"
},
"bssid": {
"description": "The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"channelId": {
"description": "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
},
"measurementMode": {
"description": "0 for passive.\n1 for active.\n2 for beacon table.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"operatingClass": {
"description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"ssid": {
"description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
],
"type": "object",
"x-etsi-ref": "6.5.25"
},
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
"BssCapabilities": {
"properties": {
"apsd": {
"description": "APSD Option implemented",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"delayedBACK": {
"description": "Delayed Block Ack Option implemented",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"immediateBACK": {
"description": "Immediate Block Ack Option implemented",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qos": {
"description": "QoS Option implemented",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"radioMeasurements": {
"description": "Radio Measurement Activated",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"spectrumManagement": {
"description": "Spectrum Management required",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
}
},
"required": [
"spectrumManagement",
"qos",
"apsd",
"radioMeasurements",
"delayedBACK",
"immediateBACK"
],
"type": "object",
"x-etsi-ref": "6.5.31"
},
"BssLoad": {
"properties": {
"availAdmCap": {
"description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"channelUtilization": {
"description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"staCount": {
"description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
}
},
"required": [
"staCount",
"channelUtilization",
"availAdmCap"
],
"type": "object",
"x-etsi-ref": "6.5.7"
},
"apReachability": {
"description": "The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values:\n0 = reserved\n1 = not reachable\n2 = unknown\n3 = reachable.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"capabilities": {
"$ref": "#/components/schemas/BssCapabilities"
},
"ftm": {
"description": "True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1.\n\nFalse indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time.",
"type": "boolean",
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
"x-etsi-mec-origin-type": "Boolean"
},
"highThroughput": {
"description": "True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"mobilityDomain": {
"description": "True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"security": {
"description": "True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association.\n\nFalse indicates either that the AP does not support the same security provisioning or that the security information is not available at this time.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"veryHighThroughput": {
"description": "True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
"apReachability",
"security",
"capabilities",
"mobilityDomain",
"highThroughput",
"veryHighThroughput",
"ftm"
"channel": {
"description": "Channel number indicates the channel number for which the measurement report applies.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
"channelLoad": {
"description": "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
"measurementDuration": {
"description": "Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this Channel Load Report.",
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
"operatingClass": {
"description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"staId": {
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
"measurementId",
"operatingClass",
"channel",
"measurementDuration",
"channelLoad"
],
"type": "object",
"x-etsi-ref": "6.5.39"
},
"ChannelLoadConfig": {
"properties": {
"channel": {
"description": "Channel for which the channel load report is requested.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"operatingClass": {
"description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"reportingCondition": {
"description": "Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = Report to be issued when Channel Load is greater than or equal to the threshold.\n2 = Report to be issued when Channel Load is less than or equal to the threshold.\n\nIf this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"threshold": {
"description": "Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"operatingClass",
"channel"
],
"type": "object",
"x-etsi-ref": "6.5.24"
},
"CivicLocation": {
"properties": {
"ca0": {
"description": "Language",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca1": {
"description": "National subdivisions (state, canton, region, province, prefecture) ",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca128": {
"description": "Script",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca16": {
"description": "Leading street direction",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca17": {
"description": "Trailing street suffix",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
},
"ca18": {
"description": "Street suffix or type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca19": {
"description": "House number",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca2": {
"description": "County, parish, gun (JP), district (IN)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca20": {
"description": "House number suffix",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca21": {
"description": "Landmark of vanity address",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca22": {
"description": "Additional location information",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca23": {
"description": "Name (residence and office occupant)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca24": {
"description": "Postal/zip code",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca25": {
"description": "Building (structure)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca26": {
"description": "Unit (apartment/suite)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca27": {
"description": "Floor",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca28": {
"description": "Room",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca29": {
"description": "Type of place",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca3": {
"description": "City, township, shi (JP)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca30": {
"description": "Postal community name",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca31": {
"description": "Post office box",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca32": {
"description": "Additional code",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca33": {
"description": "Seat (desk.cubicle, workstation)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca34": {
"description": "Primary road name",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca35": {
"description": "Road section",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca36": {
"description": "Branch road name",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca37": {
"description": "Sub-branch road name",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca38": {
"description": "Street name pre-modifier",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca39": {
"description": "Street name post-modifier",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca4": {
"description": "City division, borough, city district, ward, chou (JP)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca5": {
"description": "Neighborhood, block",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ca6": {
"description": "Group of streets below the neighborhood level ",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"country": {
"description": "The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"country"
],
"type": "object",
"x-etsi-ref": "6.5.20"
},
"DmgCapabilities": {
"properties": {
"ExtScMcsCap": {
"description": "Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"dmgApOrPcpCapInfo": {
"description": "DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"dmgStaBeamTrackTimeLimit": {
"description": "DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. ",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"dmgStaCapInfo": {
"description": "DMG station capabilities information as defined in IEEE 802.11-2016 [8]. ",
"format": "uint64",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint64"
},
"maxNrBasicAmsduSubframes": {
"description": "Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"maxNrShortAmsduSubframes": {
"description": "Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"dmgStaCapInfo",
"dmgApOrPcpCapInfo",
"dmgStaBeamTrackTimeLimit",
"ExtScMcsCap",
"maxNrBasicAmsduSubframes",
],
"type": "object",
"x-etsi-ref": "6.5.17"
},
"EdmgCapabilities": {
"properties": {
"ampduParameters": {
"description": "A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"supportedMcs": {
"description": "Supported MCS as defined in draft IEEE P802.11ay [i.11]",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"trnParameters": {
"description": "Training parameters as defined in draft IEEE P802.11ay [i.11]",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
}
},
"required": [
"ampduParameters",
"trnParameters",
"supportedMcs"
],
"type": "object",
"x-etsi-ref": "6.5.18"
},
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
"ExpiryNotification": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource.",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
"subscription"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"notificationType": {
"description": "Shall be set to \"ExpiryNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"notificationType",
"_links",
"expiryDeadline"
],
"type": "object",
"x-etsi-ref": "6.4.4"
},
"ExtBssLoad": {
"properties": {
"muMimoStaCount": {
"description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
},
"obsSec20MhzUtil": {
"description": "Observable loading on each of the secondary 20 MHz channel.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"obsSec40MhzUtil": {
"description": "Observable loading on each of the secondary 40 MHz channel.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"obsSec80MhzUtil": {
"description": "Observable loading on each of the secondary 80 MHz channel.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"spatStreamUnderUtil": {
"description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
}
},
"required": [
"muMimoStaCount",
"spatStreamUnderUtil",
"obsSec20MhzUtil",
"obsSec40MhzUtil",
"obsSec80MhzUtil"
],
"type": "object",
"x-etsi-ref": "6.5.8"
},
"GeoLocation": {
"properties": {
"altitude": {
"description": "The altitude value of location as defined in IETF RFC 6225 [6]",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"altitudeType": {
"description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"altitudeUncertainty": {
"description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"datum": {
"description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"lat": {
"description": "The latitude value of location as defined in IETF RFC 6225 [6]",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint64"
},
"latUncertainty": {
"description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"long": {
"description": "The longitude value of location as defined in IETF RFC 6225 [6]",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint64"
},
"longUncertainty": {
"description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"latUncertainty",
"lat",
"longUncertainty",
"long",
"datum"
],
"type": "object",
"x-etsi-ref": "6.5.19"
},
"HeCapabilities": {
"properties": {
"heMacCapInfo": {
"description": "MAC capabilities of an Access Point.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"hePhyCapinfo": {
"description": "PHY capabilities of an Access Point.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"supportedHeMcsNssSet": {
"description": "Supported MCS and NSS Set.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"heMacCapInfo",
"hePhyCapinfo",
"supportedHeMcsNssSet"
],
"type": "object",
"x-etsi-ref": "6.5.16"
},
"HtCapabilities": {
"properties": {
"ampduParameters": {
"description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"aselCap": {
"description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"htCapabilityInfo": {
"description": "HT Capability Information as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
},
"htExtendedCap": {
"description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
},
"supportedMcsSet": {
"description": "Supported MCS set as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint128"
},
"txBeamFormCap": {
"description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt32"
}
},
"required": [
"htCapabilityInfo",
"ampduParameters",
"supportedMcsSet",
"htExtendedCap",
"txBeamFormCap",
"aselCap"
],
"type": "object",
"discriminator": {
"propertyName": "notificationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaNotification"
},
{
"$ref": "#/components/schemas/StaDataRateNotification"
},
{
"$ref": "#/components/schemas/MeasurementReportNotification"
"discriminator": {
"propertyName": "subscriptionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AssocStaSubscription"
},
{
"$ref": "#/components/schemas/StaDataRateSubscription"
},
{
"$ref": "#/components/schemas/MeasurementReportSubscription"
},
"LinkType": {
"properties": {
"href": {
}
},
"required": [
"href"
],
"type": "object",
"x-etsi-ref": "6.5.23"
},
"MeasurementConfig": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
"description": "Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"measurementInfo": {
"$ref": "#/components/schemas/MeasurementInfo"
"staId": {
"description": "Identifier(s) to uniquely specify the target client station(s) for the measurement configuration.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "StaIdentity"
],
"type": "object",
"x-etsi-ref": "6.2.4"
},
"_links": {
"description": "Hyperlink related to the resource.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
"self"
],
"type": "object",
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
"measurementConfig": {
"description": "",
"items": {
"properties": {
"href": {
"description": "The URI referring to a measurement configuration.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"measurementId": {
"description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"href",
"measurementId"
],
"type": "object"
},
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
"beaconRequestConf": {
"$ref": "#/components/schemas/BeaconRequestConfig"
"channelLoadConf": {
"$ref": "#/components/schemas/ChannelLoadConfig"
"measurementDuration": {
"description": "Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
"neighborReportConf": {
"$ref": "#/components/schemas/NeighborReportConfig"
},
"randomInterval": {
"description": "Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint16"
},
"staStatisticsConf": {
"$ref": "#/components/schemas/StaStatisticsConfig"
}
},
"type": "object",
"x-etsi-notes": "NOTE 1:\tOnly one of channelLoadConf, beaconRequestConf, staStatisticsConf or neighborReportConf is allowed in a MeasurementInfo instance.\nNOTE 2:\tAs per IEEE 802.11-2016 [8], measurementDuration and randomInterval apply to channelLoad, beaconRequest, staStatistics, and neighborReport configurations.",
"x-etsi-ref": "6.5.41"
},
"MeasurementReportNotification": {
"properties": {
"beaconReport": {
"description": "Beacon Report as defined in IEEE 802.11-2016 [8].",
"items": {
"$ref": "#/components/schemas/BeaconReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "BeaconReport"
},
"channelLoad": {
"description": "Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8].",
"items": {
"$ref": "#/components/schemas/ChannelLoad"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ChannelLoad"
},
"neighborReport": {
"description": "Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8].",
"items": {
"$ref": "#/components/schemas/NeighborReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "NeighborReport"
},
"notificationType": {
"description": "Shall be set to \"MeasurementReportNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"staStatistics": {
"description": "STA Statistics Report as defined in IEEE 802.11-2016 [8].",
"items": {
"$ref": "#/components/schemas/StaStatistics"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaStatistics"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
"notificationType"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tEach MeasurementReportNotification shall include a single measurement report type (channelLoad, beaconRequest, etc.), based on the MeasurementReportSubscription.\nNOTE 2:\tA single MeasurementReportNotification may include multiple measurement reports (of the same type), if the MeasurementReportSubscription configured the measurement report for several client stations and multiple reports are available to WAIS.",
"x-etsi-ref": "6.4.5"
},
"MeasurementReportSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"callbackReference": {
"type": "string"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"measurementId": {
"description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"measurementInfo": {
"$ref": "#/components/schemas/MeasurementInfo"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"staId": {
"description": "Identifier(s) to uniquely specify the target client station(s) for the subscription.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "StaIdentity"
},
"subscriptionType": {
"description": "Shall be set to \"MeasurementReportSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": [
"subscriptionType",
"staId",
"measurementId",
"measurementInfo"
],
"type": "object",
"x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.",
"x-etsi-ref": "6.3.5"
},
"NeighborReport": {
"properties": {
"bssTransitionCandidatePreference": {
"description": "Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"bssid": {
"description": "BSSID (MAC address) of the Access Point that is being reported.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"bssidInfo": {
"$ref": "#/components/schemas/BssidInfo"
},
"channel": {
"description": "Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this Neighbor Report.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"operatingClass": {
"description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"phyType": {
"description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8].\n2 = dsss\n4 = ofdm\n5 = hrdsss\n6 = erp\n7 = ht\n8 = dmg\n9 = vht\n10 = tvht",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"staId": {
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
"measurementId",
"bssid",
"bssidInfo",
"operatingClass",
"channel",
"phyType"
],
"type": "object",
"x-etsi-ref": "6.5.10"
},
"NeighborReportConfig": {
"properties": {
"bssid": {
"description": "BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ssid": {
"description": "The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
}
},
"type": "object",
"x-etsi-notes": "NOTE:\tBoth SSID and BSSID are optional configuration parameters. BSSID is valid when a SSID setting is provided, otherwise ignored. If SSID is not included, the neighbor report will be generated for the SSID (i.e. current ESS) that the station is associated.",
"x-etsi-ref": "6.5.32"
},
"OBssLoad": {
"properties": {
"allocatedTrafficSelfMean": {
"description": "Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"allocatedTrafficSelfStdDev": {
"description": "Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint16"
},
"allocatedTrafficShareMean": {
"description": "Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"allocatedTrafficShareStdDev": {
"description": "Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint16"
},
"overlap": {
"description": "Indicates the number of other APs that are sharing the same channel as the reporting AP.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"allocatedTrafficSelfMean",
"allocatedTrafficShareMean"
],
"type": "object",
"x-etsi-ref": "6.5.40"
},
"ProblemDetails": {
"properties": {
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"title": {
"description": "A short, human-readable summary of the problem type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"type": {
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
},
"type": "object"
},
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
"ReportedBeaconFrameInfo": {
"properties": {
"frameType": {
"description": "A value of 0 indicates a Beacon or Probe Response.\nA value of 1 indicates a Measurement Pilot frame.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"phyType": {
"description": "Value between 0 and 127 coded according to dot11PHYType.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"phyType",
"frameType"
],
"type": "object",
"x-etsi-ref": "6.5.29"
},
"ReportingReasonQoSCounters": {
"properties": {
"qosAckFailure": {
"description": "dot11QoSAckFailure",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosDiscarded": {
"description": "dot11QoSDiscarded",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosFailed": {
"description": "dot11QoSFailed ",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosFrameDuplicate": {
"description": "dot11QoSFrameDuplicate",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosMultipleRetry": {
"description": "dot11QoSMultipleRetry",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosRetry": {
"description": "dot11QoSRetry",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"qosRtsFailure": {
"description": "dot11QoSRTSFailure",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
}
},
"required": [
"qosFailed",
"qosRetry",
"qosMultipleRetry",
"qosFrameDuplicate",
"qosRtsFailure",
"qosAckFailure",
"qosDiscarded"
],
"type": "object",
"x-etsi-ref": "6.5.38"
},
"ReportingReasonStaCounters": {
"properties": {
"ackFailure": {
"description": "dot11AckFailure",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"failed": {
"description": "dot11Failed",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"fcsError": {
"description": "dot11FCSError ",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"frameDuplicate": {
"description": "dot11FrameDuplicate ",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"multipleRetry": {
"description": "dot11MultipleRetry",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"retry": {
"description": "dot11Retry",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
},
"rtsFailure": {
"description": "dot11RTSFailure",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
}
},
"required": [
"failed",
"fcsError",
"multipleRetry",
"frameDuplicate",
"rtsFailure",
"ackFailure",
"retry"
],
"type": "object",
"x-etsi-ref": "6.5.37"
},
"Rssi": {
"properties": {
"rssi": {
"description": "The Received Signal Strength Indicator from a station",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"rssi"
],
"type": "object",
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
"x-etsi-ref": "6.5.21"
},
"STACounterTriggerCondition": {
"properties": {
"ackFailureCountThreshold": {
"description": "Configure and set threshold for dot11AckFailureCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"failedCountThreshold": {
"description": "Configure and set threshold for dot11FailedCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"fcsErrorCountThreshold": {
"description": "Configure and set threshold for dot11FCSErrorCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"frameDuplicateCountThreshold": {
"description": "Configure and set threshold for dot11FrameDuplicateCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"multipleRetryCountThreshold": {
"description": "Configure and set threshold for dot11MultipleRetryCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"retryCountThreshold": {
"description": "Configure and set threshold for dot11RetryCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"rtsFailureCountThreshold": {
"description": "Configure and set threshold for dot11RTSFailureCount trigger",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"type": "object",
"x-etsi-ref": "6.5.33"
},
"StaDataRate": {
"properties": {
"staId": {
},
"staLastDataDownlinkRate": {
"description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"staLastDataUplinkRate": {
"description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"type": "object",
"x-etsi-notes": "NOTE:\tStaDataRate shall include at least one instance of either downlink rate or uplink rate and may include both.\n If this report is contained within a data type that provides the station's identifier, staId field may be omitted",
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
"x-etsi-ref": "6.5.22"
},
"StaDataRateNotification": {
"properties": {
"notificationType": {
"description": "Shall be set to \"StaDataRateNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"staDataRate": {
"description": "Data rates of a client station.",
"items": {
"$ref": "#/components/schemas/StaDataRate"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaDataRate"
},
"timeStamp": {
}
},
"required": [
"notificationType"
],
"type": "object",
"x-etsi-ref": "6.4.3"
},
"StaDataRateSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"callbackReference": {
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
"notificationEvent": {
"description": "Set for trigger-based event notification reporting.",
"properties": {
"downlinkRateThreshold": {
"description": "Downlink data rate threshold for StaDataRate reporting.",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"trigger": {
"description": "Trigger event for the notification:\n1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.\n2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.\n3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.\n4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.\n5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.\n6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.\n7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.\n8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum (inline)"
},
"uplinkRateThreshold": {
"description": "Uplink data rate threshold for StaDataRate reporting.",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": [
"trigger"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inline)"
},
"notificationPeriod": {
"description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"description": "Identifier(s) to uniquely specify the target client station(s) for the subscription.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "StaIdentity"
},
"subscriptionType": {
"description": "Shall be set to \"StaDataRateSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": [
"subscriptionType",
"staId"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tStaDataRateSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied.",
"x-etsi-ref": "6.3.3"
},
"StaIdentity": {
"properties": {
"aid": {
"description": "Number which identifies a particular association between a station and an Access Point",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ipAddress": {
"description": "IPv4 or IPv6 address(es) allocated for the station.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"macId": {
"description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ssid": {
"description": "Service Set Identifier(s) to identify logical networks.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"macId"
],
"type": "object",
"x-etsi-ref": "6.5.11"
},
"StaInfo": {
"properties": {
"apAssociated": {
"description": "Beacon Report as defined in IEEE 802.11-2016 [8]. ",
"items": {
"$ref": "#/components/schemas/BeaconReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "BeaconReport"
"description": "Channel currently used by the station to connect with its associated Access Point.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"channelLoad": {
"description": "Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association.",
"items": {
"$ref": "#/components/schemas/ChannelLoad"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ChannelLoad"
},
"neighborReport": {
"description": "Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].",
"items": {
"$ref": "#/components/schemas/NeighborReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "NeighborReport"
},
"description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.",
"items": {
"$ref": "#/components/schemas/StaStatistics"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaStatistics"
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
"staId"
],
"type": "object",
"x-etsi-ref": "6.2.3"
},
"StaStatistics": {
"properties": {
"group2to9Data": {
"$ref": "#/components/schemas/StaStatisticsGroup2to9Data"
"groupIdentity": {
"description": "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present.",
"format": "uint8",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
"groupOneData": {
"$ref": "#/components/schemas/StaStatisticsGroupOneData"
"groupZeroData": {
"$ref": "#/components/schemas/StaStatisticsGroupZeroData"
"measurementDuration": {
"description": "Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values.",
"format": "uint16",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this STA Statistics Report.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"staId": {
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
"measurementId",
"measurementDuration",
"groupIdentity"
],
"type": "object",
"x-etsi-ref": "6.5.13"
},
"StaStatisticsConfig": {
"properties": {
"groupIdentity": {
"description": "As per Table 9-92 of IEEE 802.11-2016 [8].",
"format": "uint8",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
"measurementCount": {
"description": "Valid if triggeredReport = true.\nSpecifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"triggerCondition": {
"$ref": "#/components/schemas/STACounterTriggerCondition"
"triggerTimeout": {
"description": "Valid if triggeredReport = true.\nThe Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"triggeredReport": {
"description": "True = triggered reporting, otherwise duration.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
}
},
"required": [
"groupIdentity",
"triggeredReport"
],
"type": "object",
"x-etsi-ref": "6.5.26"
},
"StaStatisticsGroup2to9Data": {
"properties": {
"qosAckFailureCount": {
"description": "dot11QosAckFailureCount counter",
"qosDiscardedFrameCount": {
"description": "dot11QosDiscardedFrameCount counter",
"qosFailedCount": {
"description": "dot11QosFailedCount counter",
"qosFrameDuplicateCount": {
"description": "dot11QosFrameDuplicateCount counter",
"qosMPDUsReceivedCount": {
"description": "dot11QosMPDUsReceivedCount counter",
"qosMultipleRetryCount": {
"description": "dot11QosMultipleRetryCount counter",
"qosRTSFailureCount": {
"description": "dot11QosRTSFailureCount counter",
"qosRTSSuccessCount": {
"description": "dot11QosRTSSuccessCount counter",
"qosReceivedFragmentCount": {
"description": "dot11QosReceivedFragmentCount counter",
"qosRetriesReceivedCount": {
"description": "dot11QosRetriesReceivedCount counter",
"qosRetryCount": {
"description": "dot11QosRetryCount counter",
"qosTransmittedFragmentCount": {
"description": "dot11QosTransmittedFragmentCount counter",
"qosTransmittedFrameCount": {
"description": "dot11QosTransmittedFrameCount counter",
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
"reportingReasonQoSCounters": {
"$ref": "#/components/schemas/ReportingReasonQoSCounters"
}
},
"required": [
"qosTransmittedFragmentCount",
"qosFailedCount",
"qosRetryCount",
"qosMultipleRetryCount",
"qosFrameDuplicateCount",
"qosRTSSuccessCount",
"qosRTSFailureCount",
"qosAckFailureCount",
"qosReceivedFragmentCount",
"qosTransmittedFrameCount",
"qosDiscardedFrameCount",
"qosMPDUsReceivedCount",
"qosRetriesReceivedCount"
],
"type": "object",
"x-etsi-ref": "6.5.36"
},
"StaStatisticsGroupOneData": {
"properties": {
"ackFailureCount": {
"description": "dot11AckFailureCount counter",
"frameDuplicateCount": {
"description": "dot11FrameDuplicateCount counter",
"multipleRetryCount": {
"description": "dot11MultipleRetryCount counter",
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"retryCount": {
"description": "dot11RetryCount counter",
"rtsFailureCount": {
"description": "dot11RTSFailureCount counter",
"rtsSuccessCount": {
"description": "dot11RTSSuccessCount counter",
}
},
"required": [
"retryCount",
"multipleRetryCount",
"frameDuplicateCount",
"rtsSuccessCount",
"rtsFailureCount",
"ackFailureCount"
],
"type": "object",
"x-etsi-ref": "6.5.35"
},
"StaStatisticsGroupZeroData": {
"properties": {
"failedCount": {
"description": "dot11FailedCount counter",
"fcsErrorCount": {
"description": "dot11FCSErrorCount counter",
"groupReceivedFrameCount": {
"description": "dot11GroupReceivedFrameCount counter",
"groupTransmittedFrameCount": {
"description": "dot11GroupTransmittedFrameCount counter",
"receivedFragmentCount": {
"description": "dot11ReceivedFragmentCount counter",
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"transmittedFragmentCount": {
"description": "dot11TransmittedFragmentCount counter",
"transmittedFrameCount": {
"description": "dot11TransmittedFrameCount counter",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": [
"transmittedFragmentCount",
"groupTransmittedFrameCount",
"failedCount",
"receivedFragmentCount",
"groupReceivedFrameCount",
"fcsErrorCount",
"transmittedFrameCount"
],
"type": "object",
"x-etsi-ref": "6.5.34"
},
"SubscriptionLinkList": {
"properties": {
"_links": {
"description": "List of hyperlinks related to the resource.",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
"minItems": 0,
"properties": {
"href": {
"description": "The URI referring to the subscription.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"subscriptionType": {
"description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:\n“AssocStaSubscription”\n“StaDataRateSubscription”\n“MeasurementReportSubscription”",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"href",
"subscriptionType"
],
"type": "object"
},
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"required": [
"_links"
],
"type": "object",
"x-etsi-ref": "6.3.4"
},
"TestNotification": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. ",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
"required": [
"subscription"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"notificationType": {
"description": "Shall be set to \"TestNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"seconds": {
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"VhtCapabilities": {
"properties": {
"vhtCapInfo": {
"description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt32"
},
"vhtMcsNss": {
"description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt64"
}
},
"required": [
"vhtCapInfo",
"vhtMcsNss"
],
"type": "object",
"x-etsi-ref": "6.5.15"
},
"WanMetrics": {
"properties": {
"downlinkLoad": {
"description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"downlinkSpeed": {
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"lmd": {
"description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"uplinkLoad": {
"description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"uplinkSpeed": {
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt32"
},
"wanInfo": {
"description": "Info about WAN link status, link symmetricity and capacity currently used.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"wanInfo",
"downlinkSpeed",
"uplinkSpeed",
"downlinkLoad",
"uplinkLoad",
"lmd"
],
"type": "object",
"x-etsi-ref": "6.5.6"
},
"WebsockNotifConfig": {
"properties": {
"requestWebsocketUri": {
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"websocketUri": {
"description": "Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"type": "string"
}
},
"type": "object",
"x-etsi-ref": "6.3.6"
},
"WlanCapabilities": {
"properties": {
"dmg": {
}
},
"type": "object",
"x-etsi-ref": "6.5.4"
}
}
}
}