Drivers

Add, update, invite, enable and disable drivers, manage license types, and read or change how the driver app behaves for your company.

Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.

Drivers

Method	Path	Summary
GET	/Drivers	Search drivers.
POST	/Drivers	Add driver.
DELETE	/Drivers	Delete several drivers.
GET	/Drivers/{id}	Get driver.
PUT	/Drivers/{id}	Update driver.
DELETE	/Drivers/{id}	Delete driver.
POST	/Drivers/{id}/Invite	Invite driver.
POST	/Drivers/ChangeDriverStatus	Change driver status.
PUT	/Drivers/ChangeStatus/{status}	Change active or disabled driver status.
GET	/Drivers/DriversStats	Get drivers stats.
DELETE	/Drivers/Permanent/{id}	Permanently delete a driver.
PUT	/Drivers/Restore/{id}	Restore driver.
GET	/Drivers/StatusCheck	List truck inspection records submitted by drivers.
POST	/Drivers/ValidateDisable	Check whether drivers can be disabled.
POST	/Drivers/ValidateDriver	Validate driver details before saving them.

GET /Drivers

Search drivers.

Parameters

Name	In	Type	Required	Description
deletedDrivers	query	boolean	No	Default: false.
driversOnRoute	query	boolean	No
includeDriverAvailability	query	boolean	No	Default: false.

Also accepts the shared list parameters.

Response: envelope; data is DriverPagedList.

POST /Drivers

Add driver.

Required access: the Create/Edit Drivers permission.

Parameters

Name	In	Type	Required	Description
sendEmail	query	boolean	No	Default: false.

Request body: Driver (JSON).

Response: envelope; data is Driver.

DELETE /Drivers

Delete several drivers.

Required access: the Enable/Disable drivers permission.

Request body: array of integer (int32) (JSON).

Response: envelope; data has no documented shape.

GET /Drivers/{id}

Get driver.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is Driver.

PUT /Drivers/{id}

Update driver.

Required access: the Create/Edit Drivers permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: Driver (JSON).

Response: envelope; data is Driver.

DELETE /Drivers/{id}

Delete driver.

Required access: the Enable/Disable drivers permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

POST /Drivers/{id}/Invite

Invite driver.

Required access: the Create/Edit Drivers permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

POST /Drivers/ChangeDriverStatus

Change driver status.

Required access: the Create/Edit Drivers permission.

Parameters

Name	In	Type	Required	Description
driverStatus	query	string	No	One of: New, Approved, Blocked, Deactivated.
id	query	integer (int32)	No

Response: envelope; data is string. One of: New, Approved, Blocked, Deactivated.

PUT /Drivers/ChangeStatus/{status}

Change active or disabled driver status.

Required access: the Create/Edit Drivers permission.

Parameters

Name	In	Type	Required	Description
status	path	string	Yes	One of: Active, Inactive, Deleted, Draft, New, Invited, Disabled.
unassignPendingRoutes	query	boolean	No	Default: false.

Request body: array of integer (int32) (JSON).

Response: envelope; data has no documented shape.

GET /Drivers/DriversStats

Get drivers stats.

Parameters

Name	In	Type	Required	Description
driverId	query	integer (int32)	No

Response: envelope; data is DriversStats.

DELETE /Drivers/Permanent/{id}

Permanently delete a driver.

Required access: the Delete Drivers permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

PUT /Drivers/Restore/{id}

Restore driver.

Required access: the Enable/Disable drivers permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

GET /Drivers/StatusCheck

List truck inspection records submitted by drivers.

Required access: the Company Admin role.

Also accepts the shared list parameters.

Response: envelope; data is DriverStatusCheckPagedList.

POST /Drivers/ValidateDisable

Check whether drivers can be disabled.

Required access: the Enable/Disable drivers permission.

Request body: array of integer (int32) (JSON).

Response: envelope; data is ValidateDriverDisableDto.

POST /Drivers/ValidateDriver

Validate driver details before saving them.

Request body: Driver (JSON).

Response: envelope; data is ValidateDriverDto.

License types

Method	Path	Summary
GET	/LicenseTypes	List license types.
POST	/LicenseTypes	Create a license type.
PUT	/LicenseTypes	Update a license type.
DELETE	/LicenseTypes/{id}	Delete a license type.

GET /LicenseTypes

List license types.

Also accepts the shared list parameters.

Response: envelope; data is LicenseTypePagedList.

POST /LicenseTypes

Create a license type.

Required access: the Drivers settings - edit/delete data permission.

Request body: LicenseType (JSON).

Response: envelope; data is LicenseType.

PUT /LicenseTypes

Update a license type.

Required access: the Drivers settings - edit/delete data permission.

Request body: LicenseType (JSON).

Response: envelope; data is LicenseType.

DELETE /LicenseTypes/{id}

Delete a license type.

Required access: the Drivers settings - edit/delete data permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

Driver App settings

Method	Path	Summary
GET	/DriverApp/Flow	Get the Driver App flow settings.
PUT	/DriverApp/Flow	Update the Driver App flow settings.
GET	/DriverApp/Settings	Get the Driver App settings.
PUT	/DriverApp/Settings	Update the Driver App settings.

GET /DriverApp/Flow

Get the Driver App flow settings.

Response: envelope; data is array of UserPrompt.

PUT /DriverApp/Flow

Update the Driver App flow settings.

Request body: array of UserPrompt (JSON).

Response: envelope; data is array of UserPrompt.

GET /DriverApp/Settings

Get the Driver App settings.

Response: envelope; data is DriverApplicationSettings.

PUT /DriverApp/Settings

Update the Driver App settings.

Request body: DriverApplicationSettings (JSON).

Response: envelope; data is DriverApplicationSettings.