Get Job

GET /locations/{location_id}/jobs/{job_id}

Get job configuration.

Roles

Users with the following roles may access this endoint:

Admin
CrmUser
Dispatcher
Driver
ThirdPartyAdmin
ThirdPartyCrmUser
ThirdPartyDispatcher
ThirdPartyDriver

Request

GET /locations/{location_id}/jobs/{job_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Path Parameters

job_id Integer, Required

Job identifier.


location_id Integer, Required

Location identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

Authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

x-tenant-id Integer, 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.

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

Accept String

Mime type (e.g. application/json).

  • At least 1 and no more than 256 characters.

x-request-id String

Request identifier.

  • Valid UUID.

Response Body

Refer to JobModel for more details.

arrived_at_dest String

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

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

  • Date in an ISO 8601 compatible format.

asset Object

JobAssetModel

Asset profile.


asset_dropped Integer

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

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.

  • Greater than or equal to 0.

asset_type Object

JobAssetTypeModel

Asset type profile.


asset_type_id Integer

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


completed_by Integer

Dispatcher or driver id.


completed_by_driver Boolean

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

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

completed_on String

Job completion time.

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

confirmed_on String

Job confirmation date.

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

created_by_id Integer

Customer, dispatcher, or driver id.


created_with_portal Boolean

Set record active state.

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

customer Object

JobCustomerModel

Job customer.


customer_id Integer

Customer identifier.


customer_notes String

Notes entered by customers to communicate with dispatchers.

  • At least 0 and no more than 2048 characters.

departed_on String

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

desired_asset_desc String

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

Future estimated time of job completion.

  • Date in an ISO 8601 compatible format.

desired_start_time String

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

  • Date in an ISO 8601 compatible format.

dispatch_priority String

Entered by dispatchers to determine dispatch order.

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

dispatched_by_route Integer

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


dispatched_on String

Time the job is assigned to a truck.

  • Date in an ISO 8601 compatible format.

dispatcher_notes String

Entered by dispatchers, read by drivers and dispatchers.

  • At least 0 and no more than 2048 characters.

do_confirm Boolean

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

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

driver_notes String

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

  • At least 0 and no more than 2048 characters.

dropped_number String


dump_location Object

DumpDestinationModel

Job dump destination profile.


dump_location_id Integer

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


dumped_on String

Dump request completion date.

  • Date in an ISO 8601 compatible format.

fail_reason String

Failure description selected by a driver for use by dispatchers.

  • At least 0 and no more than 64 characters.

final_location Object

DumpDestinationModel

Job dump destination profile.


final_location_id Integer

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


flags String

Job notes.

  • At least 0 and no more than 64 characters.

id Integer

Job identifier.


invoice_notes String

Invoice notes from the billing system.

  • At least 0 and no more than 2048 characters.

is_completed Boolean

Job completion flag set by dispatchers and drivers.

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

is_declined Boolean

Job completion flag set by dispatchers and drivers.

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

is_deleted Boolean

Indicates whether job is still valid.

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

is_failed Boolean

Set by drivers and dispatchers to indicate a failed job.

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

is_paid Boolean


job_group_id Integer

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


last_updated_on String

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

location_id Integer

Location identifier.


materials Array[JobMaterialModel]

Refer to JobMaterialModel.


merged_with_route Integer

Assigned by dispatchers for dispatchers and drivers.


original_schedule_date String

Original scheduling date.

  • Date in an ISO 8601 compatible format.

pickup_date String

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


priority Integer

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

Reference number (free text).

  • At least 1 and no more than 256 characters.

removed_number String


requested_on String

Requested date.

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

require_image Boolean

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

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

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

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

Scale ticket.

  • At least 0 and no more than 64 characters.

schedule_date String

Scheduled job completion date.

  • Date in an ISO 8601 compatible format.

start_location Object

DumpDestinationModel

Job dump destination profile.


start_location_id Integer

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


third_party_hauler_id String

Third party hauler identifier.

  • Valid UUID.

times_failed Integer

Number of times a job has been attempted and failed.

  • Greater than or equal to 0.

times_rolled_over Integer

Tracks job age in days for dispatchers.

  • Greater than or equal to 0.

truck_id Integer

Truck identifier.


type String

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

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

weighed_on String

Time of truck weight entry.

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

Code Samples

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/locations/{location_id}/jobs/{job_id}