ACacculynx
jobs

Create Job Measurements Order

Changed on

Use this endpoint to create a measurements order with the external provider Information for a specific job.

  • The measurement file can be an XML or JSON file.
    • The file content has to be a valid XML or JSON structure.
    • The file must contain the measurements order information with the measurements to be created.
  • A report PDF can be attached.
  • A list of PDF files can be attached.
  • Special characters and spaces will be removed from all the file names before upload.
  • The PDF files content will not be validated, only the type as PDF and the file size.

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

post/jobs/{jobId}/measurements/files

Request

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

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body multipart/form-data

measurementsFilestring binary

The file must be uploaded to the job to initiate the creation of a new measurement order. This file should contain the relevant measurements.

The permitted file formats are XML and JSON.

reportPdfstring binary

PDF File to be Uploaded attached to the measurement order that corresponds to the order report, it will be related to the job.

miscPdfsstring[]

A list of PDF Files to be attached to the new measurement order, a maximum of 10 files are allowed.

latitudenumber double required

Latitude of the map location for the new measurement order, value between -90 and 90.

longitudenumber double required

Longitude of the map location for the new measurement order, value between -180 and 180.

providerMeasurementOrderIdstring required

A text with the provider order identifier, special characters not allowed.

providerId'Unknown' | 'Hover' | 'RoofSnap' | 'External' required

The external provider from which a measurement order comes.

  • Unknown
  • Hover
  • RoofSnap
  • External
measurementOrderDescriptionstring required

A text with a description of the new measurement order.

model3DUrlstring uri

The URL of the 3D model file.

orderedDatestring date-time required

The creation DateTime for the new measurement order. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

completedDatestring date-time

The completed DateTime for the new measurement order. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

Example request

{
  "latitude": 50.09,
  "longitude": -54.489,
  "model3DUrl": "https://www.acculynx.com/3DModel",
  "orderedDate": "2024-06-25T10:00:00Z",
  "completedDate": "2025-08-20T05:00:00Z"
}

Response

Accepted

measurementOrderIdstring uuid

The created measurement order unique identifier.

Example response

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

Changes

  • 443924b00f43Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status