SHshapemaker
structures

Get Discrete Ancillaries By Structure Id

This endpoint retrieves all discrete ancillaries associated with a structure by its ID. The structure ID should be provided as a path parameter in the URL. If the 'include_epa' query parameter is true, each discreteAncillary carries its front/side/rear EPA.

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

Query parameters

include_epaboolean

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
xMnumber nullable
yMnumber nullable
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL' required
shelterIdinteger nullable
shelterXMnumber nullable
shelterYMnumber nullable
shelterZMnumber nullable
shelterAzimuthDEGnumber nullable
shelterIsExteriorboolean
isPositionManualboolean required

Changes

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