5 Services offered by the SEAL servers

29.5493GPPApplication Programming Interface (API) specificationRelease 18Service Enabler Architecture Layer for Verticals (SEAL)Stage 3TS

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

5.1 Introduction of SEAL services

The table 5.1-1 lists the SEAL 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 SEAL Service APIs

Service Name	Service Operations	Operation Semantics	Consumer(s)
SS_LocationReporting	Create_Trigger_Location_Reporting	Request/ Response	VAL server
	Fetch_Location_Report_Trigger	Request/Response	VAL server
	Update_Trigger_Location_Reporting	Request/ Response	VAL server
	Cancel_Trigger_Location_Reporting	Request/ Response	VAL server
SS_LocationInfoEvent	Subscribe_Location_Info	Subscribe/Notify	VAL server
SS_LocationInfoEvent	Notify_Location_Info	Subscribe/Notify	VAL server
SS_LocationInfoRetrieval	Obtain_Location_Info	Request/ Response	VAL server
SS_LocationAreaInfoRetrieval	Obtain_UEs_Info	Request/ Response	VAL server
SS_LocationMonitoring	Subscribe_Location_Monitoring	Subscribe/Notify	VAL server
SS_LocationMonitoring	Notify_Location_Monitoring_Events	Subscribe/Notify	VAL server
SS_LocationAreaMonitoring	Subscribe_Location_Area_Monitoring	Subscribe/Notify	VAL server
	Notify_Location_Area_Monitoring_Events
	Update_Location_Area_Monitoring_Subscribe
	Unsubscribe_Location_Area_Monitoring
SS_GroupManagement	Query_Group_Info	Request/ Response	VAL server
	Update_Group_Info	Request/ Response	VAL server
	Create_Group	Request/ Response	VAL server
	Delete_Group	Request/Response	VAL server
SS_GroupManagementEvent	Subscribe_Group_Info_Modification	Subscribe/Notify	VAL server
	Notify_Group_Info_Modification		VAL server
	Notify_Group_Creation		VAL server
SS_UserProfileRetrieval	Obtain_User_Profile	Request/ Response	VAL server
SS_UserProfileEvent	Subscribe_User_Profile_Update	Subscribe/Notify	VAL server
SS_UserProfileEvent	Notify_User_Profile_Update	Subscribe/Notify	VAL server
SS_NetworkResourceAdaptation	Reserve_Network_Resource	Request/Response	VAL server
	Request_Unicast_Resource	Request/Response	VAL server
	Update_Unicast_Resource	Request/Response	VAL server
	Request_Multicast_Resource	Request/Response	VAL server
	Notify_UP_Delivery_Mode	Subscribe/Notify	VAL server
	Discover_TSC_Stream_Availability	Request/Response	VAL server
	Create_TSC_Stream	Request/Response	VAL server
	Delete_TSC_Stream	Request/Response	VAL server
SS_EventsMonitoring	Subscribe_Monitoring_Events	Subscribe/Notify	VAL server
SS_EventsMonitoring	Notify_Monitoring_Events	Subscribe/Notify	VAL server
SS_Events	Subscribe_Event	Subscribe/Notify	VAL server
	Notify_Event		VAL server
	Unsubscribe_Event		VAL server
SS_KeyInfoRetrieval	Obtain_Key_Info	Request/Response	VAL server
SS_NetworkSliceAdaptation	Request_Network_Slice_Adaptation	Request/Response	VAL server
SS_NetworkResourceMonitoring	Subscribe_Unicast_QoS_Monitoring_Data	Subscribe/Notify	VAL server
	Unsubscribe_Unicast_QoS_Monitoring_Data		VAL server
	Notify_Unicast_QoS_Monitoring_Data		VAL server
	Obtain_Unicast_QoS_Monitoring_Data	Request/Response	VAL server
	Update_Unicast_QoS_Monitoring_Subscription	Request/Response	VAL server
NOTE: The service operations of SS_Events API are reused by the SS_LocationInfoEvent, SS_LocationMonitoring, SS_LocationAreaMonitoring, SS_GroupManagementEvent, SS_UserProfileEvent and SS_EventsMonitoring for events related services.

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

Table 5.1-2: API Descriptions

Service Name	Clause	Description	OpenAPI Specification File	apiName	Annex
SS_LocationReporting	7.1	Report Location Information Service.	TS29549_SS_LocationReporting.yaml	ss-lr	A.2
SS_GroupManagement	7.2	Group Management Service	TS29549_SS_GroupManagement.yaml	ss-gm	A.3
SS_UserProfileRetrieval	7.3	User Profile Retrieval Service	TS29549_SS_UserProfileRetrieval.yaml	ss-upr	A.4
SS_NetworkResourceAdaptation	7.4	Network Resource Adaptation Service	TS29549_SS_NetworkResourceAdaptation.yaml	ss-nra	A.5
SS_Events	7.5	Events Notify Service	TS29549_SS_Events.yaml	ss-events	A.6
SS_KeyInfoRetrieval	7.6	Key Information Retrieval Service	TS29549_SS_KeyInfoRetrieval.yaml	ss-kir	A.7
SS_LocationAreaInfoRetrieval	7.1	Location Area Info Retrieval Service	TS29549_SS_LocationAreaInfoRetrieval.yaml	ss-lair	A.8
SS_NetworkSliceAdaptation	7.7	Network Slice Adaptation Service	TS29549_SS_NetworkSliceAdaptation.yaml	ss-nsa	A.9
SS_NetworkResourceMonitoring	7.4	Network Resource Monitoring	TS29549_SS_NetworkResourceMonitoring.yaml	ss-nrm	A.10

5.2 Location management APIs

5.2.1 SS_LocationReporting API

5.2.1.1 Service Description

5.2.1.1.1 Overview

The SS_LocationReporting API, as defined 3GPP TS 23.434 [2], allows VAL server via LM-S reference point to configure reporting trigger of location information to the location management server.

5.2.1.2 Service Operations

5.2.1.2.1 Introduction

The service operation defined for SS_LocationReporting API is shown in the table 5.2.1.2.1-1.

Table 5.2.1.2.1-1: Operations of the SS_LocationReporting API

Service operation name	Description	Initiated by
Create_Trigger_Location_Reporting	This service operation is used by VAL server to create the trigger to report location information.	VAL server
Fetch_Location_Report_Trigger	This service operation is used by VAL server to retrieve the location reporting trigger information.	VAL server
Update_Trigger_Location_Reporting	This service operation is used by VAL server to update the trigger to report location information.	VAL server
Cancel_Trigger_Location_Reporting	This service operation is used by VAL server to cancel the trigger to report location information.	VAL server

5.2.1.2.2 Create_Trigger_Location_Reporting

5.2.1.2.2.1 General

This service operation is used by a VAL server to create the trigger to report location information.

