try out ↗

← API Index


/api/system/geo

Geo points (lat/lng + marker meta data) for the geo tools: addresses of tours, delivery dates or id lists, customers, driver tracks or registration misses. Exactly one selection mode is used, precedence: miss, cid, aid, did, tid+tf, tid. Replaces the legacy geo/data.jsp.

Parameters

Name Description Type
tid tour id (tours.tourid), repeatable; 0 = all tours. Without tf/ddate: the current addresses on these tours int
ddate with tid: delivery date spec (yyyy-mm-dd) to show the predicted addresses of that delivery day instead string
tf with a single tid: track date (yyyy-mm-dd). Returns the driver track positions of that day (kind=track) followed by the planned addresses string
did delivery date id (ddates.id), repeatable: the planned tour addresses (dtour) of these delivery dates int
aid comma separated delivery address id list. Additional lists may be given as aid1..aid19, each list forms its own color group string
cid comma separated customer id list, returned in the given sequence string
miss if set (1): positions of failed new-customer address lookups of the last year, colored by calendar week int
good 1 = only well geocoded points (llq >= 5) int
active 1 = only active customers int
notnew 1 = hide new customers that are not yet synced with the backend int
nosort if set: keep the given aid sequence instead of sorting by tour position 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 not_auth Session has no GEO_TOOL_ACCESS permission
400 parameter_error Invalid id list or date parameter

Response Types

Type Version Description
GeoPoint 1 A geo located point (delivery address, customer, registration miss or driver track position) as used by the geo tools

OpenAPI

See geo.yaml