Content for TS 23.437 Word version: 20.1.0
8.5 SEAL APIs for spatial anchor management
8.5.1 General
8.5.2 SS_SAnManagement API
8.5.3 SS_SAnDiscovery API
8.5.4 SS_SAnUsageInfo API
8.5.5 SS_SAnUsageReport API
...
...
8.5 SEAL APIs for spatial anchor management p. 49
8.5.1 General p. 49
Table 8.5.1-1 illustrates the SEAL APIs for spatial anchor management.
| API Name | API Operations | Known Consumer(s) | Communication Type |
|---|---|---|---|
| SS_ | Create | VAL server, SAn client | Request/Response |
| Update | VAL server, SAn client | ||
| Delete | VAL server, SAn client | ||
| Get | VAL server, SAn client | ||
| Subscribe | VAL server, SAn client | Subscribe/Notify | |
| Notify | VAL server, SAn client | ||
| UpdateSubscription | VAL server, SAn client | ||
| Unsubscribe | VAL server, SAn client | ||
| SS_ | Request | SAn client, VAL server | Request/Response |
| SS_ | Request | VAL server | Request/Response |
| Subscribe | VAL server | Subscribe/Notify | |
| Notify | VAL server | ||
| SS_ | Request | VAL server, SAn client | Request/Response |
8.5.2 SS_SAnManagement API p. 49
8.5.2.1 General p. 49
Service description:
This API enables a VAL server (or SAn client) to manage spatial anchors on SEAL SAn server.
8.5.2.2 Create operation p. 49
API operation name:
SS_SAnManagement_Create
Description:
The consumer requests to create spatial anchors.
Known Consumers:
VAL server, SAn client.
Inputs:
See Table 8.3.1.3.1-1.
Outputs:
See Table 8.3.1.3.2-1.
See clause 8.3.1 for details of usage of this operation.
8.5.2.3 Update operation p. 49
API operation name:
SS_SAMnanagement_Update
Description:
The consumer requests to update spatial anchors.
Known Consumers:
VAL server, SAn client.
Inputs:
See Table 8.3.2.3.1-1.
Outputs:
See Table 8.3.2.3.2-1.
See clause 8.3.2 for details of usage of this operation.
8.5.2.4 Delete operation p. 50
API operation name:
SS_SAnManagement_Delete
Description:
The consumer requests to delete spatial anchors.
Known Consumers:
VAL server, SAn client.
Inputs:
See Table 8.3.3.3.1-1.
Outputs:
See Table 8.3.3.3.2-1.
See clause 8.3.3 for details of usage of this operation.
8.5.2.5 Retrieve operation p. 50
API operation name:
SS_SAnManagement_Retrieve
Description:
The consumer requests to get spatial anchor profile.
Known Consumers:
VAL server, SAn client.
Inputs:
See Table 8.3.6.3.1-1.
Outputs:
See Table 8.3.6.3.2-1.
See clause 8.3.6 for details of usage of this operation.
8.5.2.6 Subscribe operation p. 50
API operation name:
SS_SAnManagement_Subscribe
Description:
The consumer subscribes for spatial anchors information.
Inputs:
See clause 8.3.5.3.1.
Outputs:
See clause 8.3.5.3.2.
See clause 8.3.5.2.1 for details of usage of this operation.
8.5.2.7 Notify operation p. 50
API operation name:
SS_SAnManagement_Notify
Description:
The consumer is notified with spatial anchors information.
Inputs:
See clause 8.3.5.3.3.
Outputs:
None.
See clause 8.3.5.2.2 for details of usage of this operation.
8.5.2.8 UpdateSubscription operation p. 50
API operation name:
SS_SAnManagement_UpdateSubscription
Description:
The consumer updates an existing subscription for spatial anchors information.
Inputs:
See clause 8.3.5.3.4.
Outputs:
See clause 8.3.5.3.5.
See clause 8.3.5.2.3 for details of usage of this operation.
8.5.2.9 Unsubscribe operation p. 51
API operation name:
SS_SAnManagement_Unsubscribe
Description:
The consumer cancels an existing subscription for spatial anchors information.
Inputs:
See clause 8.3.5.3.6.
Outputs:
See clause 8.3.5.3.7.
See clause 8.3.5.2.4 for details of usage of this operation.
8.5.3 SS_SAnDiscovery API p. 51
8.5.3.1 General p. 51
Service description:
This API enables a VAL server or SAn client to discover spatial anchors from SEAL SAn server.
8.5.3.2 Request operation p. 51
API operation name:
SS_SAnDiscovery_Request
Description:
The consumer requests to discover spatial anchors.
Known Consumers:
VAL server, SAn client.
Inputs:
See Table 8.3.4.3.1-1.
Outputs:
See Table 8.3.4.3.2-1.
See clause 8.3.4 for details of usage of this operation.
8.5.4 SS_SAnUsageInfo API p. 51
8.5.4.1 General p. 51
Service description:
This API enables a VAL server to get spatial anchor usage information from the SEAL SAn server.
8.5.4.2 Request operation p. 51
API operation name:
SS_SAnUsageInfo_Request
Description:
The consumer requests for spatial anchors usage information.
Inputs:
See clause 8.4.3.3.1.
Outputs:
See clause 8.4.3.3.2.
See clause 8.4.3 for details of usage of this operation.
8.5.4.3 Subscribe operation p. 51
API operation name:
SS_SAnUsageInfo_Subscribe
Description:
The consumer subscribes for spatial anchors usage information.
Inputs:
See clause 8.4.2.3.1.
Outputs:
See clause 8.4.2.3.2.
See clause 8.4.2.2 for details of usage of this operation.
8.5.4.4 Notify operation p. 52
API operation name:
SS_SAnUsageInfo_Notify
Description:
The consumer is notified with spatial anchors usage information.
Inputs:
See clause 8.4.2.3.3.
Outputs:
None.
See clause 8.4.2.2 for details of usage of this operation.
8.5.5 SS_SAnUsageReport API p. 52
8.5.5.1 General p. 52
Service description: This API enables a VAL server or SAn client to report spatial anchor usage information to the SEAL SAn server.
8.5.5.2 Request operation p. 52
API operation name:
SS_SAnUsageReport_Request
Description:
The consumer provides spatial anchors usage information.
Inputs:
See clause 8.4.4.3.1.
Outputs:
See clause 8.4.4.3.2.
See clause 8.4.4 for details of usage of this operation.
