8.3 Eees_UEIdentifier API
29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS
8.3.1 Introduction
The Eees_UEIdentifier service shall use the Eees_UEIdentifier API.
The API URI of the Eees_UEIdentifier API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in clause 7.5.
– The <apiName> shall be "eees-ueidentifier".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 8.3.2.
8.3.2 Resources
There are no resources defined for this API in this release of the specification.
8.3.3 Custom Operations without associated resources
8.3.3.1 Overview
The structure of the custom operation URIs of the Eees_UEIdentifier API is shown in Figure 8.3.3.1-1.
Figure 8.3.3.1-1: Custom operation URI structure of the Eees_UEIdentifier API
Table 8.3.3.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees_UEIdentifier API.
Table 8.3.3.1-1: Custom operations without associated resources
|
Operation name |
Custom operation URI |
Mapped HTTP method |
Description |
|
Fetch |
/fetch |
POST |
Fetch the identifier of a UE. |
8.3.3.2 Operation: Fetch
8.3.3.2.1 Description
This custom operation allows the EAS to fetch a UE’s identifier, which is UE ID as specified in 3GPP TS 23.558 [2], from the EES for a given UE information.
8.3.3.2.2 Operation Definition
This operation shall support the request data structures and the response data structure and response codes specified in the tables 8.3.3.2.2-1 and 8.3.3.2.2-2.
Table 8.3.3.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UserInformation |
M |
1 |
Information about the User or the UE, available at the EAS. |
Table 8.3.3.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
Gpsi |
M |
1 |
200 OK |
The UE Identifier (UE ID), returned by the Edge Enabler Server. |
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6] |
||
|
NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 8.3.3.2.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative target URI located in an alternative UAE Server. |
Table 8.3.3.2.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative target URI located in an alternative UAE Server. |
8.3.4 Notifications
None.
8.3.5 Data Model
8.3.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API
Table 8.3.5.1-1 specifies the data types defined specifically for the Eees_UEIdentifier API service.
Table 8.3.5.1-1: Eees_UEIdentifier API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
UserInformation |
8.3.5.2.2 |
Information about the User or the UE, that used by EES to use 3GPP CN capability to retrieve the EAS specific UE identifier. |
Table 8.3.5.1-2 specifies data types re-used by the Eees_UEIdentifier API service.
Table 8.3.5.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
Gpsi |
3GPP TS 29.571 [8] |
Used to identify the UE with GPSI. |
|
|
IpvAddr |
3GPP TS 29.571 [8] |
IP address of the UE. |
|
|
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of optional features defined in table 8.3.7-1. |
8.3.5.2 Structured data types
8.3.5.2.1 Introduction
8.3.5.2.2 Type: UserInformation
Table 8.3.5.2.2-1: Definition of type UserInformation
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
easId |
string |
M |
1 |
The application identifier of the EAS, e.g. URI, FQDN, requesting the UE Identifier information. |
|
|
easProviderId |
string |
O |
0..1 |
Identifier of the ASP that provides the EAS. |
|
|
ipAddr |
IpAddr |
M |
1 |
IP address of the UE. |
|
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 7.8. This attribute shall be provided in the HTTP POST request and success response. |
8.3.5.3 Simple data types and enumerations
None
8.3.6 Error Handling
General error responses are defined in clause 7.7.
8.3.7 Feature negotiation
General feature negotiation procedures are defined in clause 7.8. Table 8.3.7-1 lists the supported features for Eees_UEIdentifier API.
Table 8.3.7-1: Supported Features
|
Feature number |
Feature Name |
Description |