summary:Retrieve a list of active subscriptions for this subscriber.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
description:The POST method is used to create a new subscription to WLAN notifications. Upon success, the response contains entity body describing the created subscription.
summary:Retrieve information on current specific subscription.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)
operationId:subscriptionsPUT
$ref:'#/components/responses/429'
parameters:
-name:subscriptionId
in:path
description:Subscription Id, specifically the "self" returned in the subscription request
required:true
style:simple
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Modify existing subscription by sending a new data structure.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
operationId:subscriptionsDELETE
$ref:'#/components/responses/412'
parameters:
-name:subscriptionId
in:path
description:Subscription Id, specifically the "self" returned in the subscription request
required:true
style:simple
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Cancel an existing subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
description:The unique identifier of the subscriptionId.
schema:
$ref:'#/components/schemas/ProblemDetails'
deprecated:false
parameters:[]
type:string
/measurements:
get:
summary:Retrieve a list of configured measurements for this subscriber.
description:The GET method is used to request information about the measurement configurations for this requestor. Upon success, the response contains an entity body with the list of links to the measurement configurations that are present for the requestor.
description:The POST method is used to create a new WLAN measurement configuration. Upon success, the response contains an entity body describing the created measurement configuration.
operationId:MeasurementsPOST
tags:
-wai
summary:'Createsanewmeasurementconfiguration'
description:Creates a new measurement configuration
operationId:measurementsPOST
parameters:[]
-measurements
requestBody:
description:Measurement configuration information
description:Entity body in the request contains the measurement configuration as defined in clause 6.2.4.
summary:Retrieve information on an existing measurement configuration.
description:The GET method is used to retrieve information about this measurement configuration. Upon success, the response contains entity body with the data type describing the measurement configuration.
description:Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
operationId:measurementsPUT
$ref:'#/components/responses/429'
parameters:
-name:measurementConfigId
in:path
description:Measurement configuration Id, specifically the "self" returned in the measurement configuration request
required:true
style:simple
description:The unique identifier of the measurementConfigId.
schema:
type:string
put:
summary:Modify an existing measurement configuration by sending a new data structure.
description:The PUT method is used to update the existing WAI measurement configuration. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
operationId:MeasurementsPUTMeasurementconfigid
tags:
-measurements
requestBody:
description:Measurement configuration to be modified
description:Entity body in the request contains the measurement configuration as defined in clause 6.2.4.
description:Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)
operationId:measurementsDELETE
$ref:'#/components/responses/422'
parameters:
-name:measurementConfigId
in:path
description:Measurement configuration Id, specifically the "self" returned in the measurement configuration request
required:true
style:simple
description:The unique identifier of the measurementConfigId.
schema:
type:string
delete:
summary:Cancel an existing measurement configuration.
description:The DELETE method is used to remove an existing measurement configuration. After the measurement configuration is removed, the configuration's associated measurementId will no longer be available in the ap_information and sta_information queries.
description:The unique identifier of the measurementConfigId.
schema:
$ref:'#/components/schemas/ProblemDetails'
deprecated:false
parameters:[]
type:string
components:
schemas:
ApAssociated:
title:ApAssociated
required:
-bssid
ProblemDetails:
type:object
properties:
assocId:
type:
type:string
description:Unique number which identifies a particular association between the station and Access Point.
bssid:
format:uri
description:A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type:string
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:
type:array
items:
description:A short, human-readable summary of the problem type
status:
type:integer
format:uint32
description:The HTTP status code for this occurrence of the problem
detail:
type:string
description:IPv4 or IPv6 address allocated for the Access Point.
ssid:
type:array
items:
description:A human-readable explanation specific to this occurrence of the problem
instance:
type:string
description:Service Set Identifier to identify logical networks.
ApIdentity:
title:ApIdentity
format:uri
description:A URI reference that identifies the specific occurrence of the problem
MeasurementConfigLinkList1_:
properties:
_links:
description:Hyperlink related to the resource.
properties:
self:
description':Self-referring URI
$ref:'#/components/schemas/LinkType'
required:
-bssid
-self
type:object
measurementConfig:
description:''
items:
type:object
properties:
bssid:
href:
description:The URI referring to a measurement configuration.
format:uri
type:string
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:
type:array
items:
measurementId:
description:Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
type:string
description:IPv4 or IPv6 address allocated for the Access Point.
ssid:
required:
-href
-measurementId
type:array
required:
-_links
type:object
x-etsi-ref:6.2.5
SubscriptionLinkList1_:
properties:
_links:
description:List of hyperlinks related to the resource.
properties:
self:
description':Self referring URI
$ref:'#/components/schemas/LinkType'
required:
-self
type:object
subscription:
description:''
items:
type:object
properties:
href:
description:The URI referring to the subscription.
format:uri
type:string
description:Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.
description:Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type.
$ref:'#/components/schemas/ApIdentity'
apLocation:
$ref:'#/components/schemas/ApLocation'
bssLoad:
$ref:'#/components/schemas/BssLoad'
type:object
channel:
type:integer
description:Channel configured for the Access Point.
contentEncoding:int32
type:integer
format:uint32
wlanCap:
description:WLAN capabilities of Access Point.
$ref:'#/components/schemas/WlanCapabilities'
type:object
wanMetrics:
description:WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3].
$ref:'#/components/schemas/WanMetrics'
type:object
bssLoad:
description:BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/BssLoad'
type:object
extBssLoad:
description:Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4].
$ref:'#/components/schemas/ExtBssLoad'
type:object
oBssLoad:
description:Overlapping BSS Load attribute contains information related to the contribution of channel usage by Access Points in proximity to the reporting Access Point and operating on the same channel.
$ref:'#/components/schemas/OBssLoad'
type:object
apLocation:
description:The location on the Access Point.
$ref:'#/components/schemas/ApLocation'
type:object
required:
-apId
StaInfo:
x-etsi-ref:6.2.3
type:object
properties:
timeStamp:
description:Time stamp.
$ref:'#/components/schemas/TimeStamp'
wanMetrics:
$ref:'#/components/schemas/WanMetrics'
wlanCap:
$ref:'#/components/schemas/WlanCapabilities'
ApLocation:
title:ApLocation
type:object
staId:
description:Identifier(s) uniquely specify the station whose information is exposed within this data type.
$ref:'#/components/schemas/StaIdentity'
type:object
channel:
description:Channel currently used by the station to connect with its associated Access Point.
type:integer
format:uint32
apAssociated:
description:Information about the station's associated Access Point.
$ref:'#/components/schemas/ApAssociated'
type:object
rssi:
description:Receive Signal Strength Indicator.
$ref:'#/components/schemas/Rssi'
type:object
staDataRate:
description:Station Data Rate as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/StaDataRate'
type:object
staStatistics:
description:Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.
description:The URI referring to a measurement configuration.
type:string
format:uri
measurementId:
description:Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
type:string
required:
-href
-measurementId
MeasurementConfigLinkList:
x-etsi-ref:6.2.5
type:object
properties:
apId:
$ref:'#/components/schemas/ApIdentity'
staId:
_links:
$ref:'#/components/schemas/_links1'
measurementConfig:
type:array
items:
$ref:'#/components/schemas/StaIdentity'
description:Identifier(s) to uniquely specify the client station(s) associated.
timeStamp:
$ref:'#/components/schemas/TimeStamp'
$ref:'#/components/schemas/MeasurementConfig'
required:
-_links
AssocStaSubscription:
title:AssocStaSubscription
allOf:
-$ref:'#/components/schemas/InlineSubscription'
-required:
-apId
x-etsi-ref:6.3.2
type:object
properties:
subscriptionType:
description:Shall be set to "AssocStaSubscription".
type:string
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
type:string
format:uri
requestTestNotification:
description:Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [10], clause 6.12a.
type:boolean
websockNotifConfig:
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. See note 1.
$ref:'#/components/schemas/WebsockNotifConfig'
type:object
_links:
$ref:'#/components/schemas/Links'
$ref:'#/components/schemas/_links2'
apId:
description:Identifier(s) to uniquely specify the target Access Point for the subscription.
$ref:'#/components/schemas/ApIdentity'
callbackReference:
type:string
description:URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
expiryDeadline:
$ref:'#/components/schemas/TimeStamp'
type:object
notificationPeriod:
description:'Setforperiodicnotificationreporting.
Valueindicatesthenotificationperiodinseconds.'
type:integer
format:uint8
notificationEvent:
$ref:'#/components/schemas/NotificationEvent'
expiryDeadline:
description:The expiration time of the subscription determined by the WLAN Access Information Service.
description:Shall be set to "StaDataRateSubscription".
type:string
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note 1.
type:string
format:uri
requestTestNotification:
description:Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [10], clause 6.12a.
type:boolean
websockNotifConfig:
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. See note 1.
$ref:'#/components/schemas/WebsockNotifConfig'
type:object
_links:
$ref:'#/components/schemas/_links2'
staId:
description:Identifier(s) to uniquely specify the target client station(s) for the subscription.
type:array
minItems:1
items:
$ref:'#/components/schemas/StaIdentity'
notificationPeriod:
description:'Setforperiodicnotificationreporting.
Valueindicatesthenotificationperiodinseconds.'
type:integer
description:>-
Set for periodic notification reporting.Value indicates the notification period in seconds.
contentEncoding:int32
format:uint8
notificationEvent:
$ref:'#/components/schemas/NotificationEvent1'
expiryDeadline:
description:The expiration time of the subscription determined by the WLAN Access Information Service.
description:Shall be set to "MeasurementReportSubscription".
type:string
callbackReference:
description:URI exposed by the client on which to receive notifications via HTTP. See note.
type:string
format:uri
requestTestNotification:
description:Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [10], clause 6.12a.
type:boolean
description:Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
websockNotifConfig:
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. See note.
$ref:'#/components/schemas/WebsockNotifConfig'
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
BeaconReport:
title:BeaconReport
type:object
_links:
$ref:'#/components/schemas/_links2'
staId:
description:Identifier(s) to uniquely specify the target client station(s) for the subscription.
type:array
minItems:1
items:
$ref:'#/components/schemas/StaIdentity'
measurementId:
description:Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.
type:string
measurementInfo:
description:Information used to configure this measurement.
$ref:'#/components/schemas/MeasurementInfo'
type:object
expiryDeadline:
description:The expiration time of the subscription determined by the WLAN Access Information Service.
description:The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
type:integer
description:The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in clause 9.4.2.40 of IEEE 802.11-2016.
contentEncoding:int32
format:uint32
nanoSeconds:
description:The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
type:integer
format:uint32
required:
-seconds
-nanoSeconds
ApIdentity:
x-etsi-ref:6.5.3
type:object
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
description:Indicates the BSSID of the BSS for which a beacon report has been received.
channel:
ssid:
description:Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.
type:array
minItems:0
items:
type:string
ipAddress:
description:IPv4 or IPv6 address allocated for the Access Point.
type:array
minItems:0
items:
type:string
required:
-bssid
WlanCapabilities:
x-etsi-ref:6.5.4
type:object
properties:
ht:
description:Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/HtCapabilities'
type:object
vht:
description:Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/VhtCapabilities'
type:object
he:
description:Information about Access Point HE capabilities as defined in IEEE P802.11ax [i.10], clause 9.2.2.248.
$ref:'#/components/schemas/HeCapabilities'
type:object
dmg:
description:Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/DmgCapabilities'
type:object
edmg:
description:Information about Access Point EDMG capabilities as defined in draft IEEE P802.11ay [i.11].
$ref:'#/components/schemas/EdmgCapabilities'
type:object
WanMetrics:
x-etsi-ref:6.5.6
type:object
properties:
wanInfo:
description:Info about WAN link status, link symmetricity and capacity currently used.
type:integer
description:Channel number where the beacon was received.
contentEncoding:int32
format:uint8
downlinkSpeed:
description:4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.
type:integer
format:uint32
uplinkSpeed:
description:4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
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.
type:integer
format:uint16
required:
-wanInfo
-downlinkSpeed
-uplinkSpeed
-downlinkLoad
-uplinkLoad
-lmd
BssLoad:
x-etsi-ref:6.5.7
type:object
properties:
staCount:
description:An unsigned integer that indicates the total number of STAs currently associated with this BSS.
description:Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.
type:integer
format:uint16
required:
-staCount
-channelUtilization
-availAdmCap
ExtBssLoad:
x-etsi-ref:6.5.8
type:object
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.
description:Observable loading on each of the secondary 20 MHz channel.
type:integer
format:uint8
obsSec40MhzUtil:
description:Observable loading on each of the secondary 40 MHz channel.
type:integer
format:uint8
obsSec80MhzUtil:
description:Observable loading on each of the secondary 80 MHz channel.
type:integer
format:uint8
required:
-muMimoStaCount
-spatStreamUnderUtil
-obsSec20MhzUtil
-obsSec40MhzUtil
-obsSec80MhzUtil
ApLocation:
x-etsi-ref:6.5.9
type:object
properties:
geolocation:
description:Geospatial Location of the AP as defined in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/GeoLocation'
type:object
civicLocation:
description:Civic Location of the AP as described in IETF RFC 4776 [7].
$ref:'#/components/schemas/CivicLocation'
type:object
NeighborReport:
x-etsi-ref:6.5.10
type:object
properties:
staId:
description:Identifier to uniquely specify the station whose information is exposed within this Neighbor Report. If NeighborReport is contained within a data type that provides the station's identifier, this field may be omitted.
$ref:'#/components/schemas/StaIdentity'
type:object
measurementId:
description:Measurement ID of the Measurement configuration applied to this Neighbor Report.
type:string
description:Measurement ID of the Measurement configuration applied to this Beacon Report.
bssid:
description:BSSID (MAC address) of the Access Point that is being reported.
type:string
bssidInfo:
description:Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements, as defined in Figure 9-296, BSSID information field, within IEEE 802.11-2016 [8].
$ref:'#/components/schemas/BssidInfo'
type:object
operatingClass:
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
type:integer
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016.
contentEncoding:int32
parentTsf:
format:uint8
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].
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.
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 clause .4.2.38 of IEEE 802.11-2016.
description:RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in clause 9.4.2.41 of IEEE 802.11-2016.
contentEncoding:int32
format:uint8
required:
-measurementId
-bssid
-bssidInfo
-operatingClass
-channel
-phyType
StaIdentity:
x-etsi-ref:6.5.11
type:object
properties:
macId:
description:Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
type:string
ssid:
description:Service Set Identifier(s) to identify logical networks.
type:array
minItems:0
items:
type:string
aid:
description:Number which identifies a particular association between a station and an Access Point.
type:string
ipAddress:
description:IPv4 or IPv6 address(es) allocated for the station.
type:array
minItems:0
items:
type:string
description:The SSID subelement indicates the ESS or IBSS for which a beacon report is received.
staId:
$ref:'#/components/schemas/StaIdentity'
BeaconReportingConfig:
title:BeaconReportingConfig
required:
-reportingCondition
-threshold
-macId
ApAssociated:
x-etsi-ref:6.5.12
type:object
properties:
reportingCondition:
type:integer
description:>-
Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016:
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
threshold:
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
ssid:
description:Service Set Identifier to identify logical networks.
type:array
minItems:0
items:
type:string
assocId:
description:Unique number which identifies a particular association between the station and Access Point.
type:string
ipAddress:
description:IPv4 or IPv6 address allocated for the Access Point.
type:array
minItems:0
items:
type:string
required:
-bssid
StaStatistics:
x-etsi-ref:6.5.13
type:object
properties:
staId:
description:Identifier to uniquely specify the station whose information is exposed within this STA Statistics Report. If StaStatistics is contained within a data type that provides the station's identifier, this field may be omitted.
$ref:'#/components/schemas/StaIdentity'
type:object
measurementId:
description:Measurement ID of the Measurement configuration applied to this STA Statistics Report.
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 clause 9.4.2.38 of IEEE 802.11-2016 .
For reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in clause 9.4.2.41 of IEEE 802.11-2016 .
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.
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.
channelId:
htCapabilityInfo:
description:HT Capability Information as defined in IEEE 802.11-2016 [8].
type:integer
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
measurementMode:
format:uint16
ampduParameters:
description:A-MPDU parameters as defined in IEEE 802.11-2016 [8].
type:integer
description:>-
0 for passive.
1 for active.
2 for beacon table.
contentEncoding:int32
operatingClass:
format:uint8
supportedMcsSet:
description:Supported MCS set as defined in IEEE 802.11-2016 [8].
type:integer
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 .
contentEncoding:int32
ssid:
type:string
description:The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.
BssCapabilities:
title:BssCapabilities
format:uint128
htExtendedCap:
description:Extended HT Capabilities as defined in IEEE 802.11-2016 [8].
type:integer
format:uint16
txBeamFormCap:
description:Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].
type:integer
format:uint32
aselCap:
description:ASEL capabilities as defined in IEEE 802.11-2016 [8].
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
channelUtilization:
format:uint8
hePhyCapinfo:
description:PHY capabilities of an Access Point.
type:integer
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
staCount:
format:uint8
supportedHeMcsNssSet:
description:Supported MCS and NSS Set.
type:integer
description:An unsigned integer that indicates the total number of STAs currently associated with this BSS.
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.
contentEncoding:int32
capabilities:
$ref:'#/components/schemas/BssCapabilities'
ftm:
type:boolean
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.
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.
highThroughput:
type:boolean
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.
mobilityDomain:
type:boolean
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.
security:
type:boolean
description:>-
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.
veryHighThroughput:
type:boolean
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.
description:Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
type:integer
format:uint8
maxNrShortAmsduSubframes:
description:Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
type:integer
format:uint8
required:
-channel
-channelLoad
-measurementDuration
-measurementId
-operatingClass
-dmgStaCapInfo
-dmgApOrPcpCapInfo
-dmgStaBeamTrackTimeLimit
-ExtScMcsCap
-maxNrBasicAmsduSubframes
-maxNrShortAmsduSubframes
EdmgCapabilities:
x-etsi-ref:6.5.18
type:object
properties:
channel:
type:integer
description:Channel number indicates the channel number for which the measurement report applies.
contentEncoding:int32
channelLoad:
ampduParameters:
description:A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]
type:integer
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
measurementDuration:
format:uint8
trnParameters:
description:Training parameters as defined in draft IEEE P802.11ay [i.11]
type:integer
description:Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.
contentEncoding:int32
measurementId:
type:string
description:Measurement ID of the Measurement configuration applied to this Channel Load Report.
operatingClass:
format:uint16
supportedMcs:
description:Supported MCS as defined in draft IEEE P802.11ay [i.11]
type:integer
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 .
contentEncoding:int32
staId:
$ref:'#/components/schemas/StaIdentity'
ChannelLoadConfig:
title:ChannelLoadConfig
format:uint32
required:
-channel
-operatingClass
-ampduParameters
-trnParameters
-supportedMcs
GeoLocation:
x-etsi-ref:6.5.19
type:object
properties:
channel:
latUncertainty:
description:The uncertainty for Latitude information as defined in IETF RFC 6225 [6]
type:integer
description:Channel for which the channel load report is requested.
description:City division, borough, city district, ward, chou (JP)
ca5:
type:string
description:Neighborhood, block
ca6:
type:string
description:Group of streets below the neighborhood level
country:
type:string
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
required:
-ExtScMcsCap
-dmgApOrPcpCapInfo
-dmgStaBeamTrackTimeLimit
-dmgStaCapInfo
-maxNrBasicAmsduSubframes
-maxNrShortAmsduSubframes
type:object
properties:
ExtScMcsCap:
type:integer
description:Extended SC MCS capabilities as defined in IEEE 802.11-2016.
contentEncoding:int32
dmgApOrPcpCapInfo:
type:integer
description:DMG AP or PCP capabilities information as defined in IEEE 802.11-2016.
contentEncoding:int32
dmgStaBeamTrackTimeLimit:
type:integer
description:DMG station beam tracking time limit as defined in IEEE 802.11-2016.
contentEncoding:int32
dmgStaCapInfo:
type:integer
description:DMG station capabilities information as defined in IEEE 802.11-2016.
contentEncoding:int32
maxNrBasicAmsduSubframes:
type:integer
description:Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016.
contentEncoding:int32
maxNrShortAmsduSubframes:
type:integer
description:Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016.
contentEncoding:int32
EdmgCapabilities:
title:EdmgCapabilities
required:
-ampduParameters
-supportedMcs
-trnParameters
type:object
properties:
ampduParameters:
type:integer
description:A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]
contentEncoding:int32
supportedMcs:
type:integer
description:Supported MCS as defined in draft IEEE P802.11ay [i.11]
contentEncoding:int32
trnParameters:
type:integer
description:Training parameters as defined in draft IEEE P802.11ay [i.11]
contentEncoding:int32
ExpiryNotification:
title:ExpiryNotification
required:
-_links
-expiryDeadline
-notificationType
type:object
properties:
_links:
$ref:'#/components/schemas/Links1'
expiryDeadline:
$ref:'#/components/schemas/TimeStamp'
notificationType:
ca128:
description:Script
type:string
description:Shall be set to "ExpiryNotification".
ExtBssLoad:
title:ExtBssLoad
required:
-muMimoStaCount
-obsSec20MhzUtil
-obsSec40MhzUtil
-obsSec80MhzUtil
-spatStreamUnderUtil
type:object
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
obsSec20MhzUtil:
type:integer
description:Observable loading on each of the secondary 20 MHz channel.
contentEncoding:int32
obsSec40MhzUtil:
type:integer
description:Observable loading on each of the secondary 40 MHz channel.
contentEncoding:int32
obsSec80MhzUtil:
type:integer
description:Observable loading on each of the secondary 80 MHz channel.
contentEncoding:int32
spatStreamUnderUtil:
type:integer
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
required:
-datum
-lat
-latUncertainty
-long
-longUncertainty
type:object
properties:
altitude:
type:integer
description:The altitude value of location as defined in IETF RFC 6225
contentEncoding:int32
altitudeType:
type:integer
description:The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225
contentEncoding:int32
altitudeUncertainty:
type:integer
description:The uncertainty for altitude information as defined in IETF RFC 6225
contentEncoding:int32
datum:
type:integer
description:The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225
contentEncoding:int32
lat:
type:integer
description:The latitude value of location as defined in IETF RFC 6225
contentEncoding:int32
latUncertainty:
type:integer
description:The uncertainty for Latitude information as defined in IETF RFC 6225
contentEncoding:int32
long:
type:integer
description:The longitude value of location as defined in IETF RFC 6225
contentEncoding:int32
longUncertainty:
type:integer
description:The uncertainty for Longitude information as defined in IETF RFC 6225
contentEncoding:int32
HeCapabilities:
title:HeCapabilities
required:
-heMacCapInfo
-hePhyCapinfo
-supportedHeMcsNssSet
type:object
properties:
heMacCapInfo:
type:integer
description:MAC capabilities of an Access Point.
contentEncoding:int32
hePhyCapinfo:
type:integer
description:PHY capabilities of an Access Point.
contentEncoding:int32
supportedHeMcsNssSet:
type:integer
description:Supported MCS and NSS Set.
contentEncoding:int32
HtCapabilities:
title:HtCapabilities
required:
-ampduParameters
-aselCap
-htCapabilityInfo
-htExtendedCap
-supportedMcsSet
-txBeamFormCap
-country
Rssi:
x-etsi-ref:6.5.21
type:object
properties:
ampduParameters:
type:integer
description:A-MPDU parameters as defined in IEEE 802.11-2016.
contentEncoding:int32
aselCap:
type:integer
description:ASEL capabilities as defined in IEEE 802.11-2016.
contentEncoding:int32
htCapabilityInfo:
type:integer
description:HT Capability Information as defined in IEEE 802.11-2016.
contentEncoding:int32
htExtendedCap:
type:integer
description:Extended HT Capabilities as defined in IEEE 802.11-2016.
contentEncoding:int32
supportedMcsSet:
type:integer
description:Supported MCS set as defined in IEEE 802.11-2016.
contentEncoding:int32
txBeamFormCap:
rssi:
description:The Received Signal Strength Indicator from a station
type:integer
description:Transmit Beamforming Capabilities as defined in IEEE 802.11-2016.
contentEncoding:int32
LinkType:
title:LinkType
required:
-href
type:object
properties:
href:
type:string
MeasurementConfig:
title:MeasurementConfig
required:
-measurementId
-measurementInfo
-staId
type:object
properties:
_links:
$ref:'#/components/schemas/Links4'
measurementId:
type:string
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:
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
format:uint8
required:
-_links
type:object
properties:
_links:
$ref:'#/components/schemas/Links4'
measurementConfig:
type:array
items:
$ref:'#/components/schemas/MeasurementConfig1'
description:''
MeasurementInfo:
title:MeasurementInfo
type:object
properties:
beaconRequestConf:
$ref:'#/components/schemas/BeaconRequestConfig'
channelLoadConf:
$ref:'#/components/schemas/ChannelLoadConfig'
measurementDuration:
type:integer
description:Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in clause 11.11.4 of IEEE 802.11-2016. 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:
type:integer
description:Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in clause 11.11.3 of IEEE 802.11-2016. 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:
title:MeasurementReportNotification
allOf:
-$ref:'#/components/schemas/InlineNotification'
-type:object
properties:
beaconReport:
type:array
items:
$ref:'#/components/schemas/BeaconReport'
description:Beacon Report as defined in IEEE 802.11-2016.
channelLoad:
type:array
items:
$ref:'#/components/schemas/ChannelLoad'
description:Channel Load reports as seen by the station as defined in IEEE 802.11-2016.
neighborReport:
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.
staStatistics:
type:array
items:
$ref:'#/components/schemas/StaStatistics'
description:STA Statistics Report as defined in IEEE 802.11-2016.
timeStamp:
$ref:'#/components/schemas/TimeStamp'
MeasurementReportSubscription:
title:MeasurementReportSubscription
allOf:
-$ref:'#/components/schemas/InlineSubscription'
-required:
-measurementId
-measurementInfo
-staId
-rssi
StaDataRate:
x-etsi-ref:6.5.22
type:object
properties:
_links:
$ref:'#/components/schemas/Links'
callbackReference:
type:string
description:URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
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 via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
staId:
type:array
items:
description:Identifier to uniquely specify the station whose information is exposed within StaDataRate. If StaDataRate is contained within a data type that provides the station's identifier, this field may be omitted.
$ref:'#/components/schemas/StaIdentity'
description:Identifier(s) to uniquely specify the target client station(s) for the subscription.
websockNotifConfig:
$ref:'#/components/schemas/WebsockNotifConfig'
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
NeighborReport:
title:NeighborReport
required:
-bssid
-bssidInfo
-channel
-measurementId
-operatingClass
-phyType
type:object
properties:
bssTransitionCandidatePreference:
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
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.
contentEncoding:int32
bssid:
type:string
description:BSSID (MAC address) of the Access Point that is being reported.
bssidInfo:
$ref:'#/components/schemas/BssidInfo'
channel:
format: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
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.
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
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.
ssid:
description:The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.
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.
OBssLoad:
title:OBssLoad
beaconReportingConf:
description:Beacon reporting configuration data field format as in Figure 9-157 in IEEE 802.11-2016 [8].
$ref:'#/components/schemas/BeaconReportingConfig'
type:object
required:
-allocatedTrafficSelfMean
-allocatedTrafficShareMean
-operatingClass
-channelId
-measurementMode
-beaconReportingConf
StaStatisticsConfig:
x-etsi-ref:6.5.26
type:object
properties:
allocatedTrafficSelfMean:
type:integer
description:Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.
contentEncoding:int32
allocatedTrafficSelfStdDev:
type:integer
description:Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.
contentEncoding:int32
allocatedTrafficShareMean:
groupIdentity:
description:As per Table 9-92 of IEEE 802.11-2016 [8].
type:integer
description:Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
description:Indicates the number of other APs that are sharing the same channel as the reporting AP.
contentEncoding:int32
ProblemDetails:
title:ProblemDetails
format:uint16
triggerCondition:
description:Valid if triggeredReport = true. As per Figure 9-161 of IEEE 802.11-2016 [8]. Defines what are the metrics returned by the STA Statistics Report.
description:A human-readable explanation specific to this occurrence of the problem
instance:
staId:
description:Identifier to uniquely specify the station whose information is exposed within this Beacon Report. If BeaconReport is contained within a data type that provides the station's identifier, this field may be omitted.
$ref:'#/components/schemas/StaIdentity'
type:object
measurementId:
description:Measurement ID of the Measurement configuration applied to this Beacon Report.
type:string
description:A URI reference that identifies the specific occurrence of the problem
status:
operatingClass:
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
type:integer
description:The HTTP status code for this occurrence of the problem
contentEncoding:int32
title:
format:uint8
channel:
description:Channel number where the beacon was received.
type:integer
format:uint8
reportedFrameInfo:
description:Information about the reported beacon frame.
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.
type:integer
format:uint32
required:
-frameType
-phyType
-measurementId
-operatingClass
-channel
-reportedFrameInfo
-bssid
BeaconReportingConfig:
x-etsi-ref:6.5.28
type:object
properties:
frameType:
type:integer
description:>-
A value of 0 indicates a Beacon or Probe Response.
description:Capability information for the AP indicated by this BSSID.
$ref:'#/components/schemas/BssCapabilities'
type:object
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
description:dot11QoSFrameDuplicate
qosMultipleRetry:
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
description:dot11QoSMultipleRetry
qosRetry:
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.
description:The Received Signal Strength Indicator from a station
contentEncoding:int32
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
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.
description:Configure and set threshold for dot11AckFailureCount trigger
contentEncoding:int32
failedCountThreshold:
type:integer
description:Configure and set threshold for dot11FailedCount trigger
contentEncoding:int32
fcsErrorCountThreshold:
type:integer
format:uint32
fcsErrorCountThreshold:
description:Configure and set threshold for dot11FCSErrorCount trigger
contentEncoding:int32
frameDuplicateCountThreshold:
type:integer
description:Configure and set threshold for dot11FrameDuplicateCount trigger
contentEncoding:int32
format:uint32
multipleRetryCountThreshold:
type:integer
description:Configure and set threshold for dot11MultipleRetryCount trigger
contentEncoding:int32
retryCountThreshold:
type:integer
description:Configure and set threshold for dot11RetryCount trigger
contentEncoding:int32
rtsFailureCountThreshold:
format:uint32
frameDuplicateCountThreshold:
description:Configure and set threshold for dot11FrameDuplicateCount trigger
type:integer
format:uint32
rtsFailureCountThreshold:
description:Configure and set threshold for dot11RTSFailureCount trigger
contentEncoding:int32
StaDataRate:
title:StaDataRate
type:object
properties:
staId:
$ref:'#/components/schemas/StaIdentity'
staLastDataDownlinkRate:
type:integer
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
staLastDataUplinkRate:
format:uint32
ackFailureCountThreshold:
description:Configure and set threshold for dot11AckFailureCount trigger
type:integer
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
StaDataRateNotification:
title:StaDataRateNotification
allOf:
-$ref:'#/components/schemas/InlineNotification'
-type:object
properties:
staDataRate:
type:array
items:
$ref:'#/components/schemas/StaDataRate'
description:Data rates of a client station.
timeStamp:
$ref:'#/components/schemas/TimeStamp'
StaDataRateSubscription:
title:StaDataRateSubscription
allOf:
-$ref:'#/components/schemas/InlineSubscription'
-required:
-staId
type:object
properties:
_links:
$ref:'#/components/schemas/Links'
callbackReference:
type:string
description:URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
expiryDeadline:
$ref:'#/components/schemas/TimeStamp'
notificationEvent:
$ref:'#/components/schemas/NotificationEvent1'
notificationPeriod:
format:uint32
retryCountThreshold:
description:Configure and set threshold for dot11RetryCount trigger
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 via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
staId:
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'
description:Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a
StaIdentity:
title:StaIdentity
required:
-macId
type:object
properties:
aid:
type:string
description:Number which identifies a particular association between a station and an Access Point
ipAddress:
type:array
items:
type:string
description:IPv4 or IPv6 address(es) allocated for the station.
macId:
type:string
description:Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
ssid:
type:array
items:
type:string
description:Service Set Identifier(s) to identify logical networks.
StaInfo:
title:StaInfo
required:
-staId
format:uint32
StaStatisticsGroupZeroData:
x-etsi-ref:6.5.34
type:object
properties:
apAssociated:
$ref:'#/components/schemas/ApAssociated'
beaconReport:
type:array
items:
$ref:'#/components/schemas/BeaconReport'
description:Beacon Report as defined in IEEE 802.11-2016.
channel:
transmittedFragmentCount:
description:dot11TransmittedFragmentCount counter
type:integer
description:Channel currently used by the station to connect with its associated Access Point.
contentEncoding:int32
channelLoad:
type:array
items:
$ref:'#/components/schemas/ChannelLoad'
description:Channel Load reports as seen by the station as defined IEEE 802.11-2016. Channel Load reports may be configured for any channel, including the station's current channel for association.
neighborReport:
type:array
items:
$ref:'#/components/schemas/NeighborReport'
description:Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016.
rssi:
$ref:'#/components/schemas/Rssi'
staDataRate:
$ref:'#/components/schemas/StaDataRate'
staId:
$ref:'#/components/schemas/StaIdentity'
staStatistics:
type:array
items:
$ref:'#/components/schemas/StaStatistics'
description:Statistics as defined in IEEE 802.11-2016 for the client station collected over measurement duration.
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
measurementId:
type:string
description:Measurement ID of the Measurement configuration applied to this STA Statistics Report.
staId:
$ref:'#/components/schemas/StaIdentity'
StaStatisticsConfig:
title:StaStatisticsConfig
required:
-groupIdentity
-triggeredReport
type:object
properties:
groupIdentity:
format:uint32
receivedFragmentCount:
description:dot11ReceivedFragmentCount counter
type:integer
description:As per Table 9-92 of IEEE 802.11-2016.
contentEncoding:int32
measurementCount:
format:uint32
groupReceivedFrameCount:
description:dot11GroupReceivedFrameCount counter
type:integer
description:>-
Valid if triggeredReport = true.
Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.
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.
description:Identifier to uniquely specify the station whose information is exposed within Channel Load. If ChannelLoad is contained within a data type that provides the station's identifier, this field may be omitted.
$ref:'#/components/schemas/StaIdentity'
type:object
measurementId:
description:Measurement ID of the Measurement configuration applied to this Channel Load Report.
type:string
operatingClass:
description:Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
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
seconds:
format:uint8
channel:
description:Channel number indicates the channel number for which the measurement report applies.
type:integer
description:The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
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.
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.
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
uplinkSpeed:
format:uint16
overlap:
description:Indicates the number of other APs that are sharing the same channel as the reporting AP.
type:integer
description:4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
description:Set to true by the service consumer to indicate that Websocket delivery is requested.
type:boolean
_links:
description:Hyperlink related to the resource.
type:object
properties:
self:
description:Self-referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an Id for the measurement configuration (MeasurementConfigId).
$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
_links1:
description:Hyperlink related to the resource.
type:object
properties:
self:
description:Self-referring URI.
$ref:'#/components/schemas/LinkType'
description:Hyperlink related to the resource.
Links6:
title:Links6
type:object
required:
-self
_links2:
description:Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
type:object
properties:
self:
description:Self-referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an ID for the subscription (SubscriptionId).
$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.
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
type:integer
format:uint8
required:
-trigger
-threshold
NotificationEvent1:
description:Set for trigger-based event notification reporting.
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:
description:Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 [10] for details. The WLAN Access Information API shall support this parameter.
name:all_fields
in:query
required:false
x-exportParamName:Query.All_fields
schema:
type:string
Query.Fields:
description:Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 [10] for details. The WLAN Access Information API shall support this parameter.
name:fields
in:query
required:false
x-exportParamName:Query.Fields
schema:
type:string
Query.Exclude_fields:
description:Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 [10] for details. The WLAN Access Information API shall support this parameter.