← API Index
/api/driver/pauses
List active driver pauses for a tour and date
Parameters
| Name |
Description |
Type |
| ddate |
delivery date id (ddates.id; resolves tourid automatically) |
int |
| tourid |
tour id (used when ddate not provided) |
int |
| oo-rf |
optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml |
String |
| oo-auth |
optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. |
int |
Error Responses
| HTTP Status |
Error Code |
Description |
| 403 |
access_error |
Not authenticated as driver |
| 400 |
parameter_error |
Missing tourid or ddate |
Response Types
| Type |
Version |
Description |
| DriverPause |
1 |
A scheduled driver pause |
OpenAPI
See pauses.yaml
Referenced in skills