structures

Get Structure Result Summaries

This endpoint retrieves the current and historical result summaries associated with a structure by its ID. The structure ID should be provided as a path parameter in the URL.

get/v1/structures/{structure_id}/results/summaries

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

createdAtUTCstring date-time required
status'UNKNOWN' | 'OVERLOADED' | 'UNDERLOADED' required
isStaleboolean required
legsPercentnumber required
legsIsOkboolean required
bracingMembersPercentnumber required
bracingMembersIsOkboolean required
jointsPercentnumber required
jointsIsOkboolean required
foundationPercentnumber nullable
foundationIsOkboolean nullable
anchorsPercentnumber nullable
anchorsIsOkboolean nullable
naturalFrequencyHznumber nullable required
naturalFrequencyIsOkboolean nullable required
deformationnumber nullable required
deformationIsOkboolean nullable required
restCapacitynumber required
restCapacityIsOkboolean required
restCapacityGoverningPartstring required
designStandardKey'EN_01' | 'MSZ_EN_01' | 'NS_EN_01' | 'DIN_EN_01' | 'NF_EN_01' | 'SFS_EN_01' | 'SS_EN_01' | 'BS_EN_01' | 'IS_EN_01' | 'BDS_EN_01' | 'UNI_EN_01' | 'TIA_222_I' | 'TIA_222_H' | 'TIA_222_G' | 'TIA_222_F' | 'PN_EN_01' | 'ASNZS_01' required
guyFoundationsPercentnumber nullable required
guyFoundationsIsOkboolean nullable required
guyWiresPercentnumber nullable required
guyWiresIsOkboolean nullable required
monopoleHoldDownBoltsPercentnumber nullable required
monopoleHoldDownBoltsIsOkboolean nullable required
monopoleMembersPercentnumber nullable required
monopoleMembersIsOkboolean nullable required
monopoleConnectionCapacitiesPercentnumber nullable required
monopoleConnectionCapacitiesIsOkboolean nullable required
mountSlidingPercentnumber nullable
mountSlidingIsOkboolean nullable
mountOverturningPercentnumber nullable
mountOverturningIsOkboolean nullable
tiaServicabilityCheckUtilizationPercentnumber nullable
tiaServicabilityCheckIsOkboolean nullable
analysisRunIdstring uuid4 required
createdBystring
designStandardType'EN' | 'TIA' | 'ASNZS' required

Changes

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