5.2.1.2.2.2 VAL server providing trigger configuration using Create_Trigger_Location_Reporting service operation

To create the reporting trigger configuration, the VAL server shall send HTTP POST request message to location management server. The body of the HTTP POST message shall include the LocationReportConfiguration data type, as specified in the clause 7.1.1.2.2.3.1.

Upon receiving the HTTP POST message as described above, the location management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to provide the trigger;

2. if the VAL server is authorized to provide the triggers, the location management server shall;

a. create a new resource for Individual SEAL Location Reporting Configuration as specified in clause 7.1.1.2.1; and

b. return the SEAL Resource URI in the response message.

5.2.1.2.3 Fetch_Location_Report_Trigger

5.2.1.2.3.1 General

This service operation is used by VAL server to retrieve an individual location reporting configuration information.

5.2.1.2.3.2 VAL server fetching trigger configuration using Fetch_Location_Report_Trigger service operation

To fetch the location report trigger configuration, the VAL server shall send HTTP GET request message to location management server on the resource URI representing the individual SEAL location reporting configuration, as specified in 7.1.1.2.3.3.1.

Upon receiving the HTTP GET message as described above, the location management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the trigger information;

2. if the VAL server is authorized to fetch the trigger information, the location management server shall;

a. return the location report trigger configuration in LocationReportConfiguration data type, as specified in clause 7.1.1.2.1.

5.2.1.2.4 Update_Trigger_Location_Reporting

5.2.1.2.4.1 General

This service operation is used by a VAL server to update the trigger to report location information.

5.2.1.2.4.2 VAL server providing trigger configuration using Update_Trigger_Location_Reporting service operation

To modify the reporting trigger configuration, the VAL server shall send HTTP PUT message to the location management server to the Resource URI identifying the individual SEAL location reporting configuration resource representation, as specified in the clause 7.1.1.2.3.3.2. If the "PatchUpdate" feature defined in clause 7.1.1.6 is supported, the VAL server may send an HTTP PATCH request message to the Individual SEAL Location Reporting Configuration resource URI as specified in clause 7.1.1.2.3.3.4. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.1.1.2.3.3.4.

When HTTP PUT is used, the "valServerId" attribute within the LocationReportConfiguration data structure shall not be updated.

Upon receiving the HTTP PUT or PATCH request message, the location management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to modify the configuration information;

2. if the VAL server is authorized to modify the information, then the location management server shall;

a. if the configuration information in the request is valid, update/modify the resource identified by the Resource URI of the configuration received in the request;

b. return a 200 OK status code with the updated location reporting configuration information in the response or a 204 No Content status code.

5.2.1.2.5 Cancel_Trigger_Location_Reporting

5.2.1.2.5.1 General

This service operation is used by a VAL server to cancel the trigger to report location information.

5.2.1.2.5.2 VAL server providing trigger configuration using Cancel_Trigger_Location_Reporting service operation

To delete the reporting trigger configuration, the VAL server shall send an HTTP DELETE message to the resource representing Individual SEAL Location Reporting Configuration as specified in clause 7.1.1.2.3.3.3.

Upon receiving the HTTP DELETE message, the location management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to delete the configuration information; and

2. if the VAL server is authorized to delete the configuration information, the location management server shall delete the resource pointed by the Resource URI for Individual SEAL Location Reporting Configuration.

5.2.2 SS_LocationInfoEvent API

The SS_LocationInfoEvent API, as defined 3GPP TS 23.434 [2], allows a VAL server via LM-S reference point to subscribe for and receive notifications of location information from the location management server. The SS_LocationInfoEvent API supports this via the event "LM_LOCATION_INFO_CHANGE" of the SS_Events API as specified in clause 7.5. If the event subscription includes an indication for supplementary location information, then the location management server obtains the UE location information from the 3GPP core network.

5.2.3 SS_LocationInfoRetrieval API

The SS_LocationInfoRetrieval API, as defined 3GPP TS 23.434 [2], enables the VAL server via LM-S reference point to obtain location information from the location management server. The SS_LocationInfoRetrieval API supports this via the event "LM_LOCATION_INFO_CHANGE" of the SS_Events API by setting the "immRep" attribute to true and setting the "notifMethod" attribute to "ONE_TIME" within the "eventReq" attribute, as specified in clause 7.5.

Upon receipt of the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true in the HTTP POST request, the location management server shall ignore the "notificationDestination" attribute within the SEALEventSubscription data type and include the event details in the "eventDetails" attribute, if available, in the HTTP POST response.

5.2.4 SS_LocationAreaInfoRetrieval API

5.2.4.1 Service Description

5.2.4.1.1 Overview

The SS_LocationAreaInfoRetrieval API, as defined 3GPP TS 23.434 [2], enables the VAL server via LM-S reference point to obtain UE(s) information in an application defined proximity range of a location.

5.2.4.2 Service Operations

5.2.4.2.1 Introduction

The service operation defined for SS_LocationAreaInfoRetrieval API is shown in the table 5.2.4.2.1-1.

Table 5.2.4.2.1-1: Operations of the SS_LocationAreaInfoRetrieval API

Service operation name	Description	Initiated by
Obtain_UEs_Info	This service operation is used by VAL server to obtain UE(s) information in an application defined proximity range of a location.	VAL server

5.2.4.2.2 Obtain_UEs_Info

5.2.4.2.2.1 General

This service operation is used by a VAL server to obtain UE(s) information in an application defined proximity range of a location.

5.2.4.2.2.2 VAL server obtains UE(s) information in an application defined proximity range of a location using Obtain_UEs_Info service operation

To obtain the UE(s) information in an application defined proximity range of a location, the VAL server shall send HTTP GET message to the location management server, on location information collection resource representation URI as specified in the clause 7.1.2.2.2.3.1. The GET message shall include the query parameters: Location information and proximity range.

Upon receiving the HTTP GET message as described above, the location management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the UE(s) information;

2. if the VAL server is authorized to fetch the UE(s) information, the location management server shall;

a. determine the VAL UE(s) information that are in the proximity range of the location as per the query parameters in the request message from the VAL server;

b. return HTTP "200 OK" status code with the determined VAL UE(s) information in the LMInformation data type to the VAL server.

5.2.5 SS_LocationMonitoring API

The SS_LocationMonitoring API, as defined 3GPP TS 23.434 [2], allows a VAL server via the LM-S reference point to monitor the VAL UE(s) in relation to a given area of interest. The VAL server subscribes to the LM server to receive notifications of deviation of VAL UE(s) / User(s) location from a given location information. The SS_LocationMonitoring API supports this via the event "LM_LOCATION_DEVIATION_MONITOR" of the SS_Events API as specified in clause 7.5.

Upon the receipt of "LM_LOCATION_DEVIATION_MONITOR" event subscription request from the VAL server, in order to notify the location deviation events to the VAL server, the location management server shall:

1. periodically obtain the VAL UE location information using the SEAL location information procedures as per the SS_LocationReporting and SS_LocationAreaInfoRetrieval APIs as specified in clauses 5.2.1 and 5.2.4;

2. periodically obtain the VAL UE location information from the 3GPP core network using the MonitoringEvent API as specified in 3GPP TS 29.122 [3] and 3GPP TS 29.522 [28]; and

3. process the location information received in steps 1 and 2 above and continue as follows;

a. if the location information from the location management client and the 3GPP core network do not match, then notify the VAL server with the "NOTIFY_MISMATCH_LOCATION" value in the event report;

b. if the location information from the location management client and the 3GPP core network match and is not within the area of interest of the VAL server, then notify the VAL server with the "NOTIFY_ABSENCE" value in the event report; or

c. if the location information from the location management client and the 3GPP core network match and is within the area of interest of the VAL server, then notify to the VAL server with the "NOTIFY_PRESENCE" value in the event report, based on the notification interval parameter in VAL server’s event subscription.

5.2.6 SS_LocationAreaMonitoring API

The SS_LocationAreaMonitoring API, as defined 3GPP TS 23.434 [2], allows a VAL server via the LM-S reference point to subscribe for and receive notifications of list of UE(s) moving in or out of a given area of interest from the location management server. The SS_LocationAreaMonitoring API supports this via the event "LM_LOCATION_AREA_MONITOR" of the SS_Events API as specified in clause 7.5. The VAL server may indicate the periodic time interval in which the LM server needs to notify the VAL UE’s location information in the Reporting Requirements, during the Subscribe_Event service operation of SS_Events API.

5.3 Group management APIs

5.3.1 SS_GroupManagement API

5.3.1.1 Service Description

5.3.1.1.1 Overview

The SS_GroupManagement API, as defined 3GPP TS 23.434 [2], allows VAL server via GM-S reference point to create, fetch, update and delete VAL group membership and configuration information.

5.3.1.2 Service Operations

5.3.1.2.1 Introduction

The service operation defined for SS_GroupManagement API is shown in the table 5.3.1.2.1-1.

Table 5.3.1.2.1-1: Operations of the SS_GroupManagement API

Service operation name	Description	Initiated by
Query_Group_Info	This service operation is used by VAL server to query for VAL group documents, group membership list and configuration information.	VAL Server
Update_Group_Info	This service operation is used by VAL server to modify group membership and configuration information.	VAL server
Create_Group	This service operation is used by VAL server to configure new VAL group.	VAL server
Delete_Group	This service operation is used by the VAL server to delete the VAL group.	VAL server

5.3.1.2.2 Query_Group_Info

5.3.1.2.2.1 General

This service operation is used by a VAL server to obtain VAL group documents, group membership and configuration information.

5.3.1.2.2.2 VAL server fetching VAL group documents, group membership and configuration information using Query_Group_Info service operation

To obtain membership, configuration information of a VAL group, the VAL server shall send a HTTP GET message to the group management server, on VAL group document’s resource representation URI as specified in clause 7.2.1.2.3.3.1. The GET message may include the following query parameters: membership list, group configuration. To obtain VAL groups information, the VAL server shall send a HTTP GET message to the group management server, on VAL group documents collection resource representation URI as specified in clause 7.2.1.2.2.3.2. The GET message may include the following query parameters: VAL Group ID, VAL Service ID.

Upon receiving the HTTP GET message as described above, the group management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the VAL group information;

2. if the VAL server is authorized to obtain the group information, the group management server shall;

a. if the request to VAL group document’s resource representation URI includes query parameters, then, return in the response message with VAL group information which includes, group membership list information if the request includes membership list query, group configuration information if the request includes group configuration query and VAL group identifier;

b. if the request to VAL group document’s resource representation URI does not include query parameter, then, return the VAL group document resource in the response message;

c. in the request to VAL group documents collection resource representation URI, return the VAL group documents matching the query parameters in the response message.

5.3.1.2.3 Update_Group_Info

5.3.1.2.3.1 General

This service operation is used by a VAL server to modify group membership and configuration information.

5.3.1.2.3.2 VAL server modifying group membership and configuration using Update_Group_Info service operation

To modify group information of a VAL group, the VAL server shall send HTTP PUT message to the group management server to the Resource URI identifying the VAL group document resource representation, as specified in the clause 7.2.1.2.3.3.2. This request shall not replace valGroupId property in the existing resource. If the "PatchUpdate" feature defined in clause 7.2.1.6 is supported, then the VAL server may send an HTTP PATCH request message to the Individual VAL Group Document resource URI as specified in clause 7.2.1.2.3.3.4, to partially update the VAL group document. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.2.1.2.3.3.4. Upon receiving the HTTP PUT message, the group management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to modify VAL group information;

2. for the HTTP PUT request message, verify that valGroupId in the request is same as valGroupId of the VAL group document resource;

3. if the VAL server is authorized to modify/update the group information and the valGroupId matches, then the group management server shall;

a. if the group configuration information in the request is valid, update/modify the resource identified by the Resource URI of the group document with group members list, group configuration information, description, VAL service identifiers, external group identifier and location information received in the request;

b. if the group document information in the request includes 5G LAN-Type communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP PUT/PATCH message as defined in clause 4.4.15.3 of 3GPP TS 29.522 [28].

c. return a 200 OK status code with the updated VAL group document in the response or a 204 No Content status code.

NOTE: The group management server maintains a mapping between DNN and S-NSSAI of the 5GVN group and the VAL server requester identity based on operator policy. How such mapping is configured is implementation specific and out of the scope of this specification.

5.3.1.2.4 Create_Group

5.3.1.2.4.1 General

This service operation is used by a VAL server to create VAL group.

5.3.1.2.4.2 VAL server creating new group using Create_Group service operation

To create a VAL group, the VAL server shall send a HTTP POST message to the group management server. The body of the POST message shall include VAL group document information as specified in clause 7.2.1.2.2.3.1. The VAL server shall use this service operation to create the location-based VAL group as specified for Create_LocationBasedGroup_Info service operation of SS_GroupManagement API, in 3GPP TS 23.434 [2].

Upon receiving HTTP POST message, the group management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to create VAL group document;

2. if the VAL group document information in the request includes location criteria, shall obtain the list of VAL users or VAL UEs within the requested location criteria information from the Location Management server and include them in VAL group members of the new VAL group;

a. if the "valServiceIds" attribute within VALGroupDocument structure was present in the received VAL group document information and the received response from the location management server does not include the identical list of the VAL service IDs as defined in the "valServiceIds" attribute within VALGroupDocument structure, the group management server shall retrieve the VAL service data from the configuration management server for the missed VAL service IDs and include the relevant VAL users or VAL UEs in the VAL group members of the new VAL group;

