← HomeFleetPay / Schema

VpoPontoParada

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.

A waypoint — provide cidade or the latitude/longitude pair.

cidadestring | nullOptional

City and state code of the point ("City, UF").

minLength3

maxLength150

latitudenumber | null · doubleOptional

Latitude in decimal degrees (required together with longitude when cidade is absent).

minimum-90

maximum90

longitudenumber | null · doubleOptional

Longitude in decimal degrees.

minimum-180

maximum180

descricaostring | nullOptional

Free-text waypoint label, returned by the operator in error messages.

maxLength60

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "description": "Um ponto de parada — informe `cidade` ou o par `latitude`/`longitude`.",
  "properties": {
    "cidade": {
      "type": "string",
      "minLength": 3,
      "maxLength": 150,
      "nullable": true,
      "description": "Cidade e UF do ponto (\"Cidade, UF\")."
    },
    "latitude": {
      "type": "number",
      "format": "double",
      "minimum": -90,
      "maximum": 90,
      "nullable": true,
      "description": "Latitude em graus decimais (obrigatória junto com `longitude` quando não há `cidade`)."
    },
    "longitude": {
      "type": "number",
      "format": "double",
      "minimum": -180,
      "maximum": 180,
      "nullable": true,
      "description": "Longitude em graus decimais."
    },
    "descricao": {
      "type": "string",
      "maxLength": 60,
      "nullable": true,
      "description": "Rótulo livre do ponto, devolvido pela operadora em mensagens de erro."
    }
  }
}