5 Services offered by Edge Enabler Server

29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.1 Introduction

The table 5.1-1 lists the Edge Enabler Server APIs below the service name. A service description clause for each API gives a general description of the related API.

Table 5.1-1: List of EES Service APIs

Service Name	Service Operations	Operation Semantics	Consumer(s)
Eees_EASRegistration	Request	Request/Response	EAS
	Update	Request/Response	EAS
	Deregister	Request/Response	EAS
Eees_UELocation	Get	Request/Response	EAS
	Subscribe	Subscribe/Notify	EAS
	Notify
	UpdateSubscription
	Unsubscribe
Eees_UEIdentifier	Get	Request/Response	EAS
Eees_AppClientInformation	Subscribe	Subscribe/Notify	EAS
	Notify
	UpdateSubscription
	Unsubscribe
Eees_SessionWithQoS	Create	Request/Response	EAS
	Update	Request/Response	EAS
	Revoke	Request/Response	EAS
	Notify	Subscribe/Notify	EAS
Eees_EASDiscovery	TEasDiscRequest	Request/Response	EAS, EES
Eees_ACRManagementEvent	Subscribe	Subscribe/Notify	EAS
	Notify
	UpdateSubscription
	Unsubscribe
Eees_EECContextRelocation	Push	Request/Response	EES
Eees_EECContextRelocation	Pull	Request/Response	EES
Eees_EELManagedACR	Request	Request/Response	EAS
	Subscribe	Subscribe/Notify	EAS
	Notify	Subscribe/Notify	EAS
Eees_ACRStatusUpdate	Request	Request/Response	EAS
Eees_AppContextRelocation	ACRDetermination_Request	Request/Response	EAS
Eees_AppContextRelocation	SelectedTargetEAS_Declare	Request/Response	EAS

Table 5.1-2 summarizes the corresponding Edge Enabler Server APIs defined in this specification.

Table 5.1-2: API Descriptions

Service Name	Clause	Description	OpenAPI Specification File	apiName	Annex
Eees_EASRegistration	5.2	EAS registration service	TS29558_Eees_EASRegistration.yaml	eees-easregistration	A.2
Eees_UELocation	5.3	Service for fetching UE location information	TS29558_Eees_UELocation.yaml	eees-uelocation	A.3
Eees_UEIdentifier	5.4	Service for fetching UE identifier.	TS29558_Eees_UEIdentifier.yaml	eees-ueidentifier	A.4
Eees_AppClientInformation	5.5	Service to obtain the capabilities of the ACs.	TS29558_Eees_AppClientInformation.yaml	eees-appclientinformation	A.5
Eees_SessionWithQoS	5.6	Service to setup data session between AC and EAS with specific QoS.	TS29558_Eees_SessionWithQoS.yaml	eees-session-with-qos	A.6
Eees_ACRManagementEvent	5.8	Service to receive notification related to ACR management events.	TS29558_Eees_ACRManagementEvent.yaml	eees-acrmgmtevent	A.7
Eees_EECContextRelocation	5.10	Service to push or pull EEC context information.	TS29558_Eees_EECContextRelocation.yaml	eees-eeccontextreloc	A.8
Eees_EELManagedACR	5.11	Service to request for handling of ACR related operations and receive ACT notifications.	TS29558_Eees_EELManagedACR.yaml	eees-eel-acr	A.9
Eees_ACRStatusUpdate	5.12	Service to update the status of ACR.	TS29558_Eees_ACRStatusUpdate.yaml	eees-acrstatus-update	A.10

5.2 Eees_EASRegistration Service

5.2.1 Service Description

The Eees_EASRegistration API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to register, update its registration and deregister at a given Edge Enabler Server.

5.2.2 Service Operations

5.2.2.1 Introduction

The service operation defined for Eees_EASRegistration API is shown in the table 5.2.2.1-1.

Table 5.2.2.1-1: Operations of the Eees_EASRegistration API

Service operation name	Description	Initiated by
Eees_EASRegistration_Request	This service operation is used by the EAS to register itself to a given EES.	EAS
Eees_EASRegistration_Update	This service operation is used by the EAS to update its registration information at EES.	EAS
Eees_EASRegistration_Deregister	This service operation is used by the EAS to deregister itself from a given EES.	EAS

5.2.2.2 Eees_EASRegistration_Request

5.2.2.2.1 General

This service operation is used by EAS to register itself to a given EES.

5.2.2.2.2 EAS registering to EES using Eees_EASRegistration_Request operation

To register itself as an Edge Application Server at the EES, the EAS shall send an HTTP POST message to the Edge Enabler Server on the "EAS Registrations" collection resource. The body of the HTTP POST message shall include the EAS profile information, may include proposed expiration time for the registration, as specified in clause 8.1.2.2.3.1.

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. Process the EAS registration request information;

2. verify the identity of the Edge Application Server and check if the EAS is authorized to register itself at EES ;

3. if the EAS is authorized to register to EES, then the EES shall;

a. store the EAS profile and create a new resource with the EAS registration information as specified in clause 8.1.2.1;

b. return the EAS registration information, the resource URI of the EAS registration information, in the "201 Created" response message. The EES shall include a Location HTTP header field. The Location header field shall contain the URI of the created registration i.e. {apiRoot}/eees-easregistration/<apiVersion>/registrations/{registrationId}.

The response message may include expiration time to indicate when the EAS registration will automatically expire.

On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code.

If the expiration time is provided, then to maintain the registration, the EAS shall send a registration update request (as described in clause 5.2.2.3) prior to the expiration time. If the registration update request is not sent before the expiry time, then the EES shall treat the EAS as deregistered and remove the corresponding EAS registration resource.

5.2.2.3 Eees_EASRegistration_Update

5.2.2.3.1 General

This service operation is used by EAS to update its registration information at a given EES.

5.2.2.3.2 EAS updating registration information using Eees_EASRegistration_Update operation

To update the EAS registration information at the EES, the EAS shall send a HTTP PUT or PATCH message to the Edge Enabler Server on resource URI identifying the Individual EAS registration resource representation, as specified in clause 8.1.2.3.3.2 for HTTP PUT message and in clause 8.1.2.3.3.4 for HTTP PATCH message.

The HTTP PUT message shall replace all properties in the existing resource with the EAS registration information in the request. The EASRegistration data type in the request body of the HTTP PUT message shall include the EAS profile information, may include proposed expiration time to update the registration. This request shall not replace the easId property of the existing resource.

The HTTP PATCH message includes parameters (EAS Profile, expiry time) in the EASRegistrationPatch data type that need to modify the existing Individual EAS registration resource. This request shall not replace the easId property of the existing resource.

Upon receiving the HTTP PUT or PATCH message from the EAS, the EES shall:

1. check the registration update message from the EAS to see if the EAS is authorized to modify the requested registration resource;

2. if the EAS is authorized to update the registration information, then the EES shall:

a. update the resource identified by Resource URI of the EAS registration information with the updated EAS registration information received in the HTTP PUT or PATCH request message;

b. upon successful update of EAS registration information, respond to the EAS with "204 No Content", or "200 OK" along with the updated EAS registration information in the response. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated registration will automatically expire.

On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP PUT or PATCH request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

If the expiration time is provided, then to maintain the registration, the EAS shall send a registration update prior to registration expiry time. If the registration update request is not sent before the expiry time, then the EES shall treat EAS as deregistered and remove the corresponding EAS registration resource.

5.2.2.4 Eees_EASRegistration_Deregister

5.2.2.4.1 General

This service operation is used by EAS to deregister itself from a given EES.

5.2.2.4.2 EAS deregistering from EES using Eees_EASRegistration_Deregister operation

