Zum Hauptinhalt springen

List company vehicle fleet with pagination

GET 
/company/vehicles/

Ruft den vollständigen Fahrzeugbestand des authentifizierten Unternehmens mit Paginierungs-, Such- und Filterfunktionen ab.

Ziel​

Unternehmen in die Lage versetzen, ihren Fuhrpark zu verwalten, indem sie alle registrierten Fahrzeuge einsehen, durchsuchen und seitenweise durchblättern können.

Anwendungsfälle​

  • Paginierte Liste aller Firmenfahrzeuge in der Fuhrparkverwaltung anzeigen
  • Nach bestimmten Fahrzeugen über das Kennzeichen suchen
  • Autovervollständigung für schnelle Fahrzeugsuche nutzen
  • Standardfahrzeug für digitale Signaturvorgänge abrufen

Validierungsablauf​

flowchart TD
  A[Anfrage empfangen] --> B{Benutzer authentifiziert?}
  B -->|Nein| C[401 Unauthorized]
  B -->|Ja| D{Benutzer hat Unternehmen?}
  D -->|Nein| E[401 CIA_NOT_FOUND]
  D -->|Ja| F[Firmenfahrzeuge abrufen]
  F --> G{Filter anwenden}
  G --> H[Ergebnisse paginieren]
  H --> I{isSign = true?}
  I -->|Ja| J[Standardfahrzeug einbeziehen]
  I -->|Nein| K[Paginierte Liste zurückgeben]
  J --> K

Paginierung​

Die Antwort verwendet ein benutzerdefiniertes Paginierungsformat mit Metadaten, einschließlich:

  • docs: Array von Fahrzeugobjekten
  • totalDocs: Gesamtzahl der passenden Fahrzeuge
  • page: Aktuelle Seitenzahl
  • limit: Ergebnisse pro Seite
  • totalPages: Gesamtzahl der Seiten
  • hasNextPage/hasPrevPage: Navigationsflags
  • nextPage/prevPage: Seitenzahlen für die Navigation

Suchverhalten​

Sowohl die Parameter search als auch autocomplete filtern Fahrzeuge nach Kennzeichen unter Verwendung von regex-Matching ohne Berücksichtigung der Groß-/Kleinschreibung.

Request​

Responses​

Flottenliste erfolgreich abgerufen.

Response Headers