Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Get Storage Location

Gets storage location for a project.

get/projects/{project_id}/storage_locations/{id}

Path parameters

project_idstring required
Example:prj_1CTWZQGKE1S0VAXA
idstring required
Example:slc_1F3PMGVC91S0SBK3

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required
namestring required

The name of the storage location

descriptionstring nullable

Optional description of the storage location

latitudenumber nullable

A WGS84 latitude in decimal degrees, between -90 and 90.

longitudenumber nullable

A WGS84 longitude in decimal degrees, between -180 and 180.

supplier_reference_idstring nullable

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

project_idstring required

The ID of the project this storage location belongs to

supplier_idstring required

The ID of the supplier this storage location belongs to

storage_method'biochar_field' | 'biochar_landfill' | 'permeable_reservoir' | 'biomass_subsurface' | 'salt_cavern' | 'saline_aquifer' | 'in_situ_mineralization' required

Example response

{
  "id": "slc_1F3PMGVC91S0SBK3",
  "latitude": 51.5072,
  "longitude": -0.1276,
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "supplier_id": "spl_1CC712KFS1S0YKPS"
}