3. if the VAL group document information in the request includes 5G LAN-Type communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP POST message as defined in clause 4.4.15.2 of 3GPP TS 29.522 [28]; and

4. if the VAL server is authorized to create VAL group document, shall create a new resource as defined in 7.2.1.2.2.3.1 and return the VAL group document and its Resource URI in the response message.

5.3.1.2.5 Delete_Group

5.3.1.2.5.1 General

This service operation is used by a VAL server to delete a VAL group.

5.3.1.2.5.2 VAL server deleting VAL group using Delete_Group service operation

To delete a VAL group, the VAL server shall send a HTTP DELETE message to the Group Management server to its resource representation in the Group Management server as specified in clause 7.2.1.2.3.3.3. Upon receiving HTTP DELETE message, the Group Management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to delete the VAL group document;

2. if the VAL server is authorized to delete the VAL group document, the Group Management server shall

a. if the group communication type is 5GLAN communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP DELETE message as defined in clause 4.4.15.4 of 3GPP TS 29.522 [28].

b. delete the resource representation pointed by the group document resource identifier.

5.3.2 SS_GroupManagementEvent API

The SS_GroupManagementEvent API, as defined 3GPP TS 23.434 [2], allows a VAL server via GM-S reference point to subscribe for and receive notifications from Group Management server on new VAL group creations, on modifications to VAL Group membership and configuration information and on temporary VAL group formation. The SS_GroupManagementEvent API supports this via the "GM_GROUP_CREATE", "GM_GROUP_INFO_CHANGE" and "GM_TEMP_GROUP_FORMATION" events of the SS_Events API as specified in clause 7.5. In order to authorize the VAL servers that have to be notified of a "GM_GROUP_CREATE" event, the Group Management server shall identify the VAL services (VAL Service IDs) allowed for the VAL server by the "subscriberId" attribute and shall notify the VAL server if the VAL services enabled for the created VAL group are allowed for the VAL server.

Upon the receipt of the VAL group document from the group management server during Create_Group service operation, if the VAL server is interested in receiving the notifications about newly registered or de-registered VAL UE IDs to the VAL group, then the VAL server may subscribe to "GM_GROUP_INFO_CHANGE" event using the SS_Events API as specified in clause 7.5.1, to receive any VAL group membership update notifications.

Upon the receipt of the message filters information in the "GM_GROUP_INFO_CHANGE" event notification from the group management server, the VAL server shall consider the message filters in VAL specific communication.

5.4 Configuration management APIs

5.4.1 SS_UserProfileRetrieval API

5.4.1.1 Service Description

5.4.1.1.1 Overview

The SS_UserProfileRetrieval API, as defined in 3GPP TS 23.434 [2], allows VAL server via CM-S reference point to obtain user profile from the configuration management server.

5.4.1.2 Service Operations

5.4.1.2.1 Introduction

The service operation defined for SS_UserProfileRetrieval API is shown in the table 5.4.1.2.1-1.

Table 5.4.1.2.1-1: Operations of the SS_UserProfileRetrieval API

Service operation name	Description	Initiated by
Obtain_User_Profile	This service operation is used by VAL server to obtain user profile.	VAL server

5.4.1.2.2 Obtain_User_Profile

5.4.1.2.2.1 General

This service operation is used by a VAL server to obtain VAL user profile information.

5.4.1.2.2.2 VAL server retrieving VAL user profile information using Obtain_User_Profile service operation

To obtain a VAL user’s profile, the VAL server shall send HTTP GET request message to configuration management server, on VAL service’s resource representation URI, with query parameters VAL user ID or VAL UE ID and optionally VAL service ID, as specified in 7.3.1.2.2.3.1.

Upon receiving the HTTP GET message as described above, the configuration management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the VAL user profile information;

2. if the VAL server is authorized to obtain the requested VAL user profile information, the configuration management server shall;

a. return in the response message with profile information corresponding to the query parameters that was sent in the request message.

5.4.2 SS_UserProfileEvent API

The SS_UserProfileEvent API, as defined in 3GPP TS 23.434 [2], allows a VAL server via CM-S reference point to subscribe for and receive notifications from the Configuration Management server on profile updates to VAL User or VAL UE. The SS_UserProfileEvent API supports this via the "CM_USER_PROFILE_CHANGE" event in SS_Events API as specified in clause 7.5.

5.5 Network resource management APIs

5.5.1 SS_NetworkResourceAdaptation API

5.5.1.1 Service Description

5.5.1.1.1 Overview

The SS_NetworkResourceAdaptation API, as defined 3GPP TS 23.434 [2], allows VAL server via NRM-S reference point to communicate with the network resource management server for network resource adaptation including reserving network resource, requesting and subscribing for unicast and multicast resources.

5.5.1.2 Service Operations

5.5.1.2.1 Introduction

The service operation defined for SS_NetworkResourceAdaptation API is shown in the table 5.5.1.2.1-1.

Table 5.5.1.2.1-1: Operations of the SS_NetworkResourceAdaptation API

Service operation name	Description	Initiated by
Reserve_Network_Resource	Requesting for network resource adaptation	VAL server
Request_Unicast_Resource	Requesting unicast resource	VAL server
Update_Unicast_Resource	Updating unicast resource	VAL server
Request_Multicast_Resource	Requesting multicast resource	VAL server
Notify_UP_Delivery_Mode	Notifying the user plane delivery mode	NRM server
Discover_TSC_Stream_Availability	Requesting the NRM server to discover the connectivity and available QoS characteristics between the source and the destination DS-TT ports.	VAL server
Create_TSC_Stream	Requesting the NRM server to create a TSC stream.	VAL server
Delete_TSC_Stream	Requesting the NRM server to delete a TSC stream.	VAL server

5.5.1.2.2 Reserve_Network_Resource

5.5.1.2.2.1 General

This service operation is used by a VAL server to request for network resource adaptation.

5.5.1.2.2.2 VAL server requesting for network resource adaptation using Reserve_Network_Resource service operation

The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL UE(s) or VAL group information and the VAL service QoS requirement. Upon receiving HTTP POST message, the NRM server shall

1. verify the identity of the VAL server and check if the VAL server is authorized to request for network resource adaptation;

2. if the VAL server is authorized, the NRM server shall determine the QoS requirements for each VAL UE based on the VAL UE(s) or VAL group information;

3. for each VAL UE, the NRM server initiates the PCC procedures; and

4. the NRM server provides result and optionally includes the accepted value for the QoS requirements based on the outcome of the PCC procedure in the response message

5.5.1.2.3 Request_Unicast_Resource

5.5.1.2.3.1 General

This service operation is used by a VAL server to request for unicast resource.

5.5.1.2.3.2 VAL server requesting for unicast resource using Request_Unicast_Resource service operation

The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL user or UE information and the VAL service requirement. Upon receiving HTTP POST message, the NRM server shall

