Listar veículos cadastrados

Este endpoint retorna os veículos cadastrados para monitoramento na integração. Use esta listagem para consultar quais veículos estão ativos, conferir dados de identificação e acompanhar a paginação dos registros.

Requisição

GET {{host}}/integration/vehicle?page=1
Content-Type: application/json
x-api-key: {{api-key}}

Parâmetros

• page: número da página que será consultada. Quando não informado, a API considera a primeira página.

Autenticação

Envie sua chave de API no header x-api-key. Essa chave identifica a conta do integrador e autoriza o acesso aos veículos cadastrados.

Resposta

{
  "items": [
    {
      "id": "6a47acc1936f80ec9c9b4841",
      "licensePlate": "ABC1234",
      "chassis": "1234567890ABC12",
      "renavam": "00123456789",
      "status": "ACTIVE"
    }
  ],
  "amountInThisPage": 1,
  "totalPages": 1,
  "itemsPerPage": 10,
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "count": 1
}

Campos principais

• items: lista de veículos retornados na página atual.
• items[].id: identificador único do veículo na Autodock.
• items[].licensePlate: placa do veículo.
• items[].chassis: chassi do veículo, quando disponível.
• items[].renavam: RENAVAM do veículo, quando disponível.
• items[].status: status atual do veículo no monitoramento. Os valores possíveis são ACTIVE, quando o veículo está ativo, e DISABLE, quando o veículo está desativado.
• amountInThisPage: quantidade de veículos retornados na página atual.
• totalPages: total de páginas disponíveis.
• itemsPerPage: quantidade máxima de itens por página.
• currentPage: página atual.
• nextPage: próxima página, quando existir.
• previousPage: página anterior, quando existir.
• count: total de veículos cadastrados.