Newer
Older
- 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'
examples:
response-example:
value:
_links:
self:
href: 'http://meAppServer.example.com/wai/v2/measurements/meas123'
staId:
- macId: 005C01111111
ssid:
- myNetworkSsid
- myOtherNetworkSsid
measurementId: myId1
measurementInfo: {}
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
summary: 'Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)'
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'
value:
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
summary: 'Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)'
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:
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:
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:
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the client station(s) associated.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
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
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/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 via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
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.
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 clause 9.4.2.40 of IEEE 802.11-2016.
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.
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 clause .4.2.38 of IEEE 802.11-2016.
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 clause 9.4.2.41 of IEEE 802.11-2016.
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:
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 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.
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.
type: integer
description: >-
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 .
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.
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 %.
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 .
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.
Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016:
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, etc.)
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.
description: DMG AP or PCP capabilities information as defined in IEEE 802.11-2016.
dmgStaBeamTrackTimeLimit:
type: integer
description: DMG station beam tracking time limit as defined in IEEE 802.11-2016.
description: DMG station capabilities information as defined in IEEE 802.11-2016.
maxNrBasicAmsduSubframes:
type: integer
description: Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016.
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
- 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
description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225
description: The uncertainty for altitude information as defined in IETF RFC 6225
description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225
description: The latitude value of location as defined in IETF RFC 6225
description: The uncertainty for Latitude information as defined in IETF RFC 6225
description: The longitude value of location as defined in IETF RFC 6225
description: The uncertainty for Longitude information as defined in IETF RFC 6225
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.
description: ASEL capabilities as defined in IEEE 802.11-2016.
description: HT Capability Information as defined in IEEE 802.11-2016.
description: Extended HT Capabilities as defined in IEEE 802.11-2016.
description: Supported MCS set as defined in IEEE 802.11-2016.
description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016.
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:
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 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.
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 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.
staStatisticsConf:
$ref: '#/components/schemas/StaStatisticsConfig'
MeasurementReportNotification:
title: MeasurementReportNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'