UpdateJobProfileModel

Update job profile.

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

Examples

Fill this template out with real values.

{
"add_to_routes_settings": "array[RouteSettingsModel], 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_description": "String, optional",
"desired_end_time": "String, optional",
"desired_start_time": "String, optional",
"dispatch_priority": "Integer, 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_settings Array[RouteSettingsModel], Optional

Refer to RouteSettingsModel.


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.


asset_quantity Integer, Optional

Number of assets that relate to this job, should be greater than zero and less than or equal to the number of assets in the cluster, if the asset's cluster is not-null. If the asset's cluster is NULL, the asset_quantity should be 1.

  • Greater than or equal to 0.

asset_type_id Integer, Optional

Job asset type identifier.


departed_on String, Optional

Job starting time.

  • Date in an ISO 8601 compatible format.

desired_asset_description String, Optional

Job asset description.

  • At least 0 and no more than 10240 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 Integer, Optional

One of 'H', 'M', 'L', that correspond to "High", "Medium", "Low". Specifies how important it is for a dispatcher to deal with and dispatch this job. Also influences job ordering for jobs with truck_id == None.

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

dispatcher_notes String, Optional

Job type identifier.

  • At least 0 and no more than 10240 characters.

do_confirm Boolean, Optional

Call the customer to confirm the job if TRUE.

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

driver_notes String, Optional

Job type identifier.

  • At least 0 and no more than 10240 characters.

dump_location_id Integer, Optional

ID of dump destination to dump the asset at.


ends_at_customer Boolean, Optional

The job begins at the customer location when TRUE.

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

final_location_id Integer, Optional

Holding yard ID to return asset to upon 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

Date when the asset should be picked up.

  • Date occurring in the future 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

Job starting time.

  • At least 0 and no more than 256 characters.

require_image Boolean, Optional

Require image if TRUE.

  • 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

When TRUE, signature is required.

  • 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

Job type identifier.

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