6.7 VAE_SessionOrientedService API

29.4863GPPRelease 18Stage 3TSV2X Application Enabler (VAE) Services

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

6.7.1 Introduction

The VAE_SessionOrientedService Service shall use the VAE_SessionOrientedService API.

The API URI of the VAE_SessionOrientedService API shall be:

{apiRoot}/<apiName>/<apiVersion>

The request URIs used in HTTP requests from the NF service consumer towards the VAE Server shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [3], i.e.:

{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>

with the following components:

– The {apiRoot} shall be set as described in 3GPP TS 29.501 [3].

– The <apiName> shall be "vae-session-oriented-service".

– The <apiVersion> shall be "v1".

– The <apiSpecificResourceUriPart> shall be set as described in clause 6.7.3.

6.7.2 Usage of HTTP

6.7.2.1 General

Support of HTTP/1.1 (IETF RFC 7230 [12], IETF RFC 7231 [13], IETF RFC 7232 [14], IETF RFC 7233 [15], IETF RFC 7234 [16] and IETF RFC 7235 [17]) over TLS (IETF RFC 5246 [18]) is mandatory and support of HTTP/2 as specified in clause 5 of 3GPP TS 29.500 [2] is recommended. A V2X application specific server desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 7540 [5].

HTTP/2, shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [2].

An OpenAPI [6] specification of HTTP messages and content bodies for the VAE_SessionOrientedService is contained in Annex A.8.

6.7.2.2 HTTP standard headers

6.7.2.2.1 General

See clause 5.2.2 of 3GPP TS 29.500 [2] for the usage of HTTP standard headers.

6.7.2.2.2 Content type

JSON, IETF RFC 8259 [7], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [2]. The use of the JSON format shall be signalled by the content type "application/json".

6.7.2.3 HTTP custom headers

6.7.2.3.1 General

The HTTP custom header fields specified in clause 5.2.8 of 3GPP TS 29.122 [22] may be applicable.

6.7.3 Resources

6.7.3.1 Overview

This clause describes the structure for the Resource URIs and the resources and methods used for the service.

Figure 6.7.3.1-1 depicts the resource URIs structure for the VAE_SessionOrientedService API.

Figure 6.7.3.1-1: Resource URI structure of the VAE_SessionOrientedService API

Table 6.7.3.1-1 provides an overview of the resources and applicable HTTP methods.

Table 6.7.3.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method or custom operation	Description
Session Oriented Service Subscriptions	/subscriptions	POST	Create a new Individual Session Oriented Service Subscription.
Individual Session Oriented Service Subscription	/subscriptions/{subscriptionId}	GET	Read an Individual Session Oriented Service Subscription.
		PUT	Update an Individual Session Oriented Service Subscription.
		DELETE	Delete an Individual Session Oriented Service Subscription

6.7.3.2 Resource: Session Oriented Service Subscriptions

6.7.3.2.1 Description

This resource represents the collection of the Individual Session Oriented Service Subscription resources created in the VAE Server.

6.7.3.2.2 Resource Definition

Resource URI: {apiRoot}/vae-session-oriented-service/<apiVersion>/subscriptions

This resource shall support the resource URI variables defined in table 6.7.3.2.2-1.

Table 6.7.3.2.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.7.1

6.7.3.2.3 Resource Standard Methods

6.7.3.2.3.1 POST

This method shall support the URI query parameters specified in table 6.7.3.2.3.1-1.

Table 6.7.3.2.3.1-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description	Applicability
n/a

This method shall support the request data structures specified in table 6.7.3.2.3.1-2 and the response data structures and response codes specified in table 6.7.3.2.3.1-3.

Table 6.7.3.2.3.1-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
SessionOrientedData	M	1	Parameters to create an Individual Session Oriented Service Subscription resource.

Table 6.7.3.2.3.1-3: Data structures supported by the POST Response Body on this resource

Data type

Cardinality

Response

codes

Description

SessionOrientedData

0..1

201 Created

An individual Session Oriented Service Subscription resource is created successfully.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [2] shall also apply.

Table 6.7.3.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}/vae-session-oriented-service/<apiVersion>/subscriptions/{subscriptionId}

