Suggest approximate coverage for own-business work/regions

Approximate bounds, not proof of the smallest missing road corridor. Review/save the proposed geometry and explicitly approve download. Never classifies every routing failure as missing coverage.

Authentication

Authorized business administrator session, or a business API key with resources.read.

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/businesses/11111111-1111-4111-8111-111111111111/maps/coverage-proposal' \
  --header 'Authorization: Bearer REPLACE_WITH_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

{
  "available": false,
  "geometry": {},
  "requires_approval": false,
  "warning": "example",
  "reason": "The customer could not provide access."
}

{
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    },
    "geometry": {
      "type": "object"
    },
    "requires_approval": {
      "type": "boolean"
    },
    "warning": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    }
  }
}

401 · Invalid/revoked driver session

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid/revoked driver session"
  }
}

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

403 · Required driver permission denied

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Required driver permission denied"
  }
}

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

404 · Not found in own business

application/json

{
  "error": {
    "code": "not_found",
    "message": "Not found in own business"
  }
}

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

422 · Validation failed

application/json

{
  "error": {
    "code": "validation",
    "message": "Validation failed"
  }
}

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

503 · Required infrastructure unavailable

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required infrastructure unavailable"
  }
}

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