← API Index
/api/driver/setpause1
Record a planned or actual driver pause, returning the stored pause with its computed start and end times. Pass either length (minutes) or endtime - exactly one is required. To set a recurring pause that applies to every run of a tour (e.g. a standing lunch pause set by PCG), pass ddate=0 and include tourid; for a date-specific pause, pass the ddates.id as ddate.
Parameters
| Name |
Description |
Type |
| ddate |
delivery date id (ddates.id); pass 0 for a general pause that applies to all runs of this tour |
int |
| tourid |
tour id - required when ddate=0 |
int |
| starttime |
pause start time (ISO8601 datetime with timezone, e.g. 2026-06-25T10:00:00+02:00) |
string |
| length |
pause length in minutes; mutually exclusive with endtime |
int |
| endtime |
pause end time (ISO8601 datetime with timezone); mutually exclusive with length |
string |
| 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 ddate, starttime, or neither/both of length/endtime; or endtime <= starttime; or datetime missing timezone offset |
Response Types
| Type |
Version |
Description |
| PauseResult |
1 |
Result of a driver pause operation |
OpenAPI
See setpause1.yaml
Referenced in skills