6.7.3.2.4 Resource Custom Operations

None.

6.7.3.3 Resource: Individual Session Oriented Service Subscription

6.7.3.3.1 Description

The Individual Session Oriented Service Subscription resource represents Individual Session Oriented Service Subscription created in the VAE Server.

6.7.3.3.2 Resource definition

Resource URI: {apiRoot}/vae-session-oriented-service/<apiVersion>/subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 6.7.3.3.2-1.

Table 6.7.3.3.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.7.1
subscriptionId	string	Unique identifier of the Individual Session Oriented Service Subscription resource.

6.7.3.3.3 Resource Standard Methods

6.7.3.3.3.1 GET

This method shall support the URI query parameters specified in table 6.7.3.3.3.1-1.

Table 6.7.3.3.3.1-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 6.7.3.3.3.1-2 and the response data structures and response codes specified in table 6.7.3.3.3.1-3.

Table 6.7.3.3.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.7.3.3.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SessionOrientedData	M	1	200 OK	An Individual Session Oriented Service Subscription resource is returned successfully.
n/a			307 Temporary Redirect	Temporary redirection, during Individual Session Oriented Service Subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during Individual Session Oriented Service Subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [2] shall also apply.

Table 6.7.3.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 VAE Server.

Table 6.7.3.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 VAE Server.

6.7.3.3.3.2 PUT

This method shall support the URI query parameters specified in table 6.7.3.3.3.2-1.

Table 6.7.3.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 6.7.3.3.3.2-2 and the response data structures and response codes specified in table 6.7.3.3.3.2-3.

Table 6.7.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
SessionOrientedData	M	1	Parameters to update an Individual Session Oriented Service Subscription resource.

Table 6.7.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SessionOrientedData	M	1	200 OK	The Individual Session Oriented Service Subscription resource was successfully updated.
n/a			204 No Content	The Individual Session Oriented Service Subscription resource was successfully updated.
n/a			307 Temporary Redirect	Temporary redirection, during the Individual Session Oriented Service Subscription update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during the Individual Session Oriented Service Subscription update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply.

Table 6.7.3.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 VAE Server.

Table 6.7.3.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 VAE Server.

6.7.3.3.3.3 DELETE

This method shall support the URI query parameters specified in table 6.7.3.3.3.3-1.

Table 6.7.3.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 6.7.3.3.3.3-2 and the response data structures and response codes specified in table 6.7.3.3.3.3-3.

Table 6.7.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.7.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Individual Session Oriented Service Subscription resource was successfully deleted
n/a			307 Temporary Redirect	Temporary redirection, during the Individual Session Oriented Service Subscription resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during the Individual Session Oriented Service Subscription resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply.

Table 6.7.3.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 VAE Server.

Table 6.7.3.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 VAE Server.

6.7.3.4 Resource Custom Operations

None.

6.7.4 Custom Operations without associated resources

There are no custom operations without associated resources supported on VAE_SessionOrientedService.

6.7.5 Notifications

6.7.5.1 General

The VAE server and NF service consumer shall support the delivery of Notifications using a separate HTTP connection towards an address as assigned the NF service consumer described in clause 6.7.5.2.

A VAE server and NF service consumer may support testing a notification connection as described in clause 6.7.5.3. A VAE server and NF service consumer may support the delivery of Notification using Websocket (IETF RFC 6455 [21]) as described in clause 6.7.5.4.

6.7.5.2 Notification Delivery using a separate HTTP connection

The descriptions in clause 5.2.5.2 of 3GPP TS 29.122 [22] apply with following differences:

– description of SCS/AS applies to the NF service consumer;

– description of SCEF applies to the VAE server; and

– "notificationDestination" attribute is replaced by the "notifUri" attribute.

6.7.5.3 Notification Test Event

The descriptions in clause 5.2.5.3 of 3GPP TS 29.122 [22] apply with following differences:

