Skip to main content
PATCH
/
locations
/
{location_id}
/
jobs
/
{job_id}
Update Job
curl --request PATCH \
  --url https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "add_to_routes": "<string>",
  "add_to_routes_settings": [
    {
      "id": 123,
      "priority": 123,
      "skip": true
    }
  ],
  "arrived_at_destination_on": "2023-11-07T05:31:56Z",
  "asset_dropped_id": 123,
  "asset_id": 123,
  "asset_quantity": 123,
  "asset_type_id": 123,
  "departed_on": "2023-11-07T05:31:56Z",
  "desired_asset_desc": "<string>",
  "desired_end_time": "2023-11-07T05:31:56Z",
  "desired_start_time": "2023-11-07T05:31:56Z",
  "dispatch_priority": "<string>",
  "dispatcher_notes": "<string>",
  "do_confirm": true,
  "driver_notes": "<string>",
  "dump_location_id": 123,
  "ends_at_customer": true,
  "final_location_id": 123,
  "is_acknowledged": true,
  "is_separate_from_route_list": true,
  "merged_with_route_id": 123,
  "pickup_date": "2023-11-07T05:31:56Z",
  "priority": 123,
  "reference_number": "<string>",
  "require_image": true,
  "require_materials": true,
  "require_signature": true,
  "require_weights": true,
  "started_on": "2023-11-07T05:31:56Z",
  "starts_at_customer": true,
  "type": "<string>"
}
'
import requests

url = "https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}"

payload = {
    "add_to_routes": "<string>",
    "add_to_routes_settings": [
        {
            "id": 123,
            "priority": 123,
            "skip": True
        }
    ],
    "arrived_at_destination_on": "2023-11-07T05:31:56Z",
    "asset_dropped_id": 123,
    "asset_id": 123,
    "asset_quantity": 123,
    "asset_type_id": 123,
    "departed_on": "2023-11-07T05:31:56Z",
    "desired_asset_desc": "<string>",
    "desired_end_time": "2023-11-07T05:31:56Z",
    "desired_start_time": "2023-11-07T05:31:56Z",
    "dispatch_priority": "<string>",
    "dispatcher_notes": "<string>",
    "do_confirm": True,
    "driver_notes": "<string>",
    "dump_location_id": 123,
    "ends_at_customer": True,
    "final_location_id": 123,
    "is_acknowledged": True,
    "is_separate_from_route_list": True,
    "merged_with_route_id": 123,
    "pickup_date": "2023-11-07T05:31:56Z",
    "priority": 123,
    "reference_number": "<string>",
    "require_image": True,
    "require_materials": True,
    "require_signature": True,
    "require_weights": True,
    "started_on": "2023-11-07T05:31:56Z",
    "starts_at_customer": True,
    "type": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    add_to_routes: '<string>',
    add_to_routes_settings: [{id: 123, priority: 123, skip: true}],
    arrived_at_destination_on: '2023-11-07T05:31:56Z',
    asset_dropped_id: 123,
    asset_id: 123,
    asset_quantity: 123,
    asset_type_id: 123,
    departed_on: '2023-11-07T05:31:56Z',
    desired_asset_desc: '<string>',
    desired_end_time: '2023-11-07T05:31:56Z',
    desired_start_time: '2023-11-07T05:31:56Z',
    dispatch_priority: '<string>',
    dispatcher_notes: '<string>',
    do_confirm: true,
    driver_notes: '<string>',
    dump_location_id: 123,
    ends_at_customer: true,
    final_location_id: 123,
    is_acknowledged: true,
    is_separate_from_route_list: true,
    merged_with_route_id: 123,
    pickup_date: '2023-11-07T05:31:56Z',
    priority: 123,
    reference_number: '<string>',
    require_image: true,
    require_materials: true,
    require_signature: true,
    require_weights: true,
    started_on: '2023-11-07T05:31:56Z',
    starts_at_customer: true,
    type: '<string>'
  })
};

