ETSI GS MEC 028 V2.1.1 (2020-06)
Multi-access Edge Computing (MEC); WLAN Information API
Multi-access Edge Computing (MEC); WLAN Information API
DGS/MEC-0028WlanAPI
General Information
Standards Content (Sample)
ETSI GS MEC 028 V2.1.1 (2020-06)
GROUP SPECIFICATION
Multi-access Edge Computing (MEC);
WLAN Information API
Disclaimer
The present document has been produced and approved by the Multi-access Edge Computing (MEC) ETSI Industry
Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.
---------------------- Page: 1 ----------------------
2 ETSI GS MEC 028 V2.1.1 (2020-06)
Reference
DGS/MEC-0028WlanAPI
Keywords
API, MEC, service, WLAN
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2020.
All rights reserved.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS MEC 028 V2.1.1 (2020-06)
Contents
Intellectual Property Rights . 6
Foreword . 6
Modal verbs terminology . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 8
3 Definition of terms, symbols and abbreviations . 8
3.1 Terms . 8
3.2 Symbols . 8
3.3 Abbreviations . 9
4 Overview . 9
5 Description of the service (informative). 10
5.1 WLAN Access Information Service introduction . 10
5.2 Sequence diagrams . 10
5.2.1 Introduction. 10
5.2.2 Sending a query for Access Point information . 10
5.2.2.1 General query procedure . 10
5.2.2.2 Sending a query for a list of Access Points . 11
5.2.2.3 Sending a query for WLAN capabilities . 11
5.2.2.4 Sending a query for BSS Load . 11
5.2.2.5 Sending a query for WAN metrics . 11
5.2.2.6 Sending a query for AP Location . 12
5.2.2.7 Sending a query for AP Neighbor report . 12
5.2.3 Sending a query for Station information . 12
5.2.3.1 General query procedure . 12
5.2.3.2 Sending a query for a list of stations . 12
5.2.3.3 Sending a query for channel used by station(s) . 13
5.2.3.4 Sending a query for RSSI of station(s) . 13
5.2.3.5 Sending a query for station data rates . 13
5.2.3.6 Sending a query for station statistics . 13
5.2.4 REST based subscribe-notify model . 13
5.2.4.1 Subscribing to WLAN event notifications . 13
5.2.4.2 Receiving notification on expiry of WLAN event subscription . 14
5.2.4.3 Updating subscription for WLAN event notifications . 15
5.2.4.4 Unsubscribing from WLAN event notifications . 15
5.2.5 Receiving WLAN event notifications about station data rates . 16
5.2.6 Receiving WLAN event notifications about associated stations. 17
5.2.7 Measurement Configuration . 18
5.2.7.1 Creating a Measurement configuration . 18
5.2.7.2 Updating a Measurement Configuration . 19
5.2.7.3 Deleting a Measurement Configuration . 20
5.2.7.4 Example of using a Measurement Configuration . 20
6 Data Model . 20
6.1 General . 20
6.2 Resource data types . 21
6.2.1 Introduction. 21
6.2.2 Type: ApInfo . 21
6.2.3 Type: StaInfo . 21
6.2.4 Type: MeasurementConfig . 22
6.3 Subscription data types . 22
6.3.1 Introduction. 22
6.3.2 Type: AssocStaSubscription . 22
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS MEC 028 V2.1.1 (2020-06)
6.3.3 Type: StaDataRateSubscription . 22
6.4 Notifications data types . 23
6.4.1 Introduction. 23
6.4.2 Type: AssocStaNotification . 23
6.4.3 Type: StaDataRateNotification . 23
6.5 Referenced structured data types . 24
6.5.1 Introduction. 24
6.5.2 Type: TimeStamp . 24
6.5.3 Type: ApIdentity . 24
6.5.4 Type: WlanCapabilities . 24
6.5.5 Type: AssociatedStations . 25
6.5.6 Type: WanMetrics . 25
6.5.7 Type: BssLoad . 25
6.5.8 Type: ExtBssLoad . 26
6.5.9 Type: ApLocation . 26
6.5.10 Type: NeighborReport . 26
6.5.11 Type: StaIdentity . 26
6.5.12 Type: ApAssociated . 27
6.5.13 Type: StaStatistics . 27
6.5.14 Type: HtCapabilities . 27
6.5.15 Type: VhtCapabilities . 27
6.5.16 Type: HeCapabilities . 27
6.5.17 Type: DmgCapabilities . 28
6.5.18 Type: EdmgCapabilities . 28
6.5.19 Type: GeoLocation . 28
6.5.20 Type: CivicLocation . 29
6.5.21 Type: Rssi . 30
6.5.22 Type: StaDataRate . 30
6.5.23 Type: LinkType . 30
6.5.24 Type: ChannelLoadConfig . 30
6.5.25 Type: BeaconRequestConfig . 31
6.5.26 Type: StaStatisticsConfig . 31
6.5.27 Type: BeaconReport . 31
6.6 Referenced simple data types and enumerations . 32
7 API definition . 32
7.1 Introduction . 32
7.2 Global definitions and resource structure . 32
7.3 Resource: ap_information . 33
7.3.1 Description . 33
7.3.2 Resource definition . 33
7.3.3 Resource Methods . 33
7.3.3.1 GET . 33
7.3.3.2 PUT . 35
7.3.3.3 PATCH . 35
7.3.3.4 POST . 35
7.3.3.5 DELETE . 35
7.4 Resource: sta_information . 35
7.4.1 Description . 35
7.4.2 Resource definition . 36
7.4.3 Resource Methods . 36
7.4.3.1 GET . 36
7.3.3.2 PUT . 37
7.3.3.3 PATCH . 37
7.3.3.4 POST . 37
7.3.3.5 DELETE . 37
7.5 Resource: subscriptions . 37
7.5.1 Description . 37
7.5.2 Resource definition . 38
7.5.3 Resource methods . 38
7.5.3.1 GET . 38
7.5.3.2 PUT . 39
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS MEC 028 V2.1.1 (2020-06)
7.5.3.3 PATCH . 39
7.5.3.4 POST . 39
7.5.3.5 DELETE . 40
7.6 Resource: existing subscription . 40
7.6.1 Description . 40
7.6.2 Resource definition . 40
7.6.3 Resource methods . 41
7.6.3.1 GET . 41
7.6.3.2 PUT . 42
7.6.3.3 PATCH . 43
7.6.3.4 POST . 43
7.6.3.5 DELETE . 43
Annex A (informative): Complementary material for API utilization . 45
History . 46
ETSI
---------------------- Page: 5 ----------------------
6 ETSI GS MEC 028 V2.1.1 (2020-06)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Multi-access Edge
Computing (MEC).
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 6 ----------------------
7 ETSI GS MEC 028 V2.1.1 (2020-06)
1 Scope
The present document focuses on the WLAN Information MEC service. It describes the message flows and the required
information. The present document also specifies the RESTful API with the data model.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI GS MEC 001: "Multi-access Edge Computing (MEC); Terminology".
[2] IETF RFC 2818: "HTTP Over TLS".
NOTE: Available at https://tools.ietf.org/html/rfc2818.
[3] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2".
NOTE 1: Available at https://tools.ietf.org/html/rfc5246.
NOTE 2: Obsoleted by IETF RFC 8446.
[4] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
NOTE: Available at https://tools.ietf.org/html/rfc6749.
[5] IETF RFC 6750: "The OAuth 2.0 Authorization Framework: Bearer Token Usage".
NOTE: Available at https://tools.ietf.org/html/rfc6750.
[6] IETF RFC 6225: "Dynamic Host Configuration Protocol Options for Coordinate-Based Location
Configuration Information".
NOTE: Available at https://tools.ietf.org/html/rfc6225.
[7] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for
Civic Addresses Configuration Information".
NOTE: Available at https://tools.ietf.org/html/rfc4776.
TM
[8] IEEE 802.11-2016 : "IEEE Standard for Information technology -- Telecommunications and
information exchange between systems Local and metropolitan area networks -- Specific
requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY)
Specifications".
[9] Wi-Fi Agile Multiband Specification, Version 1.4.
NOTE: Available at https://www.wi-fi.org/file/wi-fi-agile-multiband-specification.
[10] ETSI GS MEC 009: "Multi-access Edge Computing (MEC); General principles for MEC Service
APIs".
ETSI
---------------------- Page: 7 ----------------------
8 ETSI GS MEC 028 V2.1.1 (2020-06)
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] ETSI GS MEC 011: "Multi-access Edge Computing (MEC); Edge Platform Application
Enablement".
TM
[i.2] OpenAPI Specification.
NOTE 1: Available at https://github.com/OAI/OpenAPI-Specification.
NOTE 2: OpenAPI Specification and OpenAPI Initiative and their respective logos, are trademarks of the Linux
Foundation.
[i.3] Wi-Fi Alliance 2014: "Hot Spot 2.0 (Release 2) Technical Specification V1.0.0".
[i.4] ETSI GS MEC 002: "Multi-access Edge Computing (MEC); Phase 2: Use Cases and
Requirements".
[i.5] ETSI GS MEC 003: "Multi-access Edge Computing (MEC); Framework and Reference
Architecture".
[i.6] ETSI GS MEC 012: "Multi-access Edge Computing (MEC); Radio Network Information API".
[i.7] ETSI GS MEC 029: "Multi-access Edge Computing (MEC); Fixed Access Information API".
[i.8] WiFi Alliance 2019: "Data Elements Specification v1.0".
[i.9] ISO 3166: "Codes for the representation of names of countries and their subdivisions".
TM
[i.10] IEEE 802.11ax : "Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY)
Specifications - Amendment 1: Enhancement for High Effficiency WLAN".
TM
[i.11] IEEE P802.11ay D4.0: "Wireless LAN Medium Access Control (MAC) and Physical Layer
(PHY) Specifications - Amendment 1: Enhancement for High Effficiency WLAN - Amendment 2:
Enhanced throughput for operation in license-exempt bands
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.