Tech-invite  3GPPspace  IETFspace
◀  ▶  21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x

Content for  TS 23.286  Word version:  19.0.0

Top   Top   Up   Prev   Next
0…   6…   7…   9…   9.2…   9.3…   9.4…   9.5…   9.6…   9.7…   9.8…   9.9…   9.10…   9.11…   9.12…   9.13…   9.14…   9.15…   9.16…   9.17…   9.18   9.19…   9.20…   9.21…   9.22…   10…   A… 
10 VAE layer APIs  10.1 General  10.2 VAE server APIs  10.2.1 General  10.2.2 VAE_MessageDelivery API  10.2.3 VAE_FileDistribution API  10.2.4 VAE_ApplicationRequirement API  10.2.5 VAE_DynamicGroup API  10.2.6 VAE_ServiceContinuity API  10.2.7 VAE_HDMapDynamicInfo API  10.2.8 VAE_SessionOrientedService API  10.2.9 VAE_PC5ProvisioningRequirement API  10.2.10 VAE_V2VConfigRequirement API  10.2.11 VAE_ ServiceAndQoSControlInfo API  10.2.12 VAE_ VRUzoneManagement API  10.2.13 VAE_ V2PApplicationRequirement 

 

10  VAE layer APIs  p. 105

10.1  General  p. 105

The following VAE capabilities are offered as APIs:
  • VAE server APIs;
The following SEAL service APIs are specified in TS 23.434:
  • Group management server APIs;
  • Location management server APIs;
  • Configuration management server APIs;
  • Identity management server APIs; and
  • Key management server APIs.

10.2  VAE server APIs  p. 105

10.2.1  General  p. 105

Table 10.2.1-1 illustrates the VAE server APIs.
API Name API Operations Known Consumer(s) Communication Type
VAE_MessageDelivery APIDeliver_DL_MessageV2X application specific serverRequest/ Response
Deliver_UL_MessageV2X application specific serverSubscribe/notify
V2X_MessageDelivery_Subscribe
V2X_MessageDelivery_Unsubscribe
VAE_FileDistribution APIDistribute_FileV2X application specific serverRequest/ Response
VAE_ApplicationRequirement APIReserve_NetworkResourceV2X application specific serverSubscribe/ notify
Notify_NetworkResource
VAE_DynamicGroup APIConfigure_DynamicGroupV2X application specific serverRequest/Response
Notify_DynamicGroup
VAE_ServiceContinuity APIQuery_ServiceContinuityVAE serverRequest/Response
VAE_HDMapDynamicInfo APISubscribe_HDMapDynamicInfoV2X application specific serverSubscribe/notify
Notify_HDMapDynamicInfo
VAE_SessionOrientedService APIEstablish_SessionV2X application specific serverSubscribe/notify
Notify_Establish_Session
Update_Session
Notify_Update_Session
Terminate_Session
Notify_Terminate_Session
VAE_PC5ProvisioningRequirement APIConfig_PC5ProvisioningRequirementV2X application specific serverSubscribe/notify
Notify_PC5ProvisioningRequirement
VAE_V2VConfigRequirement APIRequest_V2VConfigRequirementV2X application specific serverRequest/Response
VAE_ServiceAdaptationQoSControlInfo APISubscribe_ServiceandQoSControlInfoV2X application specific serverSubscribe/notify
Notify_ServicandQoSControlInfo
VAE_VRUzoneManagement APISubscribe_VRUzoneManagement operationV2X application specific serverSubscribe/notify
Notify_Enter/Leave
VAE_V2PApplicationRequirement APIRequest_V2PApplicationRequirementV2X application specific server, V2X application specific clientRequest/Response
The SEAL server(s) APIs available via SEAL-S reference point as specified in TS 23.434 are consumed by the V2X application specific server via the VAE server (acting as a VAL server) over the Vs reference point. When V2X application specific server invokes a SEAL server API via the VAE server over the Vs reference point, the VAE server shall interact with the corresponding SEAL server over the SEAL-S reference point for the API invocation request and response.
Up

10.2.2  VAE_MessageDelivery API  p. 107

10.2.2.1  General  p. 107

API description: This API enables the V2X application specific server to subscribe/unsubscribe to the VAE server and communicate with the VAE server to send and receive V2X messages to and from the V2X UEs (including V2X groups).

10.2.2.2  Deliver_DL_Message operation  p. 107

API operation name:
Deliver_DL_Message
Description:
Delivers the V2X messages to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.4.2.1, 9.4.2.3.
Outputs:
None.
See subclause 9.4.3 and subclause 9.4.4 for the details of usage of this API operation.

10.2.2.3  Deliver_UL_Message operation  p. 107

API operation name:
Deliver_UL_Message
Description:
Delivers the uplink V2X messages from the V2X UEs to the V2X application specific server.
Known Consumers:
V2X application specific server.
Inputs:
None
Outputs:
Refer subclause 9.4.2.4.
See subclause 9.4.5 for the details of usage of this API operation.

10.2.2.4  V2X_MessageDelivery_Subscribe operation  p. 107

