SHshapemaker
structures

Put Ancillaries Linear With Structure Id

This endpoint allows you to update the linear ancillaries associated with a structure. The structure ID should be provided as a path parameter in the URL. The ancillaries to be updated should be provided in the request body as a list of objects, each representing a linear ancillary.

If an ancillary with the provided ID already exists, it will be updated with the new details. If an ancillary with the provided ID can not be found on the indicated structure, it will be created. If an existing ancillary is not included in the request body, it will be deleted. Rows that detailed placements produce are left as they are: they change with their placements.

The request can not contain ancillaries with duplicate ancillary IDs.

put/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

Request body

ancillary_type'feeder' | 'access_ladder' required
namestring required
idstring required
tenant_idinteger nullable
tenant_namestring nullable
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
shouldAnalyseboolean nullable
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL'

Response

Successful Response

unknown required

Changes

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