Aller au contenu principal

List company vehicle fleet with pagination

GET 
/company/vehicles/

Récupère la flotte de véhicules complète de l'entreprise authentifiée avec des capacités de pagination, de recherche et de filtrage.

Objectif​

Permettre aux entreprises de gérer leur flotte en visualisant, recherchant et naviguant par pagination parmi tous les véhicules enregistrés.

Cas d'utilisation​

  • Afficher une liste paginée de tous les véhicules de l'entreprise dans l'interface de gestion de flotte
  • Rechercher des véhicules spécifiques par plaque d'immatriculation
  • Utiliser l'auto-complétion pour une recherche rapide de véhicule
  • Récupérer le véhicule par défaut pour les opérations de signature numérique

Flux de validation​

flowchart TD
  A[Reçoit la Requête] --> B{Utilisateur Authentifié ?}
  B -->|Non| C[401 Non Autorisé]
  B -->|Oui| D{L'Utilisateur a une Entreprise ?}
  D -->|Non| E[401 CIA_NOT_FOUND]
  D -->|Oui| F[Récupérer les Véhicules de l'Entreprise]
  F --> G{Appliquer les Filtres}
  G --> H[Paginer les Résultats]
  H --> I{isSign = vrai ?}
  I -->|Oui| J[Inclure le Véhicule par Défaut]
  I -->|Non| K[Retourner la Liste Paginée]
  J --> K

Pagination​

La réponse utilise un format de pagination personnalisé avec des métadonnées incluant :

  • docs : Tableau d'objets véhicule
  • totalDocs : Nombre total de véhicules correspondants
  • page : Numéro de page actuel
  • limit : Résultats par page
  • totalPages : Nombre total de pages
  • hasNextPage/hasPrevPage : Indicateurs de navigation
  • nextPage/prevPage : Numéros de page pour la navigation

Comportement de la Recherche​

Les paramètres search et autocomplete filtrent tous deux les véhicules par plaque d'immatriculation en utilisant une correspondance d'expressions réguli

Request​

Responses​

Liste de flotte récupérée avec succès.

Response Headers