6.5 VAE_ServiceContinuity Service API
29.4863GPPRelease 18Stage 3TSV2X Application Enabler (VAE) Services
6.5.1 Introduction
The VAE_ServiceContinuity shall use the VAE_ServiceContinuity API.
The API URI of the VAE_ServiceContinuity 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-service-continuity".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.5.3.
6.5.2 Usage of HTTP
6.5.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_ServiceContinuity is contained in Annex A.6.
6.5.2.2 HTTP standard headers
6.5.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [2] for the usage of HTTP standard headers.
6.5.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.5.2.3 HTTP custom headers
6.5.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.5.3 Resources
6.5.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.5.3.1-1 depicts the resource URIs structure for the VAE_ServiceContinuity API.
Figure 6.5.3.1-1: Resource URI structure of the VAE_ServiceContinuity API
Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.5.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
Individual Geographical Area |
/geo-areas/{geoId} |
GET |
Query the Individual Geographical Area resource. |
6.5.3.2 Resource: Individual Geographical Area
6.5.3.2.1 Description
This resource represents the individual geographical area resource in the VAE Server.
6.5.3.2.2 Resource Definition
Resource URI: {apiRoot}/vae-service-continuity/<apiVersion>/geo-areas/{geoId}
This resource shall support the resource URI variables defined in table 6.5.3.2.2-1.
Table 6.5.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.5.1 |
|
geoId |
string |
Geographical area id. |
6.5.3.2.3 Resource Standard Methods
6.5.3.2.3.1 GET
This method shall support the URI query parameters specified in table 6.5.3.2.3.1-1.
Table 6.5.3.2.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
service-id |
V2xServiceId |
M |
1 |
V2X service id |
|
|
supp-feat |
SupportedFeatures |
O |
0..1 |
To filter irrelevant responses related to unsupported features. |
This method shall support the request data structures specified in table 6.5.3.2.3.1-2 and the response data structures and response codes specified in table 6.5.3.2.3.1-3.
Table 6.5.3.2.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.5.3.2.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
V2xServiceInfo |
M |
1 |
200 OK |
An individual geographical area resource including the designated V2X service id is returned successfully. |
|
n/a |
307 Temporary Redirect |
Temporary redirection, during Individual geographical area resource 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 geographical area resource 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.5.3.2.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.5.3.2.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.5.3.2.4 Resource Custom Operations
None.
6.5.4 Custom Operations without associated resources
There are no custom operations without associated resources supported on VAE_ServiceContinuity.
6.5.5 Notifications
Notifications are not applicable for the current Release.
6.5.6 Data Model
6.5.6.1 General
This clause specifies the application data model supported by the API.
Table 6.5.6.1-1 specifies the data types defined for the VAE_ServiceContinuity API.
Table 6.5.6.1-1: VAE_ServiceContinuity specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
V2xServiceInfo |
6.5.6.2.2 |
Represents an individual geographical area resource including the designated V2X service identifier. |
Table 6.5.6.1-2 specifies data types re-used by the VAE_ServiceContinuity 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_ServiceContinuity service based interface.
Table 6.5.6.1-2: VAE_ServiceContinuity re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
V2xServiceId |
6.1.6.3.2 |
Defines a V2X service ID. |
6.5.6.2 Structured data types
6.5.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.5.6.2.2 Type: V2xServiceInfo
Table 6.5.6.2.2-1: Definition of type V2xServiceInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
serviceIds |
array(V2xServiceId) |
M |
1..N |
Indicates a list of supported V2X service identifiers. |
|
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the features supported by the service consumer and VAE server. It shall be included if the query request includes supported features. |
6.5.6.3 Simple data types and enumerations
6.5.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.5.6.3.2 Simple data types
The simple data types defined in table 6.5.6.3.2-1 shall be supported.
Table 6.5.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
6.5.7 Error Handling
6.5.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_ServiceContinuity 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_ServiceContinuity Service API.
6.5.7.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the VAE_ServiceContinuity API.
6.5.7.3 Application Errors
The application errors defined for the VAE_ServiceContinuity service are listed in Table 6.5.7.3-1.
Table 6.5.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
6.5.8 Feature negotiation
The optional features in table 6.5.8-1 are defined for the VAE_ServiceContinuity API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [2].
Table 6.5.8-1: Supported Features
|
Feature number |
Feature Name |
Description |