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 role description
/drivers
GET /drivers Users Retrieves a List of Drivers with a full or partial match to given value.
GET /drivers/application/new Not Logged In 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 Users 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 Users Searches the database for drivers matching the given request parameters.
GET /drivers/userSavedSearch Users Retrieves a List of RowDriver objects based on an existing saved search.
GET /drivers/{id} Users, Drivers Retrieves the Driver record with the given ID.
GET /drivers/{id}/assignments Users, Drivers Retrieves a list of all past, present, and future movements for the driver with the given parameters.
GET /drivers/{id}/current Users, Drivers Retrieves the current movement record for the given driver ID.
GET /drivers/{id}/lastStop Users, Drivers Retrieves the last stop of the driver's last preassignment (or if none, the driver's current assignment).
GET /drivers/{id}/picture Users, Drivers Retrieves the driver's profile picture, if it exists.
GET /drivers/{id}/preassignments Users, Drivers Retrieves preassignments for the driver with the specified ID.
GET /drivers/{id}/revenueReport Users Produces a driver revenue report.
GET /drivers/{id}/scorecardReport Users, Drivers Produces the driver scorecard report.
POST /drivers/{id}/confirmNotDriving Drivers Notes that the given driver has confirmed he's not driving while using the application.
PUT /drivers/application/create Not Logged In Creates a new RowDriverApplication record for the given application data.
PUT /drivers/create Users Creates a new RowDriver record for the given Driver data.