SHshapemaker
structures

Get Ancillaries Linear By Structure Id

This endpoint retrieves all linear ancillaries associated with a structure. The structure ID should be provided as a path parameter in the URL.

get/v1/structures/{structure_id}/ancillaries_linear

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

ancillary_type'feeder' | 'access_ladder' required
namestring required
idstring required
tenant_idinteger nullable required
tenant_namestring nullable required
azimuthnumber required
shielding_factornumber required
weightnumber required
fpa_sidenumber required
fpa_frontnumber required
start_atnumber required
end_atnumber required
latticeMountingLegsIndicesinteger[] nullable
forceCoefficientFrontnumber required
forceCoefficientSidenumber required
placementIdinteger nullable
shouldAnalyseboolean
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL'

Changes

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