ETSI GS MEC 013 V1.1.1 (2017-07)
Mobile Edge Computing (MEC); Location API
Mobile Edge Computing (MEC); Location API
DGS/MEC-0013LocationApi
General Information
Standards Content (Sample)
ETSI GS MEC 013 V1.1.1 (2017-07)
GROUP SPECIFICATION
Mobile Edge Computing (MEC);
Location API
Disclaimer
The present document has been produced and approved by the Mobile 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 013 V1.1.1 (2017-07)
Reference
DGS/MEC-0013LocationApi
Keywords
API, location, MEC, service
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 only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
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 2017.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members.
TM
3GPP and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members
GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS MEC 013 V1.1.1 (2017-07)
Contents
Intellectual Property Rights . 5
Foreword . 5
Modal verbs terminology . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 7
3 Definitions and abbreviations . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
4 Overview . 7
5 Description of the service (informative). 8
5.1 Introduction . 8
5.2 Relation with OMA API for Zonal Presence . 8
5.3 Sequence diagrams . 9
5.3.1 Introduction. 9
5.3.2 UE Location Lookup . 9
5.3.3 UE Information Lookup . 9
5.3.4 UE Location Subscribe . 10
5.3.5 UE Information Subscribe . 10
5.3.6 Subscribe Cancellation . 11
5.3.7 Radio Node Location Lookup . 11
6 Data Model . 12
6.1 Introduction . 12
6.2 Resource data types . 12
6.2.1 Zonal presence data types . 12
6.2.2 Type: UserInfo . 12
6.3 Subscription data types . 13
6.4 Notifications data types . 13
6.5 Referenced structured data types . 13
6.6 Mapping of Identifiers . 14
6.6.1 accessPointId . 14
6.6.2 userId . 14
7 API definition . 14
7.1 Introduction . 14
7.2 Global definitions and relation with OMA resources . 14
7.3 Mapping of services to API functions . 15
7.3.1 Introduction. 15
7.3.2 UE Location Lookup . 15
7.3.2.1 Definition . 15
7.3.2.2 Example: Two steps method to retrieve the geographical coordinates of an access point a specific
user is connected to (informative) . 15
7.3.3 UE Information Lookup . 16
7.3.3.1 Definition . 16
7.3.3.2 Example: Retrieve UE Information for all the users (informative) . 16
7.3.3.3 Example: Retrieve UE Information for the users in a zone (informative). 17
7.3.3.4 Example: Retrieve UE Information for the users in an access point of a zone (informative) . 18
7.3.4 UE Location Subscribe . 18
7.3.4.1 Definition . 18
7.3.4.2 Example: create a UE Location subscription (informative) . 18
7.3.5 UE Information Subscribe . 19
7.3.5.1 Definition . 19
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS MEC 013 V1.1.1 (2017-07)
7.3.5.2 Example: create a UE Information subscription (informative) . 19
7.3.6 Subscribe Cancellation . 20
7.3.6.1 Definition . 20
7.3.6.2 Example: cancelling a UE Location subscription (informative) . 20
7.3.6.3 Example: cancelling a UE Information subscription (informative) . 21
7.3.7 Radio Node Location Lookup . 21
7.3.7.1 Definition . 21
7.3.7.2 Example: Retrieve a list of radio nodes associated to a zone (informative) . 21
Annex A (informative): Complementary material for API utilisation . 23
History . 24
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS MEC 013 V1.1.1 (2017-07)
Intellectual Property Rights
IPRs essential or potentially essential to the present document 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.
Foreword
This Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Mobile 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: 5 ----------------------
6 ETSI GS MEC 013 V1.1.1 (2017-07)
1 Scope
The present document focuses on the Mobile Edge Location Service. It describes the related application policy
information including authorization and access control, information flows, required information and service aggregation
patterns. The present document specifies the necessary API with the data model and data format.
It is to be noted that the actual data model and data format which is functional for the present API is defined in
"RESTful Network API for Zonal Presence" published by the Open Mobile Alliance [5].
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: "Mobile Edge Computing (MEC); Terminology".
[2] ETSI GS MEC 002: "Mobile Edge Computing (MEC); Technical Requirements".
[3] ETSI GS MEC 003: "Mobile Edge Computing (MEC); Framework and Reference Architecture".
[4] ETSI GS MEC 009: "Mobile Edge Computing (MEC); General principles for Mobile Edge
Service APIs".
[5] OMA-TS-REST-NetAPI-ZonalPresence-V1-0-20160308-C: "RESTful Network API for Zonal
Presence".
[6] OMA-TS-REST-NetAPI-ACR-V1-0-20151201-C: "RESTful Network API for Anonymous
Customer Reference Management".
[7] ETSI TS 129 171: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal
Mobile Telecommunications System (UMTS); LTE; Location Services (LCS); LCS Application
Protocol (LCS-AP) between the Mobile Management Entity (MME) and Evolved Serving Mobile
Location Centre (E-SMLC); SLs interface (3GPP TS 29.171)".
[8] IETF RFC 2818: "HTTP Over TLS".
NOTE: Available at https://tools.ietf.org/html/rfc2818.
[9] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2".
NOTE: Available at https://tools.ietf.org/html/rfc5246.
[10] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
NOTE: Available at https://tools.ietf.org/html/rfc6749.
[11] IETF RFC 6750: "The OAuth 2.0 Authorization Framework: Bearer Token Usage".
NOTE: Available at https://tools.ietf.org/html/rfc6750.
ETSI
---------------------- Page: 6 ----------------------
7 ETSI GS MEC 013 V1.1.1 (2017-07)
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] SCF 084.07.01: "Small cell zone services - RESTful bindings".
[i.2] SCF 152.07.01: "Small cell services API".
[i.3] OpenAPI Specification.
NOTE 1: Available at https://github.com/OAI/OpenAPI-Specification.
NOTE 2: OpenAPI Specification version 2.0 is recommended as it is the official release at the time of publication.
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ETSI GS MEC 001 [1] and the following
apply:
Anonymous Customer Reference (ACR): Uniform Resource Identifier (URI) scheme describing an anonymous
reference that can be mapped to a resource or user/user group
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI GS MEC 001 [1] and the following apply:
ACR Anonymous Customer Reference
API Application Programming Interface
E-SMLC Evolved Serving Mobile Location Centre
ID Identifier
LS Location Service
OMA Open Mobile Alliance
REST Representational State Transfer
SCF Small Cell Forum
UE User Equipment
URI Uniform Resource Identifier
URL Uniform Resource Locator
4 Overview
The present document specifies the Location Service API to support the requirements defined for Mobile Edge
Computing in ETSI GS MEC 002 [2]. The Location Service (LS) defined in the present document leverages the Zonal
Presence service described in SCF 084.07.01 [i.1] and in SCF 152.07.01 [i.2]. The Location Service is accessible
through the API defined in the Open Mobile Alliance (OMA) specification "RESTful Network API for Zonal Presence"
[5].
ETSI
---------------------- Page: 7 ----------------------
8 ETSI GS MEC 013 V1.1.1 (2017-07)
In addition to referencing the OMA API [5], the present document contains application instructions on how to apply the
OMA API [5] in the MEC environment, and application instructions on how the Anonymous Customer Reference
(ACR) defined in [6] can be applied to fulfil the ETSI MEC requirement [Location-04] on addressing user categories
defined in ETSI GS MEC 002 [2], and application instructions on how the 3GPP Cell Identifiers defined in ETSI
TS 129 171 [7] can be mapped to the Access Point identifier of the OMA API [5].
5 Description of the service (informative)
5.1 Introduction
Location Service is a service to provide the location related information to the Mobile edge platform or authorized
applications. With location related information, the Mobile edge platform or applications perform the active device
location tracking, location-based service recommendation, etc. see ETSI GS MEC 002 [2]. The Location Service is
registered and discovered over the Mp1 reference point defined in ETSI GS MEC 003 [3].
The Location Service supports the location retrieval mechanism, i.e. the location is reported only once for each location
information request.
The Location Service supports the location subscribe mechanism, i.e. the location is able to be reported multiple times
for each location request, periodically or based on specific events, such as location change.
The Location Service supports the anonymous location report, i.e. without the related UE ID information, e.g. for the
statistics collection.
The Location Service supports the following location information:
• the location information of specific UEs currently served by the radio node(s) associated with the Mobile edge
host;
• the location information of all UEs currently served by the radio node(s) associated with the Mobile edge host;
• the location information of a certain category of UEs currently served by the radio node(s) associated with the
Mobile edge host;
• a list of UEs in a particular location area;
• the specific UEs which move in or out of a particular location area;
• information about the location of all radio nodes currently associated with the Mobile edge host.
The Location Service supports both geolocation, such as a geographical coordinates, and logical location, such as a Cell
ID.
5.2 Relation with OMA API for Zonal Presence
The Zonal Presence service utilizes the concept of "zone", defined in OMA API [5]. According to the definition therein,
a zone lends itself to be used to group all the radio nodes that are associated to a Mobile edge host, or a subset of them,
according to the desired deployment.
The OMA Zonal Presence API provides means to an application to retrieve information about a zone, the access points
associated to the zones and the users that are connected to the access points. In addition, the OMA Zonal Presence API,
allows authorized application to subscribe to a notification mechanism, reporting about user activities within a zone.
In the present document, clauses 6 and 7 define how the OMA Zonal Presence API is used to provide the Mobile edge
Location Service.
ETSI
---------------------- Page: 8 ----------------------
9 ETSI GS MEC 013 V1.1.1 (2017-07)
5.3 Sequence diagrams
5.3.1 Introduction
Clauses 5.3.2 to 5.3.7 describe how the Service Consumers interact with the Location Service over LS API to obtain
location information of a UE, a group of UEs or the radio nodes currently associated with the Mobile edge host. The
sequence diagrams that are relevant for the Location Service are presented.
The Service Consumers communicate with the Location Service over the LS API. Both the Mobile edge application and
Mobile edge platform can be Service Consumers. Location information can be provided by both Mobile edge platform
and Mobile edge application.
The Location Service API supports both queries and subscriptions (pub/sub mechanism) that can be used over RESTful
API as per the mechanism in OMA API [5].
5.3.2 UE Location Lookup
The UE Location Lookup is the procedure for applications acquiring the current location information of a specific UE
or a group of UEs. In this procedure, the Location Service will report the lookup result once on each request.
The UE Location Lookup procedure is illustrated in figure 5.3.2-1.
Figure 5.3.2-1: Flow of UE Location Lookup
1) The Mobile edge application looks up an UE location by sending a request to the resource representing the UE
location, which includes the UE(s) identifier, e.g. UE IP address.
2) The Location Service returns a response with a message body including the location information of the UE(s)
if the UE location lookup is accepted.
5.3.3 UE Information Lookup
The UE Information Lookup is the procedure for applications acquiring information of a list of UEs in a particular
location. In this procedure, the Location Service will report the lookup result once on each request.
The UE Information Lookup procedure is illustrated in figure 5.3.3-1.
Figure 5.3.3-1: Flow of UE Information Lookup
ETSI
---------------------- Page: 9 ----------------------
10 ETSI GS MEC 013 V1.1.1 (2017-07)
1) The Mobile edge application looks up UE information in a particular area by sending a request to the resource
representing the UE Information, which includes location area information.
2) The Location Service returns a response with a message body including the list of UEs in the location area, if
the UE information lookup is accepted.
5.3.4 UE Location Subscribe
The UE Location Subscribe is the procedure for applications acquiring up-to-data location information of a specific UE
or a group of UEs in a period, which help the applications to track the UE(s). In this procedure, the Location Service
will continue to report the subscribed information until the subscription is cancelled.
The UE Location Subscribe procedure is illustrated in figure 5.3.4-1.
Figure 5.3.4-1: Flow of UE Location Subscribe
1) The Mobile edge application subscribes to UE location notification by requesting the creation of a resource
containing the subscription details, which includes UE(s) identifier, e.g. UE IP address, and a callbackURL for
receiving the UE location.
2) The Location Service returns a response with resource URI containing the subscriptionId.
3) The Location Service reports the up-to-data subscribed information to the ME application by sending a
message with the message body containing the UE Location notification to the callbackURL, which includes
location information.
5.3.5 UE Information Subscribe
The UE Information Subscribe is the procedure for applications to receive notifications of UE Information updates for
the list of UEs in a particular location. The UE Information can be to update the status changes or periodic notifications
of UE information. In this procedure, the Location Service will continue to report the subscribed information until the
subscription is cancelled.
The UE Information Subscribe procedure is illustrated in figure 5.3.5-1.
ETSI
---------------------- Page: 10 ----------------------
11 ETSI GS MEC 013 V1.1.1 (2017-07)
Figure 5.3.5-1: Flow of UE Information Subscribe
1) The Mobile edge application subscribes to the UE information notification for a particular area by requesting
the creation of a resource containing all subscription details, which includes location area information and a
callbackURL for receiving the UE information.
2) The Location Service returns a response with resource URI containing the subscriptionId.
3) The Location Service reports the subscribed information to the ME application by sending a message with the
request body containing the UE Information notification to the callbackURL, which includes the UE
information for the list of UEs in the location area.
5.3.6 Subscribe Cancellation
The Subscribe Cancellation is the procedure for applications to cancel the subscription, with which the Location Service
stop reporting the subscribed information to the application.
The Subscribe Cancellation procedure is illustrated in figure 5.3.6-1.
Figure 5.3.6-1: Flow of Location Subscribe Cancellation
1) The Mobile edge application unsubscribes the notification by sending a request to delete the resource URI
containing the subscriptionId.
2) The Location Service returns a response if the subscription cancellation is accepted.
5.3.7 Radio Node Location Lookup
The Radio Node Location Lookup procedure enables an application to make a location enquiry about the radio nodes
currently associated with the Mobile edge host. The Radio Node Location Lookup procedure is illustrated in
figure 5.3.7-1.
ETSI
---------------------- Page: 11 ----------------------
12 ETSI GS MEC 013 V1.1.1 (2017-07)
Figure 5.3.7-1: Radio Node Location Lookup
1) The Mobile edge application makes an enquiry about the radio nodes currently associated with the Mobile
edge host by sending a request to the resource representing radio node information.
2) The Location Service returns a response with message body including the list of radio nodes currently
associated with the Mobile edge host and the location of each radio node.
6 Data Model
6.1 Introduction
Data types from the API defined in [5] are reused. The following application instructions describe the mapping between
the terminology used in the OMA specifications and the terminologies used in ETSI MEC and ETSI TS 129 171 [7].
6.2 Resource data types
6.2.1 Zonal presence data types
The data structures to be used in resource representations for the Location Service API consist in the following data
types defined in [5], clause 5:
• ZoneList
A type containing list of zones;
• ZoneInfo
A type containing zone information;
• AccessPointList
A type containing list of access points;
• AccessPointInfo
A type containing access point information;
• UserList
A type containing list of users;
• UserInfo
A type containing user information.
6.2.2 Type: UserInfo
This type represents the information related to a user attached to an access point associated to the Mobile edge host,
such access point is in scope of the Location Service instance.
The UserInfo data type extends the UserInfo data type defined in [5], and its elements shall follow the notations
provided in table 6.2.2-1.
ETSI
---------------------- Page: 12 ----------------------
13 ETSI GS MEC 013 V1.1.1 (2017-07)
Table 6.2.2-1: Definition of type UserInfo
Attribute name Data type Cardinality Description
address AnyURI 1 Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI)
currently on the access point, see note 1.
accessPointId String 1 The identity of the access point the user is currently on,
see note 1.
zoneId String
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.