Driver location

Driver bearer session only. Revoked/deactivated account immediately blocked. Network loss never automatically ends duty. Refresh returns published plans/current execution and successful-refresh time; driver clients should refresh continuously and display last success. Location permission denial blocks work; GPS unavailable with permission granted does not.

Authentication

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

Parameters

No path or query parameters.

Request

Example JSON body

{
  "permission_granted": true,
  "location": {
    "latitude": 52.2297,
    "longitude": 21.0122
  }
}

{
  "type": "object",
  "properties": {
    "permission_granted": {
      "type": "boolean"
    },
    "location": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Location"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "permission_granted"
  ]
}

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 POST 'https://route-api.okok.space/api/v1/driver/location' \
  --header 'Authorization: Bearer REPLACE_WITH_DRIVER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"permission_granted":true,"location":{"latitude":52.2297,"longitude":21.0122}}'

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

{
  "id": "example-id",
  "created_at": "2026-11-02T09:00:00Z",
  "updated_at": "2026-11-02T09:00:00Z",
  "revision": 1,
  "deleted_at": "2026-11-02T09:00:00Z",
  "deleted_by": "11111111-1111-4111-8111-111111111111"
}

{
  "$ref": "#/components/schemas/Record"
}

401 · Missing/invalid/revoked token

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Missing/invalid/revoked token"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

403 · Business membership or required API-key scope denied

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Business membership or required API-key scope denied"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

404 · Record not found in authorized business

application/json

{
  "error": {
    "code": "not_found",
    "message": "Record not found in authorized business"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

409 · Duplicate identifier, stale revision, expired reservation, protected publication or unavailable capacity

application/json

{
  "error": {
    "code": "conflict",
    "message": "Duplicate identifier, stale revision, expired reservation, protected publication or unavailable capacity"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

422 · Domain validation rejected the operation

application/json

{
  "error": {
    "code": "validation",
    "message": "Domain validation rejected the operation"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

503 · Required persistence, map/routing or other infrastructure unavailable

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required persistence, map/routing or other infrastructure unavailable"
  }
}

{
  "$ref": "#/components/schemas/Error"
}