To deregister itself from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the Individual EAS registration resource representation as specified in clause 8.1.2.3.3.3. Upon receiving the HTTP DELETE request, the EES shall:

1. verify the identity of the EAS and check if the EAS is authorized to deregister the EAS registration information;

2. if the EAS is authorized to deregister the EAS registration information, then the EES shall deregister the EAS profile from the EES and delete the resource representing EAS registration information;

3. return the "204 Not Content" message to the EAS, indicating the successful deregistration of the EAS information.

On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP DELETE request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.3 Eees_UELocation Service

5.3.1 Service Description

The Eees_UELocation API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain the UE location information as one time request or subscribe for continuous reporting.

5.3.2 Service Operations

5.3.2.1 Introduction

The service operation defined for Eees_UELocation API is shown in the table 5.3.2.1-1.

Table 5.3.2.1-1: Operations of the Eees_UELocation API

Service operation name	Description	Initiated by
Eees_UELocation_Get	This service operation is used by the EAS to request UE location information from a given EES.	EAS
Eees_UELocation_Subscribe	This service operation is used by the EAS to subscribe to EES, for continuous reporting of UE location information.	EAS
Eees_UELocation_Notify	This service operation is used by the EES to notify the EAS about the UE location information.	EES
Eees_UELocation_UpdateSubscription	This service operation is used by the EAS to update its subscription at EES, for continuous reporting of UE location information.	EAS
Eees_UELocation_Unsubscribe	This service operation is used by the EAS to remove its subscription from EES, for continuous reporting of UE location information.	EAS

5.3.2.2 Eees_UELocation_Get

5.3.2.2.1 General

This service operation is used by EAS to obtain a UE’s location information from a given EES.

5.3.2.2.2 EAS obtaining UE location information from EES using Eees_UELocation_Get operation

To obtain an UE’s location information from the EES, the EAS shall send an HTTP POST message to the EES on the URI "{apiRoot}/eees-uelocation/<apiVersion>/fetch" as specified in clause 8.2.3.2. The POST request includes:

– the identifier of the UE for which location information is requested;

– the accuracy of the requested location in terms of granularity and location QoS.

Upon reception of the HTTP POST request from the EAS, the EES shall:

1. process the EAS UE location information request;

2. verify the identity of the Edge Application Server and check if the EAS is authorized to obtain UE location information;

3. if the EAS is authorized to obtain the UE’s location information, then the EES shall:

a. consider the location granularity information received in the request message to obtain the UE’s location information;

b. check if a valid locally cached UE location information is available, and if available then the EES shall return the UE location information in the format requested by the EAS along with the location accuracy and its timestamp;

c. if valid UE location information is not available in local cache, then the EES shall obtain the UE location information by consuming the 3GPP core network capabilities. The EES shall return the UE location information to EAS in the format requested by the EAS along with the location accuracy and its timestamp as a 200 OK response.

On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.3.2.2.3 User consent management

Based on local regulations’ requirements and/or operator policies, user consent management specified in Annex V of 3GPP TS 33.501 [6] may be required for accessing the Eees_UELocation API. When it is the case and the EES is accessing the 3GPP 5GC network services directly, the EES shall act as the consent enforcement entity, as specified in clause 5.1.3 of 3GPP TS 33.558 [20].

When user consent management and enforcement shall be undertaken for the Eees_UELocation API, then:

– the EES shall check user consent for the targeted UE by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM, as specified in clause 5.2.2.2.24 of 3GPP TS 29.503 [22] and:

– if user consent is not granted for the targeted UE, the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER_CONSENT_NOT_GRANTED" application error; and

– if user consent is granted for the targeted UE, the EES shall accept the request to retrieve UE location information and process it as specified in clause 5.3.2.2.2.

5.3.2.3 Eees_UELocation_Subscribe

5.3.2.3.1 General

This service operation is used by the EAS to subscribe for continuous UE(s) location reporting.

5.3.2.3.2 EAS subscribing to continuous UE(s) location reporting from EES using Eees_UELocation_Subscribe operation

To subscribe to continuous UE(s) location information reporting at the EES, the EAS shall send a HTTP POST message to the EES on the "Location Information Subscriptions" resource. The body of the POST message shall include EAS identifier, the identifier of the UE or the identifier of the group uniquely identifying a group of UEs, Notification Destination URI and may include location format that is understood by EAS, location QoS, proposed expiry time of the subscription and reporting requirements, as specified in clause 8.2.2.2.3.1.

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. Process the EAS UE location information subscription request;

2. verify the identity of the Edge Application Server and check if the EAS is authorized to subscribe for the continuous UE(s) location reporting;

3. if the EAS is authorized to subscribe for the continuous UE(s) location information reporting, then the EES shall;

a. create a new resource with the Location Information Subscription as specified in clause 8.2.2.1;

b. return the EAS’s location subscription information, the resource URI of the EAS location subscription, in the response message. The response message may include expiration time to indicate when the location information subscription will automatically expire;

On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code.

EES shall obtain the UE location information by consuming the 3GPP core network capabilities from NEF as specified in 3GPP TS 29.522 [10], or from SCEF as specified in 3GPP TS 29.122 [6] or from LCS (Location Service) as specified in 3GPP TS 23.271 [23] or 3GPP TS 23.273 [24]. The EES may also consume the UE mobility analytics from NEF as specified in 3GPP TS 29.522 [10] or from NWDAF as specified in 3GPP TS 29.520 [12].

If the expiration time is provided, then to maintain the registration, the EAS shall send a subscription update request (as described in clause 5.3.2.5) prior to the expiration time. If the subscription update request is not sent before the expiry time, then the EES shall treat the subscription as unsubscribed and remove the corresponding EAS’s Individual Location Information Subscription resource.

5.3.2.3.3 User consent management

When user consent management and enforcement shall be undertaken for the Eees_UELocation API, then:

– if the EAS does not support the "UserConsentRevocation" feature or does not indicate its support for this feature in the HTTP POST request to create a new "Individual Location Information Subscription" resource, the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "CONSENT_REVOCATION_NOT_SUPPORTED" application error;

– if the EAS indicates its support for the "UserConsentRevocation" feature in the HTTP POST request to create a new "Individual Location Information Subscription" resource, the EES shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM as specified in clause 5.2.2.2.24 of 3GPP TS 29.503 [22], subscribe to user consent revocation notifications only for those UE(s) for which user consent is granted also using the Nudm_SDM service API of the UDM and accept the request for the creation of the UE location information subscription only for the UE(s) for which user consent is granted;

– if user consent is not granted for all the targeted UE(s), the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER_CONSENT_NOT_GRANTED" application error;

– the EAS shall provide within the payload body of the HTTP POST request to create a new UE location information subscription the URI via which it desires to receive user consent revocation notifications within the "revocationNotifUri" attribute. The EAS may update this URI in subsequent HTTP PUT/PATCH requests to update/modify the corresponding "Individual Location Information Subscription" resource;

– when becoming aware of user consent revocation for one or several UE(s), the EES shall:

– stop processing the data related to the concerned UE(s);

– send a user consent revocation notification to the EAS by sending an HTTP POST request with the request body including the ConsentRevocNotif data structure that shall contain the user consent revocation information (e.g. UE(s) for which user consent was revoked, etc.); and

– remove the concerned UE(s) from the "Individual Location Information Subscription" resource and from the related subscriptions at the 3GPP 5GC network entities, if any;

– unsubscribe from user consent revocation notifications for the concerned UE(s) at the UDM;

and

– at the reception of the user consent revocation notification from the EES, the EAS shall take the necessary actions to stop processing the data related to the concerned UE(s); and

