go back Home

DriverService

This service provides operations that allow callers to retrieve and update drivers, enter driver applications for employment and to run various individually-scoped reports.

Operations

name description
GET /drivers Retrieves a List of Drivers with a full or partial match to given value.
GET /drivers/application/new Creates a driver application object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /drivers/new Creates a driver object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /drivers/search Searches the database for drivers matching the given request parameters.
GET /drivers/userSavedSearch Retrieves a List of RowDriver objects based on an existing saved search.
GET /drivers/{id} Retrieves the Driver record with the given ID.
GET /drivers/{id}/assignments Retrieves a list of all past, present, and future movements for the driver with the given parameters.
GET /drivers/{id}/current Retrieves the current movement record for the given driver ID.
GET /drivers/{id}/preassignments Retrieves preassignments for the driver with the specified ID.
GET /drivers/{id}/revenueReport Produces a driver revenue report.
GET /drivers/{id}/scorecardReport Produces the driver scorecard report.
POST /drivers/{id}/confirmNotDriving Notes that the given driver has confirmed he's not driving while using the application.
PUT /drivers/application/create Creates a new RowDriverApplication record for the given application data.
PUT /drivers/create Creates a new RowDriver record for the given Driver data.
PUT /drivers/update Updates a RowDriver record for the given Driver data.