API operation name:
V2X_MessageDelivery_Subscribe
Description:
Subscribe to the VAE server for sending and receiving V2X messages.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.4.2.6.
Outputs:
Refer subclause 9.4.2.7.
See subclause 9.4.6 for the details of usage of this API operation.

10.2.2.5  V2X_MessageDelivery_Unsubscribe operation  p. 107

API operation name:
V2X_MessageDelivery_Unsubscribe
Description:
Unsubscribe to the VAE server for sending and receiving V2X messages.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.4.2.8.
Outputs:
Refer subclause 9.4.2.9.
See subclause 9.4.6 for the details of usage of this API operation.

10.2.3  VAE_FileDistribution API  p. 108

10.2.3.1  General  p. 108

API description: This API enables the V2X application specific server to communicate with the VAE server to initiate file distribution to the V2X UEs.

10.2.3.2  Distribute_File operation  p. 108

API operation name:
Distribute_File
Description:
Distributes files to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.5.2.
Outputs:
Refer subclause 9.5.2.
See subclause 9.5.2 for the details of usage of this API operation.

10.2.4  VAE_ApplicationRequirement API  p. 108

10.2.4.1  General  p. 108

API description: This API enables the V2X application specific server to communicate with the VAE server to provide V2X application requirement to the underlying 3GPP network.

10.2.4.2  Reserve_NetworkResource operation  p. 108

API operation name:
Reserve_NetworkResource
Description:
Provides V2X application requirement to underlying 3GPP network.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.11.2.1
Outputs:
Refer subclause 9.11.2.2
See subclause 9.11.3 for the details of usage of this API operation.

10.2.4.3  Notify_NetworkResource operation  p. 108

API operation name:
Notify_NetworkResource
Description:
Notify the result of network resource adaptation corresponding to the V2X application requirement.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.11.2.3
Outputs:
None
See subclause 9.11.3 for the details of usage of this API operation.

10.2.5  VAE_DynamicGroup API  p. 109

10.2.5.1  General  p. 109

API description: This API enables the V2X application specific server to communicate with the VAE server to configure dynamic group information.

10.2.5.2  Configure_DynamicGroup operation  p. 109

API operation name:
Configure_DynamicGroup
Description:
Configures the dynamic group information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.12.2.2.
Outputs:
Refer subclause 9.12.2.3.
See subclause 9.12.3 for the details of usage of this API operation.

10.2.5.3  Notify_DynamicGroup operation  p. 109

API operation name:
Notify_DynamicGroup
Description:
Notify the dynamic group information (i.e. group member joins or leaves) at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.12.2.4.
Outputs:
None.
See subclause 9.12.5 for the details of usage of this API operation.

10.2.6  VAE_ServiceContinuity API  p. 109

10.2.6.1  General  p. 109

API description: This API enables the VAE server to query whether the target VAE server can serve the GEO ID and V2X Service ID for service continuity.

10.2.6.2  Query_ServiceContinuity operation  p. 109

API operation name:
Query_ServiceContinuity
Description:
Query the service continuity information.
Known Consumers:
VAE server.
Inputs:
Refer subclause 9.10.2.1.
Outputs:
Refer subclause 9.10.2.2.
See subclause 9.10.3 for the details of usage of this API operation.

10.2.7  VAE_HDMapDynamicInfo API |R17|  p. 110

10.2.7.1  General  p. 110

API description:
This API enables the V2X application specific server to communicate with the VAE server to subscribe and receive notifications for HD map dynamic information.

10.2.7.2  Subscribe_HDMapDynamicInfo operation  p. 110

API operation name:
Subscribe_HDMapDynamicInfo
Description:
Subscribes for the HD map dynamic information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.16.2.1.
Outputs:
Refer subclause 9.16.2.2.
See subclause 9.16.3 for the details of usage of this API operation.

10.2.7.3  Notify_HDMapDynamicInfo operation  p. 110

API operation name:
Notify_HDMapDynamicInfo
Description:
Notify the HD map dynamic information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.16.2.3.
Outputs:
None.
See subclause 9.16.6 for the details of usage of this API operation.

10.2.8  VAE_SessionOrientedService API |R17|  p. 110

10.2.8.1  General  p. 110

API description:
This API enables the V2X application specific server to communicate with the VAE server to trigger establishment, update and termination of session-oriented service.

10.2.8.2  Establish_Session operation  p. 110

API operation name:
Establish_Session
Description:
Triggers the establishment of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.1.
Outputs:
Refer subclause 9.19.2.2.
See subclause 9.19.4.2 for the details of usage of this API operation.

10.2.8.3  Notify_Establish_Session operation  p. 110

API operation name:
Notify_Establish_Session
Description:
Notification about the establishment of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.3.
Outputs:
None.
See subclause 9.19.5.2 for the details of usage of this API operation.

10.2.8.4  Update_Session operation  p. 111

API operation name:
Update_Session
Description:
Triggers the update to the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.4.
Outputs:
Refer subclause 9.19.2.5.
See subclause 9.19.4.3 for the details of usage of this API operation.