– if user consent is revoked for all the UE(s), the EAS shall delete the corresponding "Individual Location Information Subscription" resource, as specified in clause 5.3.2.6.

5.3.2.4 Eees_UELocation_Notify

5.3.2.4.1 General

This service operation is used by the EES to send UE(s) location information notifications or user consent revocation notifications to the EAS.

5.3.2.4.2 EES notifying the UE(s) location reporting to EAS using Eees_UELocation_Notify operation

The EES determines to notify the EAS with the UE location information, when the UE location information is available either locally cached or from the 3GPP core network.

To notify the UE(s) location information events, the EES shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include LocationNotification. LocationNotification includes location information of each UE with accuracy, and timestamp. The location information of each UE may be actual location change or predictive location report from the UE mobility analytics report from NEF as specified in 3GPP TS 29.522 [10] , or from SCEF as specified in 3GPP TS 29.122 [6], or from LCS (Location Service) as specified in 3GPP TS 29.271 [23] or 3GPP TS 29.273 [24] or from NWDAF as specified in 3GPP TS 29.520 [12]. The EES may modify the UE location information in the format requested by the EAS in the subscription request.

Upon receiving the HTTP POST message, the EAS shall process the Location Notification.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EES with an appropriate error status code.

If the EAS determines that the received HTTP POST message needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.3.2.4.3 EES notifying the EAS about user consent revocation using Eees_UELocation_Notify operation

The EES determines to notify the EAS about user consent revocation, when becoming aware of user consent revocation for one or several UE(s) from the UDM as specified in 3GPP TS 29.503 [22].

To notify user consent revocation, the EES shall send an HTTP POST message using the revocation notification URI received from the EAS in the UE location information subscription creation/update/modification request as specified in clause 5.3.2.3.3. The body of the HTTP POST message shall include ConsentRevocNotif data structure.

Upon reception of the HTTP POST request, the EAS shall take the necessary actions to stop processing the data related to the UE(s) for which user consent was revoked.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EES with an appropriate error status code.

5.3.2.5 Eees_UELocation_UpdateSubscription

5.3.2.5.1 General

This service operation is used by the EAS to update its location information subscription at the EES.

5.3.2.5.2 EAS updating continuous UE(s) location reporting subscription at EES using Eees_UELocation_UpdateSubscribe operation

To update continuous UE(s) location information reporting subscription at the EES, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI identifying the "Individual Location Information" Subscription resource representation, as specified in clause 8.2.2.3.3.2 for HTTP PATCH message and in clause 8.2.2.3.3.3 for HTTP PUT message.

The PATCH message includes the parameters (location QoS, location granularity, Notification Destination, Reporting requirements and proposed expiry time) that need to be replaced in the existing subscription resource.

The PUT message shall replace all the properties of the existing resource with the location subscription information in the request. The request shall not replace the easId, ueId and groupId properties of the existing resource.

Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall:

1. check the update subscription message from the EAS to see if the EAS is authorized to modify the requested subscription resource;

2. if the EAS is authorized to update the location information subscription, then the EES shall:

a. update the resource identified by Resource URI of the EAS location information subscription with the updated information received in the HTTP PATCH or PUT request message;

b. return the updated EAS Location information subscription in the response. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated subscription will automatically expire.

On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP PATCH or PUT request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

If the expiration time is provided, then to maintain the subscription, the EAS shall send a update subscription prior to subscription expiry time. If the update subscription request is not sent before the expiry time, then the EES shall treat EAS subscription as unsubscribed and remove the corresponding EAS location information subscription resource.

5.3.2.5.3 User consent management

When user consent management and enforcement shall be undertaken for the Eees_UELocation API, then:

– the EAS may update/modify the revocation notification URI when updating/modifying an existing "Individual Location Information Subscription" resource;

– if user consent is still granted for the concerned UE(s), i.e. no user consent revocation notification is received by the EES from the UDM, then the EES shall process the request as specified in clause 5.3.2.5.2;

– if user consent is granted for only a subset of the UE(s), process the request as specified in clause 5.3.2.5.2 only for this subset of UE(s);

– otherwise, if the EES is made aware by the UDM that user consent is not granted for one or several UE(s) at the reception of the Eees_UELocation_UpdateSubscribe request, then the EES shall:

– stop processing the data related to the concerned UE(s);

– if user consent is not anymore granted for all the UE(s), reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER_CONSENT_NOT_GRANTED" application error;

– remove the concerned UE(s) from the concerned "Individual Location Information Subscription" resource and from the related subscriptions at the 3GPP 5GC network entities, if any; and

– unsubscribe from user consent revocation notifications for the concerned UE(s) at the UDM;

and the EAS shall:

– at the reception of the user consent revocation notification from the EES, take the necessary actions to stop processing the data related to the concerned UE(s); and

– if user consent is revoked for all the UE(s), delete the corresponding "Individual Location Information Subscription" resource, as specified in clause 5.3.2.6.

5.3.2.6 Eees_UELocation_Unsubscribe

5.3.2.6.1 General

This service operation is used by the EAS to unsubscribe from an existing UE(s) location information subscription.

5.3.2.6.2 EAS unsubscribing to continuous UE(s) location reporting from EES using Eees_UELocation_Unsubscribe operation

To unsubscribe its location information subscription from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the "Individual Location Information Subscription" resource representation as specified in clause 8.2.2.3.3.4. Upon receiving the HTTP DELETE request, the EES shall:

1. verify the identity of the EAS and check if the EAS is authorized to unsubscribe the Individual Location Information Subscription resource;

2. if the EAS is authorized to unsubscribe the Individual Location Information Subscription resource, then the EES shall unsubscribe the EAS subscription identified by the subscriptionId from the EES and delete the resource representing Individual Location Information Subscription resource represented by subscriptionId;

3. return the "204 Not Content" message to the EAS, indicating the successful removal of the subscription information and may unsubscribe to the corresponding 3GPP core network service subscriptions.

On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP DELETE message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.4 Eees_UEIdentifier Service

5.4.1 Service Description

The Eees_UEIdentifier API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain an identifier uniquely identifying a UE from the EES.

5.4.2 Service Operations

5.4.2.1 Introduction

The service operation defined for Eees_UEIdentifier API is shown in the table 5.4.2.1-1.

Table 5.4.2.1-1: Operations of the Eees_UEIdentifier API

Service operation name	Description	Initiated by
Eees_UEIdentifier_Get	This service operation is used by the EAS to request UE identifier from a given EES that uses 3GPP CN capability to retrieve UE Identifier which is specific to the EAS.	EAS

5.4.2.2 Eees_UEIdentifier_Get

5.4.2.2.1 General

This service operation is used by EAS to obtain a UE’s identifier (UE ID, as specified in 3GPP TS 23.558 [2]) from a given EES that uses 3GPP CN capability to retrieve UE Identifier which is specific to the EAS.

5.4.2.2.2 EAS obtaining UE identifier from EES using Eees_UEIdentifier_Get operation

To obtain an UE’s Identifier from the EES, the EAS shall send a HTTP POST message to the EES with the request URI set to "{apiRoot}/eees-ueidentifier/<apiVersion>/fetch" and the request body with the UserInformation data structure including the information about the user or UE available with EAS, for which the UE identifier is requested.

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. Process the EAS UE Identifier request;

2. verify the identity of the EAS and check if the EAS is authorized to obtain the UE Identifier;

3. if the EAS is authorized to obtain the UE’s Identifier information, then the EES shall;

a. invoke the Nnef_UEId service as specified in clause 4.4.32 of 3GPP TS 29.522 [10] to obtain the UE identifier based on the user information received, and may derive the corresponding DNN and/or S-NSSAI based on the verified identity of the EAS;

