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.255  Word version:  19.0.0

Top   Top   Up   Prev   Next
0…   5…   6…   7…   7.1a…   7.2…   7.3…   7.4…   7.5…   7.6…   7.7…   7.8…   8…   A   B…   C… 
8 APIs  8.1 General  8.2 UAE server APIs  8.2.1 General  8.2.2 UAE_C2OperationModeManagement API  8.2.2.1 General  8.2.2.2 Manage_C2OperationMode operation  8.2.2.3 Notify_SelectedC2Mode  8.2.2.4 Notify_C2ModeSwitching  8.2.2.5 Notify_C2OperationModeManagementComplete  8.2.3 UAE_ RealtimeUAVStatus API  8.2.3.1 General  8.2.3.2 Subscribe_RealtimeUAVStatus operation  8.2.3.3 Unsubscribe_RealtimeUAVStatus operation  8.2.3.4 Notify_RealtimeUAVStatus operation  8.2.4 UAE_ChangeUSSManagement API  8.2.4.1 General  8.2.4.2 Manage_USSManagement operation  8.2.4.3 Notify_USSManagementComplete operation  8.2.4.4 Manage_USSChange operation  8.2.4.5 Notify_USSChange operation  8.2.4.6 Notify_USSChangeTrigger  8.2.5 UAE_DAASupport API  8.2.5.1 General  8.2.5.2 Manage_DAAManagement operation  8.2.5.3 Notify_DAAManagementComplete operation  8.2.5.4 Notify_DAAClientSupportEvent operation  8.2.5.5 Manage_DAAServerSupportEvent operation  8.2.6 UAE_UAVDynamicInfo API  8.2.6.1 General  8.2.6.2 Subscribe_UAVDynamicInfo operation  8.2.6.3 Unsubscribe_UAVDynamicInfo operation  8.2.6.4 Notify_UAVDynamicInfo operation 
...

 

8  APIs  p. 69

8.1  General  p. 69

The following UAE capabilities are offered as APIs:
  • UAE 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.
When UAS application specific server invokes a SEAL server API directly, the UAS application specific server acting as VAL server shall interact with the corresponding SEAL server over the SEAL-S reference point for the API invocation request and response as specified in TS 23.434.
Up

8.2  UAE server APIs  p. 69

8.2.1  General  p. 69

Table 8.2.1-1 illustrates the UAE server APIs.
API Name API Operations Known Consumer(s) Communication Type
UAE_C2OperationModeManagement APIManage_C2OperationModeUAS application specific serverRequest/ Response
Notify_SelectedC2Mode (NOTE)UAS application specific serverSubscribe/notify
Notify_C2ModeSwitching (NOTE)UAS application specific serverSubscribe/notify
Notify_C2OperationModeManagementComplete (NOTE)UAS application specific serverSubscribe/notify
UAE_RealtimeUAVStatus APISubscribe_RealtimeUAVStatusUAS application specific serverSubscribe/notify
Unsubscribe_RealtimeUAVStatusUAS application specific serverSubscribe/notify
Notify_RealtimeUAVStatusUAS application specific serverSubscribe/notify
UAE_ChangeUSSManagement APIManage_USSManagementUAS application specific serverRequest/ Response
Notify_USSManagementCompleteUAS application specific serverSubscribe/notify
Manage_USSChangeUAS application specific serverRequest/ Response
Notify_USSChangeUAS application specific serverSubscribe/notify
Notify_USSChangeTriggerUAS application specific serverSubscribe/notify
Manage_DAAManagementUAS application specific serverRequest/ Response
Notify_DAAManagementCompleteUAS application specific serverSubscribe/notify
Notify_DAAClientSupportEventUAS application specific serverSubscribe/notify
Manage_DAAServerSupportEventUAS application specific serverRequest/ Response
UAE_UAVDynamicInfo APISubscribe_UAVDynamicInfoUAS application specific serverSubscribe/ notify
Unsubscribe_UAVDynamicInfoUAS application specific serverSubscribe/ notify
Notify_UAVDynamicInfoUAS application specific serverSubscribe/ notify
NOTE:
The subscribe operation for Notify_C2OperationModeManagementComplete, Notify_SelectedC2Mode and Notify_C2ModeSwitching is part of Manage_C2OperationMode.
Up

