SHshapemaker
structures

Get Linear Placements

This endpoint lists the site's detailed linear ancillaries: library items placed over a height range, and the feeders and clusters each route carries (with their parent route's id).

get/v1/structures/{structure_id}/linear_placements

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

idstring required
linearAncillaryIdinteger required
parentIdstring nullable required
tenantIdinteger nullable required
tenantNamestring nullable required
startAtMnumber required
endAtMnumber required
azimuthDegnumber nullable required
shieldingFactornumber nullable required
latticeMountingLegsIndicesinteger[] nullable required
fromLeftMmnumber nullable required
fromFloorMmnumber nullable required
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL' required
clampWeightKgPerMnumber required
shouldAnalyseboolean required
namestring nullable

Changes

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