b. upon successful retrieval of UE identifier, respond with "200 OK" along with the retrieved UE identifier to the EAS. If the UE identifier cannot be successfully retrieved or an internal error or an error in the HTTP POST request, the EES shall send an HTTP error response as specified in clause 7.7.

If the EES determines the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.5 Eees_AppClientInformation Service

5.5.1 Service Description

The Eees_AppClientInformation API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain the information about the capabilities of the ACs based on certain filter criteria.

5.5.2 Service Operations

5.5.2.1 Introduction

The service operation defined for Eees_AppClientInformation API is shown in the table 5.5.2.1-1.

Table 5.5.2.1-1: Operations of the Eees_AppClientInformation API

Service operation name	Description	Initiated by
Eees_AppClientInformation_Subscribe	This service operation is used by the EAS to subscribe to EES, for reporting of AC information.	EAS
Eees_AppClientInformation_Notify	This service operation is used by the EES to notify the EAS about the AC information.	EES
Eees_AppClientInformation_UpdateSubscription	This service operation is used by the EAS to update its subscription at EES, for reporting of AC information.	EAS
Eees_AppClientInformation_Unsubscribe	This service operation is used by the EAS to remove its subscription from EES, for reporting of AC information.	EAS

5.5.2.2 Eees_AppClientInformation_Subscribe

5.5.2.2.1 General

This service operation is used by the EAS to subscribe for AC(s) information reporting.

5.5.2.2.2 EAS subscribing to AC information reporting from EES using Eees_AppClientInformation_Subscribe operation

To subscribe to AC information reporting at the EES, the EAS shall send an HTTP POST request to the EES targeting the "Application Client Information Subscriptions" resource, with the request body containing the ACInfoSubscription data structure, as specified in clause 8.4.2.2.3.1.

Upon receiving the HTTP POST request from the EAS, the EES shall:

1. Process the EAS AC information subscription request;

2. verify the identity of the Edge Application Server and check if the EAS is authorized to subscribe for the AC information reporting;

3. if the EAS is authorized to subscribe for the AC information reporting, then the EES shall;

a. create a new resource with the AC Information Subscription as specified in clause 8.4.2.1; and

b. respond to the EAS with an HTTP "201 Created" status code including an HTTP Location header field containing the URI of the created "Individual Application Client Information Subscription" resource, and the response body containing a representation of the created resource within the ACInfoSubscription data structure.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. If the EAS is not registered at the EES when sending the AC information reporting subscription creation request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION_REQUIRED".

The EES determines the matching AC information corresponding to the filter criteria information in the subscription request to compose the AC information to the EAS.

If the expiration time is provided, then to maintain the registration, the EAS shall send a subscription update request (as described in clause 5.5.2.4) prior to the expiration time. If the subscription update request is not sent before the expiry time, then the EES shall treat the subscription as unsubscribed and remove the corresponding EAS’s Individual Application Client Information Subscription resource.

5.5.2.3 Eees_AppClientInformation_Notify

5.5.2.3.1 General

This service operation is used by the EES to send AC information notifications to the EAS.

5.5.2.3.2 EES notifying the AC information to EAS using Eees_AppClientInformation_Notify operation

The EES determines to notify the EAS with the AC information matching the filter criteria, when the AC information updates are available to EES, e.g. EES receives registration request from EEC.

To notify the AC(s) information, the EES shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include "ACInfoNotification". "ACInfoNotification" includes AC(s) information matching the filter criteria. The AC(s) information consist of AC(s) profiles, UE identifiers hosting the AC(s) and the location information of the UE(s) hosting the AC(s).

Upon receiving the HTTP POST message, the EAS shall process the AC Information Notification and shall respond to the EES with "204 No Content" message.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.4.6, and respond to the EES with an appropriate error status code.

5.5.2.4 Eees_AppClientInformation_UpdateSubscription

5.5.2.4.1 General

This service operation is used by the EAS to update its AC information subscription at the EES.

5.5.2.4.2 EAS updating AC information reporting subscription at EES using Eees_AppClientInformation_UpdateSubscribe operation

To update AC information reporting subscription at the EES, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI identifying the "Individual Application Client Information" Subscription resource representation, as specified in clause 8.4.2.3.3.2 for HTTP PATCH message and in clause 8.4.2.3.3.3 for HTTP PUT message.

The PATCH message includes the parameters (AC filter criteria, Notification Destination, Reporting requirements and proposed expiry time) that need to be replaced in the existing subscription resource.

The PUT message shall replace all the properties of the existing resource with the AC subscription information in the request. The request shall not replace the "easId" property of the existing resource.

Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall:

1. check the update subscription message from the EAS to see if the EAS is authorized to modify the requested subscription resource;

2. if the EAS is authorized to update the AC information subscription, then the EES shall:

a. update the resource identified by Resource URI of the EAS AC information subscription with the updated information received in the HTTP PATCH or PUT request message;

b. return the updated EAS AC information subscription in the "200 OK" response message or respond with the "204 No Content" message indicating to the EAS that the EAS AC information subscription is updated successfully. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated subscription will automatically expire.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PATCH or PUT response body. If the EAS is not registered at the EES when sending the AC information reporting subscription update request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION_REQUIRED".

If the EES determines that the received HTTP PATCH or PUT message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

If the expiration time is provided, then to maintain the subscription, the EAS shall send an update subscription prior to subscription expiry time. If the update subscription request is not sent before the expiry time, then the EES shall treat EAS subscription as unsubscribed and remove the corresponding EAS AC information subscription resource.

5.5.2.5 Eees_AppClientInformation_Unsubscribe

5.5.2.5.1 General

This service operation is used by the EAS to unsubscribe from an existing AC information subscription.

5.5.2.5.2 EAS unsubscribing to AC information reporting from EES using Eees_AppClientInformation_Unsubscribe operation

To unsubscribe its AC information subscription from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the "Individual Application Client Information Subscription" resource representation as specified in clause 8.4.2.3.3.4. Upon receiving the HTTP DELETE request, the EES shall:

1. verify the identity of the EAS and check if the EAS is authorized to unsubscribe the Individual Application Client Information Subscription resource;

2. if the EAS is authorized to unsubscribe the Individual Application Client Information Subscription resource, then the EES shall unsubscribe the EAS subscription identified by the "subscriptionId" from the EES and delete the resource representing Individual Application Client Information Subscription resource represented by "subscriptionId";

3. return the "204 Not Content" message to the EAS, indicating the successful removal of the subscription information.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. If the EAS is not registered at the EES when sending the AC information reporting subscription deletion request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION_REQUIRED".

5.6 Eees_SessionWithQoS Service

5.6.1 Service Description

The Eees_SessionWithQoS API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to support the setup of a data session between AC and EAS with a specific QoS and the modification of the QoS of this data session.

5.6.2 Service Operations

5.6.2.1 Introduction

The service operation defined for Eees_SessionWithQoS API is shown in the table 5.6.2.1-1.

Table 5.6.2.1-1: Operations of the Eees_SessionWithQoS API

Service operation name	Description	Initiated by
Eees_SessionWithQoS_Create	The service operation is used by the EAS to request reservation of resources for a data session between AC and EAS with a specific QoS and to subscribe to certain session with user plane event notifications.	EAS
Eees_SessionWithQoS_Update	The service operation is used by the EAS to request a modification of the QoS of the data session between AC and EAS.	EAS
Eees_SessionWithQoS_Revoke	The service operation is used by the EAS to revoke the data session between AC and EAS with a specific QoS and to unsubscribe to the related session with user plane event notifications.	EAS
Eees_SessionWithQoS_Notify	The service operation is used by the EES to notify the EAS about a user plane event associated with the established session between an AC and the EAS.	EES

