Content for TS 23.437 Word version: 20.1.0
9.7 SEAL APIs for spatial map management
9.7.1 General
9.7.2 SS_SmManagement API
9.7.3 SS_SmDiscovery API
9.7.4 SS_SmLocalization API
9.7.5 SS_SmDataSourceRegistration API
9.7.6 SS_SmDataSourceDiscovery API
9.7.7 SS_SmSmasRegistration API
$ Change history
9.7 SEAL APIs for spatial map management p. 84
9.7.1 General p. 84
Table 9.7.1-1 illustrates the SEAL APIs for spatial map management.
| API Name | API Operations | Known Consumer(s) | Communication Type |
|---|---|---|---|
| SS_ | Create | VAL server, SEAL SM client | Request/Response |
| Get | VAL server, SEAL SM client | ||
| Update | VAL server, SEAL SM client | ||
| Delete | VAL server, SEAL SM client | ||
| Subscribe | VAL server, SEAL SM client | Subscribe/Notify | |
| Notify | VAL server, SEAL SM client | ||
| Unsubscribe | VAL server, SEAL SM client | ||
| SS_ | Request | SEAL SM client, VAL server | Request/Response |
| SS_ | Request | VAL server, SEAL SM client | Request/Response |
| SS_ | Request | SEAL SM client | Request/Response |
| Update | SEAL SM client | ||
| Deregister | SEAL SM client | ||
| SS_ | Request | VAL server | Request/Response |
| Notify | SEAL SM client | Notify | |
| SS_ | Request | VAL server | Request/Response |
| Update | VAL server | ||
| Deregister | VAL server |
9.7.2 SS_SmManagement API p. 85
9.7.2.1 General p. 85
Service description:
This API enables the VAL server or SEAL SM client to manage spatial maps on SEAL SM server.
9.7.2.2 Create operation p. 85
API operation name:
SS_SmManagement_Create
Description:
Create a spatial map in the given three-dimensional area of interest.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.1.3.1-1
Outputs:
Refer Table 9.3.1.3.2-1
See clause 9.3.1 for the details of usage of this API operation.
9.7.2.3 Get operation p. 85
API operation name:
SS_SmManagement_Get
Description:
Provide requested spatial map information to the authorized consumers.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.3.3.1-1
Outputs:
Refer Table 9.3.3.3.2-1
See clause 9.3.3 for the details of usage of this API operation.
9.7.2.4 Update operation p. 86
API operation name:
SS_SmManagement_Update
Description:
Update the information on a spatial map as requested.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.4.3.1-1
Outputs:
Refer Table 9.3.4.3.2-1
See clause 9.3.4 for the details of usage of this API operation.
9.7.2.5 Delete operation p. 86
API operation name:
SS_SmManagement_Delete
Description:
Delete spatial map.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.5.3.1-1
Outputs:
Refer Table 9.3.5.3.2-1
See clause 9.3.5 for the details of usage of this API operation.
9.7.2.6 Subscribe operation p. 86
API operation name:
SS_SmManagement_Subscribe
Description:
Process the authorized consumer's subscription to the spatial map events.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.6.3.1-1
Outputs:
Refer Table 9.3.6.3.2-1
See clause 9.3.6.2.1 for the details of usage of this API operation.
9.7.2.7 Notify operation p. 86
API operation name:
SS_SmManagement_Notify
Description:
Notify the information on the detected triggering events to which the authorized consumers are subscribed.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
None
Outputs:
Refer Table 9.3.6.3.3-1
See clause 9.3.6.2.2 for the details of usage of this API operation.
9.7.2.8 Unsubscribe operation p. 86
API operation name:
SS_SmManagement_Unsubscribe
Description:
Revoke the authorized consumer's subscription to the spatial map events.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.6.3.4-1
Outputs:
Refer Table 9.3.6.3.5-1
See clause 9.3.6.2.3 for the details of usage of this API operation.
9.7.3 SS_SmDiscovery API p. 87
9.7.3.1 General p. 87
Service description:
This API enables the VAL server or SEAL SM client to discover spatial maps and SMAS from the SEAL SM server.
9.7.3.2 Request operation p. 87
API operation name:
SS_SmDiscovery_Request
Description:
Discover spatial maps or SMAS in the given three-dimensional area of interest.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.3.2.3.1-1
Outputs:
Refer Table 9.3.2.3.2-1
See clause 9.3.2 for the details of usage of this API operation.
9.7.4 SS_SmLocalization API p. 87
9.7.4.1 General p. 87
Service description:
This API enables the VAL server or SEAL SM client to get localization information from the spatial maps.
9.7.4.2 Request operation p. 87
API operation name:
SS_SmLocalization_Request
Description:
Get localization information of the requested object from the spatial map.
Known Consumers:
VAL server, SEAL SM client.
Inputs:
Refer Table 9.4.3.1-1
Outputs:
Refer Table 9.4.3.2-1
See clause 9.4.2 for the details of usage of this API operation.
9.7.5 SS_SmDataSourceRegistration API p. 87
9.7.5.1 General p. 87
Service description:
This API enables the SM data source to register, update register or deregister with SEAL SM server.
9.7.5.2 Request operation p. 87
API operation name:
SS_SmDataSourceRegistration_Request
Description:
registers the SM data source to the SEAL SM server.
Known Consumers:
SEAL SM client.
Inputs:
Refer Table 9.5.2.3.1-1
Outputs:
Refer Table 9.5.2.3.2-1
See clause 9.5.2.2 for the details of usage of this API operation.
9.7.5.3 Update operation p. 88
API operation name:
SS_SmDataSourceRegistration_Update
Description:
Updates existing registration of the SM data source to the SEAL SM server.
Known Consumers:
SEAL SM client.
Inputs:
Refer Table 9.5.3.3.1-1
Outputs:
Refer Table 9.5.3.3.2-1
See clause 9.5.3.2 for the details of usage of this API operation.
9.7.5.4 Deregister operation p. 88
API operation name:
SS_SmDataSourceRegistration_Deregister
Description:
Deregisters the existing registration of the SM data source to the SEAL SM server.
Known Consumers:
SEAL SM client.
Inputs:
Refer Table 9.5.4.3.1-1
Outputs:
Refer Table 9.5.4.3.2-1
See clause 9.5.4.2 for the details of usage of this API operation.
9.7.6 SS_SmDataSourceDiscovery API p. 88
9.7.6.1 General p. 88
Service description:
This API enables the VAL server to discover SM data sources from the SEAL SM server.
9.7.6.2 Request operation p. 88
API operation name:
SS_SmDataSourceDiscovery_Request
Description:
discovers the SM data sources from the SEAL SM server.
Known Consumers:
VAL server.
Inputs:
Refer Table 9.5.5.3.1-1
Outputs:
Refer Table 9.5.5.3.2-1
See clause 9.5.5.2 for the details of usage of this API operation.
9.7.6.3 Notify operation p. 88
API operation name:
SS_SmDataSourceDiscovery_Notify
Description:
Notify a SM data source to trigger a spatial mapping information session.
Known Consumers:
SEAL SM client.
Inputs:
Refer Table 9.5.5.3.3-1
Outputs:
None
See clause 9.5.5 for the details of usage of this API operation.
9.7.7 SS_SmSmasRegistration API p. 89
9.7.7.1 General p. 89
Service description:
This API enables the VAL server with SM capabilities to register, update register or deregister with the SEAL SM server.
9.7.7.2 Request operation p. 89
API operation name:
SS_SmSmasRegistration_Request
Description:
registers the VAL server with SM capabilities to the SEAL SM server.
Known Consumers:
VAL server.
Inputs:
Refer Table 9.6.2.3.1-1
Outputs:
Refer Table 9.6.2.3.2-1
See clause 9.6.2.2 for the details of usage of this API operation.
9.7.7.3 Update operation p. 89
API operation name:
SS_SmSmasRegistration_Update
Description:
Updates existing registration of the VAL server with SM capabilities to the SEAL SM server.
Known Consumers:
VAL server.
Inputs:
Refer Table 9.6.3.3.1-1
Outputs:
Refer Table 9.6.3.3.2-1
See clause 9.6.3.2 for the details of usage of this API operation.
9.7.7.4 Deregister operation p. 89
API operation name:
SS_SmSmasRegistration_Deregister
Description:
Deregisters the existing registration of the VAL server with SM capabilities to the SEAL SM server.
Known Consumers:
VAL server.
Inputs:
Refer Table 9.6.4.3.1-1
Outputs:
Refer Table 9.6.4.3.2-1
See clause 9.6.4.2 for the details of usage of this API operation.
$ Change history p. 90
