JobModel

Job profile.

Examples

Fill this template out with real values.

{
"arrived_at_dest": "String",
"arrived_on": "String",
"asset": "JobAssetModel",
"asset_dropped": "Integer",
"asset_id": "Integer",
"asset_quantity": "Integer",
"asset_type": "JobAssetTypeModel",
"asset_type_id": "Integer",
"completed_by": "Integer",
"completed_by_driver": "Boolean",
"completed_on": "String",
"confirmed_on": "String",
"created_by_id": "Integer",
"created_with_portal": "Boolean",
"customer": "JobCustomerModel",
"customer_id": "Integer",
"customer_notes": "String",
"departed_on": "String",
"desired_asset_desc": "String",
"desired_end_time": "String",
"desired_start_time": "String",
"dispatch_priority": "String",
"dispatched_by_route": "Integer",
"dispatched_on": "String",
"dispatcher_notes": "String",
"do_confirm": "Boolean",
"driver_notes": "String",
"dropped_number": "String",
"dump_location": "DumpDestinationModel",
"dump_location_id": "Integer",
"dumped_on": "String",
"fail_reason": "String",
"final_location": "DumpDestinationModel",
"final_location_id": "Integer",
"flags": "String",
"id": "Integer",
"invoice_notes": "String",
"is_completed": "Boolean",
"is_declined": "Boolean",
"is_deleted": "Boolean",
"is_failed": "Boolean",
"is_paid": "Boolean",
"job_group_id": "Integer",
"last_updated_on": "String",
"location_id": "Integer",
"materials": "array[JobMaterialModel]",
"merged_with_route": "Integer",
"original_schedule_date": "String",
"pickup_date": "String",
"pickup_item": "Integer",
"priority": "Integer",
"reference_number": "String",
"removed_number": "String",
"requested_on": "String",
"require_image": "Boolean",
"require_material": "Boolean",
"require_signature": "Boolean",
"require_weights": "Boolean",
"scale_ticket": "String",
"schedule_date": "String",
"start_location": "DumpDestinationModel",
"start_location_id": "Integer",
"third_party_hauler_id": "String",
"times_failed": "Integer",
"times_rolled_over": "Integer",
"truck_id": "Integer",
"type": "String",
"weighed_on": "String"
}

Fields

arrived_at_dest String, Required

Entered by driver for dispatcher and customer. Asset arrival at destination time. Only applicable for jobs with a valid dump destination.

  • Date in an ISO 8601 compatible format.

arrived_on String, Required

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

  • Date in an ISO 8601 compatible format.

asset Object, Required

JobAssetModel

Asset profile.


asset_dropped Integer, Required

Reference to deployed asset entered by driver for customer, dispatcher applicable to job types 'D', 'E'.

  • Less than or equal to 10000.
  • Greater than or equal to 0.

asset_id Integer, 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.

  • Greater than or equal to 0.

asset_type Object, Required

JobAssetTypeModel

Asset type profile.


asset_type_id Integer, Required

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


completed_by Integer, Required

Dispatcher or driver id.


completed_by_driver Boolean, Required

If TRUE, completed by driver. If FALSE, completed by dispatcher.

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

completed_on String, Required

Job completion time.

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

confirmed_on String, Required

Job confirmation date.

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

created_by_id Integer, Required

Customer, dispatcher, or driver id.


created_with_portal Boolean, Required

Set record active state.

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

customer Object, Required

JobCustomerModel

Job customer.


customer_id Integer, Required

Customer identifier.


customer_notes String, Required

Notes entered by customers to communicate with dispatchers.

  • At least 0 and no more than 2048 characters.

departed_on String, Required

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

desired_asset_desc String, Required

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

Future estimated time of job completion.

  • Date in an ISO 8601 compatible format.

desired_start_time String, Required

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

  • Date in an ISO 8601 compatible format.

dispatch_priority String, Required

Entered by dispatchers to determine dispatch order.

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

dispatched_by_route Integer, Required

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


dispatched_on String, Required

Time the job is assigned to a truck.

  • Date in an ISO 8601 compatible format.

dispatcher_notes String, Required

Entered by dispatchers, read by drivers and dispatchers.

  • At least 0 and no more than 2048 characters.

do_confirm Boolean, Required

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

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

driver_notes String, Required

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

  • At least 0 and no more than 2048 characters.

dropped_number String, Required


dump_location Object, Required

DumpDestinationModel

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

Dump request completion date.

  • Date in an ISO 8601 compatible format.

fail_reason String, Required

Failure description selected by a driver for use by dispatchers.

  • At least 0 and no more than 64 characters.

final_location Object, Required

DumpDestinationModel

Job dump destination profile.


final_location_id Integer, 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.

  • At least 0 and no more than 64 characters.

id Integer, Required

Job identifier.


invoice_notes String, Required

Invoice notes from the billing system.

  • At least 0 and no more than 2048 characters.

is_completed Boolean, Required

Job completion flag set by dispatchers and drivers.

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

is_declined Boolean, Required

Job completion flag set by dispatchers and drivers.

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

is_deleted Boolean, Required

Indicates whether job is still valid.

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

is_failed Boolean, Required

Set by drivers and dispatchers to indicate a failed job.

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

is_paid Boolean, Required


job_group_id Integer, Required

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


last_updated_on String, Required

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

location_id Integer, Required

Location identifier.


materials Array[JobMaterialModel], Required

Refer to JobMaterialModel.


merged_with_route Integer, Required

Assigned by dispatchers for dispatchers and drivers.


original_schedule_date String, Required

Original scheduling date.

  • Date in an ISO 8601 compatible format.

pickup_date String, 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.

  • Date in an ISO 8601 compatible format.

pickup_item Integer, Required


priority Integer, Required

Assigned by dispatchers for job order completion determination for drivers.

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

reference_number String, Required

Reference number (free text).

  • At least 1 and no more than 256 characters.

removed_number String, Required


requested_on String, Required

Requested date.

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

require_image Boolean, Required

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

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

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

require_signature Boolean, Required

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

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

Scale ticket.

  • At least 0 and no more than 64 characters.

schedule_date String, Required

Scheduled job completion date.

  • Date in an ISO 8601 compatible format.

start_location Object, Required

DumpDestinationModel

Job dump destination profile.


start_location_id Integer, Required

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


third_party_hauler_id String, Required

Third party hauler identifier.

  • Valid UUID.

times_failed Integer, Required

Number of times a job has been attempted and failed.

  • Greater than or equal to 0.

times_rolled_over Integer, Required

Tracks job age in days for dispatchers.

  • Greater than or equal to 0.

truck_id Integer, Required

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

Time of truck weight entry.

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