Newer
Older
info:
title: ETSI GS MEC 028 - WLAN Access Information API
description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
contact:
url: https://forge.etsi.org/rep/mec/gs028-wai-api
version: '2.2.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
- url: https://localhost/wai/v2
variables: {}
paths:
/queries/ap/ap_information:
get:
tags:
description: Queries information about existing WLAN Access Points
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
- name: filter
in: query
description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.
style: form
explode: true
schema:
type: array
items:
type: string
- 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.
style: form
explode: true
schema:
type: array
items:
type: string
- 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'
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successful response to ap_info request
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApInfo'
description: ''
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/queries/sta/sta_information:
get:
tags:
description: Queries information about existing WLAN stations
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
- name: filter
in: query
description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.
style: form
explode: true
schema:
type: array
items:
type: string
- 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.
style: form
explode: true
schema:
type: array
items:
type: string
- 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'
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successful response to sta_info request
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StaInfo'
description: ''
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
- wai
summary: subscriptionLinkList_subscriptionsGET
description: Queries information on subscriptions for notifications
operationId: subscriptionLinkList_subscriptionsGET
parameters:
- name: subscription_type
in: query
description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.'
style: form
explode: true
schema:
type: string
description: Response body contains the list of links to requestors subscriptions.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLinkList'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: subscriptionsPOST
description: Creates a new subscription to WLAN Access Information notifications
requestBody:
description: Subscription to be created
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
description: Subscription to be created
examples:
- subscriptionType: AssocStaSubscription
callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
apId:
bssid: 005C0A0A0A0A
ssid:
- myNetworkSsid
ipAddress:
- 10.10.100.1
contentMediaType: application/json
example:
subscriptionType: AssocStaSubscription
callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
apId:
responses:
'201':
description: Successful subscription response
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
examples:
- 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
contentMediaType: application/json
example:
subscriptionType: AssocStaSubscription
callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
apId:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$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
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/subscriptions/{subscriptionId}:
- wai
summary: subscriptionsGET
description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)
operationId: subscriptionsGET
parameters:
- name: subscriptionId
in: path
description: Subscription Id, specifically the "self" returned in the subscription request
required: true
style: simple
schema:
type: string
responses:
'200':
description: Subscription information regarding subscription notifications
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
examples:
- 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
contentMediaType: application/json
example:
subscriptionType: AssocStaSubscription
callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
apId:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: subscriptionsPUT
description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)
parameters:
- name: subscriptionId
in: path
description: Subscription Id, specifically the "self" returned in the subscription request
required: true
style: simple
schema:
type: string
requestBody:
description: Subscription to be modified
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
description: Subscription to be modified
examples:
- 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
contentMediaType: application/json
example:
subscriptionType: AssocStaSubscription
callbackReference: http://meAppClient.example.com/wai/v2/notifications/1
href: http://meAppServer.example.com/wai/v2/subscriptions/sub123
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
apId:
responses:
'200':
description: Successful subscription modification
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
examples:
- _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
contentMediaType: application/json
href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123
callbackReference: http://my.callback.com/wai/some-id
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$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
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: subscriptionsDELETE
description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
operationId: subscriptionsDELETE
parameters:
- name: subscriptionId
in: path
description: Subscription Id, specifically the "self" returned in the subscription request
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
- wai
summary: measurementLinkList_measurementsGET
description: Queries information on measurements configuration
operationId: measurementLinkList_measurementsGET
description: Response body contains the list of links to requestors measurement configurations.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfigLinkList'
example:
_links:
self:
href: http://meAppServer.example.com/wai/v2/measurements
- href: http://meAppServer.example.com/wai/v2/measurements/meas123
measurementId: myId1
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: measurementsPOST
description: Creates a new measurement configuration
operationId: measurementsPOST
requestBody:
description: Measurement configuration information
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfig'
responses:
'201':
description: Successful measurement configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfig'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$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.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$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
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/measurements/{measurementConfigId}:
- wai
summary: measurementsGET
description: Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
- name: measurementConfigId
in: path
description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request
required: true
style: simple
schema:
type: string
responses:
'200':
description: Measurement configuration information
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfig'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: measurementsPUT
description: Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
parameters:
- name: measurementConfigId
in: path
description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request
required: true
style: simple
schema:
type: string
requestBody:
description: Measurement configuration to be modified
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfig'
responses:
'200':
description: Successful measurement configuration modification
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementConfig'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$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
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- wai
summary: measurementsDELETE
description: Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
- name: measurementConfigId
in: path
description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
components:
schemas:
ApAssociated:
title: ApAssociated
required:
- bssid
type: object
properties:
assocId:
type: string
description: Unique number which identifies a particular association between the station and Access Point.
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.
ipAddress:
minItems: 0
type: array
items:
type: string
description: IPv4 or IPv6 address allocated for the Access Point.
ssid:
items:
type: string
description: Service Set Identifier to identify logical networks.
ApIdentity:
title: ApIdentity
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.
ipAddress:
minItems: 0
type: array
items:
type: string
description: IPv4 or IPv6 address allocated for the Access Point.
ssid:
items:
type: string
description: Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.
ApInfo:
title: ApInfo
type: object
properties:
apId:
$ref: '#/components/schemas/ApIdentity'
apLocation:
$ref: '#/components/schemas/ApLocation'
bssLoad:
$ref: '#/components/schemas/BssLoad'
channel:
type: integer
description: Channel configured for the Access Point.
contentEncoding: int32
extBssLoad:
$ref: '#/components/schemas/ExtBssLoad'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
wanMetrics:
$ref: '#/components/schemas/WanMetrics'
wlanCap:
$ref: '#/components/schemas/WlanCapabilities'
ApLocation:
title: ApLocation
type: object
properties:
civicLocation:
$ref: '#/components/schemas/CivicLocation'
geolocation:
$ref: '#/components/schemas/GeoLocation'
AssocStaNotification:
title: AssocStaNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
type: object
properties:
apId:
$ref: '#/components/schemas/ApIdentity'
staId:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the client station(s) associated.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
title: AssocStaSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- apId
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
apId:
$ref: '#/components/schemas/ApIdentity'
callbackReference:
type: string
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
notificationEvent:
$ref: '#/components/schemas/NotificationEvent'
notificationPeriod:
type: integer
description: >-
Set for periodic notification reporting.
Value indicates the notification period in seconds.
contentEncoding: int32
requestTestNotification:
type: boolean
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.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
BeaconReport:
title: BeaconReport
- bssid
- channel
- measurementId
- operatingClass
- reportedFrameInfo
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].
contentEncoding: int32
description: Indicates the BSSID of the BSS for which a beacon report has been received.
description: Channel number where the beacon was received.
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this Beacon Report.
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
type: integer
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.
contentEncoding: int32
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].
contentEncoding: int32
reportedFrameInfo:
$ref: '#/components/schemas/ReportedBeaconFrameInfo'
rsni:
type: integer
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].
contentEncoding: int32
description: The SSID subelement indicates the ESS or IBSS for which a beacon report is received.
staId:
$ref: '#/components/schemas/StaIdentity'
BeaconReportingConfig:
title: BeaconReportingConfig
- reportingCondition
- threshold
Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]:
0 = Report to be issued after each measurement.
1 = measured RCPI level is greater than the threshold.
2 = measured RCPI level is less than the threshold.
3 = measured RSNI level is greater than the threshold.
4 = measured RSNI level is less than the threshold.
5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI.
6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI.
7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI.
8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI.
9 = 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.
10 = 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.
contentEncoding: int32
description: >-
The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.
For 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].
For 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].
For 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.
contentEncoding: int32
BeaconRequestConfig:
title: BeaconRequestConfig
- beaconReportingConf
- channelId
- measurementMode
- operatingClass
beaconReportingConf:
$ref: '#/components/schemas/BeaconReportingConfig'
bssid:
type: string
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.
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.
contentEncoding: int32
type: integer
description: >-
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8].
contentEncoding: int32
description: The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.
BssCapabilities:
title: BssCapabilities
- apsd
- delayedBACK
- immediateBACK
- qos
- radioMeasurements
- spectrumManagement
description: APSD Option implemented
description: Delayed Block Ack Option implemented
description: Immediate Block Ack Option implemented
description: QoS Option implemented
description: Radio Measurement Activated
description: Spectrum Management required
BssLoad:
title: BssLoad
- availAdmCap
- channelUtilization
- staCount
properties:
availAdmCap:
type: integer
description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.
contentEncoding: int32
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.
contentEncoding: int32
description: An unsigned integer that indicates the total number of STAs currently associated with this BSS.
contentEncoding: int32
BssidInfo:
title: BssidInfo
- apReachability
- capabilities
- ftm
- highThroughput
- mobilityDomain
- security
- veryHighThroughput
The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values:
0 = reserved
1 = not reachable
2 = unknown
3 = reachable.
capabilities:
$ref: '#/components/schemas/BssCapabilities'
ftm:
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.
False 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.
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.
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.
True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association.
False indicates either that the AP does not support the same security provisioning or that the security information is not available at this time.
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.
ChannelLoad:
title: ChannelLoad
- channel
- channelLoad
- measurementDuration
- measurementId
- operatingClass
type: object
properties:
channel:
type: integer
description: Channel number indicates the channel number for which the measurement report applies.
contentEncoding: int32
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 %.
contentEncoding: int32
description: Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this Channel Load Report.
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
ChannelLoadConfig:
title: ChannelLoadConfig
description: Channel for which the channel load report is requested.
contentEncoding: int32
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]:
1 = Report to be issued when Channel Load is greater than or equal to the threshold.
2 = Report to be issued when Channel Load is less than or equal to the threshold.
If this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).
contentEncoding: int32
description: Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.
contentEncoding: int32
CivicLocation:
title: CivicLocation
type: object
properties:
ca0:
type: string
description: National subdivisions (state, canton, region, province, prefecture)
description: Leading street direction
description: Trailing street suffix
description: Street suffix or type
description: County, parish, gun (JP), district (IN)
description: Landmark of vanity address
description: Additional location information
description: Name (residence and office occupant)
description: Building (structure)
description: Unit (apartment/suite)
description: City, township, shi (JP)
description: Postal community name
description: Seat (desk.cubicle, workstation)
description: Sub-branch road name
description: Street name pre-modifier
description: Street name post-modifier
description: City division, borough, city district, ward, chou (JP)
description: Group of streets below the neighborhood level
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]
DmgCapabilities:
title: DmgCapabilities
- ExtScMcsCap
- dmgApOrPcpCapInfo
- dmgStaBeamTrackTimeLimit
- dmgStaCapInfo
- maxNrBasicAmsduSubframes
- maxNrShortAmsduSubframes
type: object
properties:
ExtScMcsCap:
type: integer
description: Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
dmgStaBeamTrackTimeLimit:
type: integer
description: DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: DMG station capabilities information as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
maxNrBasicAmsduSubframes:
type: integer
description: Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
maxNrShortAmsduSubframes:
type: integer
description: Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
EdmgCapabilities:
title: EdmgCapabilities
- ampduParameters
- supportedMcs
- trnParameters
type: object
properties:
ampduParameters:
type: integer
description: A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]
contentEncoding: int32
description: Supported MCS as defined in draft IEEE P802.11ay [i.11]
contentEncoding: int32
description: Training parameters as defined in draft IEEE P802.11ay [i.11]
contentEncoding: int32
ExpiryNotification:
title: ExpiryNotification
- _links
- expiryDeadline
- notificationType
$ref: '#/components/schemas/Links1'
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
notificationType:
type: string
description: Shall be set to "ExpiryNotification".
ExtBssLoad:
title: ExtBssLoad
- muMimoStaCount
- obsSec20MhzUtil
- obsSec40MhzUtil
- obsSec80MhzUtil
- spatStreamUnderUtil
properties:
muMimoStaCount:
type: integer
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.
contentEncoding: int32
description: Observable loading on each of the secondary 20 MHz channel.
contentEncoding: int32
description: Observable loading on each of the secondary 40 MHz channel.
contentEncoding: int32
description: Observable loading on each of the secondary 80 MHz channel.
contentEncoding: int32
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.
contentEncoding: int32
GeoLocation:
title: GeoLocation
- datum
- lat
- latUncertainty
- long
- longUncertainty
type: object
properties:
altitude:
type: integer
description: The altitude value of location as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The uncertainty for altitude information as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The latitude value of location as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The longitude value of location as defined in IETF RFC 6225 [6]
contentEncoding: int32
description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6]
contentEncoding: int32
HeCapabilities:
title: HeCapabilities
- heMacCapInfo
- hePhyCapinfo
- supportedHeMcsNssSet
type: object
properties:
heMacCapInfo:
type: integer
description: MAC capabilities of an Access Point.
contentEncoding: int32
description: PHY capabilities of an Access Point.
contentEncoding: int32
description: Supported MCS and NSS Set.
contentEncoding: int32
HtCapabilities:
title: HtCapabilities
- ampduParameters
- aselCap
- htCapabilityInfo
- htExtendedCap
- supportedMcsSet
- txBeamFormCap
type: object
properties:
ampduParameters:
type: integer
description: A-MPDU parameters as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: ASEL capabilities as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: HT Capability Information as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: Supported MCS set as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
LinkType:
title: LinkType
type: object
properties:
href:
type: string
MeasurementConfig:
title: MeasurementConfig
- measurementId
- measurementInfo
- staId
$ref: '#/components/schemas/Links4'
description: Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration.
measurementInfo:
$ref: '#/components/schemas/MeasurementInfo'
staId:
minItems: 1
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the target client station(s) for the measurement configuration.
MeasurementConfigLinkList:
title: MeasurementConfigLinkList
$ref: '#/components/schemas/Links4'
items:
$ref: '#/components/schemas/MeasurementConfig1'
description: ''
title: MeasurementInfo
type: object
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.
contentEncoding: int32
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.
contentEncoding: int32
staStatisticsConf:
$ref: '#/components/schemas/StaStatisticsConfig'
MeasurementReportNotification:
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
title: MeasurementReportNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- type: object
properties:
beaconReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/BeaconReport'
description: Beacon Report as defined in IEEE 802.11-2016 [8].
channelLoad:
minItems: 0
type: array
items:
$ref: '#/components/schemas/ChannelLoad'
description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8].
neighborReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/NeighborReport'
description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8].
staStatistics:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaStatistics'
description: STA Statistics Report as defined in IEEE 802.11-2016 [8].
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: MeasurementReportSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
- staId
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
measurementId:
type: string
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.
measurementInfo:
$ref: '#/components/schemas/MeasurementInfo'
requestTestNotification:
type: boolean
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.
staId:
minItems: 1
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
title: NeighborReport
required:
- bssid
- bssidInfo
- channel
- measurementId
- operatingClass
- phyType
type: object
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].
contentEncoding: int32
description: BSSID (MAC address) of the Access Point that is being reported.
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].
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this Neighbor Report.
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
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].
2 = dsss
4 = ofdm
5 = hrdsss
6 = erp
7 = ht
8 = dmg
9 = vht
10 = tvht
contentEncoding: int32
staId:
$ref: '#/components/schemas/StaIdentity'
title: NeighborReportConfig
type: object
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
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.
title: OBssLoad
required:
- allocatedTrafficSelfMean
- allocatedTrafficShareMean
type: object
description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.
contentEncoding: int32
description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.
contentEncoding: int32
description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
contentEncoding: int32
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.
contentEncoding: int32
description: Indicates the number of other APs that are sharing the same channel as the reporting AP.
contentEncoding: int32
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title: ReportedBeaconFrameInfo
required:
- frameType
- phyType
type: object
type: integer
description: >-
description: Value between 0 and 127 coded according to dot11PHYType.
contentEncoding: int32
ReportingReasonQoSCounters:
title: ReportingReasonQoSCounters
- qosAckFailure
- qosDiscarded
- qosFailed
- qosFrameDuplicate
- qosMultipleRetry
- qosRetry
- qosRtsFailure
type: object
properties:
qosAckFailure:
type: boolean
description: dot11QoSFrameDuplicate
description: dot11QoSMultipleRetry
description: dot11QoSRTSFailure
ReportingReasonStaCounters:
title: ReportingReasonStaCounters
- ackFailure
- failed
- fcsError
- frameDuplicate
- multipleRetry
- retry
- rtsFailure
type: object
properties:
ackFailure:
type: boolean
title: Rssi
required:
- rssi
type: object
description: The Received Signal Strength Indicator from a station
contentEncoding: int32
title: STACounterTriggerCondition
type: object
description: Configure and set threshold for dot11AckFailureCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FailedCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FCSErrorCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FrameDuplicateCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11MultipleRetryCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11RetryCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11RTSFailureCount trigger
contentEncoding: int32
title: StaDataRate
type: object
properties:
staId:
$ref: '#/components/schemas/StaIdentity'
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.
contentEncoding: int32
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.
contentEncoding: int32
title: StaDataRateNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- type: object
properties:
staDataRate:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaDataRate'
description: Data rates of a client station.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: StaDataRateSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- staId
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
notificationEvent:
$ref: '#/components/schemas/NotificationEvent1'
notificationPeriod:
type: integer
description: >-
Set for periodic notification reporting.
Value indicates the notification period in seconds.
contentEncoding: int32
requestTestNotification:
type: boolean
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.
staId:
minItems: 1
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
StaIdentity:
title: StaIdentity
description: Number which identifies a particular association between a station and an Access Point
items:
type: string
description: IPv4 or IPv6 address(es) allocated for the station.
description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
items:
type: string
description: Service Set Identifier(s) to identify logical networks.
StaInfo:
title: StaInfo
type: object
properties:
apAssociated:
$ref: '#/components/schemas/ApAssociated'
beaconReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/BeaconReport'
description: Beacon Report as defined in IEEE 802.11-2016 [8].
description: Channel currently used by the station to connect with its associated Access Point.
contentEncoding: int32
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.
neighborReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/NeighborReport'
description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].
rssi:
$ref: '#/components/schemas/Rssi'
staDataRate:
$ref: '#/components/schemas/StaDataRate'
staId:
$ref: '#/components/schemas/StaIdentity'
staStatistics:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaStatistics'
description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.
StaStatistics:
title: StaStatistics
- groupIdentity
- measurementDuration
- measurementId
type: object
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].
Depending on group identity, one and only one of the STA Statistics Group Data will be present.
contentEncoding: int32
groupOneData:
$ref: '#/components/schemas/StaStatisticsGroupOneData'
groupZeroData:
$ref: '#/components/schemas/StaStatisticsGroupZeroData'
measurementDuration:
type: integer
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.
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this STA Statistics Report.
StaStatisticsConfig:
title: StaStatisticsConfig
- groupIdentity
- triggeredReport
type: object
properties:
groupIdentity:
type: integer
description: As per Table 9-92 of IEEE 802.11-2016 [8].
contentEncoding: int32
Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.
contentEncoding: int32
triggerCondition:
$ref: '#/components/schemas/STACounterTriggerCondition'
triggerTimeout:
The 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.
contentEncoding: int32
description: True = triggered reporting, otherwise duration.
StaStatisticsGroup2to9Data:
title: StaStatisticsGroup2to9Data
- qosAckFailureCount
- qosDiscardedFrameCount
- qosFailedCount
- qosFrameDuplicateCount
- qosMPDUsReceivedCount
- qosMultipleRetryCount
- qosRTSFailureCount
- qosRTSSuccessCount
- qosReceivedFragmentCount
- qosRetriesReceivedCount
- qosRetryCount
- qosTransmittedFragmentCount
- qosTransmittedFrameCount
description: dot11QosAckFailureCount counter
contentEncoding: int32
description: dot11QosDiscardedFrameCount counter
contentEncoding: int32
description: dot11QosFailedCount counter
contentEncoding: int32
description: dot11QosFrameDuplicateCount counter
contentEncoding: int32
description: dot11QosMPDUsReceivedCount counter
contentEncoding: int32
description: dot11QosMultipleRetryCount counter
contentEncoding: int32
description: dot11QosRTSFailureCount counter
contentEncoding: int32
description: dot11QosRTSSuccessCount counter
contentEncoding: int32
description: dot11QosReceivedFragmentCount counter
contentEncoding: int32
description: dot11QosRetriesReceivedCount counter
contentEncoding: int32
description: dot11QosRetryCount counter
contentEncoding: int32
description: dot11QosTransmittedFragmentCount counter
contentEncoding: int32
description: dot11QosTransmittedFrameCount counter
contentEncoding: int32
reportingReasonQoSCounters:
$ref: '#/components/schemas/ReportingReasonQoSCounters'
StaStatisticsGroupOneData:
title: StaStatisticsGroupOneData
- ackFailureCount
- frameDuplicateCount
- multipleRetryCount
- retryCount
- rtsFailureCount
- rtsSuccessCount
description: dot11AckFailureCount counter
contentEncoding: int32
description: dot11FrameDuplicateCount counter
contentEncoding: int32
description: dot11MultipleRetryCount counter
contentEncoding: int32
reportingReasonStaCounters:
$ref: '#/components/schemas/ReportingReasonStaCounters'
retryCount:
description: dot11RetryCount counter
contentEncoding: int32
description: dot11RTSFailureCount counter
contentEncoding: int32
description: dot11RTSSuccessCount counter
contentEncoding: int32
StaStatisticsGroupZeroData:
title: StaStatisticsGroupZeroData
- failedCount
- fcsErrorCount
- groupReceivedFrameCount
- groupTransmittedFrameCount
- receivedFragmentCount
- transmittedFragmentCount
- transmittedFrameCount
description: dot11FailedCount counter
contentEncoding: int32
description: dot11FCSErrorCount counter
contentEncoding: int32
description: dot11GroupReceivedFrameCount counter
contentEncoding: int32
description: dot11GroupTransmittedFrameCount counter
contentEncoding: int32
description: dot11ReceivedFragmentCount counter
contentEncoding: int32
reportingReasonStaCounters:
$ref: '#/components/schemas/ReportingReasonStaCounters'
transmittedFragmentCount:
description: dot11TransmittedFragmentCount counter
contentEncoding: int32
description: dot11TransmittedFrameCount counter
contentEncoding: int32
SubscriptionLinkList:
title: SubscriptionLinkList
$ref: '#/components/schemas/Links6'
items:
$ref: '#/components/schemas/Subscription'
description: ''
TestNotification:
title: TestNotification
$ref: '#/components/schemas/Links1'
description: Shall be set to "TestNotification".
TimeStamp:
title: TimeStamp
type: object
properties:
nanoSeconds:
type: integer
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
VhtCapabilities:
title: VhtCapabilities
type: object
properties:
vhtCapInfo:
type: integer
description: VHT capabilities Info as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
WanMetrics:
title: WanMetrics
- downlinkLoad
- downlinkSpeed
- lmd
- uplinkLoad
- uplinkSpeed
- wanInfo
type: object
properties:
downlinkLoad:
type: integer
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.
contentEncoding: int32
description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.
contentEncoding: int32
type: integer
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.
contentEncoding: int32
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.
contentEncoding: int32
description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
contentEncoding: int32
description: Info about WAN link status, link symmetricity and capacity currently used.
contentEncoding: int32
title: WebsockNotifConfig
type: object
description: Set to true by the service consumer to indicate that Websocket delivery is requested.
description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
title: WlanCapabilities
type: object
properties:
dmg:
$ref: '#/components/schemas/DmgCapabilities'
edmg:
$ref: '#/components/schemas/EdmgCapabilities'
he:
$ref: '#/components/schemas/HeCapabilities'
ht:
$ref: '#/components/schemas/HtCapabilities'
vht:
$ref: '#/components/schemas/VhtCapabilities'
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
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
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
InlineNotification:
title: InlineNotification
required:
- notificationType
type: object
properties:
notificationType:
type: string
discriminator:
propertyName: notificationType
mapping:
AssocStaNotification: AssocStaNotification
MeasurementReportNotification: MeasurementReportNotification
StaDataRateNotification: StaDataRateNotification
InlineSubscription:
title: InlineSubscription
required:
- subscriptionType
type: object
properties:
subscriptionType:
type: string
discriminator:
propertyName: subscriptionType
mapping:
AssocStaSubscription: AssocStaSubscription
MeasurementReportSubscription: MeasurementReportSubscription
StaDataRateSubscription: StaDataRateSubscription
Links:
title: Links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
Links1:
title: Links1
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource.
Links4:
title: Links4
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource.
Links6:
title: Links6
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: List of hyperlinks related to the resource.
MeasurementConfig1:
title: MeasurementConfig1
required:
- href
- measurementId
type: object
properties:
href:
type: string
description: The URI referring to a measurement configuration.
measurementId:
type: string
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
NotificationEvent:
title: NotificationEvent
required:
- threshold
- trigger
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
2822
2823
2824
properties:
threshold:
type: integer
description: Number of connected stations threshold for trigger-based event reporting.
contentEncoding: int32
trigger:
$ref: '#/components/schemas/Trigger'
description: Set for trigger-based event notification reporting.
NotificationEvent1:
title: NotificationEvent1
required:
- trigger
type: object
properties:
downlinkRateThreshold:
type: integer
description: Downlink data rate threshold for StaDataRate reporting.
contentEncoding: int32
trigger:
$ref: '#/components/schemas/Trigger1'
uplinkRateThreshold:
type: integer
description: Uplink data rate threshold for StaDataRate reporting.
contentEncoding: int32
description: Set for trigger-based event notification reporting.
Subscription:
title: Subscription
required:
- href
- subscriptionType
type: object
properties:
href:
type: string
description: The URI referring to the subscription.
subscriptionType:
type: string
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:
“AssocStaSubscription”
“StaDataRateSubscription”
“MeasurementReportSubscription”
Trigger:
title: Trigger
enum:
- 1
- 2
type: integer
description: >-
Trigger for the notification:
1 = Notification issued when the number of connected stations is greater than or equal to the threshold.
2 = Notification issued when the number of connected stations is less than or equal to the threshold.
examples:
- 1
Trigger1:
title: Trigger1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
description: >-
Trigger event for the notification:
1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.
2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.
3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.
4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.
5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.
6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.
7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.
8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.
examples:
- 1
security:
- {}
tags:
- name: wai
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