fetch('https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'add_to_routes' => '<string>',
    'add_to_routes_settings' => [
        [
                'id' => 123,
                'priority' => 123,
                'skip' => true
        ]
    ],
    'arrived_at_destination_on' => '2023-11-07T05:31:56Z',
    'asset_dropped_id' => 123,
    'asset_id' => 123,
    'asset_quantity' => 123,
    'asset_type_id' => 123,
    'departed_on' => '2023-11-07T05:31:56Z',
    'desired_asset_desc' => '<string>',
    'desired_end_time' => '2023-11-07T05:31:56Z',
    'desired_start_time' => '2023-11-07T05:31:56Z',
    'dispatch_priority' => '<string>',
    'dispatcher_notes' => '<string>',
    'do_confirm' => true,
    'driver_notes' => '<string>',
    'dump_location_id' => 123,
    'ends_at_customer' => true,
    'final_location_id' => 123,
    'is_acknowledged' => true,
    'is_separate_from_route_list' => true,
    'merged_with_route_id' => 123,
    'pickup_date' => '2023-11-07T05:31:56Z',
    'priority' => 123,
    'reference_number' => '<string>',
    'require_image' => true,
    'require_materials' => true,
    'require_signature' => true,
    'require_weights' => true,
    'started_on' => '2023-11-07T05:31:56Z',
    'starts_at_customer' => true,
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}"

	payload := strings.NewReader("{\n  \"add_to_routes\": \"<string>\",\n  \"add_to_routes_settings\": [\n    {\n      \"id\": 123,\n      \"priority\": 123,\n      \"skip\": true\n    }\n  ],\n  \"arrived_at_destination_on\": \"2023-11-07T05:31:56Z\",\n  \"asset_dropped_id\": 123,\n  \"asset_id\": 123,\n  \"asset_quantity\": 123,\n  \"asset_type_id\": 123,\n  \"departed_on\": \"2023-11-07T05:31:56Z\",\n  \"desired_asset_desc\": \"<string>\",\n  \"desired_end_time\": \"2023-11-07T05:31:56Z\",\n  \"desired_start_time\": \"2023-11-07T05:31:56Z\",\n  \"dispatch_priority\": \"<string>\",\n  \"dispatcher_notes\": \"<string>\",\n  \"do_confirm\": true,\n  \"driver_notes\": \"<string>\",\n  \"dump_location_id\": 123,\n  \"ends_at_customer\": true,\n  \"final_location_id\": 123,\n  \"is_acknowledged\": true,\n  \"is_separate_from_route_list\": true,\n  \"merged_with_route_id\": 123,\n  \"pickup_date\": \"2023-11-07T05:31:56Z\",\n  \"priority\": 123,\n  \"reference_number\": \"<string>\",\n  \"require_image\": true,\n  \"require_materials\": true,\n  \"require_signature\": true,\n  \"require_weights\": true,\n  \"started_on\": \"2023-11-07T05:31:56Z\",\n  \"starts_at_customer\": true,\n  \"type\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"add_to_routes\": \"<string>\",\n  \"add_to_routes_settings\": [\n    {\n      \"id\": 123,\n      \"priority\": 123,\n      \"skip\": true\n    }\n  ],\n  \"arrived_at_destination_on\": \"2023-11-07T05:31:56Z\",\n  \"asset_dropped_id\": 123,\n  \"asset_id\": 123,\n  \"asset_quantity\": 123,\n  \"asset_type_id\": 123,\n  \"departed_on\": \"2023-11-07T05:31:56Z\",\n  \"desired_asset_desc\": \"<string>\",\n  \"desired_end_time\": \"2023-11-07T05:31:56Z\",\n  \"desired_start_time\": \"2023-11-07T05:31:56Z\",\n  \"dispatch_priority\": \"<string>\",\n  \"dispatcher_notes\": \"<string>\",\n  \"do_confirm\": true,\n  \"driver_notes\": \"<string>\",\n  \"dump_location_id\": 123,\n  \"ends_at_customer\": true,\n  \"final_location_id\": 123,\n  \"is_acknowledged\": true,\n  \"is_separate_from_route_list\": true,\n  \"merged_with_route_id\": 123,\n  \"pickup_date\": \"2023-11-07T05:31:56Z\",\n  \"priority\": 123,\n  \"reference_number\": \"<string>\",\n  \"require_image\": true,\n  \"require_materials\": true,\n  \"require_signature\": true,\n  \"require_weights\": true,\n  \"started_on\": \"2023-11-07T05:31:56Z\",\n  \"starts_at_customer\": true,\n  \"type\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.crosoftware.com/v0/locations/{location_id}/jobs/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"add_to_routes\": \"<string>\",\n  \"add_to_routes_settings\": [\n    {\n      \"id\": 123,\n      \"priority\": 123,\n      \"skip\": true\n    }\n  ],\n  \"arrived_at_destination_on\": \"2023-11-07T05:31:56Z\",\n  \"asset_dropped_id\": 123,\n  \"asset_id\": 123,\n  \"asset_quantity\": 123,\n  \"asset_type_id\": 123,\n  \"departed_on\": \"2023-11-07T05:31:56Z\",\n  \"desired_asset_desc\": \"<string>\",\n  \"desired_end_time\": \"2023-11-07T05:31:56Z\",\n  \"desired_start_time\": \"2023-11-07T05:31:56Z\",\n  \"dispatch_priority\": \"<string>\",\n  \"dispatcher_notes\": \"<string>\",\n  \"do_confirm\": true,\n  \"driver_notes\": \"<string>\",\n  \"dump_location_id\": 123,\n  \"ends_at_customer\": true,\n  \"final_location_id\": 123,\n  \"is_acknowledged\": true,\n  \"is_separate_from_route_list\": true,\n  \"merged_with_route_id\": 123,\n  \"pickup_date\": \"2023-11-07T05:31:56Z\",\n  \"priority\": 123,\n  \"reference_number\": \"<string>\",\n  \"require_image\": true,\n  \"require_materials\": true,\n  \"require_signature\": true,\n  \"require_weights\": true,\n  \"started_on\": \"2023-11-07T05:31:56Z\",\n  \"starts_at_customer\": true,\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "add_to_routes": "<string>",
  "add_to_routes_settings": [
    {
      "id": 123,
      "priority": 123,
      "skip": true
    }
  ],
  "additional_items": [
    {
      "deduct_weight": "<string>",
      "description": "<string>",
      "heavy_weight": "<string>",
      "id": 123,
      "is_completed": true,
      "is_declined": true,
      "is_failed": true,
      "job_id": 123,
      "light_weight": "<string>",
      "material_item_id": 123,
      "notes": "<string>",
      "quantity": "<string>",
      "required": true
    }
  ],
  "alternate_drop_type_id": 123,
  "arrived_at_destination_on": "2023-11-07T05:31:56Z",
  "arrived_on": "2023-11-07T05:31:56Z",
  "asset": {
    "asset_type": {
      "deleted": true,
      "id": 123,
      "is_default": true,
      "location_id": 123,
      "name": "<string>",
      "quantity": 123,
      "require_numbers": true,
      "weight": "<string>"
    },
    "asset_type_id": 123,
    "cluster": 123,
    "customer_id": 123,
    "description": "<string>",
    "dispatched_on": "2023-11-07T05:31:56Z",
    "id": 123,
    "is_returned": true,
    "last_activity_on": "2023-11-07T05:31:56Z",
    "last_rental_invoice_on": "2023-11-07T05:31:56Z",
    "latitude": "<string>",
    "location": {
      "id": 123,
      "latitude": "<string>",
      "line_1": "<string>",
      "locality": "<string>",
      "longitude": "<string>",
      "region": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "line_4": "<string>",
      "postcode": "<string>"
    },
    "location_id": 123,
    "longitude": "<string>",
    "number": "<string>",
    "quantity": 123,
    "returned_on": "2023-11-07T05:31:56Z"
  },
  "asset_dropped_id": 123,
  "asset_id": 123,
  "asset_quantity": 123,
  "asset_type": {
    "deleted": true,
    "id": 123,
    "is_default": true,
    "location_id": 123,
    "name": "<string>",
    "quantity": 123,
    "require_numbers": true,
    "weight": "<string>"
  },
  "asset_type_id": 123,
  "completed_by": 123,
  "completed_on": "2023-11-07T05:31:56Z",
  "confirmed_on": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "created_by_driver": true,
  "created_with_portal": true,
  "customer": {
    "account_number_1": "<string>",
    "account_number_2": "<string>",
    "addresses": [
      {
        "country": "<string>",
        "id": 123,
        "is_active": true,
        "is_billing": true,
        "is_physical": true,
        "is_shipping": true,
        "latitude": "<string>",
        "line_1": "<string>",
        "line_2": "<string>",
        "line_3": "<string>",
        "line_4": "<string>",
        "locality": "<string>",
        "longitude": "<string>",
        "postcode": "<string>",
        "region": "<string>"
      }
    ],
    "contacts": [
      {
        "email": "jsmith@example.com",
        "fax": "<string>",
        "id": 123,
        "name": "<string>",
        "notify_on_acknowledged_request": true,
        "notify_on_completed_request": true,
        "notify_on_dispatched_request": true,
        "notify_on_failed_request": true,
        "notify_on_new_request": true,
        "number": "<string>"
      }
    ],
    "created_on": "2023-11-07T05:31:56Z",
    "id": 123,
    "is_active": true,
    "last_updated_on": "2023-11-07T05:31:56Z",
    "location_id": 123,
    "locations": [
      {
        "created_on": "2023-11-07T05:31:56Z",
        "id": 123,
        "is_active": true,
        "last_updated_on": "2023-11-07T05:31:56Z",
        "location_id": 123,
        "renewal_date": "2023-11-07T05:31:56Z",
        "is_commercial": true,
        "note": "<string>",
        "reference_number": "<string>",
        "sales_rep": "<string>",
        "sales_rep_id": "<string>",
        "suspension_id": 123
      }
    ],
    "name": "<string>",
    "parent_id": 123,
    "renewal_date": "2023-11-07T05:31:56Z",
    "is_commercial": true,
    "note": "<string>",
    "reference_number": "<string>",
    "sales_rep": "<string>",
    "sales_rep_id": "<string>",
    "suspension_id": 123
  },
  "customer_id": 123,
  "customer_notes": "<string>",
  "departed_on": "2023-11-07T05:31:56Z",
  "desired_asset_desc": "<string>",
  "desired_end_time": "2023-11-07T05:31:56Z",
  "desired_start_time": "2023-11-07T05:31:56Z",
  "dispatch_priority": "<string>",
  "dispatched_by_route": 123,
  "dispatched_on": "2023-11-07T05:31:56Z",
  "dispatcher_notes": "<string>",
  "do_confirm": true,
  "driver_notes": "<string>",
  "dropped_asset": {
    "asset_type": {
      "deleted": true,
      "id": 123,
      "is_default": true,
      "location_id": 123,
      "name": "<string>",
      "quantity": 123,
      "require_numbers": true,
      "weight": "<string>"
    },
    "asset_type_id": 123,
    "cluster": 123,
    "customer_id": 123,
    "description": "<string>",
    "dispatched_on": "2023-11-07T05:31:56Z",
    "id": 123,
    "is_returned": true,
    "last_activity_on": "2023-11-07T05:31:56Z",
    "last_rental_invoice_on": "2023-11-07T05:31:56Z",
    "latitude": "<string>",
    "location": {
      "id": 123,
      "latitude": "<string>",
      "line_1": "<string>",
      "locality": "<string>",
      "longitude": "<string>",
      "region": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "line_4": "<string>",
      "postcode": "<string>"
    },
    "location_id": 123,
    "longitude": "<string>",
    "number": "<string>",
    "quantity": 123,
    "returned_on": "2023-11-07T05:31:56Z"
  },
  "dropped_number": "<string>",
  "dump_location": {
    "address": {
      "id": 123,
      "latitude": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "line_4": "<string>",
      "locality": "<string>",
      "longitude": "<string>",
      "postcode": "<string>",
      "region": "<string>"
    },
    "contact": {
      "email": "jsmith@example.com",
      "id": 123,
      "name": "<string>",
      "number": "<string>"
    },
    "description": "<string>",
    "id": 123,
    "is_holding_yard": true,
    "location_id": 123
  },
  "dump_location_id": 123,
  "dumped_on": "2023-11-07T05:31:56Z",
  "ends_at_customer": true,
  "fail_reason": "<string>",
  "final_location": {
    "address": {
      "id": 123,
      "latitude": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "line_4": "<string>",
      "locality": "<string>",
      "longitude": "<string>",
      "postcode": "<string>",
      "region": "<string>"
    },
    "contact": {
      "email": "jsmith@example.com",
      "id": 123,
      "name": "<string>",
      "number": "<string>"
    },
    "description": "<string>",
    "id": 123,
    "is_holding_yard": true,
    "location_id": 123
  },
  "final_location_id": 123,
  "flags": "<string>",
  "id": 123,
  "images": [
    {
      "height": 123,
      "id": 123,
      "s3_object": "<string>",
      "url": "<string>",
      "width": 123
    }
  ],
  "invoice_notes": "<string>",
  "is_acknowledged": true,
  "is_completed": true,
  "is_declined": true,
  "is_deleted": true,
  "is_failed": true,
  "is_paid": true,
  "is_separate_from_route_list": true,
  "job_group_id": 123,
  "last_updated_on": "2023-11-07T05:31:56Z",
  "line_1": "<string>",
  "location_id": 123,
  "merged_with_route_id": 123,
  "original_schedule_date": "2023-11-07T05:31:56Z",
  "pickup_date": "2023-11-07T05:31:56Z",
  "pickup_item": 123,
  "priority": 123,
  "recur_active": true,
  "recur_enabled": true,
  "reference_number": "<string>",
  "removed_number": "<string>",
  "requested_by": 123,
  "requested_on": "2023-11-07T05:31:56Z",
  "require_image": true,
  "require_material": true,
  "require_materials": true,
  "require_signature": true,
  "require_weights": true,
  "return_full": [
    {
      "bin_request_id": 123,
      "dumped_by": 123,
      "dumped_by_driver": true,
      "id": 123,
      "original_dest_id": 123,
      "original_dump_id": 123,
      "returned_by": 123,
      "returned_by_driver": true,
      "truck_id": 123,
      "yard_id": 123
    }
  ],
  "scale_ticket": "<string>",
  "schedule_date": "2023-11-07T05:31:56Z",
  "start_location": {
    "address": {
      "id": 123,
      "latitude": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "line_4": "<string>",
      "locality": "<string>",
      "longitude": "<string>",
      "postcode": "<string>",
      "region": "<string>"
    },
    "contact": {
      "email": "jsmith@example.com",
      "id": 123,
      "name": "<string>",
      "number": "<string>"
    },
    "description": "<string>",
    "id": 123,
    "is_holding_yard": true,
    "location_id": 123
  },
  "start_location_id": 123,
  "started_on": "2023-11-07T05:31:56Z",
  "starts_at_customer": true,
  "third_party_hauler_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "times_failed": 123,
  "times_rolled_over": 123,
  "truck_id": 123,
  "type": "<string>",
  "weighed_on": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-api-version
string

Version identifier (date format).

​
x-tenant-id
integer<int64>
required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Path Parameters

​
location_id
integer<int64>
required

Location identifier.

​
job_id
integer<int64>
required

Job identifier.

Body

application/json

Update job profile.

​
add_to_routes
string

CSV of route IDs which the dropped asset should be assigned to.

​
add_to_routes_settings
object[]
​
arrived_at_destination_on
string<date-time>

Job starting time.

​
asset_dropped_id
integer<int64>

DeployedBinID of the asset that was dropped by this job, only allowed to be set if the job's type is 'D' or 'E'.

​
asset_id
integer<int64>

Job asset identifier. Applicable to job types 'E', 'P', 'R'.

​
asset_quantity
integer

How many assets are being serviced within a cluster (for jobs assigned to an asset cluster). For jobs dispatched by routes, or manually dispatched route stops, this value is 0 or 1.

​
asset_type_id
integer<int64>

Selected asset for the job (job types 'D', 'L', 'E').

​
departed_on
string<date-time>
​
desired_asset_desc
string

Free-form text entered by dispatchers and drivers to be used as the future asset description.

​
desired_end_time
string<date-time>

Future estimated time of job completion.

​
desired_start_time
string<date-time>

Time customer has requested job start, set by dispatchers for dispatchers and drivers.

​
dispatch_priority
string

Entered by dispatchers to determine dispatch order.

​
dispatcher_notes
string

Entered by dispatchers, read by drivers and dispatchers.

​
do_confirm
boolean

Tell dispatcher that a customer should be contacted before job is dispatched.

​
driver_notes
string

Entered by drivers when completing or failing a job for dispatchers.

​
dump_location_id
integer

Asset or asset cluster dump location identifier (e.g. trash bin needs dumped before returning from customer).

​
ends_at_customer
boolean

The job ends at the customer location when TRUE.

​
final_location_id
integer<int64>

Final location identifier. Used by dispatchers for prioritizing jobs. Used by drivers to know where to leave the asset on job completion.

​
is_acknowledged
boolean

True if the job has been acknowledged.

​
is_separate_from_route_list
boolean

This job should be separate from any per-route job list when TRUE.

​
merged_with_route_id
integer<int64>

IDs of the route which this job should be merged into.

​
pickup_date
string<date-time>

A pickup job is scheduled for this date upon job completion. If the asset or cluster is assigned to a route stop, the route stop will be deleted. Must be in the future.

​
priority
integer

Assigned by dispatchers for job order completion determination for drivers.

​
reference_number
string

Reference number (free text).

​
require_image
boolean

Set by dispatchers and drivers, requires drivers to upload one or more job images before completion.

​
require_materials
boolean

The driver is required to report the weights of any additional materials related to the job when TRUE.

​
require_signature
boolean

Set by dispatchers and drivers, requires drivers to get a customer signature before job completion.

​
require_weights
boolean

Set by disptachers and drivers, requires drivers to set material weights before job completion.

​
started_on
string<date-time>

Job starting time.

​
starts_at_customer
boolean

The job begins at the customer location when TRUE.

​
type
string

Set by dispatchers and customers. Represents physical actions to execute on job start.

Response

200 - application/json

Success

Job model.

​
add_to_routes
string
required

CSV of route IDs which the dropped asset should be assigned to.

​
add_to_routes_settings
object[]
required
​
additional_items
object[]
required
​
alternate_drop_type_id
integer<int64>
required

Alternate asset drop type identifier.

​
arrived_at_destination_on
string<date-time>
required

Job starting time.

​
arrived_on
string<date-time>
required

Drive start time entered by driver for dispatcher and customer (arrived at job slider).

​
asset
object
required

Asset profile.

​
asset_dropped_id
integer<int64>
required

DeployedBinID of the asset that was dropped by this job, only allowed to be set if the job's type is 'D' or 'E'.

​
asset_id
integer<int64>
required

Job asset identifier. Applicable to job types 'E', 'P', 'R'.

​
asset_quantity
integer
required

How many assets are being serviced within a cluster (for jobs assigned to an asset cluster). For jobs dispatched by routes, or manually dispatched route stops, this value is 0 or 1.

​
asset_type
object
required

Asset type profile.

​
asset_type_id
integer<int64>
required

Selected asset for the job (job types 'D', 'L', 'E').

​
completed_by
integer
required

Dispatcher or driver id.

​
completed_on
string<date-time>
required

Job completion time.

​
confirmed_on
string<date-time>
required

Job confirmation date.

​
created_by
integer
required

Customer, dispatcher, or driver id.

​
created_by_driver
boolean
required

Created by driver.

​
created_with_portal
boolean
required

Set record active state.

​
customer
object
required

Customer location profile.

​
customer_id
integer<int64>
required

Customer identifier.

​
customer_notes
string
required

Notes entered by customers to communicate with dispatchers.

​
departed_on
string<date-time>
required
​
desired_asset_desc
string
required

Free-form text entered by dispatchers and drivers to be used as the future asset description.

​
desired_end_time
string<date-time>
required

Future estimated time of job completion.

​
desired_start_time
string<date-time>
required

Time customer has requested job start, set by dispatchers for dispatchers and drivers.

​
dispatch_priority
string
required

Entered by dispatchers to determine dispatch order.

​
dispatched_by_route
integer<int64>
required

Route id of dispatching route (or NULL if not dispatched by a route).

​
dispatched_on
string<date-time>
required

Time the job is assigned to a truck.

​
dispatcher_notes
string
required

Entered by dispatchers, read by drivers and dispatchers.

​
do_confirm
boolean
required

Tell dispatcher that a customer should be contacted before job is dispatched.

​
driver_notes
string
required

Entered by drivers when completing or failing a job for dispatchers.

​
dropped_asset
object
required

Asset profile.

​
dropped_number
string
required
​
dump_location
object
required

Job dump destination profile.

​
dump_location_id
integer
required

Asset or asset cluster dump location identifier (e.g. trash bin needs dumped before returning from customer).

​
dumped_on
string<date-time>
required

Dump request completion date.

​
ends_at_customer
boolean
required

The job ends at the customer location when TRUE.

​
fail_reason
string
required

Failure description selected by a driver for use by dispatchers.

​
final_location
object
required

Job dump destination profile.

​
final_location_id
integer<int64>
required

Final location identifier. Used by dispatchers for prioritizing jobs. Used by drivers to know where to leave the asset on job completion.

​
flags
string
required

Job notes.

​
id
integer<int64>
required

Job identifier.

​
images
object[]
required
​
invoice_notes
string
required

Invoice notes from the billing system.

​
is_acknowledged
boolean
required

True if the job has been acknowledged.

​
is_completed
boolean
required

Job completion flag set by dispatchers and drivers.

​
is_declined
boolean
required

Job completion flag set by dispatchers and drivers.

​
is_deleted
boolean
required

Indicates whether job is still valid.

​
is_failed
boolean
required

Set by drivers and dispatchers to indicate a failed job.

​
is_paid
boolean
required
​
is_separate_from_route_list
boolean
required

This job should be separate from any per-route job list when TRUE.

​
job_group_id
integer<int64>
required

Job group identifier for group jobs (vs service, exchange, etc.).

​
last_updated_on
string<date-time>
required
​
line_1
string
required

Street address.

​
location_id
integer<int64>
required

Location identifier.

​
merged_with_route_id
integer<int64>
required

IDs of the route which this job should be merged into.

​
original_schedule_date
string<date-time>
required

Original scheduling date.

​
pickup_date
string<date-time>
required

A pickup job is scheduled for this date upon job completion. If the asset or cluster is assigned to a route stop, the route stop will be deleted. Must be in the future.

​
pickup_item
integer<int64>
required
​
priority
integer
required

Assigned by dispatchers for job order completion determination for drivers.

​
recur_active
boolean
required

Set timeline recur active.

​
recur_enabled
boolean
required

Set timeline recur enabled.

​
reference_number
string
required

Reference number (free text).

​
removed_number
string
required
​
requested_by
integer<int64>
required

Customer identifier.

​
requested_on
string<date-time>
required

Requested date.

​
require_image
boolean
required

Set by dispatchers and drivers, requires drivers to upload one or more job images before completion.

​
require_material
boolean
required

Set by dispatchers and drivers, requires drivers to set a material before completing a job.

​
require_materials
boolean
required

The driver is required to report the weights of any additional materials related to the job when TRUE.

​
require_signature
boolean
required

Set by dispatchers and drivers, requires drivers to get a customer signature before job completion.

​
require_weights
boolean
required

Set by disptachers and drivers, requires drivers to set material weights before job completion.

​
return_full
object[]
required
​
scale_ticket
string
required

Scale ticket.

​
schedule_date
string<date-time>
required

Scheduled job completion date.

​
start_location
object
required

Job dump destination profile.

​
start_location_id
integer<int64>
required

Pickup location for asset or asset cluster Set by dispatchers and drivers for drivers.

​
started_on
string<date-time>
required

Job starting time.

​
starts_at_customer
boolean
required

The job begins at the customer location when TRUE.

​
third_party_hauler_id
string<uuid>
required

Third party hauler identifier.

​
times_failed
integer
required

Number of times a job has been attempted and failed.

​
times_rolled_over
integer
required

Tracks job age in days for dispatchers.

​
truck_id
integer<int64>
required

Truck identifier.

​
type
string
required

Set by dispatchers and customers. Represents physical actions to execute on job start.

​
weighed_on
string<date-time>
required

Time of truck weight entry.