1. verify the identity of the VAL server and check if the VAL server is authorized to request for unicast resource;

2. if the VAL server is authorized, the NRM server evaluates the need for network resources and use of resource sharing;

3. for the VAL user or UE, the NRM server initiates interaction via SIP core;

4. the NRM server creates a unicast subscription as specified in clause 7.4.1.2.4.3.1; and

5. the NRM server provides result in the response message.

5.5.1.2.4 Update_Unicast_Resource

5.5.1.2.4.1 General

This service operation is used by a VAL server to request for updating the unicast resource used by the VAL user or UE.

5.5.1.2.4.2 VAL server requesting for updating the unicast resource using Update_Unicast_Resource service operation

The VAL server shall send a HTTP PUT message to the NRM server. The body of the PUT message shall include VAL user or UE information and the VAL service requirement. Upon receiving HTTP PUT message, the NRM server shall

1. verify the identity of the VAL server and check if the VAL server is authorized to request for updating the unicast resource;

2. if the VAL server is authorized, the NRM server decides the need to update the unicast resource. If NRM server decides that no update is required for the unicast resource, then the NRM server sends a failure indication in the response message;

3. if NRM server decides to update the unicast resource, then the NRM server initiates interaction via SIP core; and

4. the NRM server provides result in the response message.

5.5.1.2.5 Request_Multicast_Resource

5.5.1.2.5.1 General

This service operation is used by a VAL server to request for multicast resource.

5.5.1.2.5.2 VAL server requesting for multicast resource using Request_Multicast_Resource service operation

The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL group information, service announcement mode, QoS information, Broadcast area, the local MBMS information or the local MBMS activation indication and VAL server notification endpoint address information. Upon receiving HTTP POST message, the NRM server shall

1. verify the identity of the VAL server and check if the VAL server is authorized to request for multicast resource;

2. if the VAL server is authorized, the NRM server decides to establish an MBMS bearer in EPS using the procedures defined in 3GPP TS 29.468 [23];

3. the NRM server creates a multicast subscription as specified in clause 7.4.1.2.2.3.1;

4. the NRM server provides the result in the response message.

5.5.1.2.6 Notify_UP_Delivery_Mode

5.5.1.2.6.1 General

This service operation is used by the NRM server to send user plane notifications to the VAL server.

5.5.1.2.6.2 Notifying user plane events using Notify_UP_Delivery_Mode service operation

To notify the user plane events, the NRM server shall send an HTTP POST message using the Notification Destination URI received in the multicast resource request. The body of the HTTP POST message shall include an UserPlaneNotification as specified in clause 7.4.1.3.2.

Upon receiving the HTTP POST message, the VAL server shall process the Event Notification.

5.5.1.2.7 Create_TSC_Stream

5.5.1.2.7.1 General

This service operation is used by a VAL server to request the NRM server to create TSC stream resources.

5.5.1.2.7.2 VAL server requesting for create TSC stream using Create_TSC_Stream service operation

In order to create a TSC stream resource, the VAL server shall send an HTTP PUT message to the NRM server with {valStreamId} in the request URI path to identify the TSC stream to be created. The request body with the "TscStreamData" data structure shall include stream specification and Traffic Specification Information which includes MaxFrameInterval, MaxFrameSize, MaxIntervalFrames, MaxLatency.

Upon reception of the HTTP PUT message, the NRM server shall:

1. verify the requestor identity of the VAL server, check whether the VAL server is authorized to request the NRM server to create a TSC stream with the VAL Stream ID as the TSC stream resource identifier;

NOTE: It’s up to the VAL server to secure the uniqueness of the VAL Stream ID.

2. if the VAL server is authorized, the NRM server shall calculate the schedule for the VAL Stream ID based on the information collected earlier from the 5GS. It provides per-stream filtering and policy parameters (e.g as defined in IEEE 802.1Qcc [29]) used to derive the TSC QoS information and related flow information. The NRM server also provides the forwarding rule (e.g.as defined in IEEE 802.1Qcc [29]) used to identify the DS-TT MAC address of the corresponding PDU session. Based on the 5GS bridge delay information it determines the TSC QoS information and TSC Assistance information for the stream;

3. for each VAL UE, the trusted NRM server within the PLMN operator domain acting as a TSCTSF shall initiate the PCC procedures by triggering the Npcf_policy_Authorization_Create service operation as described in 3GPP TS 29.514 [30] for the TSC stream for both uplink QoS flow (sender UE to UPF/bridge) and downlink QoS flow (UPF/bridge to receiver UE). The creation request includes the DS-TT port MAC address, TSC QoS information, TSC Assistance Information, flow bit rate, priority, Service Data Flow Filter containing flow description including Ethernet Packet Filters. The QoS flow will be assigned for the PDU session with the source MAC address for the uplink direction and with the destination MAC address for the downlink direction. This information is delivered to the DS-TT by the 5GS; and

4. after the NRM server receiving a successful response from the PCF, the NRM server shall create an "Individual TSC Stream" resource which represents the created TSC stream, addressed by a URI that contains the {valStreamId} as the VAL Stream ID identifier the TSC Stream, and shall respond to the VAL server with a 201 Created status code, including a Location header field containing the URI for the created resource. If the NRM server receives an error response from the PCF, the NRM server shall not create the resource and shall respond to the VAL server with a proper error status code.

5.5.1.2.8 Delete_TSC_Stream

5.5.1.2.8.1 General

This service operation is used by a VAL server to delete a TSC stream.

5.5.1.2.8.2 VAL server requesting to delete a TSC stream using Delete_TSC_Stream service operation

In order to delete a TSC stream, the VAL server shall send an HTTP DELETE message to the NRM server, with "{apiRoot}/ss-nra/<apiVersion>/tsc-streams/{valStreamId}" as the Resource URI representing the TSC stream identified by the VAL sStream ID to be deleted.

Upon reception of the HTTP DELETE message, the NRM server shall

1. identify the MAC addresses of the DS-TTs involved in the stream based on the stored information for the VAL Stream ID.

2. for each VAL UE, the trusted NRM server within the PLMN operator domain acting as a TSCTSF shall initiate the PCC procedures by triggering the Npcf_policy_Authorization_Delete service operation to delete the QoS flows as defined in 3GPP TS 29.514 [30] with all the MAC addresses referred by the VAL Stream ID; and

3. if the NRM server receive a successful response from the PCF, the NRM server shall delete the existing TSC stream in the "Individual TSC Stream" resource. Then the NRM server shall send an HTTP DELETE response message with "204 No Content" status code to the VAL server as a successful result of TSC stream deletion for the VAL Stream ID. If the NRM server receive an error code from the PCF, the NRM server shall take proper error handling action and shall respond to the VAL server with a proper error status code as unsuccessful result.

