Endpoints / Alertas

PATCH

Marcar alerta como vista

Marca una alerta visible como vista dentro de la empresa del usuario autenticado.

PATCH/alerts/:id/visto

Caso de Uso

Se usa cuando el usuario ya revisó una alerta y la aplicación necesita quitarla del estado pendiente. Al usarlo, el usuario obtiene una confirmación de que la alerta fue marcada como vista.

Autenticación

Requiere token JWT en el header `Authorization: Bearer <token>`.

Parámetros de ruta

idstringobligatorio

Identificador de la alerta.

Body

No aplica.

Reglas de negocio

1

Solo permite marcar alertas de la empresa del usuario autenticado.

2

La empresa del usuario autenticado debe estar activa.

3

El usuario autenticado debe estar activo.

4

El usuario autenticado debe tener rol administrador, jefe o empleado.

5

La alerta debe existir dentro de la empresa autenticada.

6

Solo se pueden marcar como vistas las alertas visibles.

7

Si la alerta ya estaba vista, el endpoint responde correctamente y mantiene la alerta como vista.

Errores esperados

401No autorizado

No se envió un token JWT válido o el token no contiene información válida del usuario.

400El id de alerta es requerido

No se envió el parámetro id o se envió vacío.

404Alerta no encontrada

La alerta no existe, no pertenece a la empresa autenticada o no está visible.

404La empresa no existe

La empresa asociada al usuario autenticado no fue encontrada.

404El usuario no existe

El usuario autenticado no fue encontrado dentro de su empresa.

403La empresa no está activa

La empresa asociada al usuario autenticado está inactiva.

403El usuario no pertenece a la empresa

El usuario autenticado no pertenece a la empresa indicada por su sesión.

403El usuario no puede acceder a otra empresa

El usuario autenticado intentó acceder a información de una empresa distinta a la suya.

403El usuario no es jefe, empleado o administrador

El rol del usuario no tiene permiso para marcar alertas como vistas.

403El usuario no está activo

El usuario autenticado está inactivo y no puede usar el sistema.

Notas de uso

1

No recibe body ni query params.

2

Envía el identificador de la alerta en la ruta, reemplazando :id.

3

La operación actualiza el campo alvisto a true.

4

Si necesitas consultar alertas no vistas después de marcar una alerta, usa GET /alerts?visto=false.

5

Si la alerta ya no está visible, el endpoint responde como alerta no encontrada.