5.6.2.2 Eees_SessionWithQoS_Create

5.6.2.2.1 General

This service operation is used by EAS to request reservation of resources for a data session between AC and EAS with a specific QoS and to subscribe to certain session with user plane event notifications.

5.6.2.2.2 EAS requesting reservation of resources for a data session between AC and EAS with specific QoS using Eees_SessionWithQoS operation

To request establishment of a data session between AC and EAS with a specific QoS, the EAS shall send a HTTP POST message to the Edge Enabler Server on the "Sessions with QoS" resource as specified in clause 8.5.2.2.3.1. The body of POST message shall include the EAS identifier, only one of the UE’s IP address or the Identifier of the UE or the identifier of the group uniquely identifying a group of UEs, IP flow description, and at least one of requested QoS reference. The body of POST message may include a list of associated events which the EAS subscribes, and if the event list is included, a Notification Destination URI shall also be provided.

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. Process the EAS Session with QoS Create request;

2. verify the identity of the EAS and check if the EAS is authorized to request reservation of resources for a data session between AC and EAS with a specific QoS;

3. if the EAS is authorized, then the EES shall;

a. create a new resource "Individual Session with QoS";

b. if the request is for a group of UEs identified by group ID (i.e., via the "intGrpId" or "extGrpId") or for a single UE identified via the "ueId" attribute, interact with the SCEF (as specified in 3GPP TS 29.122 [6]) or the NEF (as specified in 3GPP TS 29.522 [10]) by invoking the MonitroingEvent API with the monitoring type sets to "PDN_CONNECTIVITY_STATUS" to request to be notified when the 3GPP network detects the UE’s PDN connection or PDU session is set up or torn down. If the IP address for the single UE or, the IP address(es) for one or more UEs within the group are received from the 3GPP network, then execute step 3c; and

c. if the request is for a single UE identified by the IP address or the IP address is obtained in step 3b, interact directly with the PCRF (as specified in 3GPP TS 29.214 [15]) or the PCF (as specified in 3GPP TS 29.514 [16]), or via the SCEF (as specified in 3GPP TS 29.122 [6]) or the NEF (as specified in 3GPP TS 29.522 [10]) by invoking the AsSessionWithQoS API, to provide the specific QoS information to the PCF.

4. upon receipt of successful response from 3GPP network, respond to the EAS with "201 Created" and include the session with QoS context information. The new created resource URI shall also be included in the Location header field of the HTTP response message.in the response message.

On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code.

5.6.2.3 Eees_SessionWithQoS_Update

5.6.2.3.1 General

This service operation is used by EAS to request updating QoS of a data session between AC and EAS and to modify the subscription of the session with user plane event notifications.

5.6.2.3.2 EAS updating QoS of a data session between AC and EAS using Eees_SessionWithQoS_Update operation

To request modification of the QoS of the data session between AC and EAS, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI "Individual Session with QoS" resource as specified in clause 8.5.2.3.3.1 for HTTP PATCH message and in clause 8.5.2.3.3.2 for HTTP PUT message.

The PUT message shall replace all the QoS settings of the data session in the existing context. The request shall not change the values of the "easId", "ueId", "ueIpv4Addr", "ueIpv6Addr", "ipDomain", "intGrpId", "extGrpId", "dnn" and/or "snssai" attributes.

Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall:

1. check the update of the existing Individual Session with QoS from the EAS is authorized or not;

2. if the EAS is authorized, and to update the QoS setting, then the EES shall:

a. interact with the 3GPP network to update the associated data session; and

b. upon receipt of successful response from 3GPP network, respond to the EAS with "204 No Content", or "200 OK" with the updated Individual session with QoS context in the response message.

On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code.

5.6.2.4 Eees_SessionWithQoS_Revoke

5.6.2.4.1 General

This service operation is used by EAS to revoke the data session between AC and EAS with a specific QoS and to unsubscribe to the related session with user plane event notifications.

5.6.2.4.2 EAS revoking QoS of a data session between AC and EAS using Eees_SessionWithQoS_Revoke operation

To revoke the data session between AC and EAS with a specific QoS and unsubscribe the user plane event notifications, the EAS shall send a HTTP DELETE message to the EES targeting the Individual Session with QoS resource as specified in clause 8.5.2.3.3.3. Upon receiving the HTTP DELETE request, the EES shall:

1. verify the identity of the EAS and check if the EAS is authorized to revoke the data session between AC and EAS with a specific QoS;

2. if the EAS is authorized and the resource exists, then the EES shall interact with the 3GPP network to delete the associated data session.

3. upon receipt of successful response from 3GPP network, delete the Individual Session with QoS resource corresponding to the individual Session with QoS; and

4. return "204 No Content" message to the EAS, indicating the successful removal.

On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code.

5.6.2.5 Eees_SessionWithQoS_Notify

5.6.2.5.1 General

This service operation is used by EES to send user plane event notification information of the data session between AC and EAS with a specific QoS to the EAS.

5.6.2.5.2 EES notifying QoS of a data session between AC and EAS using Eees_SessionWithQoS_Notify operation

The EES determines to notify the user plane event notification information to the EAS, when the EES receives the notification of the user plane event information from the 3GPP core network.

To notify the user plane event notification information, the EES shall send an HTTP POST message using the Notification Destination URI received during the creation or modification of resource request. The body of POST message shall include the event report information (e.g., resource allocation outcome or information that the QoS targets can no longer (or can again) be fulfilled).

Upon receiving the HTTP POST message, the EAS shall process the event report information and return "204 No Content" message to the EES.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EES with an appropriate error status code.

5.7 Eees_EASDiscovery Service

5.7.1 Service Description

The Eees_EASDiscovery service API enables a service consumer (i.e. EAS, EES) to:

– request EAS discovery.

5.7.2 Service Operations

5.7.2.1 Introduction

The service operations defined for Eees_EASDiscovery API are shown in the table 5.7.2.1-1.

Table 5.7.2.1-1: Operations of the Eees_EASDiscovery API

Service operation name	Description	Initiated by
Eees_EASDiscovery_TEasDiscRequest	This service operation is used by the EAS or EES to request EAS discovery information.	EES, EAS

5.7.2.2 Eees_EASDiscovery_TEasDiscRequest

5.7.2.2.1 General

This service operation is used by the S-EES or S-EAS to request for T-EAS discovery information, as specified for the Eees_TargetEASDiscovery API defined in 3GPP TS 23.558 [2].

5.7.2.2.2 EES or EAS requesting T-EAS discovery information using Eees_EASDiscovery_TEasDiscRequest operation

To request for T-EAS discovery, the service consumer (i.e. EAS or EES) shall send an HTTP POST request to the EES as specified in clause 6.3.2.4.4.2 of 3GPP TS 24.558 [14]. The body of the POST message shall include the EasDiscoveryReq data structure as specified in clause 6.3.5.2.2 of 3GPP TS 24.558 [14].

Upon reception of the HTTP POST request from the service consumer (i.e. EAS or EES), the EES shall:

a) process the EAS discovery request information;

b) the EES verifies and checks if the service consumer (i.e. EAS or EES) is authorized to discover the requested EAS(s) from the EES;

c) if the service consumer (i.e. EAS or EES) is authorized to discover the requested EAS(s) from the EES, then upon successful processing of the request, the EES responds with an HTTP "200 OK" status code with the response body including the EasDiscoveryResp data structure as specified in clause 6.3.5.2.3 of 3GPP TS 24.558 [14]. If the successful processing of the request does not result in finding a matching EAS (i.e. there is no client side error), the EES responds with an HTTP "204 No Content" status code.

