Dynamic Layers

Overview

Dynamic Layers is a RESTful API for ingesting dynamic spatial data into the RapidSOS Platform.

Dynamic spatial layer data consists of a series of locations for an object, for instance a body camera, representing the object’s movement within a given map layer.

Pre-Requisites

Map Layer Management API - The implementation and use of the Map Layer Management is required for use with dynamic layers.

Prior to accessing the Dynamic Layers API, please ensure the following action items are complete:

  1. Credentials have been provisioned for your company to access the following RapidSOS APIs:
    • Layer Management/Dynamic Layers - for managing spatial layer resources.
    • Ruby - for uploading documents to RapidSOS (if providing relevant media to telecommunicators)
  2. A Spatial Layer for your company has been created by RapidSOS. The Spatial Layer serves as the container for all spatial layer resources related to your company. Without a Spatial Layer, one cannot upload any spatial layer resources.
  3. Access https://editor.swagger.io (or similar OpenAPI parser) - an OpenAPI specification for the Map Layer Management API is also provided. The site will help illustrate the expected request and response payloads.

The following tool is recommended but not required for use of this API.

  • Postman - It is recommended to download Postman, thought it is not needed.
    • A Postman Collection is provided to aid in the development and understanding of the flow of data in the Layer Management API.

Provisioning

During the provisioning process, RapidSOS will register a layer and provide the partner with a unique  layer_key.  The process is as follows:

  1. RapidSOS approves and creates a layer

  2. Partner is provided access to the Map Layer Management and Dynamic Layers APIs via a single set of credentials for both services.

  3. Layer keys are retrieved from the Map Layer Management API by the Partner and included in the request body of any payloads sent to the Dynamic Layers API.

Note: To inquire about Spatial Layer creation or status, please contact [email protected].

Making a Request

Please contact [email protected] for test credentials and confirmation of pre-requisites.

Step 1: Authentication

Uses RapidSOS standard OAuth2.0, documented here.

Refer to the Dynamic Layers API Spec for additional details.

Step 2: Creating an object

To create a dynamic spatial object, leverage the request POST Create dynamic spatial object

Example request body

IMPORTANT: The layer_key is the key that must be used when sending inbound dynamic object locations. It is a unique and immutable value representing the layer to which the object belongs.

Note: Each payload represents where an object is at a specific point in time. The object’s current location is understood to be the most recently received payload.

Attributes

Attributes will vary based on layer. The Map Layer Management API returns a JSON schema field indicating the structure of object attributes. For example, for the above attributes block, the spatial layer will have the following attributes schema:

Schemas

Refer to the Dynamic Layers API OpenAPI documentation for detailed information on available schemas.