| Available Services |
The REST web service provides services to support mobile operations. This API reference describes the available service types and the API operations for implementing each service. Each operation reference page provides the http request type (GET, POST, PUT, DELETE) and the service address to append to the base URL for the web service.
This topic contains the following sections:
Authentication- POST /login - provide a user name and password in order to obtain an authentication token.
Vehicles and vehicle assignment- GET /vehicles - Retrieve a list of available vehicles.
- GET /vehicle/<id> - Retrieve details about a specific vehicle.
- /driver_assignment - POST - Assign the authenticated user as the driver of a specified vehicle.
- POST /driver_unassignment - Remove assignment of the authenticated user from being the driver of a specified vehicle.
- GET /driver_assignments?from=<starttime>&to=<endtime> - Retrieve the history of vehicle assignments for the authenticated user.
Jobs, job types, and job assignment- GET /jobs/todo[?from=<starttime>&to=<endtime>] - Retrieve jobs on the authenticated user's to-do list.
- GET /jobs/completed[&from=<starttime>&to=<endtime>] - Retrieve jobs that were completed by the authenticated user.
- GET /jobs[?from=<starttime>&to=<endtime>] - Retrieve jobs that are assigned to the authenticated user which are expected to occur within a specific time window.
- GET /geocode/<country>/<address> - Get the location for an address (useful for creating jobs).
- GET /geocode/<lat>,<lon> - Get the address for a location (needed for WorkPlan).
- GET /job_types - Retrieve a list of all defined job types.
- POST /jobs - Create a new job or update one or more existing jobs.
Forms and form submission- GET /forms/<id>[,<id>]* - Retrieve one or more specified forms.
- GET /forms/submitted?from=<starttime>&to=<endtime> - Retrieve all forms submitted within a specified time period.
- GET /forms/submitted?limit=<number> - Retrieve the most recent forms up to a specified number.
- GET /forms?job_id=<job_id> - Retrieve all forms for a specified job.
- GET /forms - Search forms based on a combination of filters.
- POST /forms - Submit one or more forms.
- DELETE /forms - Remove one or more form instances.
- GET /form/<form_id>/events - Retrieve all recorded events for a form.
- POST /form/events - Submit one or more events for forms.
- GET /form_templates - Retrieve the form templates.
- GET /form_templates/<job_type_id> - Retrieve the form templates associated with a specified job type.
Driver details and settings- /driver - GET - Retrieve details of the currently logged-in driver.
- GET /vehicles - Retrieve a list of available vehicles.
- GET /vehicle/<id> - Retrieve details about a specific vehicle.
- /driver_assignment - POST - Assign the authenticated user as the driver of a specified vehicle.
- POST /driver_unassignment - Unssign the authenticated user as the driver of a specified vehicle.
- POST /locations - Insert locations into the system.
Signatures and photos- POST /sign?id=<id>&from=<starttime>&to=<endtime>&submission_time=<submissiontime> - Sign the specified days using a provided signature Id.
- GET /signature/<id>[,<id>]* - Retrieve the signature data associated with specified signature Ids.
- POST /signature - Add a signature Id and its associated data to those available for retrieval.
- GET /photos/<id> - Retrieve the photo and its associated data for the specified Id.
- POST /photos - Add a photo and associated metadata for use in a mobile form.
HOS events and reporting- GET /hos_event/<id> - Retrieve a status event by ID.
- GET /hos_event?time=<time> - Retrieve a status event by time.
- GET /hos_events?from=<starttime>&to=<endtime> - Retrieve status events for a specified time period.
- GET /hos_events/deleted?from=<starttime>&to=<endtime> - Retrieve deleted events within a given time period.
- POST /hos_events - Add or update one or more status events.
- DELETE /hos_events - Remove one or more existing status events.
- GET /hos_summary/<date> - Retrieve the latest HOS summary for a given date.
- GET /hos_summaries?from=<startDate>&to=<endDate> - Retrieve the latest HOS summary for each day within a date range.
- POST /hos_summaries - Add one or more HOS summaries.
Channels and Videos- GET /media - Retrieve all media information for the current user.
- GET /media/channels - Retrieve a user's available video channels
- GET /media/channels/<id> - Retrieve the details of a specific media channel.
- GET /media/video/<id> - Retrieve the details of a specific media video.
Users- GET /user - Retrieve all information about the current user.
TimeZones- GET /timezone/<abbreviation> - Retrieve all information about the requested time zone.