CreateJobRequestBodyModel

Update job profile.

Breaking Changes

2021/11/04

• created_by_id was renamed to created_by.

Examples

Template

Fill this template out with real values.

{
"add_to_routes": "String, optional",
"add_to_routes_settings": "array[[AddToRoutesSettingsModel](/docs/data_types/AddToRoutesSettingsModel)], optional",
"address_id": "Integer",
"arrived_at_destination_on": "String, optional",
"arrived_on": "String, optional",
"asset_dropped_id": "Integer, optional",
"asset_id": "Integer, optional",
"asset_quantity": "Integer, optional",
"asset_type_id": "Integer, optional",
"completed_by": "Integer, optional",
"completed_on": "String, optional",
"confirmed_on": "String, optional",
"created_by_driver": "Boolean, optional",
"created_with_portal": "Boolean, optional",
"customer_id": "Integer, optional",
"customer_notes": "String, optional",
"departed_on": "String, optional",
"desired_asset_desc": "String, optional",
"desired_end_time": "String, optional",
"desired_start_time": "String, optional",
"dispatch_priority": "String, optional",
"dispatched_by_route": "Integer, optional",
"dispatched_on": "String, optional",
"dispatcher_notes": "String, optional",
"do_confirm": "Boolean, optional",
"driver_notes": "String, optional",
"dropped_number": "String, optional",
"dump_location_id": "Integer, optional",
"dumped_on": "String, optional",
"ends_at_customer": "Boolean, optional",
"fail_reason": "String, optional",
"final_location_id": "Integer, optional",
"flags": "String, optional",
"invoice_notes": "String, optional",
"is_acknowledged": "Boolean, optional",
"is_completed": "Boolean, optional",
"is_declined": "Boolean, optional",
"is_deleted": "Boolean, optional",
"is_failed": "Boolean, optional",
"is_paid": "Boolean, optional",
"is_separate_from_route_list": "Boolean, optional",
"job_group_id": "Integer, optional",
"last_updated_on": "String, optional",
"merged_with_route_id": "Integer, optional",
"original_schedule_date": "String, optional",
"pickup_date": "String, optional",
"pickup_item": "Integer, optional",
"priority": "Integer, optional",
"recur_active": "Boolean, optional",
"recur_enabled": "Boolean, optional",
"reference_number": "String, optional",
"removed_number": "String, optional",
"requested_by": "Integer",
"requested_on": "String, optional",
"require_image": "Boolean, optional",
"require_material": "Boolean, optional",
"require_materials": "Boolean, optional",
"require_signature": "Boolean, optional",
"require_weights": "Boolean, optional",
"scale_ticket": "String, optional",
"schedule_date": "String, optional",
"start_location_id": "Integer, optional",
"started_on": "String, optional",
"starts_at_customer": "Boolean, optional",
"third_party_hauler_id": "String, optional",
"times_failed": "Integer, optional",
"times_rolled_over": "Integer, optional",
"truck_id": "Integer, optional",
"type": "String",
"weighed_on": "String, optional"
}

Fields

add_to_routes String, Optional

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

• At least 0 and no more than 2048 characters.
• List of 1 or more comma-separated integer identifiers. Whitespace allowed (newline, space, tab).

---

add_to_routes_settings Array[AddToRoutesSettingsModel], Optional

Refer to AddToRoutesSettingsModel.

---

address_id Integer, Required

Customer address identifier.

---

arrived_at_destination_on String, Optional

Job starting time.

• Date in an ISO 8601 compatible format.

---

arrived_on String, Optional

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

• Date in an ISO 8601 compatible format.

---

asset_dropped_id Integer, Optional

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, Optional

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

---

asset_quantity Integer, Optional

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.

• Greater than or equal to 0.

---

asset_type_id Integer, Optional

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

---

completed_by Integer, Optional

Dispatcher or driver id.

---

completed_on String, Optional

Job completion time.

• Date occurring in the past in an ISO 8601 compatible format.

---

confirmed_on String, Optional

Job confirmation date.

• Date occurring in the past in an ISO 8601 compatible format.

---

created_by_driver Boolean, Optional

Created by driver.

• One of 0, 1, True, False (case insensitive).

---

created_with_portal Boolean, Optional

Set record active state.

• One of 0, 1, True, False (case insensitive).

---

customer_id Integer, Optional

Customer identifier.

---

customer_notes String, Optional

Notes entered by customers to communicate with dispatchers.

• At least 0 and no more than 2048 characters.

---

departed_on String, Optional

• Date occurring in the past in an ISO 8601 compatible format.

---