If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

On failure, the EES shall take proper error handling actions, as specified in clause 6.3.6 of 3GPP TS 24.558 [14], and respond to the EAS or EES with an appropriate error status code.

5.8 Eees_ACRManagementEvent Service

5.8.1 Service Description

The Eees_ACRManagementEvent API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to support (un)subscription to the notifications of ACR management events.

5.8.2 Service Operations

5.8.2.1 Introduction

The service operation defined for Eees_ACRManagementEvent API is shown in the table 5.8.2.1-1.

Table 5.8.2.1-1: Operations of the Eees_ACRManagementEvent API

Service operation name	Description	Initiated by
Eees_ACRManagementEvent_Subscribe	The service operation is used by the EAS to subscribe to notifications of ACR management event(s).	EAS
Eees_ACRManagementEvent_UpdateSubscription	The service operation is used by the EAS to request a modification of an existing subscription of notifications of ACR management event(s).	EAS
Eees_ACRManagementEvent_Unsubscribe	The service operation is used by the EAS to unsubscribe to an existing subscription of notifications of ACR management event(s).	EAS
Eees_ACRManagementEvent_Notify	The service operation is used by the EES to notify the EAS about ACR management event(s) if detected.	EES

5.8.2.2 Eees_ACRManagementEvent_Subscribe

5.8.2.2.1 General

This service operation is used by EAS to subscribe to notifications of ACR management events.

5.8.2.2.2 EAS requesting to get notifications of ACR management events using Eees_ACRManagementEvent_Subscribe service operation

In order to subscribe to notifications of ACR management events, the EAS shall send a HTTP POST request message to the EES targeting the "ACR Management Events Subscriptions" resource as specified in clause 8.6.2.2.3.1. The body of the HTTP POST request message shall include the AcrMgntEventsSubscription data type as specified in clause 8.6.5.2.2.

Upon reception of the HTTP POST request message from the EAS, the EES shall:

1. Process the ACR management events subscription request;

2. verify the identity of the EAS and check if the EAS is authorized to subscribe to notifications of ACR management events;

3. if the EAS is authorized, then if one of the subscribed event(s) is the UP path change event, the EES shall:

a) if already subscribed to the 3GPP core network (i.e. either directly through the PCF or via the NEF TrafficInfluence API) on UP path management events and there is locally cached UP path change event information, perform step 4, and include the locally cached UP path change event information in the HTTP POST response body; or

b) if not yet subscribed to the 3GPP core network on UP path management events, interact with the NEF by invoking the TrafficInfluence API as specified in 3GPP TS 29.522 [10] or directly towards the PCF to request to be notified of the UP path change event. Upon receipt of successful response from the NEF, then the EES shall perform step 4.

NOTE: Only the trusted EES can subscribe to the 3GPP core network directly through the PCF, the untrusted EES needs to subscribe to the 3GPP core network via the NEF.

The EES may interact with the NEF by invoking the AnalyticsExposure API as specified in 3GPP TS 29.522 [10] to subscribe to notifications of, or retrieve the UE mobility and UE communication events.

4. create a new resource "Individual ACR Management Events Subscription" and respond to the EAS with "201 Created" and include the Individual ACR Management Events Subscription information. The new created resource URI shall also be included in the Location header field of the HTTP response message;

5. If the target UE and the 3GPP network supports mobility between 5GC and EPC, interact with the SCEF+NEF by invoking the MonitroingEvent API as specified in 3GPP TS 29.122 [6] with the monitoring type sets to "API_SUPPORT_CAPABILITY" or interact with the CAPIF core function by invoking the CAPIF_Events_API service as specified in 3GPP TS 29.222 [17] to request to be notified the availability of the TrafficInfluence API.

On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code.

5.8.2.3 Eees_ACRManagementEvent_UpdateSubscription

5.8.2.3.1 General

This service operation is used by EAS to request updating an existing Individual ACR Management Events Subscription.

5.8.2.3.2 EAS updating an existing Individual ACR Management Events Subscription using Eees_ACRManagementEvent_UpdateSubscription service operation

To request modification of an existing Individual ACR Management Events Subscription, the EAS shall send a HTTP PATCH request (for partial modification) or PUT request (for fully replacement) message to the EES on resource URI "Individual ACR Management Events Subscription" resource as specified in clause 8.6.2.3.3.1 for HTTP PATCH message and in clause 8.6.2.3.3.2 for HTTP PUT message. This request shall not replace the easId property of the existing resource.

Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall:

1. check the update of the existing Individual ACR Management Events Subscription from the EAS is authorized or not;

2. if the EAS is authorized, then if one of the subscribed event(s) is UP path change event, the EES shall:

a) if already successful subscribed to the 3GPP core network and there is local cached UP path change event information, perform step 3, and include the local cached UP path change event information in the HTTP PUT or PATCH response; or

b) if not subscribed to the 3GPP core network yet, interact with the NEF by invoking the TrafficInfluence API as specified in 3GPP TS 29.522 [10] to request to be notified of the UP path change event. Upon receipt of successful response from the NEF, then the EES shall perform step 3.

The EES may interact with the NEF by invoking the AnalyticsExposure API as specified in 3GPP TS 29.522 [10] to subscribe to notifications of, or retrieve the UE mobility and UE communication events.

3. update the existing resource "Individual ACR Management Events Subscription", respond to the EAS with "204 No Content", or "200 OK" with the updated Individual ACR Management Events Subscription message.

On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP PATCH or PUT message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.8.2.4 Eees_ACRManagementEvent_Unsubscribe

5.8.2.4.1 General

This service operation is used by EAS to delete an existing ACR Management Events Subscription.

5.8.2.4.2 EAS deleting an existing Individual ACR Management Events Subscription using Eees_ACRManagementEvent_Unsubscribe service operation

To delete an existing "Individual ACR Management Events Subscription", the EAS shall send a HTTP DELETE request message to the EES targeting the concerned "Individual ACR Management Events Subscription" resource as specified in clause 8.6.2.3.3.3. Upon receiving the HTTP DELETE request:

1. the EES shall verify the identity of the EAS and check if the EAS is authorized to delete the concerned ACR Management Events Subscription;

2. if the EAS is authorized and the resource exists, then the EES may interact with the 3GPP network to delete the associated Subscription(s), if needed; And

NOTE: The EES can keep the existing subscription(s) with the 3GPP network, e.g. if they are useful for other existing ACR Management Events subscriptions from other EASs.

3. upon successful processing of the request and the receipt of a successful response from 3GPP network, if needed as per step 2 above, the EES shall delete the Individual ACR Management Events Subscription; and respond with an HTTP "204 No Content" status code to the EAS, indicating the successful deletion of the concerned "Individual ACR Management Events Subscription" resource.

On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code.

If the EES determines that the received HTTP DELETE message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.8.2.5 Eees_ACRManagementEvent_Notify

5.8.2.5.1 General

This service operation is used by EES to send ACR management event notification information or the availability of user path management events monitoring via the 3GPP 5GC network to the EAS.

5.8.2.5.2 EES notifying ACR management events using Eees_ACRManagementEvent_Notify operation

In order to notify the ACR management event information, the EES shall send an HTTP POST message using the Notification Destination URI received during the creation or modification of subscription. The body of POST message shall include the AcrMgntEventsNotification data type as specified in clause 8.6.5.2.4.

Upon receiving the HTTP POST message, the EAS shall process the event report information and return "204 No Content" message to the EES.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EES with an appropriate error status code.

If the EAS determines that the received HTTP POST request needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.8.2.5.3 EES notifying the availability of user path management events monitoring via the 3GPP 5GC network using Eees_ACRManagementEvent_Notify operation