5.5.1.2.9 Discover_TSC_Stream_Availability

5.5.1.2.9.1 General

This service operation is used by a VAL server to request the NRM server to retrieve the connectivity information between the source and destination DS-TT ports and the related available QoS characteristics, prior to creating the stream.

5.5.1.2.9.2 VAL server discovering TSC stream availability using Discover_TSC_Stream_Availability service operation

In order to discover the connectivity between the source and destination DS-TT ports and the related available QoS characteristics, the VAL server shall send an HTTP GET request message to the NRM server, with the query parameters containing the targeted stream specifications.

Upon reception of the HTTP GET request message, the NRM server shall:

1. verify if the VAL server is authorized to discover the TSC stream availability;

2. if the VAL server is authorized, the NRM server shall check the connectivity between the DS-TTs ports indicated in the requested TSC stream definition based on the collected 5GS TSC bridge management and port management information, the traffic classes supported by the DS-TTs and the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) per traffic class;

The necessary information to process the TSC stream availability discovery request, i.e. 5GS TSC bridge management and port management information, the traffic classes supported by the DS-TTs and the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) per traffic class, is collected by the NRM server and shall be available at the NRM server prior to the reception of the request from the VAL server.

3. if the discovery result is successful upon the connectivity between the DS-TT ports is discovered, the NRM server shall return an HTTP GET response message to the VAL server with an HTTP "200 OK" status code with the TscStreamAvailability data structure as the response body which shall include the stream specification matching the received query parameters and the corresponding list of traffic specifications;

4. if there is no stream specification matching the query parameters or no TSC stream availability information was discovered between the DS-TT ports, then the NRM server shall responsde with a 204 No Content status code without response body;

5. Otherwise if error case occur (e.g. the necessary information to process the request is not available at the NRM server), the NRM server shall respond to the VAL server with a proper error status code.

5.5.2 SS_EventsMonitoring API

The SS_EventsMonitoring API, as defined in 3GPP TS 23.434 [2], allows a VAL server via NRM-S reference point to subscribe for and receive notifications from the Network Resource Management server about events related to VAL UE(s). The SS_EventsMonitoring API supports this via the "NRM_MONITOR_UE_USER_EVENTS" event in SS_Events API as specified in clause 7.5. Based on the events of interest information related to the VAL UE(s), the NRM server shall subscribe to UE monitoring types and analytics events as specified in clause 4.4.2 and clause 4.4.14 of 3GPP TS 29.522 [28].

5.5.3 SS_NetworkResourceMonitoring API

5.5.3.1 Service Description

5.5.3.1.1 Overview

The SS_NetworkResourceMonitoring API, as defined in 3GPP TS 23.434 [2], allows VAL server via NRM-S reference point to communicate with the network resource management server for network resource monitoring including requesting unicast QoS monitoring data and managing unicast QoS monitoring subscription.

5.5.3.2 Service Operations

5.5.3.2.1 Introduction

The service operations defined for the SS_NetworkResourceMonitoring API are shown in the table 5.5.3.2.1-1.

Table 5.5.3.2.1-1: Operations of the SS_NetworkResourceMonitoring API

Service operation name	Description	Initiated by
Subscribe_Unicast_QoS_Monitoring	This service operation is used by VAL server to subscribe to unicast QoS monitoring events from SEAL servers.	VAL server
Unsubscribe_Unicast_QoS_Monitoring	This service operation is used by VAL server to unsubscribe from unicast QoS monitoring events from SEAL servers.	VAL server
Notify_Unicast_QoS_Monitoring	This service operation is used by SEAL server to send the notifications to the VAL server.	NRM server
Obtain_Unicast_QoS_Monitoring	This service operation is used by VAL server to obtain unicast QoS monitoring data.	VAL server
Update_Unicast_QoS_Monitoring_Subscription	This service operation is used by VAL server to update or modify the individual unicast QoS monitoring subscription.	VAL server

5.5.3.2.2 Subscribe_Unicast_QoS_Monitoring

5.5.3.2.2.1 General

This service operation is used by a VAL server to create a unicast QoS monitoring subscription to the NRM server.

5.5.3.2.2.2 VAL server subscribes for Unicast QoS Monitoring using Subscribe_Unicast_QoS_Monitoring

In order to subscribe to unicast QoS monitoring, the VAL server shall send an HTTP POST message to the NRM server targeting the URI of the "Unicast Monitoring Subscriptions" resource as specified in clause 7.4.2.2.2.3.1. The request body shall include the MonitoringSubscription data structure as defined in clause 7.4.2.4.2.8. The VAL server shall indicate within the ReportingRequirement data structure whether one-time reporting and/or immediate reporting is requested, i.e.:

– the "immRep" attribute set to "true", if immediate reporting of the unicast QoS Monitoring data is requested; and/or

– the "reportingMode" attribute set to "ONE_TIME" and the "immRep" attribute set to "true", if one-time reporting of the unicast QoS Monitoring data is requested via the Obtain_Unicast_QoS_Monitoring service operation.

Upon reception of the HTTP POST request message, the NRM server shall:

1. verify the identity of the VAL server and whether the VAL server is authorized to create a unicast QoS monitoring subscription at the NRM server;

2. if the VAL server is not authorized, the NRM server shall respond to the VAL server with an appropriate error status code;

3. if the VAL server is authorized:

a. if immediate reporting and one-time reporting are requested, the NRM server determines if it the requested data is available internally or not and whether to interact with the NEF to retrieve the data using the Nnef_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) as defined in 3GPP TS 29.522 [28];

b. otherwise, the NRM server shall interact with the NEF to establish the associated QoS monitoring subscriptions by invoking the Nnef_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) and AsSessionWithQoS API as defined in 3GPP TS 29.522 [28]. The NRM server determines the relevant NEF subscription procedures and the parameters for these subscriptions based on the inputs received from the VAL server;

4. upon reception of successful response(s) from the NEF or retrieval of the requested data internally:

a. if immediate reporting and one-time reporting are requested, an HTTP "200 OK" status code, with the response body including the MonitoringReport data structure containing the available requested Unicast QoS Monitoring data as defined in clause 7.4.2.4.2.2;

b. otherwise, the NRM server shall create a new "Individual Unicast Monitoring Subscription" resource and respond to the VAL server with:

– an HTTP "201 Created" status code, including a Location header field containing the URI for the created "Individual Unicast Monitoring Subscription" resource and the response body including the MonitoringSubscription data structure containing a representation of the created resource as defined in clause 7.4.2.4.2.8; and

– if immediate reporting was requested by the VAL server, the returned MonitoringSubscription data structure shall also contain the requested Unicast QoS Monitoring data within the "monRep" attribute, if the requested data is available, as defined in clause 7.4.2.4.2.2;

