try out ↗

← API Index


/api/driver/bpos1

Store the geo position where the box is placed for a customer address. Requires power driver permission.

Parameters

Name Description Type
cid customer id int
lat box placement latitude double
lng box placement longitude double
adrname name/label of the address the box position belongs to string
aid address id, if a specific address is meant int
llq location quality 0..10 (10 = accuracy within 5m) int
note delivery place related note string
info arbitrary driver info for the office, logged separately string
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result bposduplicate 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 power driver
400 parameter_error Missing cid, lat, lng or adrname

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See bpos1.yaml

Referenced in skills