8.5 Eees_SessionWithQoS API
29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS
8.5.1 Introduction
The Eees_SessionWithQoS service shall use the Eees_SessionWithQoS API.
The API URI of the Eees_SessionWithQoS API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in clause 7.5.
– The <apiName> shall be "eees-session-with-qos".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 8.5.2.
8.5.2 Resources
8.5.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 8.5.2.1-1 depicts the resource URIs structure for the Eees_SessionWithQoS API.
Figure 8.5.2.1-1: Resource URI structure of the Eees_SessionWithQoS API
Table 8.5.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 8.5.2.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
Sessions with QoS |
/sessions |
POST |
Create a new individual Session with QoS |
GET |
Read all subscription resources for given EAS. |
||
Individual Session with QoS |
/sessions/{sessionId} |
PUT |
Fully replace an existing Individual Session with QoS resource identified by a sessionId. |
PATCH |
Partially update an existing Individual Session with QoS resource identified by a sessionId |
||
DELETE |
Remove an Individual Session with QoS resource identified by a sessionId. |
||
GET |
Read a subscription resource for a sessionId. |
8.5.2.2 Resource: Sessions with QoS
8.5.2.2.1 Description
This resource represents session information of all the data sessions with a specific QoS setting at a given Edge Enabler Server.
8.5.2.2.2 Resource Definition
Resource URI: {apiRoot}/eees-session-with-qos/<apiVersion>/sessions
This resource shall support the resource URI variables defined in the table 8.5.2.2.2-1.
Table 8.5.2.2.2-1: Resource URI variables for this resource
Name |
Data Type |
Definition |
apiRoot |
string |
See clause 7.5 |
8.5.2.2.3 Resource Standard Methods
8.5.2.2.3.1 POST
This method requests resources for a data session between AC and EAS with a specific QoS and may create the session information subscription at the Edge Enabler Server for receiving the user plane event notification of the session information. This method shall support the URI query parameters specified in table 8.5.2.2.3.1-1.
Table 8.5.2.2.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 8.5.2.2.3.1-2 and the response data structures and response codes specified in table 8.5.2.2.3.1-3.
Table 8.5.2.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SessionWithQoS |
M |
1 |
Parameters to create a subscription for a session with required QoS for the service requirement. |
Table 8.5.2.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
|
SessionWithQoS |
M |
1 |
201 Created |
The session is successfully set up with requested QoS, and the session information is provided in the response body. The URI of the created resource shall be returned in the "Location" HTTP header. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.2.3.1-4: Headers supported by the 201 response code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/ eees-session-with-qos/<apiVersion>/sessions/{sessionId} |
8.5.2.2.3.2 GET
The GET method allows to read all active subscriptions for a given EAS. The EAS shall initiate the HTTP GET request message and the EES shall respond to the message. This method shall support the URI query parameters specified in table 8.5.2.2.3.2-1.
Table 8.5.2.2.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
eas-id |
string |
M |
1 |
Represents the application identifier of the EAS , e.g. URI, FQDN, that is querying the status of subscriptions. |
This method shall support the request data structures specified in table 8.5.2.2.3.2-2 and the response data structures and response codes specified in table 8.5.2.2.3.2-3.
Table 8.5.2.2.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 8.5.2.2.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
array(SessionWithQoS) |
M |
1..N |
200 OK |
The subscription information related to the request URI is returned. |
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.2.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
Table 8.5.2.2.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
8.5.2.2.4 Resource Custom Operations
None.
8.5.2.3 Resource: Individual Session with QoS
8.5.2.3.1 Description
This resource represents an individual session information of the data session with a specific QoS setting at a given Edge Enabler Server.
8.5.2.3.2 Resource Definition
Resource URI: {apiRoot}/eees-session-with-qos/<apiVersion>/sessions/{sessionId}
This resource shall support the resource URI variables defined in the table 8.5.2.3.2-1.
Table 8.5.2.3.2-1: Resource URI variables for this resource
Name |
Data Type |
Definition |
apiRoot |
string |
See clause 7.5. |
sessionId |
string |
Contains the identifier of a Session with QoS. |
8.5.2.3.3 Resource Standard Methods
8.5.2.3.3.1 PATCH
This method partially updates the QoS of the data session between AC and EAS. This method shall support the URI query parameters specified in the table 8.5.2.3.3.1-1.
Table 8.5.2.3.3.1-1: URI query parameters supported by the PATCH method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 8.5.2.3.3.1-2 and the response data structures and response codes specified in table 8.5.2.3.3.1-3.
Table 8.5.2.3.3.1-2: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
SessionWithQoSPatch |
M |
1 |
Request to partially update the data session between AC and EAS with a specific QoS |
Table 8.5.2.3.3.1-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SessionWithQoS |
M |
1 |
200 OK |
The individual Session with QoS is successfully modified and the updated session with QoS context information is returned in the response |
n/a |
204 No Content |
The individual Session with QoS is successfully modified. |
||
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The manadatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.3.3.1-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
Table 8.5.2.3.3.1-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
8.5.2.3.3.2 PUT
This method requests modification of QoS of the data session between AC and EAS and may modify the subscription of the event monitoring by subscribing to new events or removing subscriptions to existing events at the Edge Enabler Server for receiving the user plane event notification of the session information. This method shall support the URI query parameters specified in the table 8.5.2.3.3.2-1.
Table 8.5.2.3.3.2-1: URI query parameters supported by the PUT method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 8.5.2.3.3.2-2 and the response data structures and response codes specified in table 8.5.2.3.3.2-3.
Table 8.5.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
SessionWithQoS |
M |
1 |
Parameters to create a subscription for a session with required QoS for the service requirement. |
Table 8.5.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SessionWithQoS |
M |
1 |
200 OK |
The individual Session with QoS is successfully modified and the updated session with QoS context information is returned in the response. |
n/a |
204 No Content |
The individual Session with QoS is successfully modified. |
||
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The manadatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.3.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
Table 8.5.2.3.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
8.5.2.3.3.3 DELETE
This method revokes the data session between AC and EAS with a specific QoS and unsubscribes to the related session with user plane event notification. This method shall support the URI query parameters specified in table 8.5.2.3.3.3-1.
Table 8.5.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 8.5.2.3.3.3-2 and the response data structures and response codes specified in table 8.5.2.3.3.3-3.
Table 8.5.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 8.5.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
M |
1 |
204 No Content |
The individual Session with QoS resource matching the sessionId is successfully deleted. |
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The manadatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.3.3.3-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
Table 8.5.2.3.3.3-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
8.5.2.3.3.4 GET
The GET method allows to read a subscription. The EAS shall initiate the HTTP GET request message and the EES shall respond to the message. This method shall support the URI query parameters specified in table 8.5.2.3.3.4-1.
Table 8.5.2.3.3.4-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 8.5.2.3.3.4-2 and the response data structures and response codes specified in table 8.5.2.3.3.4-3.
Table 8.5.2.3.3.4-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 8.5.2.3.3.4-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SessionWithQoS |
M |
1 |
200 OK |
The subscription information related to the request URI is returned. |
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.2.3.3.4-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
Table 8.5.2.3.3.4-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative EES. |
8.5.2.3.4 Resource Custom Operations
None.
8.5.3 Custom Operations without associated resources
None.
8.5.4 Notifications
8.5.4.1 General
Table 8.5.4.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
User Plane Event Notification |
{notificationDestination} |
POST |
Notifies the EAS the subscribed user plane event(s). |
8.5.4.2 User Plane Event Notification
8.5.4.2.1 Description
8.5.4.2.2 TargetURI
The callback URI {notificationDestination} shall be used with the callback URI variables defined in table 8.5.4.2.2-1.
Table 8.5.4.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notificationDestination |
Uri |
Callback reference provided by the EAS during session with QoS creation/update/modification procedure. |
8.5.4.2.3 Standard Methods
8.5.4.2.3.1 POST
This method shall support the request data structures specified in table 8.5.4.2.3.1-1 and the response data structures and response codes specified in table 8.5.4.2.3.1-2.
Table 8.5.4.2.3.1-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
UserPlaneEventNotification |
M |
1 |
Notification of the user plane event on the data session. |
Table 8.5.4.2.3.1-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
The receipt of the Notification is acknowledged. |
||
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
Table 8.5.4.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. |
Table 8.5.4.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. |
8.5.5 Data Model
8.5.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API
Table 8.5.5.1-1 specifies the data types defined specifically for the Eees_SessionWithQoS API service.
Table 8.5.5.1-1: Eees_SessionWithQoS API specific Data Types
Data type |
Section defined |
Description |
Applicability |
SessionWithQoS |
8.5.5.2.2 |
||
SessionWIthQoSPatch |
8.5.5.2.3 |
||
UserPlaneEventNotification |
8.5.5.2.4 |
Table 8.5.5.1-2 specifies data types re-used by the Eees_SessionWithQoS API service.
Table 8.5.5.1-2: Re-used Data Types
Data type |
Reference |
Comments |
Applicability |
Gpsi |
3GPP TS 29.571 [8] |
Used to identify the UE, for which the related session with QoS is requested to. |
|
Ipv4Addr |
3GPP TS 29.122 [6] |
Identifying the IPv4 address of the UE. |
|
Ipv6Addr |
3GPP TS 29.122 [6] |
Identifying the IPv6 address of the UE. |
|
UserPlaneEvent |
3GPP TS 29.122 [6] |
Indicates the event reported by the EES. |
|
SponsorInformation |
3GPP TS 29.122 [6] |
Indicates a sponsor information |
|
QosMonitoringInformation |
3GPP TS 29.122 [6] |
Indicates the Qos Monitoring information |
|
DurationSecRm |
3GPP TS 29.571 [8] |
This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. |
|
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of optional features. |
|
TestNotification |
3GPP TS 29.122 [6] |
This type represents a notification that can be sent to test whether a chosen notification mechanism works |
|
Uri |
3GPP TS 29.122 [6] |
||
WebsockNotifConfig |
3GPP TS 29.122 [6] |
This type represents configuration for the delivery of notifications over Websockets. |
|
Dnn |
3GPP TS 29.571 [8] |
Identifies a DNN. |
|
GroupId |
3GPP TS 29.571 [8] |
Used to present the internal group identifier in the AS session with QoS subscription/request. |
|
ExternalGroupId |
3GPP TS 29.571 [8] |
Used to present the external group identifier in the AS session with QoS subscription/request. |
|
Snssai |
3GPP TS 29.571 [8] |
Identifies a S-NSSAI |
|
FlowDescription |
3GPP TS 29.514 [16] |
Identifies an IP flow description. |
|
BitRateRm |
3GPP TS 29.571 [8] |
This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. |
|
UserPlaneEventReport |
3GPP TS 29.122 [6] |
Represents an event report for user plane. |
|
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of optional features. |
8.5.5.2 Structured data types
8.5.5.2.1 Introduction
8.5.5.2.2 Type: SessionWithQoS
Table 8.5.5.2.2-1: Definition of type SessionWIthQoS
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
self |
Uri |
C |
0..1 |
Link to the "Individual Session with QoS" resource. Shall only be present in the HTTP GET response on the "Sessions with QoS" resource. |
|
easId |
string |
M |
1 |
The application identifier of the EAS, e.g. URI, FQDN. |
|
ueIpv4Addr |
Ipv4Addr |
O |
0..1 |
IPv4 address of the UE. (NOTE 1) |
|
ueIpv6Addr |
Ipv6Addr |
O |
0..1 |
IPv6 address of the UE. (NOTE 1) |
|
ipDomain |
string |
O |
0..1 |
Identifies the IP domain. |
|
ueId |
Gpsi |
O |
0..1 |
Identifier of the UE for which related session with QoS is requested to. (NOTE 1) |
|
intGrpId |
GroupId |
O |
0..1 |
The internal group identifier, identifying the group of UEs for which related session with QoS is requested to. (NOTE 1) |
|
extGrpId |
ExternalGroupId |
O |
0..1 |
The external group identifier, identifying the group of UEs for which the related session with QoS is requested to. (NOTE 1) |
|
ipFlows |
array(FlowDescription) |
M |
1..N |
Contains the flow description for the Uplink and/or Downlink IP flows. |
|
qosReference |
string |
O |
0..1 |
Identifies a pre-defined QoS information (NOTE 2) |
|
altQosReference |
array(string) |
O |
1..N |
Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. |
|
events |
array(UserPlaneEvent) |
O |
1..N |
Indicates the events subscribed by the EAS. |
|
sponsorInformation |
SponsorInformation |
O |
0..1 |
Describes the sponsor information. |
|
qosMonInfo |
QosMonitoringInformation |
O |
0..1 |
Qos Monitoring information. It may be present when the event "QOS_MONITORING" is subscribed. |
|
notificationDestination |
Uri |
C |
0..1 |
URI where the event notification shall be delivered to. This attribute shall be present if the "events" attribute is included. |
|
dnn |
Dnn |
O |
0..1 |
Dnn of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. |
|
snssai |
Snssai |
O |
0..1 |
S-NSSAI of the PDU session. |
|
maxbrUl |
BitRate |
O |
0..1 |
Indicates the (requested) maximum bandwidth in uplink. (NOTE 2) |
|
maxbrDl |
BitRate |
O |
0..1 |
Indicates the (requested) maximum bandwidth in downlink. (NOTE 2) |
|
disUeNotif |
boolean |
O |
0..1 |
Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. |
|
requestTestNotification |
boolean |
O |
0..1 |
Set to true by Subscriber to request the EES to send a test notification as defined in 3GPP TS 29.122 [6]. Set to false or omitted otherwise. |
Notification_test_event |
websockNotifConfig |
WebsockNotifConfig |
O |
0..1 |
Configuration parameters to set up notification delivery over Websocket protocol as defined in 3GPP TS 29.122 [6]. |
Notification_websocket |
suppFeat |
SupportedFeatures |
O |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 7.8. This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. |
|
NOTE 1: Only one of UE IP address (ipv4Addr or ipv6Addr), UE Identifier (ueId), Internal group identifier (intGrpId), or External group identifier (extGrpId) shall be included. NOTE 2: Only one of requested QoS (qosReference) or Requested bandwidth (maxbuUl and/or maxbtDl) shall be included. |
8.5.5.2.3 Type: SessionWithQoSPatch
Table 8.5.5.2.3-1: Definition of type SessionWIthQoSPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
ipFlows |
array(FlowDescription) |
O |
1..N |
Contains the flow description for the Uplink and/or Downlink IP flows. |
|
qosReference |
string |
O |
0..1 |
Identifies a pre-defined QoS information. |
|
altQosReference |
array(string) |
O |
1..N |
Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. |
|
Events |
array(UserPlaneEvent) |
O |
1..N |
Indicates the event subscribed by the EAS. |
|
sponsorInformation |
SponsorInformation |
O |
0..1 |
Describes the sponsor information such as who is sponsoring the traffic. |
|
qosMonInfo |
QosMonitoringInformationRm |
O |
0..1 |
Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. |
|
notificationDestination |
Uri |
O |
0..1 |
URI where the monitoring event notification should be delivered to. |
|
maxbrUl |
BitRateRm |
O |
0..1 |
Indicates the (requested) maximum bandwidth in uplink. |
|
maxbrDl |
BitRateRm |
O |
0..1 |
Indicates the (requested) maximum bandwidth in downlink. |
|
disUeNotif |
boolean |
O |
0..1 |
Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. |
8.5.5.2.4 Type: UserPlaneEventNotification
Table 8.5.5.2.4-1: Definition of type UserPlaneEventNotifiation
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
sessionId |
string |
M |
1 |
String identifying the individual data session information for which the QoS event notification is delivered. |
|
eventReports |
array(UserPlaneEventReport) |
M |
1..N |
List of user plane event reports and application information that include the QoS event information of the data session. |
8.5.5.3 Simple data types and enumerations
None.
8.5.6 Error Handling
General error responses are defined in clause 7.7.
8.5.7 Feature negotiation
General feature negotiation procedures are defined in clause 7.8. Table 8.5.7-1 lists the supported features for Eees_SessionWithQoS API.
Table 8.5.7-1: Supported Features
Feature number |
Feature Name |
Description |
1 |
Notification_test_event |
Testing of notification connection is supported according to clause 7.6. |
2 |
Notification_websocket |
The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. |