c. in the case of partial failure, i.e. the request fails for only a subset of the targeted VAL UE(s) or VAL Stream ID(s), the NRM server shall include the "failureRep" attribute within the returned MonitoringReport data structure indicating the list of VAL UE(s) or VAL Stream ID(s) for which the NRM server failed to obtain the requested data and the related failure reasons;

and

5. if the NRM server is unable to satisfy the request, the NRM server shall respond to the VAL server with an appropriate error status code.

5.5.3.2.3 Unsubscribe_Unicast_QoS_Monitoring

5.5.3.2.3.1 General

This service operation is used by a VAL server to terminate a unicast QoS monitoring subscription at the NRM server.

5.5.3.2.3.2 VAL server unsubscribes for Unicast QoS Monitoring using Unsubscribe_Unicast_QoS_Monitoring

In order to terminate a unicast QoS monitoring subscription, the VAL server shall send an HTTP DELETE request message to the NRM server, on the corresponding "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.1.

Upon reception of the HTTP DELETE request message, the NRM server shall:

1. verify the identity of the VAL server and check if the VAL server is authorised to terminate the targeted "Individual Unicast Monitoring Subscription" associated with the resource URI;

2. if the VAL server is authorized to unsubscribe from Unicast QoS Monitoring, interact with the NEF to terminate the related QoS monitoring subscription and delete the related "Individual Unicast Monitoring Subscription" subscription resource at the NRM server; and

3. upon success, respond to the VAL server with a "204 No Content" status code.

5.5.3.2.4 Notify_Unicast_QoS_Monitoring

5.5.3.2.4.1 General

This service operation is used by the NRM server to notify the VAL server of unicast QoS monitoring data.

5.5.3.2.4.2 NRM server notifies for Unicast QoS Monitoring using Notify_Unicast_QoS_Monitoring

The NRM server receives unicast QoS monitoring data by means of notifications provided by the NEF. The NRM server coordinates and aggregates the received information from the NEF notifications and determines whether to send a notification to the VAL server based on the VAL server subscription’s reporting requirements. For event-triggered reporting, the NRM server notifies the VAL server when any given event is triggered. For a VAL group or a list of VAL UEs, the NRM server aggregates QoS monitoring data for each UE belonging to the group or the list; for a VAL stream, the NRM server aggregates the QoS monitoring data for the stream.

The NRM server stops reporting according to the VAL server subscription’s termination of reporting requirements. In the case user-triggered termination of reporting is requested or no termination of reporting requirements are provided, the NRM server terminates the Unicast Monitoring Subscription after receiving an explicit request from the VAL Server as specified in clause 5.5.3.2.3. In the case of time-triggered or event-triggered termination of reporting, the NRM server shall stop the reporting and terminate the subscription when the provided conditions are met. The NRM server may also store internally the QoS monitoring data as needed for later retrieval.

In order to notify the VAL server about Unicast QoS Monitoring information updates, the NRM server shall send an HTTP POST request message to the VAL server targeting the notification URI provided during subscription creation as specified in clause 5.5.3.2.2.2.

Upon receiving the HTTP POST request message, the VAL server shall:

1. process the Unicast QoS Monitoring notification; and

2. upon success, respond to the NRM server with a "204 No Content" status code.

5.5.3.2.5 Obtain_Unicast_QoS_Monitoring_Data

5.5.3.2.5.1 General

This service operation is used by a VAL server to obtain the QoS monitoring data from the NRM server for a time period of interest either in the past or in the present (i.e. current time). This service operation is supported via the Subscribe_Unicast_QoS_Monitoring service operation using the immediate reporting and one-time reporting mechanisms as defined in clause 5.5.3.2.2.2.

5.5.3.2.6 Update_Unicast_QoS_Monitoring_Subscription

5.5.3.2.6.1 General

This service operation is used by a VAL server to update a unicast QoS monitoring subscription at the NRM server.

5.5.3.2.6.2 VAL server modifies for Unicast QoS Monitoring Subscription using Update_Unicast_QoS_Monitoring Subscription

If the "UpdateSupport" feature defined in clause 7.4.2.6 is supported, the VAL server may send an HTTP PUT or an HTTP PATCH request to update or modify an individual unicast QoS monitoring subscription, respectively.

In order to update an existing individual unicast QoS monitoring subscription, the VAL server shall send an HTTP PUT request message to the NRM server, targeting the corresponding "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.3.

In order to modify an existing individual unicast QoS monitoring subscription, the VAL server shall send an HTTP PATCH request message targeting the "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.4. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.4.2.2.3.3.4.

The updated resource representation information provided via an HTTP PUT method shall not change any target identifier, i.e., the "valUeIds", "valGroupId", and "valStreamIds" attributes within the "Individual Unicast Monitoring Subscription" resource.

Upon receiving the HTTP PUT or HTTP PATCH request message, the NRM server shall:

1. check if the required features for the received HTTP request are supported as defined in clause 7.4.2.6;

2. verify the identity of the VAL server and check if the VAL server is authorised to update or modify the "Individual Unicast Monitoring Subscription" resource;

3. if the required feature for the received HTTP request is supported and the VAL server is authorized, then the NRM server shall:

a. if the configuration information in the request is valid, interact with the NEF to update, modify, or establish the associated QoS monitoring subscriptions by invoking the Nnef_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) and AsSessionWithQoS API as defined in 3GPP TS 29.522 [28]. The NRM server determines the relevant NEF subscription procedures and the parameters for these subscriptions based on the inputs received from the VAL server;

4. upon reception of successful response(s) from the NEF:

a. update/modify the resource identified by the Resource URI of the configuration received in the request; and

b. respond to the VAL server with an HTTP "200 OK" status;

and

5. if the NRM server is unable to satisfy the request, the NRM server shall respond to the VAL server with an appropriate error status code as defined in clause 7.4.2.5.

5.6 Events APIs

5.6.1 SS_Events API

5.6.1.1 Service Description

5.6.1.1.1 Overview

The SS_Events API, allows a VAL server via LM-S, GM-S, CM-S reference points to subscribe and unsubscribe from SEAL events and to receive notifications from the Location Management Server, Group Management Server and Configuration Management Server respectively.

5.6.1.2 Service Operations

5.6.1.2.1 Introduction

The service operations defined for the SS_Events API are shown in the table 5.6.1.2.1-1.

Table 5.6.1.2.1-1: Operations of the SS_Events API

Service operation name	Description	Initiated by
Subscribe_Event	This service operation is used by VAL server to subscribe for events from SEAL servers.	VAL Server
Unsubscribe_Event	This service operation is used by VAL server to unsubscribe for events from SEAL servers.	VAL Server
Notify_Event	This service operation is used by SEAL servers to send the notifications to the VAL server.	SEAL servers (Location Management, Group Management, Configuration Management).
Update_Subscription	This service operation is used by VAL server to update its events subscription at SEAL server.	VAL Server

5.6.1.2.2 Subscribe_Event

