Zum Hauptinhalt springen

Mark notification as read

PUT 
/company/notifications/read/:id

Aktualisiert den Status einer Benachrichtigung, um sie als gelesen zu markieren, und erfasst das aktuelle Datum und die Uhrzeit des Lesevorgangs.

Ziel​

Unternehmen ermöglichen, Benachrichtigungen als gelesen zu markieren, um eine genaue Nachverfolgung ausstehender Warnungen zu gewährleisten und die Benutzererfahrung zu verbessern.

Anwendungsfälle​

  • Benutzerinteraktion: Wenn der Benutzer auf eine Benachrichtigung klickt
  • Multi-Geräte-Synchronisierung: Als gelesen auf allen Geräten markieren
  • Massenlesen: Mehrere Benachrichtigungen stapelweise als gelesen markieren
  • Benachrichtigungsverwaltung: Statusaktualisierung über das Benachrichtigungs-Panel

Aktualisierungsablauf​

flowchart TD
    A[PUT /read/{id}] --> B{ID angegeben?}
    B -->|Nein| C[Body prüfen]
    B -->|Ja| D[Pfad-ID verwenden]
    C -->|Gefunden| E[Body-ID verwenden]
    C -->|Nicht gefunden| F[Query prüfen]
    F -->|Gefunden| G[Query-ID verwenden]
    F -->|Nicht gefunden| H[400 Bad Request]
    D --> I{Benutzer authentifiziert?}
    E --> I
    G --> I
    I -->|Nein| J[404 USER_NOT_FOUND]
    I -->|Ja| K{Unternehmen existiert?}
    K -->|Nein| L[401 CIA_NOT_FOUND]
    K -->|Ja| M{Benachrichtigung existiert?}
    M -->|Nein| N[404 NOTIFICATION_NOT_FOUND]
    M -->|Ja| O[Benachrichtigung aktualisieren]
    O --> P[Setze isRead: true]
    P --> Q[Setze readedAt: jetzt]
    Q --> R[In Datenbank speichern]
    R --> S[Benachrichtigung zurückgeben - 200]

Parameterflexibilität​

Die Benachricht

Request​

Responses​

Benachrichtigung erfolgreich als gelesen markiert.