Patch Storage Location

Changed on

Patches storage location in the Isometric system.

patch/projects/{project_id}/storage_locations/{id}

Request

  • Base URL
    https://api.isometric.com/mrv/v0
  • URL
    https://api.isometric.com/mrv/v0/projects/{project_id}/storage_locations/{id}
  • Auth
    HTTP bearer

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

Request body

Example request

{
  "latitude": 51.5072,
  "longitude": -0.1276
}

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' | 'depleted_hydrocarbon_reservoir' required

Example response

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

Changes

    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • breaking

      for the path request parameter project_id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • warning

      for the path request parameter project_id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

    • info

      for the path request parameter project_id, the type was generalized from no type to string

    • warning

      added the new depleted_hydrocarbon_reservoir enum value to the response property for the response status

    • info

      added the new depleted_hydrocarbon_reservoir enum value to the request property /