ACacculynx
jobs

Create Job Manual Measurements

  • Use this endpoint to create one or more manual measurements using a list of measurements entered in a file
  • The measurements file must contain the measurements information for the measurements to be created on the job. The file extension should be .json, and the content must be a valid JSON structure.
  • The JSON information will be created as new manual measurements; the data within the JSON file will not be validated.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/jobs/{jobId}/measurements

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/measurements
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body multipart/form-data

measurementsFilestring binary required

A file that represents the job measurement to be saved. An array of measurements is a valid structure

Example request

{
  "measurementsFile": " [ { \"roofLowSlopeArea\": 307.7, \"roofSteepSlopeArea\": 44.5, \"roofLowSlopePerimeter\": 432.3, \"dripEdge\": 152.7, \"eaves\": 672.8, \"flashing\": 139.9, \"stepFlashing\": 396.3, \"hips\": 41.9, \"parapets\": 232.9, \"rakes\": 805.6, \"ridges\": 38.3, \"valleys\": 12.5, \"roofPenetrationsArea\": 643.6, \"roofPenetrationsPerimeter\": 880.0, \"roofObstructions\": 645.7, \"roofObstructionsPerimeter\": 865.4, \"pitch\": 483, \"additionalPitches\": [ 301, 167 ], \"wallArea\": 235.7, \"windowAndDoorArea\": 112.7, \"windowAndDoorPerimeter\": 961.4, \"topOfWalls\": 782.3, \"bottomOfWalls\": 445.5, \"insideCorners\": 533.6, \"outsideCorners\": 304.5, \"insideObtuseCorners\": 662.6, \"outsideObtuseCorners\": 461.0, \"topOfSiding\": 706.4, \"bottomOfSiding\": 872.2, \"bottomOfMasonry\": 357.2, \"topOfMasonry\": 590.4, \"outsideMasonryCorners\": 531.0, \"insideMasonryCorners\": 310.0, \"pitchBreakdown\": [ { \"pitch\": 416, \"pitchValue\": 111.6 }, { \"pitch\": 24, \"pitchValue\": 33.6 } ] } ]"
}

Response

Accepted

measurementOrderIdstring uuid

The created measurement order unique identifier.

Example response

{
  "measurementOrderId": "b07a494a-3928-46b4-940a-1c856ce17e70"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.