– description of SCS/AS applies to the NF service consumer; and

– description of SCEF applies to the VAE server.

6.7.5.4 Notification Delivery using Websocket

The descriptions in clause 5.2.5.4 of 3GPP TS 29.122 [22] apply with following differences:

– description of SCS/AS applies to the NF service consumer; and

– description of SCEF applies to the VAE server.

6.7.5.5 Methods

Table 6.7.5.5-1: Methods

Callback URI	HTTP method or custom operation	Description (service operation)
{notifUri}	POST	Notify the result of the establishment or update of the session-oriented service corresponding to the subscription.

6.7.5.6 Notify Session Establishment or Update

6.7.5.6.1 Description

This notification is used by the VAE Server to notify the result of establishment or update of the session-oriented service by the VAE server.

6.7.5.6.2 Operation Definition

This operation shall support the request data structures specified in table 6.7.5.6.2-1 and the response data structure and response codes specified in table 6.7.5.6.2-2.

Table 6.7.5.6.2-1: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
Notification	M	1	Notify the result of establishment or update of the session-oriented service to the subscription.

Table 6.7.5.6.2-2: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	.
n/a			307 Temporary Redirect	Temporary redirection, during the notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative V2X application specific server where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during the notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative V2X application specific server where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.

Table 6.7.5.6.2-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 V2X application specific server towards which the notification should be redirected.

Table 6.7.5.6.2-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 V2X application specific server towards which the notification should be redirected.

6.7.6 Data Model

6.7.6.1 General

This clause specifies the application data model supported by the API.

Table 6.7.6.1-1 specifies the data types defined for the VAE_SessionOrientedService API.

Table 6.7.6.1-1: VAE_SessionOrientedService specific Data Types

Data type	Section defined	Description	Applicability
Action	6.7.6.3.3	Indicates the action of the session-oriented service, i.e. establishment and update.
AppplicationQosRequirement	6.7.6.3.4	Represents the application layer QoS requirement.
Notification	6.7.6.2.3	Represents the result of the establishment or update of the session-oriented service.
SessionOrientedData	6.7.6.2.2	Represents the data to trigger establishment or update of ession-oriented service.

Table 6.7.6.1-2 specifies data types re-used by the VAE_SessionOrientedService service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the VAE_SessionOrientedService service based interface.

Table 6.7.6.1-2: VAE_SessionOrientedService re-used Data Types

Data type	Reference	Comments	Applicability
5Qi	3GPP TS 29.571 [11]	Used to indicate a PQI.
AverWindow	3GPP TS 29.571 [11]	Used to represent aggregation window.
ExtMaxDataBurstVol	3GPP TS 29.571 [11]	Used to indicate the maximum data burst volume for an application requirement.
PacketDelBudget	3GPP TS 29.571 [11]	Used to indicate the packet delay bugget for an application requirement.
PacketErrRate	3GPP TS 29.571 [11]	Used to indicate the packet error rate for an application requirement.
QosResourceType	3GPP TS 29.571 [11]	Used to indicate a QoS bearer type, i.e., GBR, delay critical GBR, or non-GBR.
Result	6.1.6.3.3	Used to indicate a success or failure.
SupportedFeatures	3GPP TS 29.571 [11]	Used to negotiate the applicability of the optional features.
TestNotification	3GPP TS 29.122 [22]	Represents a notification that can be sent to test whether a chosen notification mechanism works.	Notification_test_event
Uinteger	3GPP TS 29.571 [11]	Used to represent integer values.
Uri	3GPP TS 29.571 [11]	Used to indicate an URI.
V2xUeId	6.1.6.3.2	Identifier of the destination V2X UE
WebsockNotifConfig	3GPP TS 29.122 [22]	Pepresents configuration for the delivery of notifications over Websockets.	Notification_websocket

6.7.6.2 Structured data types

6.7.6.2.1 Introduction

This clause defines the structures to be used in resource representations.

6.7.6.2.2 Type: SessionOrientedData

Table 6.7.6.2.2-1: Definition of type SessionOrientedData

