Skip to main content

UpdateJobProfileModel

Update job profile.

  • Drivers may not update the following: {'desired_start_time', 'confirm_on', 'pickup_date', 'do_confirm', 'require_materials', 'require_weights', 'dispatcher_notes', 'dispatch_priority', 'add_to_routes', 'require_image', 'add_to_routes_settings', 'is_separate_from_route_list', 'reference_number', 'require_signature', 'is_acknowledged', 'pickup_when_done', 'merged_with_route_id', 'priority', 'desired_asset_description', 'desired_end_time'}

Breaking Changes​

2021/11/04

  • created_by_id was renamed to created_by.

Examples​

Fill this template out with real values.

{
"add_to_routes": "String, optional",
"add_to_routes_settings": "array[[AddToRoutesSettingsModel](/docs/data_types/AddToRoutesSettingsModel)], optional",
"arrived_at_destination_on": "String, optional",
"asset_dropped_id": "Integer, optional",
"asset_id": "Integer, optional",
"asset_quantity": "Integer, optional",
"asset_type_id": "Integer, optional",
"departed_on": "String, optional",
"desired_asset_desc": "String, optional",
"desired_end_time": "String, optional",
"desired_start_time": "String, optional",
"dispatch_priority": "String, optional",
"dispatcher_notes": "String, optional",
"do_confirm": "Boolean, optional",
"driver_notes": "String, optional",
"dump_location_id": "Integer, optional",
"ends_at_customer": "Boolean, optional",
"final_location_id": "Integer, optional",
"is_acknowledged": "Boolean, optional",
"is_separate_from_route_list": "Boolean, optional",
"merged_with_route_id": "Integer, optional",
"pickup_date": "String, optional",
"priority": "Integer, optional",
"reference_number": "String, optional",
"require_image": "Boolean, optional",
"require_materials": "Boolean, optional",
"require_signature": "Boolean, optional",
"require_weights": "Boolean, optional",
"started_on": "String, optional",
"starts_at_customer": "Boolean, optional",
"type": "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.

arrived_at_destination_on String, Optional

Job starting time.

  • 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').

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').

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.

dump_location_id Integer, Optional

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

ends_at_customer Boolean, Optional

The job ends at the customer location when TRUE.

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

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.

is_acknowledged Boolean, Optional

True if the job has been acknowledged.

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

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).

merged_with_route_id Integer, Optional

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

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.

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.

reference_number String, Optional

Reference number (free text).

  • At least 1 and no more than 256 characters.

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_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).

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).

type String, Optional

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

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