Endpoints / Alertas
Listar alertas
Lista alertas de forma paginada dentro de la empresa del usuario autenticado.
/alertsCaso de Uso
Se usa cuando la aplicación necesita mostrar una bandeja o tabla de alertas, con opción de filtrar por sucursal, tipo, visibilidad o estado de visto. Al usarlo, el usuario obtiene una página de alertas y los datos de paginación necesarios para navegar el listado.
Autenticación
Requiere token JWT en el header Authorization: Bearer <token>.
Parámetros de ruta
Este endpoint no recibe parámetros de ruta.
Body
No aplica.
Query params
pagenumber opcionalNúmero de página. Si no se envía, se usa 1.
pageSizenumber opcionalTamaño de página. Si no se envía, se usa 20.
suidstring opcionalIdentificador de sucursal para filtrar alertas.
tipostring opcionalTipo de alerta a filtrar por coincidencia exacta.
visibleboolean opcionalFiltra alertas visibles. Si no se envía, solo se devuelven alertas visibles.
vistoboolean opcionalFiltra alertas vistas o no vistas.
Reglas de negocio
Solo lista alertas de la empresa del usuario autenticado.
La empresa del usuario autenticado debe estar activa.
El usuario autenticado debe estar activo.
El usuario autenticado debe tener rol administrador, jefe o empleado.
Si page no se envía, se usa 1.
Si pageSize no se envía, se usa 20.
page debe ser un entero positivo.
pageSize debe ser un entero positivo.
Si visible no se envía, solo se devuelven alertas visibles.
visible solo acepta true o false.
visto solo acepta true o false.
Si se envía suid, la sucursal debe pertenecer a la empresa autenticada.
Si se envía tipo, se filtra por coincidencia exacta del tipo de alerta.
Las alertas se ordenan por fecha de actualización descendente y luego por fecha de creación descendente.
Errores esperados
No se envió un token JWT válido o el token no contiene información válida del usuario.
El parámetro visible tiene un valor distinto de true o false.
El parámetro visto tiene un valor distinto de true o false.
El parámetro page no es un número entero mayor o igual a 1.
El parámetro pageSize no es un número entero mayor o igual a 1.
La sucursal indicada en suid no existe o no pertenece a la empresa autenticada.
La empresa asociada al usuario autenticado no fue encontrada.
El usuario autenticado no fue encontrado dentro de su empresa.
La empresa asociada al usuario autenticado está inactiva.
El usuario autenticado no pertenece a la empresa indicada por su sesión.
El usuario autenticado intentó acceder a información de una empresa distinta a la suya.
El rol del usuario no tiene permiso para consultar alertas.
El usuario autenticado está inactivo y no puede usar el sistema.
Notas de uso
Este endpoint no recibe body.
Los filtros se envían como query params opcionales: page, pageSize, suid, tipo, visible y visto.
Usa visible=true para consultar alertas visibles y visible=false para consultar alertas ocultas o resueltas.
Usa visto=false para consultar alertas pendientes de revisión.
La respuesta incluye items, page, pageSize, totalItems y totalPages.
Si no envías filtros, el endpoint devuelve la primera página de alertas visibles.