route.

API REFERENCE

Read own-business local map style as authorized driver

GET/api/v1/driver/maps/styles

Business is derived from the driver session, never supplied by client; style URLs use private driver tile proxy. No other-business map configuration or order markers are returned.

Authentication

Requires a driver bearer session. Administrator sessions and integration keys cannot perform this driver action.

Parameters

No path or query parameters.

Request

No JSON request body is required.

Example request

Replace synthetic identifiers and credentials. Example dates, coordinates, revisions, and IDs are not production defaults. Read the workflow guide before making a write.

curl --request GET 'https://route-api.okok.space/api/v1/driver/maps/styles' \
  --header 'Authorization: Bearer REPLACE_WITH_DRIVER_TOKEN'

Responses

Examples illustrate the documented shape; optional fields and current state can differ. JSON extraction/body-limit errors may be plain text.

200 · Successful response

application/json

FieldTypeDescription & constraints
availablebooleanWhether full service and travel can fit within this candidate window.
styleobjectResource-specific value; see the related workflow and schema.
centerarray<number>Resource-specific value; see the related workflow and schema.
zoomnumberResource-specific value; see the related workflow and schema.
dataset_versionstringResource-specific value; see the related workflow and schema.
reasonstringRequired free-text explanation when work cannot be completed.
Illustrative response
{
  "available": false,
  "style": {},
  "center": [
    1
  ],
  "zoom": 1,
  "dataset_version": "example",
  "reason": "The customer could not provide access."
}
Response schema
{
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    },
    "style": {
      "type": "object"
    },
    "center": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "zoom": {
      "type": "number"
    },
    "dataset_version": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    }
  }
}

401 · Invalid/revoked driver session

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid/revoked driver session"
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}

403 · Required driver permission denied

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "unauthorized",
    "message": "Required driver permission denied"
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}

404 · Not found in own business

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "not_found",
    "message": "Not found in own business"
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}

422 · Validation failed

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "validation",
    "message": "Validation failed"
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}

503 · Required infrastructure unavailable

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "unavailable",
    "message": "Required infrastructure unavailable"
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}
← All endpointsIntegration workflows →