In order to notify of the availability of user path management events monitoring via the 3GPP 5GC network, the EES shall send an HTTP POST request message targeting the URI "{notificationDestination}/report-availability", where the Notification Destination URI is the one received during the creation or modification of the ACR management event subscription. The body of HTTP POST request message shall include the AvailabilityNotif data type as specified in clause 8.6.5.2.11.

NOTE: The EAS is subscribed by default to the reception of notifications on the availability of user path management events monitoring via the 3GPP 5GC network.

Upon receiving the HTTP POST request message, the EAS shall process the received information and respond to the EES with an HTTP "204 No Content" status code.

On failure, the EAS shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EES with an appropriate error status code.

5.9 Eees_AppContextRelocation Service

5.9.1 Service Description

The Eees_AppContextRelocation API, allows S-EAS to declare to the S-EES about the T-EAS selected by the S-EAS or allows S-EAS to request ACR determination to the S-EES.

5.9.2 Service Operations

5.9.2.1 Introduction

The service operation defined for Eees_AppContextRelocation API is shown in the table 5.9.2.1-1.

Table 5.9.2.1-1: Operations of the Eees_AppContextRelocation API

Service operation name	Description	Initiated by
Eees_AppContextRelocation_SelectedTargetEAS_Declare	This service operation is used by the S-EAS to inform the S-EES about selection of the T-EAS.	EAS
Eees_AppContextRelocation_ACRDetermination_Request	This service operation is used by the S-EAS to request the S-EES to determine the ACR.	EAS

5.9.2.2 Eees_AppContextRelocation_SelectedTargetEAS_Declare

5.9.2.2.1 General

This service operation is used by S-EAS to declare the selected T-EAS information to the S-EES, as specified in 3GPP TS 23.558 [2].

5.9.2.2.2 S-EAS informing the S-EES about the selected T-EAS using Eees_AppContextRelocation_SelectedTargetEAS_Declare operation

To declare the selected T-EAS information to the S-EES, the S-EAS shall send an HTTP POST request message to the S-EES targeting the URI "{apiRoot}/eees-appctxtreloc/v1/declare" as specified in clause 6.5.3.4 of 3GPP TS 24.558 [14]. The request body of the POST request message (i.e. "Declare" custom operation) includes the AcrDecReq data structure as specified in clause 6.5.5.2.4 of 3GPP TS 24.558 [14].

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. Process the EAS request;

2. verify the identity of the EAS and check if the EAS is authorized to declare the T-EAS information;

3. if the EAS is authorized to declare T-EAS information, then the EES shall send successful declaration response message to S-EAS.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

If the EES determines that the received HTTP POST message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.9.2.3 Eees_AppContextRelocation_ACRDetermination_Request

5.9.2.3.1 General

This service operation is used by S-EAS to request the S-EES to determine the ACR, as specified in the Eees_AppContextRelocation_Request operation with ACR determination part in 3GPP TS 23.558 [2].

5.9.2.3.2 S-EAS request the S-EES to determine the ACR using Eees_AppContextRelocation_ACRDetermination_Request operation

To request the S-EES to determine the ACR, the S-EAS shall send a HTTP POST message to the S-EES on the custom URI "{apiRoot}/eees-appctxtreloc/v1/determine" as specified in clause 6.5.3.2 of 3GPP TS 24.558 [14]. The request body of the POST message includes the AcrDetermReq data structure with information about the S-EAS end point information and may include other optional information on UE and/or EASID as specified in clause 6.5.5.2.2 of 3GPP TS 24.558 [14].

Upon receiving the HTTP POST message from the EAS, the EES shall:

1. process the EAS request;

2. verify the identity of the EAS and check if the EAS is authorized to request ACR determination;

3. if the EAS is authorized to request the ACR , then the EES shall;

a. send successful ACR determination response to S-EAS with an HTTP "204 No Content" status code;

b. additionally, the S-EES determines the T-EES via the Discover T-EAS procedure and may notify the EEC with target information and/or ACR result notification as specified in 3GPP TS 24.558 [14];

c. if the ACR determination handling met with failure case , the S-EES shall send a proper HTTP error status code and may include additional error information in the POST response body.

5.10 Eees_EECContextRelocation Service

5.10.1 Service Description

The Eees_EECContextRelocation API enables the EEC context relocation from S-EES to T-EES, as defined in 3GPP TS 23.558 [2]. The Eees_EECContextRelocation_Pull service operation enables EEC context relocation from S-EES to T-EES, upon request from the T-EES to S-EES, as specified by Eees_EECContextPull API in 3GPP TS 23.558 [2]. The Eees_EECContextRelocation_Push service operation enables EEC context relocation from S-EES to T-EES, upon a request from the S-EES to T-EES, as specified by Eees_EECContextPush API in 3GPP TS 23.558 [2].

5.10.2 Service Operations

5.10.2.1 Introduction

The service operation defined for Eees_EECContextRelocation API is shown in the table 5.10.2.1-1.

Table 5.10.2.1-1: Operations of the Eees_EECContextRelocation API

Service operation name	Description	Initiated by
Eees_EECContextRelocation_Pull	This service operation is used by the T-EES to fetch the EEC context information from S-EES to relocate the EEC context information form S-EES to T-EES.	EES
Eees_EECContextRelocation_Push	This service operation is used by the S-EES to push the EEC context information to T-EES to relocate the EEC context information form S-EES to T-EES.	EES

5.10.2.2 Eees_EECContextRelocation_Pull

5.10.2.2.1 General

This service operation is used by T-EES to relocate the EEC context information from the S-EES, as specified in 3GPP TS 23.558 [2].

5.10.2.2.2 T-EES relocating EEC context information from S-EES to T-EES using Eees_EECContextRelocation_Pull operation

To relocate the EEC context information from S-EES to the T-EES, the T-EES shall send HTTP GET message to the S-EES, with the request URI set to "{apiRoot}/eees-eeccontextreloc/v1/eec-contexts" as specified in the clause 8.7.2.2.3.1. The query parameters shall include EEC context identifier, identifier of the requesting T-EES and may include the list of service context information.

Upon receiving the HTTP GET message from the T-EES, the S-EES shall:

1. Validate the request and verifies if the T-EES is authorized to relocate the EEC context;

2. if the T-EES is authorised, then authorizes the EEC context relocation, based on EEC context identifier in the request;

3. respond with HTTP "200 OK" status code, with the response body including the EECContext data type, containing the EEC context information corresponding to the query parameters provided in the HTTP GET message.

On failure, the S-EES shall take proper error handling actions, as specified in clause 8.7.6, and respond to the T-EES with an appropriate error status code.

5.10.2.3 Eees_EECContextRelocation_Push

5.10.2.3.1 General

This service operation is used by S-EES to relocate the EEC context information to the T-EES, as specified in 3GPP TS 23.558 [2].

5.10.2.3.2 S-EES relocating EEC context information from S-EES to T-EES using Eees_EECContextRelocation_Push operation

To transfer the EEC context information from S-EES to the T-EES, the S-EES shall send HTTP POST message to the T-EES, with the request URI set to "{apiRoot}/eees-eeccontextreloc/v1/eec-contexts" as specified in the clause 8.7.2.2.3.2. The request body shall include the EEC Context information and identifier of the S-EES requesting to relocate the EEC Context.

Upon receiving the HTTP POST message from the S-EES, the T-EES shall:

1. Validate the request and verifies if the S-EES is authorized to transfer the EEC context;

2. if the S-EES is authorised, then authorizes the EEC context relocation, based on EEC context identifier in the request;

