try out ↗

← API Index


/api/driver/setstart1

Set the start time of a tour. With a ddate the start applies to that specific tour run; with only a tourid the general start time of the tour is set.

Parameters

Name Description Type
starttime tour start time (ISO8601 datetime with timezone) string
ddate delivery date id (ddates.id) for a run-specific start int
tourid tour id - required when no ddate is given (general start) int
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result setstartduplicate 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 starttime, bad starttime format, or neither ddate nor tourid given

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See setstart1.yaml

Referenced in skills