Drawings

Get Drawing

Returns a drawing of your organization by drawing ID. Drawing IDs are strings.

GET https://api.arcsite.com/v1/drawings/<id>

cURL

curl "https://api.arcsite.com/v1/drawings/<ID>" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/drawings/<ID>", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/drawings/<ID>",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "id": "36029621652695015",
  "project_id": "28123123123",
  "name": "Drawing_1_Pre-Survey_Proposal (1)-page_03_test-page_02",
  "pdf_url": "https://files.example.com/drawings/36029621652695015/drawing.pdf?Expires=1700000000&Signature=EXAMPLE&Key-Pair-Id=EXAMPLEKEYPAIR",
  "png_url": "https://files.example.com/drawings/36029621652695015/drawing.png?Expires=1700000000&Signature=EXAMPLE&Key-Pair-Id=EXAMPLEKEYPAIR",
  "dxf_url": "https://files.example.com/drawings/36029621652695015/drawing.dxf?Expires=1700000000&Signature=EXAMPLE&Key-Pair-Id=EXAMPLEKEYPAIR",
  "tags": [
    "Work Order"
  ]
}

Query Parameters

Parameter	Type	In	Description
drawing_version_id	String (optional)	query	The ID of the drawing version. A version of another drawing returns 404.

Response Schema

Name	Type	Description
id	String	The ID of the drawing
project_id	String	The ID of the project
name	String	The name of the drawing
pdf_url	String | null	The URL of the PDF file
png_url	String	The URL of the PNG file (an empty string "" when there is no image, not null)
dxf_url	String | null	The URL of the DXF file
tags	List[String]	Tags added to this drawing

Note

If the drawing_version_id is passed, the data of the specified version will be returned. If not, the data of the latest version will be returned by default. name and tags always show the drawing’s current values.

Note

Please note that all URLs are not guaranteed and may be null if the app fails to upload to the cloud.

The returned urls will expire in 24 hours.

Note

The pdf could take some time(often less than 1 minute) to generate if the drawing contains location based photos, the pdf_url could be null before it has been generated.

Get Drawing Location Photos

Returns location photos associated with a drawing.

GET https://api.arcsite.com/v1/drawings/<id>/location_photos

cURL

curl "https://api.arcsite.com/v1/drawings/<ID>/location_photos" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/drawings/<ID>/location_photos", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/drawings/<ID>/location_photos",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "location_photos": [
    {
      "url": "https://files.example.com/drawings/36029621652695015/location-photo-1.jpg?Expires=1700000000&Signature=EXAMPLE&Key-Pair-Id=EXAMPLEKEYPAIR"
    },
    {
      "url": "https://files.example.com/drawings/36029621652695015/location-photo-2.jpg?Expires=1700000000&Signature=EXAMPLE&Key-Pair-Id=EXAMPLEKEYPAIR"
    }
  ]
}

Query Parameters

Parameter	Type	In	Description
drawing_version_id	String (optional)	query	The ID of the drawing version. A version of another drawing returns 404.

Response Schema

Name	Type	Description
location_photos	List[Object]	List of location photo objects

Location Photo

Name	Type	Description
url	String	The presigned URL of the photo file

Photos are ordered by location marker, then by their order within the marker.

Note

If the drawing_version_id is passed, the location photos of the specified version will be returned. If not, the location photos of the latest version will be returned by default.

Note

The returned URLs will expire in 24 hours.

Get Drawing Payment

Returns the payment data for a drawing, including balance schedules and deposit amount.

GET https://api.arcsite.com/v1/drawings/<id>/payment

cURL

curl "https://api.arcsite.com/v1/drawings/<ID>/payment" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/drawings/<ID>/payment", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/drawings/<ID>/payment",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "balance": {
    "payment_schedules": [
      {
        "name": "Progress Payment",
        "amount": 750.0,
        "percentage": 38.0
      },
      {
        "name": "On Completion",
        "amount": 750.0,
        "percentage": 38.0
      }
    ]
  },
  "deposit": 500.0
}

Query Parameters

Parameter	Type	In	Description
drawing_version_id	String (optional)	query	The ID of the drawing version. A version of another drawing returns 404.

Response Schema

Name	Type	Description
balance	Object	The balance information of the drawing payment
deposit	Number	The deposit amount (0 when there is no deposit)

Balance

Name	Type	Description
payment_schedules	List[PaymentSchedule]	The payment phases of the balance that remains after the deposit. The deposit itself isn’t listed here. Empty when the drawing has no payment terms.

PaymentSchedule

Name	Type	Description
name	String	The name of the payment schedule
amount	Number	The amount of the payment schedule
percentage	Number	This phase’s share of the drawing total (deposit and taxes included), rounded to a whole percent (e.g. 38.0). Use amount for exact values.

Note

If the drawing_version_id is passed, the payment data of the specified version will be returned. If not, the payment data of the latest version will be returned by default.