SHshapemaker
structures

Get Soil For Structure With Id

This endpoint retrieves the soil properties associated with a structure by its ID, if any. The structure ID should be provided as a path parameter in the URL.

get/v1/structures/{structure_id}/soil-properties

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Path parameters

structure_idstring required

Response

Successful Response

idinteger required
soilDensitynumber required
heightOfSoilnumber required
angleOfFrictionnumber required
cohesionOfSoilnumber required

Example response

[
  {
    "angleOfFriction": 25,
    "cohesionOfSoil": 0,
    "heightOfSoil": 18,
    "id": 1,
    "soilDensity": 1400
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.