try out ↗

← API Index


/api/driver/delpause

Delete a previously recorded driver pause, returning a PauseResult with id=0 to confirm deletion. The pauseid alone is sufficient - the tourid used as consistency guard in the delete is resolved from the pause row itself. ddate or tourid may optionally be supplied (PCG call shape); they are then cross-checked against the pause row and a mismatch is rejected.

Parameters

Name Description Type
pauseid id of the pause to delete (driver_pauses.id) int
ddate optional delivery date id (ddates.id); resolved to a tourid and cross-checked against the pause row int
tourid optional tour id; cross-checked against the pause row 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 pauseid; unknown pauseid; or supplied ddate/tourid names a different tour than the pause row

Response Types

Type Version Description
PauseResult 1 Result of a driver pause operation

OpenAPI

See delpause.yaml

Referenced in skills