Usuario
Documentación detallada del módulo de Usuario para la gestión de usuarios y perfiles en RedCollege.
Introducción
El módulo UsuarioModule proporciona métodos para gestionar usuarios en el sistema RedCollege, permitiendo actualizar información personal, gestionar avatares y obtener datos de colaboradores. Este módulo es fundamental para el manejo de identidades y perfiles de usuario en la plataforma.
Métodos
actualizarAvatar
Actualiza la imagen de avatar de un usuario.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| file | File | Archivo de imagen para el avatar | Sí |
Retorna:
- Promise con un objeto
{ url: string }que contiene la URL del avatar actualizado
Ejemplo de uso:
obtenerColaboradorById
Obtiene información detallada de un colaborador específico por su ID.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| usuarioId | number | ID del usuario/colaborador | Sí |
Retorna:
- Promise con un objeto
IUsuariocon los detalles completos del colaborador
Ejemplo de uso:
actualizarUsuarioById
Actualiza la información de un usuario específico por su ID.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| usuarioId | number | ID del usuario a actualizar | Sí |
| usuario | IUsuarioUpdate | Datos actualizados del usuario | Sí |
Propiedades de IUsuarioUpdate:
| Propiedad | Tipo | Descripción | Requerido |
|---|---|---|---|
| nombre | string | Primer nombre del usuario | Sí |
| segundoNombre | string | Segundo nombre del usuario | Sí |
| apellidoPaterno | string | Apellido paterno | Sí |
| apellidoMaterno | string | Apellido materno | Sí |
| rut | string | RUT o documento de identidad | Sí |
| correo | string | Correo electrónico | Sí |
| especialidadesIds | number | Array de IDs de especialidades | Sí |
Retorna:
- Promise con un objeto
IUsuariocon los datos actualizados
Ejemplo de uso:
Consideraciones importantes
- La mayoría de los métodos requieren autenticación previa en el sistema.
- Para actualizar el avatar, el archivo debe ser una imagen válida (JPEG, PNG, etc.) y no exceder el tamaño máximo permitido.
- La actualización de información de usuarios requiere permisos especiales, generalmente limitados a administradores o al propio usuario.
- El formato del RUT debe seguir el estándar chileno (números-dígito verificador).
- Las especialidades deben existir previamente en el sistema para poder asociarlas a un usuario.
Errores comunes
- 404 Not Found: El usuario solicitado no existe
- 403 Forbidden: El usuario actual no tiene permisos para actualizar la información
- 400 Bad Request: Datos enviados incorrectos o incompletos
- 413 Payload Too Large: Tamaño de archivo de avatar excede el límite
- 415 Unsupported Media Type: Formato de archivo no soportado
- 500 Internal Server Error: Error en el servidor, intentar más tarde
Interfaces relacionadas
Las principales interfaces utilizadas por este módulo son:
IUsuario: Representa un usuario completo con todas sus relaciones y propiedadesid: Identificador único del usuariocorreo: Correo electrónico (también usado para inicio de sesión)clave: Contraseña (encriptada)rut: Documento de identidadnombre: Primer nombrecargo: Cargo o posición en la instituciónsegundoNombre: Segundo nombreapellidoPaterno: Apellido paternoapellidoMaterno: Apellido maternoavatarUrl: URL de la imagen de perfiltelefono: Número de teléfonocreatedAt: Fecha de creaciónupdatedAt: Fecha de última actualizaciónestablecimientos: Array de establecimientos asociadosperfil: Información adicional del perfilroles: Array de roles asociadoscursos: Array de cursos asociadosmatriculas: Array de matrículas asociadasespecialidades: Array de especialidades asociadasapoderados: Array de relaciones como apoderadonombreCompleto: Nombre completo formateadoiniciales: Iniciales del nombre
IUsuarioUpdate: Formato para actualizar información de usuarios