Pular para o conteúdo principal

List company vehicle fleet with pagination

GET 
/company/vehicles/

Recupera a frota completa de veículos da empresa autenticada com recursos de paginação, busca e filtragem.

Objetivo​

Permitir que as empresas gerenciem sua frota visualizando, pesquisando e paginando todos os veículos registrados.

Casos de Uso​

  • Exibir lista paginada de todos os veículos da empresa na interface de gerenciamento de frota
  • Buscar veículos específicos por placa
  • Usar autocompletar para pesquisa rápida de veículos
  • Recuperar o veículo padrão para operações de assinatura digital

Fluxo de Validação​

flowchart TD
  A[Receber Solicitação] --> B{Usuário Autenticado?}
  B -->|Não| C[401 Não Autorizado]
  B -->|Sim| D{Usuário Tem Empresa?}
  D -->|Não| E[401 CIA_NÃO_ENCONTRADA]
  D -->|Sim| F[Obter Veículos da Empresa]
  F --> G{Aplicar Filtros}
  G --> H[Paginar Resultados]
  H --> I{isSign = verdadeiro?}
  I -->|Sim| J[Incluir Veículo Padrão]
  I -->|Não| K[Retornar Lista Paginada]
  J --> K

Paginação​

A resposta usa um formato de paginação personalizado com metadados incluindo:

  • docs: Array de objetos de veículo
  • totalDocs: Número total de veículos correspondentes
  • page: Número da página atual
  • limit: Resultados por página
  • totalPages: Número total de páginas
  • hasNextPage/hasPrevPage: Indicadores de navegação
  • nextPage/prevPage: Números das páginas para navegação

Comportamento de Busca​

Tanto os parâmetros search quanto autocomplete filtram veículos por placa usando correspondência de regex sem distinção entre maiúsculas e minúsculas.

Request​

Responses​

Lista de frota recuperada com sucesso.

Response Headers