structures

Add Discrete Ancillaries By Structure Id

This endpoint allows you to add discrete ancillaries to a structure. The structure ID should be provided as a path parameter in the URL. The ancillaries to be added should be provided in the request body.

Each discrete ancillary object should include the ancillary ID, mount option, and mount height. If the mount option is not provided, the default mount option for the ancillary will be used. If the mount height is not provided, the height of the tower will be used.

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

discreteAncillaryIdinteger required

tenantIdinteger nullable

mountHeightMnumber nullable

azimuthDEGnumber nullable

mountOption'TOP' | 'MIDDLE' | 'BOTTOM'

shieldingFactornumber nullable

mountBracketWeightKGnumber nullable

xMnumber nullable

yMnumber nullable

shouldAnalyseboolean

status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL'

shelterIdinteger nullable

shelterXMnumber nullable

shelterYMnumber nullable

shelterZMnumber nullable

shelterAzimuthDEGnumber nullable

shelterIsExteriorboolean

Response

Successful Response

idinteger required

structureIdinteger required

discreteAncillaryIdinteger required

tenantIdinteger nullable

mountHeightMnumber required

Height of the mounting point above ground level (in meters).

azimuthDEGnumber required

mountOption'TOP' | 'MIDDLE' | 'BOTTOM' required

shieldingFactornumber required

mountBracketWeightKGnumber required

shouldAnalyseboolean required