SHshapemaker
structures

Get Icing Conditions By Structure Id

This endpoint retrieves the icing conditions for a structure by its ID.

The structure ID should be provided as a path parameter in the URL.

get/v1/structures/{structure_id}/icing

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

thicknessMmnumber required

The glaze thickness [mm] of the ice on the structure.

densityKgPerM3number required

The density [kg/m^3] of the ice on the structure.

useIcingDataboolean required

If true, the icing conditions will be used in the assessment.

Example response

{
  "density": 713.8,
  "thickness": 30,
  "useIcingData": true
}

Changes

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