Contenido Actividad
Documentación detallada del módulo de Actividades de Contenido para la gestión de actividades asociadas a contenidos educativos en RedCollege.
Introducción
El módulo ContenidoActividadModule proporciona métodos para gestionar actividades específicas asociadas a contenidos educativos dentro de las planificaciones en el sistema RedCollege. Estas actividades representan tareas, ejercicios o acciones concretas que los estudiantes deben realizar como parte del proceso de aprendizaje.
Métodos
obtenerActividadesPorContenido
Obtiene todas las actividades asociadas a un contenido específico.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| contenidoId | number | ID del contenido | Sí |
Retorna:
- Promise con un array de objetos
IContenidoActividad
Ejemplo de uso:
crearNuevaActividad
Crea una nueva actividad asociada a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| data | Object | Datos de la actividad a crear | Sí |
| data.contenidoId | number | ID del contenido asociado | Sí |
| data.descripcion | string | Descripción detallada de la actividad | Sí |
Retorna:
- Promise con un objeto
IContenidoActividadde la actividad creada
Ejemplo de uso:
obtenerActividadPorId
Obtiene una actividad específica por su ID.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID de la actividad | Sí |
Retorna:
- Promise con un objeto
IContenidoActividadcon los detalles de la actividad
Ejemplo de uso:
actualizarActividad
Actualiza una actividad existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID de la actividad a actualizar | Sí |
| data | Object | Datos actualizados de la actividad | Sí |
| data.contenidoId | number | ID del contenido asociado | Sí |
| data.descripcion | string | Descripción actualizada de la actividad | Sí |
Retorna:
- Promise con un objeto
IContenidoActividadcon los datos actualizados
Ejemplo de uso:
eliminarActividad
Elimina una actividad existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID de la actividad a eliminar | Sí |
Retorna:
- Promise con un objeto
IContenidoActividadde la actividad eliminada
Ejemplo de uso:
Consideraciones importantes
- La mayoría de los métodos requieren autenticación previa en el sistema.
- Las actividades están siempre asociadas a un contenido específico, que a su vez pertenece a una unidad dentro de una planificación.
- Las actividades permiten desglosar un contenido en tareas específicas que deben realizarse como parte del proceso educativo.
- Al crear o actualizar actividades, es necesario proporcionar tanto el ID del contenido como la descripción de la actividad.
- Las descripciones de actividades deben ser claras y detalladas para facilitar su comprensión por parte de estudiantes y docentes.
Errores comunes
- 404 Not Found: La actividad o contenido solicitado no existe
- 403 Forbidden: El usuario no tiene permisos para acceder o modificar la actividad
- 400 Bad Request: Datos enviados incorrectos o incompletos
- 500 Internal Server Error: Error en el servidor, intentar más tarde
Interfaces relacionadas
La principal interfaz utilizada por este módulo es:
IContenidoActividad: Representa una actividad asociada a un contenidoid: Identificador único de la actividadcontenidoId: ID del contenido al que está asociadadescripcion: Descripción detallada de la actividadcreatedAt: Fecha de creaciónupdatedAt: Fecha de última actualizacióndeletedAt: Fecha de eliminación (si aplica)deletedBy: ID del usuario que eliminó la actividad (si aplica)