Overview of /users
For an example of how to use our /users endpoints in a typical business scenario, refer to TMS Integration Workflow.
A users object represents a driver or a fleet manager. The fleet's data is either associated with a user, vehicle, or both. User can have one the following three roles: driver, fleet_admin, or fleet_user.
Drivers can login to the Motive's mobile app, record Hours of Service logs, create inspection reports, upload documents, send messages, etc. In order to calculate availability times and determine if your driver has a violation on his logs, we require you to select a HOS cycle for your driver. Each HOS cycle listed below has some additional exceptions that you can select from:
| Cycle API Value | Description | Allowed Exceptions | Violations |
|---|---|---|---|
| 70_8 | USA Property 70 hour / 8 day | exception_24_hour_restart exception_8_hour_break exception_short_haul | duty_16 duty_14 driving_11 break_30 cycle_70 |
| 60_7 | USA Property 60 hour / 7 day | exception_24_hour_restart exception_8_hour_break exception_short_haul | duty_16 duty_14 driving_11 break_30 cycle_60 |
| 70_8_o | USA Oil and Gas 70 hour / 8 day | exception_24_hour_restart exception_8_hour_break exception_wait_time exception_short_haul | duty_16 duty_14 driving_11 break_30 cycle_70 |
| 60_7_o | USA Oil and Gas 60 hour / 7 day | exception_24_hour_restart exception_8_hour_break exception_wait_time exception_short_haul | duty_16 duty_14 driving_11 break_30 cycle_60 |
| 70_8_p | USA Passenger 70 hour / 8 day | duty_15 driving_10 cycle_70_p | |
| 60_7_p | USA Passenger 60 hour / 7 day | duty_15 driving_10 cycle_60_p | |
| 80_8 | California Property 80 hour / 8 day | exception_24_hour_restart | ca_driving_12 ca_duty_16 ca_cycle_80 |
| 80_8_o | California Oil and Gas 80 hour / 8 day | exception_24_hour_restart exception_wait_time | ca_driving_12 ca_duty_16 ca_cycle_80 |
| 80_8_p | California Passenger 80 hour / 8 day | exception_ca_farm_school_bus | ca_driving_10 ca_duty_15 ca_cycle_80_p ca_duty_16 |
| tx_70_7 | Texas 70 hour / 7 day | exception_24_hour_restart | tx_driving_12 tx_duty_15 tx_cycle_70 |
| ak_70_7 | Alaska Property 70 hour / 7 day | exception_24_hour_restart | ak_duty_20, ak_driving_15, ak_cycle_70 |
| ak_80_8 | Alaska Property 80 hour / 8 day | exception_24_hour_restart | ak_duty_20, ak_driving_15, ak_cycle_80 |
| ak_70_7_o | Alaska Oil and Gas 70 hour / 7 day | exception_24_hour_restart exception_wait_time | ak_duty_20, ak_driving_15, ak_cycle_70 |
| ak_80_8_o | Alaska Oil and Gas 80 hour / 8 day | exception_24_hour_restart exception_wait_time | ak_duty_20, ak_driving_15, ak_cycle_80 |
| ak_70_7_p | Alaska Passenger 70 hour / 7 day | ak_duty_20 ak_driving_15 ak_cycle_70_p | |
| ak_80_8_p | Alaska Passenger 80 hour / 8 day | ak_duty_20 ak_driving_15 ak_cycle_80_p | |
| 70_7 | Canada South 70 hour / 7 day (Cycle 1) | canada_driving_13 canada_duty_14 canada_duty_16 canada_daily_driving_13 canada_daily_duty_14 canada_daily_break_10 canada_cycle_70 canada_break_24 | |
| 120_14 | Canada South 120 hour / 14 day (Cycle 2) | canada_driving_13 canada_duty_14 canada_duty_16 canada_daily_driving_13 canada_daily_duty_14 canada_daily_break_10 canada_cycle_120 canada_break_24 canada_break_24_70 | |
| canada_oil | Canada South Oil and Gas | exception_wait_time | canada_oil_driving_13 canada_oil_duty_14 canada_oil_duty_16 canada_oil_daily_driving_13 canada_oil_daily_duty_14 canada_oil_daily_break_10 canada_oil_break_3_24 |
| 80_7 | Canada North 80 hour / 7 day (Cycle 1) | canada_driving_15 canada_duty_18 canada_duty_20 canada_daily_break_8 canada_cycle_80 canada_break_24 | |
| 120_14_north | Canada North 120 hour / 14 day (Cycle 2) | canada_driving_15 canada_duty_18 canada_duty_20 canada_daily_break_8 canada_cycle_120 canada_break_24_80 | |
| Other | Other |
Following is the list of exceptions with description:
| Exception API name | Description |
|---|---|
| exception_24_hour_restart | 24 hour restart exception allows any 24+ hour "off_duty" or "sleeper" period to start a new cycle. |
| exception_8_hour_break | 8 hour break exception exempts the driver from taking 30+ minutes breaks. |
| exception_wait_time | Wait time exception adds a 5th status to the log chart and any time spent waiting does not count towards the 14 hour shift limit. |
| exception_short_haul | Short haul exception allows a 16 hour shift once per week or after a 34 hour restart. |
| exception_ca_farm_school_bus | Farm/School bus exception allows for a 16 hour shift limit. |
Following is this list of violations with description:
| Violation API name | Description |
|---|---|
| break_30 | 30 Minute Break Required |
| driving_11 | 11 Hour Driving Limit |
| duty_14 | 14 Hour Shift Limit |
| duty_16 | 16 Hour Shift Limit |
| cycle_60 | 60 Hour Cycle Limit |
| cycle_70 | 70 Hour Cycle Limit |
| driving_10 | 10 Hour Driving Limit |
| duty_15 | 15 Hour On Duty Limit |
| cycle_60_p | 60 Hour Cycle Limit |
| cycle_70_p | 70 Hour Cycle Limit |
| canada_driving_13 | 13 Hour Driving Limit |
| canada_driving_15 | 15 Hour Driving Limit |
| canada_duty_14 | 14 Hour On Duty Limit |
| canada_duty_16 | 16 Hour Shift Limit |
| canada_duty_18 | 18 Hour On Duty Limit |
| canada_duty_20 | 20 Hour Shift Limit |
| canada_daily_break_8 | Daily 8 Hours Off Duty Required |
| canada_daily_break_10 | Daily 10 Hours Off Duty Required |
| canada_daily_driving_13 | Daily 13 Hour Driving Limit |
| canada_daily_duty_14 | Daily 14 Hour On Duty Limit |
| canada_cycle_70 | 70 Hour Cycle Limit |
| canada_cycle_80 | 80 Hour Cycle Limit |
| canada_cycle_120 | 120 Hour Cycle Limit |
| canada_break_24 | 24 Hour Break Required |
| canada_break_24_70 | 24 Hour Break Required |
| canada_break_24_80 | 24 Hour Break Required |
| canada_oil_driving_13 | 13 Hour Driving Limit |
| canada_oil_duty_14 | 14 Hour On Duty Limit |
| canada_oil_duty_16 | 16 Hour Shift Limit |
| canada_oil_break_3_24 | Three 24 Hour Breaks Required |
| canada_oil_daily_driving_13 | Daily 13 Hour Driving Limit |
| canada_oil_daily_duty_14 | Daily 14 Hour On Duty Limit |
| canada_oil_daily_break_10 | Daily 10 Hours Off Duty Required |
| ca_driving_12 | 12 Hour Driving Limit |
| ca_duty_16 | 16 Hour Shift Limit |
| ca_cycle_80 | 80 Hour Cycle Limit |
| ca_driving_10 | 10 Hour Driving Limit |
| ca_duty_15 | 15 Hour On Duty Limit |
| ca_duty_16_p | 16 Hour On Duty Limit |
| ca_cycle_80_p | 80 Hour Cycle Limit |
| tx_driving_12 | 12 Hour Driving Limit |
| tx_duty_15 | 15 Hour On Duty Limit |
| tx_cycle_70 | 70 Hour Cycle Limit |
| ak_cycle_70 | 70 Hour Cycle Limit |
| ak_cycle_80 | 80 Hour Cycle Limit |
| ak_duty_20 | 20 Hour Shift Limit |
| ak_driving_15 | 15 Hour Driving Limit |
| ak_cycle_70_p | 70 Hour Cycle Limit |
| ak_cycle_80_p | 80 Hour Cycle Limit |
Behind the scenes, we also track driver's performance, time driver spends driving vs idling, etc. This data is automatically recorded from the hardware device and is associated with the driver based on his driving records.
Fleet admins or fleet users have access to Motive's web dashboard. You can look at drivers' or vehicles' data and manage the fleet. Please note that fleet managers cannot use Motive's driver mobile app.
Following set of endpoints can be used to manage users including getting existing users' information, provisioning new users, and modifying users' settings.
Deleting Users
Once a user is created, it cannot be deleted. The status of the user can be set to deactivated, but it is not same as deleting the user. You will continue to see the provisioned user in the web dashboard.