DoRoutes API · version 1

Maps

GET/v1/admin/map/layers

The map layers

Any signed-in staff member. Each tile layer and whether it can be used this month; `truck` can't once the business's truck restriction tile allowance or the platform's cap is used.

Response 200 · object

Done.

layersarray of object, required
- namestring, required
  One of: base traffic truck
- availableboolean, required

Example response 200

{
  "layers": [
    {
      "name": "base",
      "available": true
    }
  ]
}

Response 401 · Error

No tenant key, or no valid session.

errorobject, required
- codestring, required
  A short machine-readable name, such as not_found.
- messagestring, required
  What went wrong, for people.
request_idstring, required
Matches the X-Request-ID response header.

Example response 401

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "request_id": "string"
}

Response 403 · Error

The session may not do this.

Fields as in The map layers

Response 500 · Error

Something failed on our side.

Fields as in The map layers

GET/v1/admin/map/tiles/{layer}/{z}/{x}/{y}

A map tile

Any signed-in staff member. A HERE vector tile in Web Mercator, for MapLibre. Each `base` or `traffic` tile served counts against the business's monthly map tile allowance; each `truck` tile against its truck restriction tile allowance, checked before the tile is fetched. The browser may keep a tile for a day.

Parameters

layerstring, in the path, required
`base` for the map, `traffic` for live traffic flow, `truck` for roads with their lorry restrictions (`hgv_restriction` and related properties on the `roads` layer).
zinteger, in the path, required
xinteger, in the path, required
From 0 to 2^z - 1.
yinteger, in the path, required
From 0 to 2^z - 1.