10.2.8.5  Notify_Update_Session operation  p. 111

API operation name:
Notify_Update_Session
Description:
Notification about the update to the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.6.
Outputs:
None.
See subclause 9.19.5.3 for the details of usage of this API operation.

10.2.8.6  Terminate_Session operation  p. 111

API operation name:
Terminate_Session
Description:
Triggers the termination of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.7.
Outputs:
Refer subclause 9.19.2.8.
See subclause 9.19.5.4 for the details of usage of this API operation.

10.2.8.7  Notify_Terminate_Session operation  p. 111

API operation name:
Notify_Terminate_Session
Description:
Notification about the termination of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.19.2.9.
Outputs:
None.
See subclause 9.19.5.4 for the details of usage of this API operation.

10.2.9  VAE_PC5ProvisioningRequirement API |R17|  p. 112

10.2.9.1  General  p. 112

API description:
This API enables the V2X application specific server to communicate with the VAE server to request from VAE server the PC5 provisioning service in multi-operator V2X scenarios.

10.2.9.2  Config_PC5ProvisioningRequirement operation  p. 112

API operation name:
Config_PC5ProvisioningRequirement
Description:
The V2X application specific server provides a V2X PC5 provisioning requirement to the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.15.2.1
Outputs:
Acknowledgement message.
See subclause 9.15.3 for the details of usage of this API operation.

10.2.9.3  Notify_PC5ProvisioningRequirement operation  p. 112

API operation name:
Notify_ PC5ProvisioningRequirement
Description:
Notify the result of multi operation PC5 provisioning requirement to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.15.2.6
Outputs:
None
See subclause 9.15.3 for the details of usage of this API operation.

10.2.10  VAE_V2VConfigRequirement API |R17|  p. 112

10.2.10.1  General  p. 112

API description:
This API enables the V2X application specific server to provide a V2V configuration requirement to the VAE server to manage the UE-to-UE broadcast/groupcast communication.

10.2.10.2  Request_V2VConfigRequirement operation  p. 112

API operation name:
Request_V2VConfigRequirement
Description:
The V2X application specific server provides a V2V configuration requirement request to the VAE server to manage the UE-to-UE broadcast/groupcast communication.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.17.2.1
Outputs:
Refer subclause 9.17.2.2
See subclause 9.17.3 for the details of usage of this API operation.

10.2.11  VAE_ ServiceAndQoSControlInfo API |R18|  p. 113

10.2.11.1  General  p. 113

API description:
This API enables the V2X application specific server to communicate with the VAE server to subscribe and receive notifications for service adaptation and QoS control information.

10.2.11.2  Subscribe_ ServiceAndQoSControlInfo operation  p. 113

API operation name:
Subscribe_ ServiceAndQoSControlInfo
Description:
Subscribes for the service adaptation and QoS control information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.20.2.1.
Outputs:
Refer subclause 9.20.2.2.
See subclause 9.20.3 for the details of usage of this API operation.
This service operation also enables to update/delete an existing subscription at the VAE server. For the update case, the parameters that may be updated are V2X group ID, V2X service ID, and V2X UE ID.
Up

10.2.11.3  Notify_ ServiceAndQoSControlInfo operation  p. 113

API operation name:
Notify_ ServiceAndQoSControlInfo
Description:
Notify the service adaptation and QoS control information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.20.2.3.
Outputs:
None.
See subclause 9.20.4 for the details of usage of this API operation.

10.2.12  VAE_ VRUzoneManagement API |R18|  p. 113

10.2.12.1  General  p. 113

API description:
This API enables the V2X application specific server to communicate with the VAE server to subscribe and receive notifications for VRU zone management.

10.2.12.2  Subscribe_VRUzoneManagement operation  p. 113

API operation name:
Subscribe_VRUzoneManagement
Description:
Subscribes for the VRU zone management / configuration at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.21.2.1.
Outputs:
Refer subclause 9.21.2.2.
See subclause 9.21.3 for the details of usage of this API operation.

10.2.12.3  Notify_ Enter/Leave operation  p. 113

API operation name:
Notify_ Enter/Leave
Description:
Notify the entry or leave of the V2X UE to / from the VRU zone area, based on the subscription.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.21.2.4.
Outputs:
None.
See subclause 9.21.3 for the details of usage of this API operation.

10.2.13  VAE_ V2PApplicationRequirement |R18|  p. 114

10.2.13.1  General  p. 114

API description:
This API enables the V2X application specific server or the V2X application specific client to communicate with the VAE server to provide a requirement to manage the support functionality for enabling V2P applications.

10.2.13.2  Request_V2PApplicationRequirement  p. 114

API operation name:
Request_V2PApplicationRequirement
Description:
The V2X application specific server or client provides a V2P application requirement request to the VAE server to provide the support functionality for enabling V2P applications.
Known Consumers:
V2X application specific server, V2X application specific client.
Inputs:
Refer subclause 9.22.2.1.
Outputs:
Refer subclause 9.22.2.2.
See subclause 9.22.3.1 and 9.22.3.2 for the details of usage of this API operation.

Up   Top   ToC