8.2.2  UAE_C2OperationModeManagement API  p. 71

8.2.2.1  General  p. 71

API description:
This API enables the UAS application specific server to communicate with the UAE server to send configurations for C2 operation modes for the UAS and receive notifications of the selected C2 communication modes from the UAS UEs (i.e. UAV, UAV-C).

8.2.2.2  Manage_C2OperationMode operation  p. 71

API operation name:
Manage_C2OperationMode
Description:
Manage (initiate, change or delete) the configuration of the C2 operation modes for the UAS UEs.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.4.3.1.
Outputs:
Refer clause 7.4.3.2.
See clause 7.4.2.1 for the details of usage of this API operation.

8.2.2.3  Notify_SelectedC2Mode  p. 71

API operation name:
Notify_SelectedC2Mode
Description:
Notification of the selected C2 communication modes from the UAS UEs.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.4.3.10.
Outputs:
Refer clause 7.4.3.11.
See clause 7.4.2.3 for the details of usage of this API operation.

8.2.2.4  Notify_C2ModeSwitching  p. 71

API operation name:
Notify_C2ModeSwitching
Description:
Notification of the C2 communication mode switching from the UAS UEs.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.4.3.5.
Outputs:
Refer clause 7.4.3.6.
See clause 7.4.2.4 for the details of usage of this API operation.

8.2.2.5  Notify_C2OperationModeManagementComplete  p. 71

API operation name:
Notify_C2OperationModeManagementComplete
Description:
Notification about the C2 operation mode management completion by UAE server.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.4.3.3.
Outputs:
None.
See clause 7.4.2.1 for the details of usage of this API operation.

8.2.3  UAE_ RealtimeUAVStatus API  p. 72

8.2.3.1  General  p. 72

API description:
This API enables the UAS application specific server to subscribe for and receive notifications for the realtime status information of the UAV.

8.2.3.2  Subscribe_RealtimeUAVStatus operation  p. 72

API operation name:
Subscribe_RealtimeUAVStatus
Description:
Subscription for obtaining the realtime UAV status information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.5.3.2.
Outputs:
Refer clause 7.5.3.3.
See clause 7.5.2.2 for the details of usage of this API operation.

8.2.3.3  Unsubscribe_RealtimeUAVStatus operation  p. 72

API operation name:
Unsubscribe_RealtimeUAVStatus
Description:
Unsubscription for a existing subscription for obtaining the realtime UAV status information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.5.3.5.
Outputs:
Refer clause 7.5.3.6.
See clause 7.5.2.4 for the details of usage of this API operation.

8.2.3.4  Notify_RealtimeUAVStatus operation  p. 72

API operation name:
Notify_RealtimeUAVStatus
Description:
Notification of the realtime UAV status information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.5.3.4.
Outputs:
None.
See clause 7.5.2.3 for the details of usage of this API operation.

8.2.4  UAE_ChangeUSSManagement API |R18|  p. 72

8.2.4.1  General  p. 72

API description:
This API enables the UAS application specific server to communicate with the UAE server to send policies, requests for change of USS for the UAS and receive notifications from the UAS UEs (i.e. UAV) about change of USS.

8.2.4.2  Manage_USSManagement operation  p. 72

API operation name:
Manage_USSManagement
Description:
Manage (initiate, change or delete) the configuration of the policies for change of USS for the UAS UEs.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.6.3.1.
Outputs:
Refer clause 7.6.3.2.
See clause 7.6.2.1 for the details of usage of this API operation.

8.2.4.3  Notify_USSManagementComplete operation  p. 73