5.6.1.2.2.1 General

This service operation is used by a VAL server to subscribe to the SEAL events.

5.6.1.2.2.2 Subscribing to SEAL events using Subscribe_Event service operation

To subscribe to SEAL events, the VAL server shall send an HTTP POST message to the SEAL server. The body of the HTTP POST message shall include VAL Server Identifier, Event Type, Event Filters, Reporting Requirements and a Notification Destination URI as specified in clause 7.5.1.2.2.3.1.

Upon receiving the above described HTTP POST message, the SEAL server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to subscribe to the SEAL events mentioned in the HTTP POST message;

2. if the VAL server is authorized to subscribe to the SEAL events, the SEAL server shall:

a. create a new resource as specified in clause 7.5.1.2.1; and

b. return the SEAL Resource URI in the response message.

5.6.1.2.3 Notify_Event

5.6.1.2.3.1 General

This service operation is used by the SEAL servers to send notifications to the VAL server.

5.6.1.2.3.2 Notifying SEAL events using Notify_Event service operation

To notify the SEAL events, the SEAL server 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 an Event Notification and SEAL Resource URI.

Upon receiving the HTTP POST message, the VAL server shall process the Event Notification.

5.6.1.2.4 Unsubscribe_Event

5.6.1.2.4.1 General

This service operation is used by a VAL server to un-subscribe from the SEAL events.

5.6.1.2.4.2 Unsubscribing from SEAL events using Unsubscribe_Event service operation

To unsubscribe from SEAL events, the VAL server shall send an HTTP DELETE message to the resource representing the event in the SEAL server as specified in clause 7.5.1.2.3.3.1.

Upon receiving the HTTP DELETE message, the SEAL sever shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to Unsubscribe from the SEAL event associated with the SEAL Resource URI; and

2. if the VAL server is authorized to unsubscribe from the SEAL events, the SEAL server shall delete the resource pointed by the SEAL Resource URI

5.6.1.2.5 Update_Subscription

5.6.1.2.5.1 General

This service operation is used by a VAL server to update its SEAL events subscription.

5.6.1.2.5.2 Updating the SEAL events subscription using Update_Subscription service operation

If the "SubscUpdate" feature as defined in clause 7.5.1.6 is supported, then to request the update/modification of an existing Individual SEAL Events Subscription, the VAL server shall send a HTTP PATCH request (for partial modification) or PUT request (for fully replacement) message to the SEAL server on resource URI "Individual SEAL Events Subscription" resource as specified in clause 7.5.1.2.3.3.2 for HTTP PATCH message and in clause 7.5.1.2.3.3.3 for HTTP PUT message.

Upon receiving the HTTP PATCH or PUT message from the VAL server, the SEAL server shall:

1. check the update of the existing Individual SEAL Events Subscription from the VAL server is authorized or not;

2. if the VAL server is authorized to update the SEAL Events Subscription, then the SEAL server shall replace/modify the existing resource "Individual SEAL Events Subscription", respond to the VAL server with "204 No Content", or "200 OK" with the updated Individual SEAL Events Subscription message.

5.7 Key management APIs

5.7.1 SS_KeyInfoRetrieval API

5.7.1.1 Service Description

5.7.1.1.1 Overview

As specified in 3GPP TS 33.434 [26], the SS_KeyInfoRetrieval API, allows the VAL server via KM-S reference point to obtain the VAL service specific key management information from the key management server.

5.7.1.2 Service Operations

5.7.1.2.1 Introduction

The service operation defined for SS_KeyInfoRetrieval API is shown in the table 5.7.1.2.1-1.

Table 5.7.1.2.1-1: Operations of the SS_ KeyInfoRetrieval API

Service operation name	Description	Initiated by
Obtain_Key_Info	This service operation is used by VAL server to obtain key management information.	VAL server

5.7.1.2.2 Obtain_Key_Info

5.7.1.2.2.1 General

This service operation is used by the VAL server to obtain VAL service specific key management information.

5.7.1.2.2.2 VAL server obtaining VAL service specific key material using Obtain_Key_Info service operation

To obtain key management information specific to VAL service, the VAL server shall send HTTP GET request message to key management server, on Key records resource collection URI, with query parameters VAL service ID and optionally VAL user ID or VAL UE ID, as specified in 7.6.1.2.2.3.1.

Upon receiving the HTTP GET message as described above, the key management server shall:

1. verify the identity of the VAL server and check if the VAL server is authorized to obtain key management information specific to VAL service, VAL user or VAL UE, the URI in the request is of target SEAL KMS and date/time of the request is in recent time window;

2. if the VAL server is authorized to obtain the requested key management information, the key management server shall;

a. return in the response message with key management information corresponding to the query parameters that were sent in the request message.

5.8 Network slice capability Enablement APIs

5.8.1 SS_NetworkSliceAdaptation API

5.8.1.1 Service Description

5.8.1.1.1 Overview

As specified in 3GPP TS 23.434 [2], the SS_NetworkSliceAdaptation API, enables a VAL server to communicate with the Network Slice Capability Enablement (NSCE) server for network slice adaptation over the NSCE-S reference point.

5.8.1.2 Service Operations

5.8.1.2.1 Introduction

The service operation defined for SS_NetworkSliceAdaptation API is shown in the table 5.8.1.2.1-1.

Table 5.8.1.2.1-1: Operations of the SS_NetworkSliceAdaptation API

Service operation name	Description	Initiated by
Network_slice_adaptation	This service operation is used by a VAL server to request network slice adaptation to the NSCE server.	VAL server

5.8.1.2.2 Network_slice_adaptation

5.8.1.2.2.1 General

This service operation is used by a VAL server to request network slice adaptation to the NSCE server.

5.8.1.2.2.2 VAL server requesting network slice adaptation using Network_slice_adaptation service operation

To request network slice adaptation, the VAL server shall send an HTTP POST request message (i.e. custom operation "Request") to the NSCE server, with the request body containing the NwSliceAdptInfo data structure which shall include the parameters VAL service ID and list of VAL UE ID(s), and may include the parameters Network slice adaptation cause, Requested slice information (S-NSSAI or ENSI) and Requested DNN, as specified in clause 7.7.1.3.2.

Upon reception of the HTTP POST request message as described above, the NSCE server shall:

1. process the request and trigger the network slice configuration per VAL UE within the VAL Application to provide the updated S-NSSAI and DNN per VAL UE;

2. send guidance with the information (i.e., the updated S-NSSAI and DNN per VAL UE) to the PCF via NEF as part of the AF-driven guidance for URSP determination to 5G system, using Nnef_ServiceParameter API as defined in 3GPP TS 29.522 [28]; and

3. after receiving a successful response from the NEF, send an HTTP 204 No content response to the VAL server confirming the fulfilment of the network slice adaptation request per VAL application.