Takeoffs

Measured routes (conduit, feeder, duct, pipe, tray) with endpoints and geometry

get/takeoffs/{takeoff_id}/routes

Request

  • Base URL: https://api.aginera.ai/partner/v1
  • URL: https://api.aginera.ai/partner/v1/takeoffs/{takeoff_id}/routes
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.aginera.ai/oauth/authorize, token URL https://auth.aginera.ai/oauth/token; client credentials, token URL https://login.microsoftonline.com/65f567a9-6e6a-4f81-863c-aea4ece1f8eb/oauth2/v2.0/token, scopes: takeoffs:read)

Path parameters

takeoff_idstring required
Example:tko_4kR9sT2vWx7yZa1bCd3eFg

Query parameters

limitinteger
cursorstring
trade'electrical' | 'mechanical' | 'plumbing' | 'fire_protection' | 'structural' | 'architectural' | 'civil' | 'process' | 'other'
system'conduit' | 'feeder' | 'branch_circuit' | 'cable_tray' | 'duct' | 'pipe' | 'other'
page_numberinteger
include_geometryboolean nullable
units'imperial' | 'metric' | 'as_drawn'

Response

OK

next_cursorstring nullable required
has_moreboolean required
totals_by_systemobject required

Example response

{
  "data": [
    {
      "id": "rte_4kR9sT2vWx7yZa1bCd3eFg",
      "takeoff_id": "tko_4kR9sT2vWx7yZa1bCd3eFg",
      "item_id": "itm_4kR9sT2vWx7yZa1bCd3eFg",
      "unit": "LF",
      "from": {
        "item_id": "itm_4kR9sT2vWx7yZa1bCd3eFg"
      },
      "to": {
        "item_id": "itm_4kR9sT2vWx7yZa1bCd3eFg"
      },
      "geometry": {
        "scale": {
          "unit": "LF"
        }
      }
    }
  ]
}

Changes

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