← HomeFleetPay / Schema

RotaRoteirizacao

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

idstringOptional

Route identifier (concatenation of plaza IDs).

nomestringOptional

Identified route name.

distancia_kmnumberOptional

Estimated highway distance in kilometers.

tempo_estimadostringOptional

Estimated travel duration.

recomendadabooleanOptional

Indicates whether the route is the main/recommended one by the operator.

Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identificador da rota (concatenação dos ids das praças)."
    },
    "nome": {
      "type": "string",
      "description": "Nome da rota identificada."
    },
    "distancia_km": {
      "type": "number",
      "description": "Distância rodoviária estimada em quilômetros."
    },
    "tempo_estimado": {
      "type": "string",
      "description": "Tempo estimado de percurso."
    },
    "recomendada": {
      "type": "boolean",
      "description": "Indica se a rota é a principal/recomendada pela operadora."
    },
    "pracas": {
      "type": "array",
      "description": "Praças de pedágio físicas no trajeto.",
      "items": {
        "$ref": "#/components/schemas/PracaRoteirizacao"
      }
    }
  }
}