Aller au contenu principal

Mark notification as read

PUT 

/company/notifications/read/:id

Met à jour l'état d'une notification pour la marquer comme lue, en enregistrant la date et l'heure actuelles de la lecture.

Objectif

Permettre aux entreprises de marquer les notifications comme lues pour maintenir un suivi précis des alertes en attente et améliorer l'expérience utilisateur.

Cas d'utilisation

  • Interaction utilisateur : Lorsque l'utilisateur clique sur une notification
  • Synchronisation multi-appareils : Marquer comme lue sur tous les appareils
  • Lecture en masse : Marquer plusieurs notifications en lot
  • Gestion des notifications : Mise à jour de l'état depuis le panneau de notifications

Flux de mise à jour

flowchart TD
A[PUT /read/{id}] --> B{ID fourni ?}
B -->|Non| C[Vérifier le Corps]
B -->|Oui| D[Utiliser l'ID du chemin]
C -->|Trouvé| E[Utiliser l'ID du corps]
C -->|Non trouvé| F[Vérifier la Requête]
F -->|Trouvé| G[Utiliser l'ID de la requête]
F -->|Non trouvé| H[400 Bad Request]
D --> I{Utilisateur authentifié ?}
E --> I
G --> I
I -->|Non| J[404 USER_NOT_FOUND]
I -->|Oui| K{Entreprise existe ?}
K -->|Non| L[401 CIA_NOT_FOUND]
K -->|Oui| M{Notification existe ?}
M -->|Non| N[404 NOTIFICATION_NOT_FOUND]
M -->|Oui| O[Mettre à jour la notification]
O --> P[Définir isRead: true]
P --> Q[Définir readedAt: maintenant]
Q --> R[Sauvegarder en base de données]
R --> S[Retourner la Notification - 200]

Flexibilité des paramètres

L'ID de la notification peut être envoyé de trois manières (par ordre de priorité) :

  1. Paramètre de chemin (recommandé) : `/company

Request

Responses

Notification marquée comme lue avec succès