try out ↗

← API Index


/api/driver/deassign1

Remove a box assignment from a customer. The box must currently be assigned to the given cid. Box-level rejections (box_not_existing, unassigned, wrong_cid) are returned as result codes with HTTP 200, see the DriverAssignResult type.

Parameters

Name Description Type
boxname box identification, e.g. Q1453 string
tourid tour id int
tid alternative name for tourid int
cid customer id the box is expected to be assigned to int
dt timestamp as ISO8601 datetime; defaults to now string
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result deassignduplicate 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 or missing box assignment permission
400 parameter_error Missing boxname or tourid

Response Types

Type Version Description
DriverAssignResult 1 Result of a driver box (de-)assignment

OpenAPI

See deassign1.yaml

Referenced in skills