try out ↗

← API Index


/api/driver/state1

Report a driver tour state change (e.g. starttour) with optional car plate, temperature and mileage. The state is logged against the tour resolved from ddate.

Parameters

Name Description Type
state the state to report, e.g. starttour string
ddate delivery date id (ddates.id) to resolve the tour int
dt timestamp as ISO8601 datetime; defaults to now string
info short info, truncated to 20 characters in the log string
plate car identification (license plate), also logged to the car log string
t temperature reading int
km mileage status of the car int
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result stateduplicate 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

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See state1.yaml

Referenced in skills