← HomeFleetPay / Schema

CiotRouteLeg

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.

origemobjectRequired
destinoobjectRequired
distancia_percorridainteger | nullOptional
minimum1
qtd_viagensinteger | nullOptional
minimum1
maximum999
Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "origem",
    "destino"
  ],
  "properties": {
    "origem": {
      "type": "object",
      "required": [
        "codigo_municipio_origem"
      ],
      "properties": {
        "codigo_municipio_origem": {
          "type": "string",
          "pattern": "^\\d{7}$"
        }
      }
    },
    "destino": {
      "type": "object",
      "required": [
        "codigo_municipio_destino"
      ],
      "properties": {
        "codigo_municipio_destino": {
          "type": "string",
          "pattern": "^\\d{7}$"
        }
      }
    },
    "distancia_percorrida": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1
    },
    "qtd_viagens": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 999
    }
  }
}