SHshapemaker
structures

Update Discrete Ancillaries By Structure Id

This endpoint allows you to update discrete ancillaries associated with a structure by its ID. 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 discrete ancillary.

If the ancillary positioning is manual, the x and y coordinates can also be provided. If they are not provided, they will be calculated automatically.

put/v1/structures/{structure_id}/discrete_ancillaries

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

structureDiscreteAncillaryIdinteger required
tenantIdinteger nullable
mountHeightMnumber required
azimuthDEGnumber required
mountOption'TOP' | 'MIDDLE' | 'BOTTOM' required
shieldingFactornumber required
mountBracketWeightKGnumber required
xMnumber nullable
yMnumber nullable
isPositionManualboolean nullable
isUsingGlobalCoordinatesboolean nullable
shouldAnalyseboolean required
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL'
discreteAncillaryIdinteger required
shelterIdinteger nullable
shelterXMnumber nullable
shelterYMnumber nullable
shelterZMnumber nullable
shelterAzimuthDEGnumber nullable
shelterIsExteriorboolean

Response

Successful Response

Changes

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