GET /jobs/todo[?from=<starttime>&to=<endtime>]

Description

This service retrieves all jobs that are:

marked as ToDo, and
assigned the driver who is currently logged in.

Optionally, you can specify a time window (in ISO 8601 format) to return only those jobs that have an expected arrival time that falls within that range.

If you do not include any time range, TDE returns ToDo jobs from today through the next 90 days.

Time ranges: For all GET /jobs calls, the default time range is today through the next 90 days. The maximum range you can specify is 90 days.

Request

No request body is used for this service.

Optional parameters

Name	Value	Description
from=<starttime>&to=<endtime>	ISO 8601 timestamp	Retrieves only relevant objects within the specified time frame.
updated_since	ISO 8601 timestamp	Finds items by modification time. This retrieves only those objects with one or more timestamp members, one of which falls after the specified timestamp.
list_all	false (default), true	(only usable with updated_since) If set to true, list_all retrieves a comprehensive list: ProductName returns a larger set of results that includes the IDs (or primary key values) of every object that falls within the selection range and the JSON for the updated objects. Setting list_all to true can be used, for example, if you need to refresh a local cache.

Response

On success, the response body contains a JSON array of job objects:

Member

Type

Purpose

string

(read-only) Uniquely identifies the job. This is an alphanumeric identifier.

status

string

Indicates the current status of the job. Values: Rejected (driver rejected the job), Todo (job is on route but not yet reached), EnRoute (previous job done but not yet reached next), OnSite (driver is at job), Completed.

This field can be updated through the API. If not specified, this field defaults to Todo.

address

Address

The address and location of the Job site, where the driver must go in order to perform a job:

Member	Type	Purpose
street	string	The street number and name of the address.
city	string	The city in which the address is located.
region	string	The region in which the address is located (e.g., state or province).
postalCode	string	The postal code or zip code of the address.
lat	double	(required for POST) The latitude of the address in decimal degrees.
lon	double	(required for POST) The longitude of the address in decimal degrees.
bearingFromStreet	double?	The side of the road on which the address is located, indicated as an angle in decimal degrees (0 is north, 90 is east).
suburb	string	The suburb in which the address is located.

This field can be updated through the API. When you create or update a job, provide the markerId, which will auto-populate the address (do not include both). If you cannot provide the markerId, you must provide the address, for which TDE will create a new marker that is associated with the job.

expectedArrival

string

The ISO 8601 timestamp for the expected arrival at the Job. If no timezone info is supplied, this value is assumed to be UTC (Zulu). This is an absolute time, not a time interval. This field can be updated through the API. It may also be modified by the server during optimization. This field is required when creating a new job.

minutesOnSite

int

(optional) The estimated number of minutes that will be spent on-site to complete this job. This field can be updated through the API.

forms

string[]

(read-only) An array of IDs for completed forms, containing from 0..n form IDs. See Form.Job as well.

notes

string

(optional) An arbitrary string of notes to attach to the Job. This field can be updated through the API.

jobType

string

(optional) The id for the job type that this job is based on. See GET /job_types. If the job type not supplied when a new job is created, the job is given a type of "Stop".

jobName

string

(optional) A human-readable job name. This is the name as entered by the user in Response, or as it displays in Response if it was submitted via the API.

lastUpdateTime

string

(read-only) The ISO 8601 timestamp for when the Job was last updated. This field is used to filter jobs when you use the updated_since query string parameter.

statusLastUpdateTime

string

(read-only) The ISO 8601 timestamp for when the Job Status was last updated. This field is used to filter jobs when you use the updated_since query string parameter.

actualArrival

string

The ISO 8601 timestamp for the actual arrival at the Job. If no timezone info is supplied, this value is assumed to be UTC (Zulu). This field can be updated through the API, but only when setting status to OnSite or Completed.

actualDeparture

string

The ISO 8601 timestamp for the actual departure from the Job. If no timezone info is supplied, this value is assumed to be UTC (Zulu). This field can be updated through the API, but only when setting status to Completed.

markerId

string

Uniquely identifies the marker for the job's location. When you create or update a job, provide the markerId, which will auto-populate the address (do not include both). If you cannot provide the markerId, you must provide the address, for which TDE will create a new marker that is associated with the job.

code

string

Free-form text that can be used to categorize the job.

routeId

string

(optional) Uniquely identifies the route for the job, if it exists.

routeName

string

(read-only) The human-readable name of the route.

custom

JSON object

(read-only) Contains one or more key-value pairs for any custom fields and values defined for the job. The items returned for this object can vary between jobs.

If the request fails, an Error Response is generated.