API References

Create Job Measurements Order

post
https://api.acculynx.com/api/v2/jobs//measurements/files

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The job's unique identifier

Body Params
file

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.

file

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

miscPdfs
array of files
length between 0 and 10

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

double
required
-90 to 90

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

double
required
-180 to 180

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

string
required
length between 1 and 40

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

string
enum
required
Defaults to Hover

The external provider from which a measurement order comes.

  • Unknown
  • Hover
  • RoofSnap
  • External
Allowed:
string
required
length between 1 and 500

A text with a description of the new measurement order.

uri

The URL of the 3D model file.

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_UniversalTime(UTC)

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_UniversalTime(UTC)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 2 months ago

Did this page help you?