Attribute name	Data type	P	Cardinality	Description	Applicability
ueId	V2xUeId	M	1	V2X UE ID of the host vehicle
notifUri	Uri	M	1	Identifies the recipient of notification sent by the VAE server.
serviceId	V2xServiceId	M	1	The V2X service ID for which application requirement corresponds to.
appSerId	AppServerId	M	1	Identity of the V2X application specific server.
appQosReq	AppplicationQosRequirement	O	0..1	The application QoS requirements for the session-oriented service.
requestTestNotification	boolean	O	0..1	Set to true by the NF service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. 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 clause 6.3.5.4.	Notification_websocket
suppFeat	SupportedFeatures	C	0..1	Indicates the features supported by the service consumer. It shall be included in the first interaction.

6.7.6.2.3 Type: Notification

Table 6.7.6.2.3-1: Definition of type Notification

Attribute name	Data type	P	Cardinality	Description	Applicability
resourceUri	Uri	M	1	The resource URI of the individual Session Oriented Service Subscription related to the notification.
action	Action	M	1	Indicate the action to the session-oriented service.
result	Result	M	1	The result indicating success or failure to establish or update session-oriented service.

6.7.6.2.4 Type: AppplicationQosRequirement

Table 6.7.6.2.4-1: Definition of type AppplicationQosRequirement

Attribute name	Data type	P	Cardinality	Description	Applicability
pqi	5Qi	C	0..1	PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [30]).
resourceType	QosResourceType	C	0..1	Indicates whether the resource type is GBR, delay critical GBR, or non-GBR.
priorityLevel	Uinteger	C	0..1	Unsigned integer indicating the Priority value of the ProSe Per-Packet Priority, within a range of 1 to 8 and the lower number means the higher priority.
packetDelayBudget	PacketDelBudget	C	0..1	Unsigned integer indicates the packet delay budget. Packet Delay Budget expressed in milliseconds.
packetErrorRate	PacketErrRate	C	0..1	String indicating the packet error rate. Examples: Packer Error Rate 4×10^-6shall be encoded as "4E-6". Packer Error Rate 10^-2shall be encoded as"1E-2".
averagingWindow	AverWindow	C	0..1	Indicates the averaging window. This IE shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow.
maxDataBurstVol	ExtMaxDataBurstVol	C	0..1	Unsigned Integer. Indicates the maximum data burst volume.
NOTE: Either "pqi" attribute or "resourceType", "priorityLevel", "packetDelayBudget" and "packetErrorRate" attributes shall be present.

6.7.6.3 Simple data types and enumerations

6.7.6.3.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

6.7.6.3.2 Simple data types

The simple data types defined in table 6.7.6.3.2-1 shall be supported.

Table 6.7.6.3.2-1: Simple data types

Type Name	Type Definition	Description	Applicability

6.7.6.3.3 Enumeration: Action

Table 6.7.6.3.3-1: Enumeration Action

Enumeration value	Description	Applicability
ESTABLISHMENT	Indicates the establishment of session-oriented service.
UPDATE	Indicates the update of session-oriented service.

6.7.7 Error Handling

6.7.7.1 General

HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [2].

For the VAE_SessionOrientedServic Service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [3].

Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [2] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [2].

In addition, the requirements in the following clauses are applicable for the VAE_SessionOrientedServic Service API.

6.7.7.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the VAE_SessionOrientedServic API.

6.7.7.3 Application Errors

The application errors defined for the VAE_SessionOrientedServic service are listed in table 6.7.7.3-1.

Table 6.7.7.3-1: Application errors

Application Error	HTTP status code	Description

6.7.8 Feature negotiation

The optional features in table 6.7.8-1 are defined for the VAE_SessionOrientedServic API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [2].

Table 6.7.8-1: Supported Features

Feature number	Feature Name	Description
1	Notification_test_event	The testing of notification connection is supported according to clause 6.7.5.3.
2	Notification_websocket	The delivery of notifications over Websocket is supported according to clause 6.7.5.4. This feature requires that the Notification_test_event feature is also supported.