6.1 VAE_MessageDelivery Service API

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

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

6.1.1 Introduction

The VAE_MessageDelivery shall use the VAE_MessageDelivery API.

The API URI of the VAE_MessageDelivery 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.:

All resource URIs of this API shall have the following root:

{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-message-delivery".

– The <apiVersion> shall be "v1".

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

6.1.2 Usage of HTTP

6.1.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 is mandatory and support of HTTP/2 as specified in clause 5 of 3GPP TS 29.500 [2] is recommended. TLS shall be used as specified in 3GPP TS 33.536 [31] and 3GPP TS 33.501 [32]. 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_MessageDelivery is contained in Annex A.2.

6.1.2.2 HTTP standard headers

6.1.2.2.1 General

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

6.1.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.1.2.3 HTTP custom headers

6.1.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.1.3 Resources

6.1.3.1 Overview

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

Figure 6.1.3.1-1 depicts the resource URIs structure for the VAE_MessageDelivery API.

Figure 6.1.3.1-1: Resource URI structure of the VAE_MessageDelivery API

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

Table 6.1.3.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method or custom operation	Description
Message Delivery Subscriptions	/subscriptions	POST	Create a new Individual Message Delivery Subscription resource.
Individual Message Delivery Subscription	/subscriptions/{subscriptionId}	GET	Read an Individual Message Delivery Subscription resource.
Individual Message Delivery Subscription	/subscriptions/{subscriptionId}	DELETE	Delete an Individual Message Delivery Subscription resource.
Downlink Message Deliveries	/subscriptions/{subscriptionId}/message-deliveries	POST	Create a new Individual Downlink Message Delivery resource for a V2X UE ID or V2X group ID.
Individual Downlink Message Delivery	/subscriptions/{subscriptionId}/message-deliveries/{dlDeliveryId}	GET	Read the Individual Downlink Message Delivery resource.
Individual Downlink Message Delivery		DELETE	Delete the Individual Downlink Message Delivery resource.

6.1.3.2 Resource: Message Delivery Subscriptions

6.1.3.2.1 Description

This resource represents the collection of the Individual Message Delivery Subscription resources created in the VAE Server.

6.1.3.2.2 Resource Definition

Resource URI: {apiRoot}/vae-message-delivery/<apiVersion>/subscriptions

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

Table 6.1.3.2.2-1: Resource URI variables for this resource

Name	Data Type	Definition
apiRoot	string	See clause 6.1.1

6.1.3.2.3 Resource Standard Methods

6.1.3.2.3.1 POST

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

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

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

Data type	P	Cardinality	Description
MessageDeliverySubscriptionData	M	1	Parameters to create an Individual Message Delivery Subscription resources.

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

Data type

Cardinality

Response

codes

Description

MessageDeliverySubscriptionData

0..1

201 Created

An Individual Message Delivery Subscription resource for the V2X UE ID or V2X group ID 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.1.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-message-delivery/<apiVersion>/subscriptions/{subscriptionId}

6.1.3.2.4 Resource Custom Operations

None.

6.1.3.3 Resource: Individual Message Delivery Subscription

6.1.3.3.1 Description

The Individual Message Subscription resource represents an Individual Message Delivery Subscription created in the VAE Server and associated with the V2X UE ID or V2X group ID.

6.1.3.3.2 Resource definition

Resource URI: {apiRoot}/vae-message-delivery/<apiVersion>/subscriptions/{subscriptionId}

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

Table 6.1.3.3.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
subscriptionId	string	Unique identifier of the individual Message Delivery Subscription resource for the V2X UE ID or V2X group ID.

6.1.3.3.3 Resource Standard Methods

6.1.3.3.3.1 GET

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

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

Table 6.1.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.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MessageDeliverySubscriptionData	M	1	200 OK	An individual Message Delivery Subscription resource for the V2X UE ID or V2X group ID is returned successfully.
n/a			307 Temporary Redirect	Temporary redirection, during Individual Message Delivery 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 SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during Individual Message Delivery 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 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.1.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.1.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.1.3.3.3.2 DELETE

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

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

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

Data type	P	Cardinality	Description
n/a

Table 6.1.3.3.3.2-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 Message Delivery Subscription was successfully deleted.
n/a			307 Temporary Redirect	Temporary redirection, during Individual Message Delivery Subscription 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 SCS/AS is replaced by the V2X application specific server.
n/a			308 Permanent Redirect	Permanent redirection, during Individual Message Delivery Subscription 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 SCS/AS is replaced by the V2X application specific server.
NOTE: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply.

Table 6.1.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.1.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.1.3.3.4 Resource Custom Operations

None.

6.1.3.4 Resource: Downlink Message Deliveries

6.1.3.4.1 Description

This resource represents the collection of the individual Downlink Message Delivery resources created in the VAE Server.

6.1.3.4.2 Resource Definition

Resource URI: {apiRoot}/vae-message-delivery/<apiVersion>/subscriptions/{subscriptionId}/message-deliveries

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

Table 6.1.3.4.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
subscriptionId	string	Unique identifier of the individual Message Delivery Subscription resource for the V2X UE ID or V2X group ID.

6.1.3.4.3 Resource Standard Methods

6.1.3.4.3.1 POST

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

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

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

Data type	P	Cardinality	Description
DownlinkMessageDeliveryData	M	1	Parameters to create an Individual Downlink Message Delivery resource.

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

Data type

Cardinality

Response

codes

Description

DownlinkMessageDeliveryData

0..1

201 Created

An Individual Downlink Message Delivery resource for the V2X UE ID or V2X group ID 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.1.3.4.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-message-delivery/<apiVersion>/subscriptions/{subscriptionId}/message-deliveries/{dlDeliveryId}

6.1.3.4.4 Resource Custom Operations

None.

6.1.3.5 Resource: Individual Downlink Message Delivery

6.1.3.3.1 Description

The Individual Downlink Message Delivery resource represents an Individual Downlink Message Delivery created in the VAE Server and associated with the V2X UE ID or V2X group ID.

6.1.3.5.2 Resource definition

Resource URI: {apiRoot}/vae-message-delivery/<apiVersion>/subscriptions/{subscriptionId}/message-deliveries/{dlDeliveryId}

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

Table 6.1.3.5.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
subscriptionId	string	Unique identifier of the individual Message Delivery Subscription resource for the V2X UE ID or V2X group ID.
dlDeliveryId	string	Unique identifier of the Individual Downlink Message Delivery resource for the V2X UE ID or V2X group ID.

6.1.3.5.3 Resource Standard Methods

6.1.3.5.3.1 GET

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

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

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

Data type	P	Cardinality	Description
n/a

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

Data type	P	Cardinality	Response codes	Description
DownlinkMessageDeliveryData	M	1	200 OK	An individual Downlink Message Delivery resource for the V2X UE ID or V2X group ID is returned successfully.
n/a			307 Temporary Redirect	Temporary redirection, during Individual Downlink Message Delivery 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 Downlink Message Delivery 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.1.3.5.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.1.3.5.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.1.3.5.3.2 DELETE

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

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

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

Data type	P	Cardinality	Description
n/a

Table 6.1.3.5.3.2-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 Downlink Message Delivery resource was successfully deleted.
n/a			307 Temporary Redirect	Temporary redirection, during Individual Downlink Message Delivery 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 Individual Downlink Message Delivery 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 codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply.

Table 6.1.3.5.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.1.3.5.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.1.3.3.4 Resource Custom Operations

None.

6.1.4 Custom Operations without associated resources

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

6.1.5 Notifications

6.1.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.1.5.2.

A VAE server and NF service consumer may support testing a notification connection as described in clause 6.1.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.1.5.4.

6.1.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.1.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.1.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.1.5.5 Methods

The notifications provided by the VAE_MessageDelivery Service are specified in this clause.

Table 6.1.5.5-1: Notifications

	Callback URI	HTTP method or custom operation	Description (service operation)
Uplink Message Delivery	{notifUri}	POST	Uplink Message Delivery.
Reception Report of Downlink Message Delivery	{notifUri}	POST	Send notifications about the result of the downlink Message delivery

6.1.5.6 Uplink Message Delivery

6.1.5.6.1 Description

This notification is used by the VAE Server to deliver the uplink message to the update the policy.

6.1.5.6.2 Operation Definition

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

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

Data type	P	Cardinality	Description
UplinkMessageDeliveryData	M	1	Contains the uplink message delivery data

Table 6.1.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	The uplink message is delivery successfully.
n/a			307 Temporary Redirect	Temporary redirection, during uplink message delivery. 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 uplink message 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 uplink message delivery. 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 uplink message 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.1.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 uplink message should be redirected.

Table 6.1.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 uplink message should be redirected.

6.1.5.7 Reception Report of Downlink Message Delivery

6.1.5.7.1 Description

This notification is used by the VAE Server to report the result of downlink message delivery to NF service consumer.

6.1.5.7.2 Operation Definition

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

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

Data type	P	Cardinality	Description
Result	M	1	Contains the result of downlink messagege delivery.

Table 6.1.5.7.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	The reception report is successfully.
n/a			307 Temporary Redirect	Temporary redirection, during reception report of downlink data delivery. 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 uplink message 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 reception report of downlink data delivery. 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 uplink message 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.1.5.7.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 uplink message should be redirected.

Table 6.1.5.7.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 uplink message should be redirected.

6.1.6 Data Model

6.1.6.1 General

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

Table 6.1.6.1-1 specifies the data types defined for the VAE_MessageDelivery API.

Table 6.1.6.1-1: VAE_MessageDelivery specific Data Types

Data type	Section defined	Description	Applicability
AppServerId	6.1.6.3.2	Identity of the V2X application specific server.
DownlinkMessageDeliveryData	6.1.6.2.2	Contains the downlink V2X message delivery data
GeoId	6.1.6.3.2	Geographical area identifier
MessageDeliverySubscriptionData	6.1.6.2.3	Contains the V2X message delivery subscription data
Result	6.1.6.3.4	Contains the result of the downlink message delivery	ReceptionReport
UplinkMessageDeliveryData	6.1.6.2.4	Contains the uplink V2X message delivery data
V2xGroupId	6.1.6.3.2	The group ID for which the V2X message is addressed
V2xServiceID	6.1.6.3.2	The V2X service ID to which the V2X message belongs to
V2xUeId	6.1.6.3.2	Identifier of the destination V2X UE
V2xMessagePayload	6.1.6.3.2	V2X message payload carried by the V2X message

Table 6.1.6.1-2 specifies data types re-used by the VAE_MessageDelivery 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_MessageDelivery service based interface.

Table 6.1.6.1-2: VAE_MessageDelivery re-used Data Types

Data type	Reference	Comments	Applicability
Bytes	3GPP TS 29.571 [11]	String with format "byte" as defined in OpenAPI Specification [6], i.e, base64-encoded characters
DateTime	3GPP TS 29.571 [11]	String with format "date-time" as defined in OpenAPI Specification [6].
SupportedFeatures	3GPP TS 29.571 [11]
TestNotification	3GPP TS 29.122 [22]	Represents a notification that can be sent to test whether a chosen notification mechanism works.	Notification_test_event
Uri	3GPP TS 29.571 [11]
WebsockNotifConfig	3GPP TS 29.122 [22]	Pepresents configuration for the delivery of notifications over Websockets.	Notification_websocket

6.1.6.2 Structured data types

6.1.6.2.1 Introduction

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

6.1.6.2.2 Type: DownlinkMessageDeliveryData

Table 6.1.6.2.2-1: Definition of type DownlinkMessageDeliveryData

Attribute name	Data type	P	Cardinality	Description	Applicability
ueId	V2xUeId	O	0..1	Indicates an identifier of the V2X UE.
groupId	V2xGroupId	O	0..1	Indicates a group ID for which the V2X message is addressed.
geoId	GeoId	O	0..1	Indicates a geographical area identifier.
payload	V2xMessagePayload	M	1	Constains the V2X message payload carried by the V2X message
duration	DateTime	O	0..1	Identifies the absolute time at which the related Individual Downlink Message Delivery resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the NF service consumer. When omitted in the response, it indicates the resource is set to valid forever by the VAE server
NOTE: Either "ueId" attribute or "groupId" attribute shall be included.

6.1.6.2.3 Type: MessageDeliverySubscriptionData

Table 6.1.6.2.3-1: Definition of type MessageDeliverySubscriptionData

Attribute name	Data type	P	Cardinality	Description	Applicability
appSerId	AppServerId	M	1	Identity of the V2X application specific server.
serviceId	V2xServiceId	M	1	Indicates a V2X service ID to which the V2X message belongs to.
geoId	GeoId	O	0..1	Indicates a geographical area identifier.
notifUri	Uri	M	1	Contains the notification URI。
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.1.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.1.5.4.	Notification_websocket
suppFeat	SupportedFeatures	C	0..1	Indicates the features supported by the service consumer and VAE server. It shall be included in the request and response of the creation of individual Message Delivery Subscription resource.

6.1.6.2.4 Type: UplinkMessageDeliveryData

Table 6.1.6.2.4-1: Definition of type UplinkMessageDeliveryData

Attribute name	Data type	P	Cardinality	Description	Applicability
resourceUri	Uri	M	1	The resource URI of the individual Uplink Message Delivery Subscription related to the notification.
ueId	V2xUeId	M	1	Indicates an identifier of the V2X UE.
geoId	GeoId	O	0..1	Indicates a geographical area identifier.
payload	V2xMessagePayload	M	1	Contains the V2X message payload carried by the V2X message

6.1.6.3 Simple data types and enumerations

6.1.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.1.6.3.2 Simple data types

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

Table 6.1.6.3.2-1: Simple data types

Type Name	Type Definition	Description	Applicability
AppServerId	string	Identity of the V2X application specific server
GeoId	string	Defines a geographical area identifier.
V2xGroupId	string	Defines a group ID for which the V2X message is addressed.
V2xServiceId	string	Defines a V2X service ID to which the V2X message belongs to
V2xUeId	string	Identifier of the V2X UE
V2xMessagePayload	Bytes	V2X message payload carried by the V2X message.

6.2.6.3.3 Enumeration: Result

Table 6.2.6.3.3-1: Enumeration Result

Enumeration value	Description	Applicability
SUCCESS	Indicates that the downlink message delivery is successful.
FAIL	Indicates that the downlink message delivery is failed.

6.1.7 Error Handling

6.1.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_MessageDelivery 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_MessageDelivery Service API.

6.1.7.2 Protocol Errors

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

6.1.7.3 Application Errors

The application errors defined for the VAE_MessageDelivery service are listed in Table 6.1.7.3-1.

Table 6.1.7.3-1: Application errors

Application Error	HTTP status code	Description

6.1.8 Feature negotiation

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

Table 6.1.8-1: Supported Features

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