SHshapemaker
ancillaries

Add Discrete Ancillaries

This endpoint creates new discrete ancillaries and adds them to the ancillary database. The data for the new ancillaries should be provided in the request body.

Each ancillary type requires exactly the geometry types listed for it by GET /v1/ancillaries/discrete/config/v2, each given once. Geometry values must be greater than zero, except RADIUS_MM (the corner radius of box-shaped types), which may be zero. weightKG must be zero or greater, and powerConsumptionKW greater than zero when powerDetails is given. Invalid input returns 422 naming the ancillary index and field, and no ancillaries are created.

post/v1/ancillaries/discrete

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

Request body

namestring required
ancillaryType'PANEL' | 'MW_SHROUD' | 'MW_NO_SHROUD' | 'MW_GRID' | 'MW_RADOME' | 'OMNI' | 'GPS' | 'YAGI' | 'DIPOLE' | 'RRU' | 'ODU' | 'FTTA' | 'PTTA' | 'TMA' | 'MHA' | 'OBSTRUCTION_LIGHT' | 'LIGHTNING_ROD' | 'PLATFORM' | 'CUSTOM_BOX' | 'CUSTOM_CYLINDER' | 'HELIX' | 'ICE_SHIELD' | 'COMBINER' | 'GRID' | 'HEADFRAME' | 'SHELTER_EQUIPMENT' required
weightKGnumber required
defaultMountOption'TOP' | 'MIDDLE' | 'BOTTOM' required

Example request

[
  {
    "ancillaryType": "PANEL",
    "defaultMountOption": "TOP",
    "forceCoefficients": {
      "front": 1.1,
      "rear": 1.3,
      "side": 1.2
    },
    "geometries": [
      {
        "geometryType": "HEIGHT_MM",
        "geometryValue": 150
      },
      {
        "geometryType": "WIDTH_MM",
        "geometryValue": 120
      },
      {
        "geometryType": "DEPTH_MM",
        "geometryValue": 120
      },
      {
        "geometryType": "RADIUS_MM",
        "geometryValue": 60
      }
    ],
    "name": "test",
    "powerConsumptionKW": 0.5,
    "weightKG": 5
  }
]

Response

Successful Response

idinteger required
namestring required
ancillaryTypestring required
weightKGnumber required
defaultMountOptionstring required
organizationIdinteger required

Changes

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