3. if authorized, the T-EES stores the EEC Context and respond with either:

– an HTTP "200 OK" status code with the response body including the EECContextPushRes data structure containing the EEC registration identifier, and if available, the associated expiration time, if implicit registration of the EEC at the T-EES is performed, i.e. in the case of S-EAS decided ACR scenario specified in clause 8.8.2.4 of 3GPP TS 23.558 [2] or S-EES executed ACR scenarios specified in clause 8.8.2.5 of 3GPP TS 23.558 [2]; or

– an HTTP "204 No content" status code, indicating that the EEC Context transfer is successful, if implicit registration of the EEC at the T-EES is not performed.

NOTE: If the EEC, for which the EEC context is pushed by the S-EES, is not registered with the T-EES, then the T-EES determines that the push request is for S-EAS decided ACR or S-EES executed ACR scenarios defined in clauses 8.8.2.4 and 8.8.2.5 of 3GPP TS 23.558 [2].

On failure, the T-EES shall take proper error handling actions, as specified in clause 8.7.6, and respond to the S-EES with an appropriate error status code.

On success, if the EEC registration ID and the associated expiration time are provided by the T-EES in the EEC context push response, then the S-EES stores them, and when required, includes them in the subsequent ACR information notification towards the EEC.

5.11 Eees_EELManagedACR Service

5.11.1 Service Description

The Eees_EELManagedACR service exposed by the EES enables a service consumer (i.e. EAS) to:

– request the EES (i.e. S-EES) to handle all the operations of an ACR;

– subscribe to ACT status reporting during an EEL Managed ACR; and

– receive notifications from the EES (i.e. T-EES) on ACT status during an EEL Managed ACR.

5.11.2 Service Operations

5.11.2.1 Introduction

The service operations defined for Eees_EELManagedACR API are shown in the table 5.11.2.1-1.

Table 5.11.2.1-1: Eees_EELManagedACR Service Operations

Service operation name	Description	Initiated by
Eees_EELManagedACR_Request	This service operation enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR.	EAS
Eees_EELManagedACR_Subscribe	This service operation enables a service consumer (i.e. T-EAS) to subscribe to ACT status reporting during an EEL Managed ACR.	EAS
Eees_EELManagedACR_Notify	This service operation enables a service consumer (i.e. T-EAS) to receive notifications from the EES (i.e. T-EES) on ACT status during an EEL Managed ACR.	EES

5.11.2.2 Eees_EELManagedACR_Request

5.11.2.2.1 General

This service operation is used by a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR.

The following procedures are supported by the "Eees_EELManagedACR_Request" service operation:

– EEL Managed ACR Request procedure.

5.11.2.2.2 EEL Managed ACR Request

The EEL Managed ACR Request procedure enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR (see also clause 8.8.3.6 of 3GPP°TS°23.558°[2]).

1. The service consumer (i.e. S-EAS) shall send for this purpose an HTTP POST request (custom operation: "Request") to the EES, with the request URI set to "{apiRoot}/eees-eel-acr/<apiVersion>/request-eelacr" and the request body including the EELACRReq data structure as defined in clause 8.8.6.2.2.

2a. Upon success, the EES shall respond with an HTTP "200 OK" status code with the response body including the feedback from the EES within the EELACRResp data structure as defined in clause 8.8.6.2.3.

2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body.

5.11.2.3 Eees_EELManagedACR_Subscribe

5.11.2.3.1 General

This service operation is used by a service consumer (i.e. T-EAS) to subscribe to ACT status information reporting at the EES (i.e. T-EES).

The following procedures are supported by the "Eees_EELManagedACR_Subscribe" service operation:

– Subscribe to ACT status information reporting.

5.11.2.3.2 Subscribe to ACT status information reporting

This procedure enables a service consumer (i.e. T-EAS) to request the creation of a subscription to ACT status information reporting (see also clause 8.8.3.6 of 3GPP°TS°23.558°[2]).

1. In order to subscribe to ACT status reporting, the service consumer (i.e. T-EAS) shall send an HTTP POST request to the EES, with the request URI set to "{apiRoot}/eees-eel-acr/<apiVersion>/subscriptions" and the request body including the ACTStatusSubsc data structure as defined in clause 8.8.6.2.4.

2a. Upon success, the EES shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created Individual ACT Status Subscription resource within the ACTStatusSubsc data structure as defined in clause 8.8.6.2.4.

2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body.

5.11.2.4 Eees_EELManagedACR_Notify

5.11.2.4.1 General

This service operation is used by an EES (i.e. T-EES) to notify a previously subscribed service consumer (i.e. T-EAS) on ACT status information.

The following procedures are supported by the "Eees_EELManagedACR_Notify" service operation:

– ACT Status Notification.

5.11.2.4.2 ACT Status Notification

The ACT Status Notification procedure enables an EES (i.e. T-EES) to notify a previously subscribed service consumer (i.e. T-EAS) on ACT status information (see also clause 8.8.3.6 of 3GPP°TS°23.558°[2]).

1. The EES (i.e. T-EES) shall send for this purpose an HTTP POST request to the service consumer (i.e. T-EAS) with the request URI set to "{notificationUri}/act-status", where the "notificationUri" is set to the value received from the service consumer (i.e. T-EAS) during the ACT status reporting subscription procedure defined in clause 5.11.2.3, and the request body including the ACTStatusNotif data structure as defined in clause 8.8.6.2.5.

2a. Upon success, the service consumer (i.e. T-EAS) shall respond with an HTTP "204 No Content" status code to acknowledge the reception of the notification to the EES.

2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body.

If the service consumer (i.e. T-EAS) is not able to handle the notification request or determines that the received HTTP POST request needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].

5.12 Eees_ACRStatusUpdate Service

5.12.1 Service Description

The Eees_ACRStatusUpdate service exposed by the EES enables a service consumer (i.e. S-EAS or T-EAS) to:

– update the information related to ACR (e.g. indicate the status of ACT, update the notification target address); and

– receive from the EES (i.e. T-EES) the status of EDGE-3 subscription relocation, including subscription ID update for EDGE-3 subscriptions.

5.12.2 Service Operations

5.12.2.1 Introduction

The service operations defined for Eees_ACRStatusUpdate API are shown in the table 5.12.2.1-1.

Table 5.12.2.1-1: Eees_ACRStatusUpdate Service Operations

Service operation name	Description	Initiated by
Eees_ACRStatusUpdate_Request	This service operation enables a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES.	EAS

5.12.2.2 Eees_ACRStatusUpdate_Request

5.12.2.2.1 General

This service operation is used by a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES.

The following procedures are supported by the "Eees_ACRStatusUpdate_Request" service operation:

– ACR Status Update Request procedure.

5.12.2.2.2 ACR Status Update Request

The ACR Status Update Request procedure enables a service consumer (i.e. S-EAS or T-EAS) to request to update the EES to request to update the information related to ACR (see also clause 8.8.3.8 of 3GPP°TS°23.558°[2]).

1. The service consumer (S-EAS or T-EAS) shall send for this purpose an HTTP POST request (custom operation: "Request") to the UAE Server, with the request URI set to "{apiRoot}/eees-acrstatus-update/<apiVersion>/request-acrupdate" and the request body including the ACRUpdateData data structure defined in clause 8.9.6.2.2.

2. Upon receiving the HTTP POST request message from the EAS, the EES shall check whether the EAS is autorized to update the ACR status. Then:

2a. Upon success, the EES shall respond with an HTTP "200 OK" status code with the response body including the feedback from the EES within the ACRDataStatus data structure defined in clause 8.9.6.2.3, or an HTTP "204 No Content" status code.

2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body.

If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6].