desired_asset_desc String, Optional

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

• At least 1 and no more than 2048 characters.

---

desired_end_time String, Optional

Future estimated time of job completion.

• Date in an ISO 8601 compatible format.

---

desired_start_time String, Optional

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

• Date in an ISO 8601 compatible format.

---

dispatch_priority String, Optional

Entered by dispatchers to determine dispatch order.

• One of: 'H', 'L', 'M' ('H'='High', 'L'='Low', 'M'='Medium').

---

dispatched_by_route Integer, Optional

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

---

dispatched_on String, Optional

Time the job is assigned to a truck.

• Date in an ISO 8601 compatible format.

---

dispatcher_notes String, Optional

Entered by dispatchers, read by drivers and dispatchers.

• At least 0 and no more than 2048 characters.

---

do_confirm Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

driver_notes String, Optional

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

• At least 0 and no more than 2048 characters.

---

dropped_number String, Optional

---

dump_location_id Integer, Optional

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

---

dumped_on String, Optional

Dump request completion date.

• Date in an ISO 8601 compatible format.

---

ends_at_customer Boolean, Optional

The job ends at the customer location when TRUE.

• One of 0, 1, True, False (case insensitive).

---

fail_reason String, Optional

Failure description selected by a driver for use by dispatchers.

• At least 0 and no more than 64 characters.

---

final_location_id Integer, Optional

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

---

flags String, Optional

Job notes.

• At least 0 and no more than 64 characters.

---

invoice_notes String, Optional

Invoice notes from the billing system.

• At least 0 and no more than 2048 characters.

---

is_acknowledged Boolean, Optional

True if the job has been acknowledged.

• One of 0, 1, True, False (case insensitive).

---

is_completed Boolean, Optional

Job completion flag set by dispatchers and drivers.

• One of 0, 1, True, False (case insensitive).

---

is_declined Boolean, Optional

Job completion flag set by dispatchers and drivers.

• One of 0, 1, True, False (case insensitive).

---

is_deleted Boolean, Optional

Indicates whether job is still valid.

• One of 0, 1, True, False (case insensitive).

---

is_failed Boolean, Optional

Set by drivers and dispatchers to indicate a failed job.

• One of 0, 1, True, False (case insensitive).

---

is_paid Boolean, Optional

---

is_separate_from_route_list Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

job_group_id Integer, Optional

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

---

last_updated_on String, Optional

• Date occurring in the past in an ISO 8601 compatible format.

---

merged_with_route_id Integer, Optional

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

---

original_schedule_date String, Optional

Original scheduling date.

• Date in an ISO 8601 compatible format.

---

pickup_date String, Optional

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.

• Date in an ISO 8601 compatible format.

---

pickup_item Integer, Optional

---

priority Integer, Optional

Assigned by dispatchers for job order completion determination for drivers.

• Less than or equal to -1.
• Greater than or equal to -999999.

---

recur_active Boolean, Optional

Set timeline recur active.

• One of 0, 1, True, False (case insensitive).

---

recur_enabled Boolean, Optional

Set timeline recur enabled.

• One of 0, 1, True, False (case insensitive).

---

reference_number String, Optional

Reference number (free text).

• At least 1 and no more than 256 characters.

---

removed_number String, Optional

---

requested_by Integer, Required

Customer identifier.

---

requested_on String, Optional

Requested date.

• Date occurring in the past in an ISO 8601 compatible format.

---

require_image Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

require_material Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

require_materials Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

require_signature Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

require_weights Boolean, Optional

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

• One of 0, 1, True, False (case insensitive).

---

scale_ticket String, Optional

Scale ticket.

• At least 0 and no more than 64 characters.

---

schedule_date String, Optional

Scheduled job completion date.

• Date in an ISO 8601 compatible format.

---

start_location_id Integer, Optional

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

---

started_on String, Optional

Job starting time.

• Date in an ISO 8601 compatible format.

---

starts_at_customer Boolean, Optional

The job begins at the customer location when TRUE.

• One of 0, 1, True, False (case insensitive).

---

third_party_hauler_id String, Optional

Third party hauler identifier.

• Valid UUID.

---

times_failed Integer, Optional

Number of times a job has been attempted and failed.

• Greater than or equal to 0.

---

times_rolled_over Integer, Optional

Tracks job age in days for dispatchers.

• Greater than or equal to 0.

---

truck_id Integer, Optional

Truck identifier.

---

type String, Required

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

• One of: 'D', 'E', 'L', 'P', 'R'.

---

weighed_on String, Optional

Time of truck weight entry.

• Date occurring in the past in an ISO 8601 compatible format.