| Action | Method | Resource | Description |
|---|---|---|---|
| Get all | GET | /drivergroups | Get all driver groups. |
| Get | GET | /drivergroups/drivergroup_id | Get driver group with id drivergroup_id. |
| Create | POST | /drivergroups | Create a driver group |
| Update | PUT | /drivergroups/drivergroup_id | Update driver group with id drivergroup_id. |
| Delete | DELETE | /drivergroups/drivergroup_id | Delete driver group with id drivergroup_id. |
The driver group model is composed of the following attributes:
| Attribute | Type | Required | Description | Whereable |
|---|---|---|---|---|
| administrator_id | integer | no, required to create. | User ID of administrador. | Yes |
| name | string | no, required to create. | The group's name. | Yes |
| drivers | json | no, required to create. | Array of driver id (e.g. [99,100,101...]) | No |
| enabled | boolean | no | The group's status. | Yes |
Requirement for use Driver group Endpoints.
To create, update, delete driver groups user must be user level 0, 2 or 5 (Type: Administrator, business owner or driver manager).
When business owner ask for drivergroups
When a business owner ask for drivergroups, just brings the ones associated with his businesses, this will always will response with 200 code if the drivergroup ID is valid, or if there is any will return an empty array.