API operation name:
Notify_USSManagementComplete
Description:
Notification about the USS management completion by UAE server.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.6.3.3.
Outputs:
None.
See clause 7.6.2.1 for the details of usage of this API operation.

8.2.4.4  Manage_USSChange operation  p. 73

API operation name:
Manage_USSChange
Description:
Manage change of USS on request from UAS application specific server.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.6.3.6.
Outputs:
Refer clause 7.6.3.7.
See clause 7.6.2.3 for the details of usage of this API operation.

8.2.4.5  Notify_USSChange operation  p. 73

API operation name:
Notify_USSChange
Description:
Notification about the change of USS required by UAS UE.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.6.3.8.
Outputs:
None.
See clause 7.6.2.4 for the details of usage of this API operation.

8.2.4.6  Notify_USSChangeTrigger  p. 73

API operation name:
Notify_USSChangeTrigger
Description:
Notify a trigger event related to the recommended change of USS.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.6.3.9.
Outputs:
None.
See clause 7.6.2.5 for the details of usage of this API operation.

8.2.5  UAE_DAASupport API |R18|  p. 74

8.2.5.1  General  p. 74

API description:
This API enables the UAS application specific server to communicate with the UAE server for the DAA application policy and send and receive notifications related with DAA support aspects between the USS and the UAE client.

8.2.5.2  Manage_DAAManagement operation  p. 74

API operation name:
Manage_DAAManagement
Description:
Manage (initiate, change or delete) configuration of the DAA application policy.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.7.3.1.
Outputs:
Refer clause 7.7.3.2.
See clause 7.7.2.1.1 for the details of usage of this API operation.

8.2.5.3  Notify_DAAManagementComplete operation  p. 74

API operation name:
Notify_DAAManagementComplete
Description:
Notification about the DAA management completion by UAE server.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.7.3.3.
Outputs:
None.
See clause 7.7.2.1.1 for the details of usage of this API operation.

8.2.5.4  Notify_DAAClientSupportEvent operation  p. 74

API operation name:
Notify_DAAClientSupportEvent
Description:
Notification about possible UAVs in proximity, identified by the client.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.7.3.6.
Outputs:
Refer clause 7.7.3.7.
See clause 7.7.2.2.1 for the details of usage of this API operation.

8.2.5.5  Manage_DAAServerSupportEvent operation  p. 74

API operation name:
Manage_DAAServerSupport
Description:
Notification about possible UAVs in proximity, identified by the server.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.7.3.8.
Outputs:
Refer clause 7.7.3.9.
See clause 7.7.2.2.2 for the details of usage of this API operation.

8.2.6  UAE_UAVDynamicInfo API |R18|  p. 75

8.2.6.1  General  p. 75

API description:
This API enables the UAS application specific server to subscribe for and receive notifications for the host UAV dynamic information.

8.2.6.2  Subscribe_UAVDynamicInfo operation  p. 75

API operation name:
Subscribe_UAVDynamicInfo
Description:
Subscription for obtaining the UAV dynamic information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.8.3.1.
Outputs:
Refer clause 7.8.3.2.
See clause 7.8.2.1 for the details of usage of this API operation.

8.2.6.3  Unsubscribe_UAVDynamicInfo operation  p. 75

API operation name:
Unsubscribe_UAVDynamicInfo
Description:
Unsubscription for a existing subscription for obtaining the UAV dynamic information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.8.3.5.
Outputs:
Refer clause 7.8.3.6.
See clause 7.8.2.5 for the details of usage of this API operation.

8.2.6.4  Notify_UAVDynamicInfo operation  p. 75

API operation name:
Notify_UAVDynamicInfo
Description:
Notification of the UAV dynamic information.
Known Consumers:
UAS application specific server.
Inputs:
Refer clause 7.8.3.4.
Outputs:
None.
See clause 7.8.2.4 for the details of usage of this API operation.

Up   Top   ToC