Contenido Recurso
Documentación detallada del módulo de Recursos de Contenido para la gestión de recursos asociados a contenidos educativos en RedCollege.
Introducción
El módulo ContenidoRecursoModule proporciona métodos para gestionar recursos didácticos asociados a contenidos educativos dentro de las planificaciones en el sistema RedCollege. Estos recursos representan materiales de apoyo, bibliografía, herramientas o elementos que facilitan el proceso de enseñanza-aprendizaje.
Métodos
obtenerRecursosPorContenido
Obtiene todos los recursos asociados 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
IContenidoRecurso
Ejemplo de uso:
crearNuevoRecurso
Crea un nuevo recurso asociado a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| data | Object | Datos del recurso a crear | Sí |
| data.contenidoId | number | ID del contenido asociado | Sí |
| data.descripcion | string | Descripción detallada del recurso | Sí |
Retorna:
- Promise con un objeto
IContenidoRecursodel recurso creado
Ejemplo de uso:
obtenerRecursoPorId
Obtiene un recurso específico por su ID.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del recurso | Sí |
Retorna:
- Promise con un objeto
IContenidoRecursocon los detalles del recurso
Ejemplo de uso:
actualizarRecurso
Actualiza un recurso existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del recurso a actualizar | Sí |
| data | Object | Datos actualizados del recurso | Sí |
| data.descripcion | string | Descripción actualizada del recurso | Sí |
Retorna:
- Promise con un objeto
IContenidoRecursocon los datos actualizados
Ejemplo de uso:
eliminarRecurso
Elimina un recurso existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del recurso a eliminar | Sí |
Retorna:
- Promise con un objeto
IContenidoRecursodel recurso eliminado
Ejemplo de uso:
Consideraciones importantes
- La mayoría de los métodos requieren autenticación previa en el sistema.
- Los recursos están siempre asociados a un contenido específico, que a su vez pertenece a una unidad dentro de una planificación.
- Los recursos permiten complementar un contenido con materiales didácticos específicos que faciliten el aprendizaje.
- Al crear un recurso, es necesario proporcionar tanto el ID del contenido como la descripción del recurso.
- Las descripciones de recursos deben ser claras y precisas, incluyendo información relevante como títulos, autores, editoriales, URLs, o cualquier otro dato que facilite su identificación y acceso.
Errores comunes
- 404 Not Found: El recurso o contenido solicitado no existe
- 403 Forbidden: El usuario no tiene permisos para acceder o modificar el recurso
- 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:
IContenidoRecurso: Representa un recurso asociado a un contenidoid: Identificador único del recursocontenidoId: ID del contenido al que está asociadodescripcion: Descripción detallada del recursocreatedAt: Fecha de creaciónupdatedAt: Fecha de última actualizacióndeletedAt: Fecha de eliminación (si aplica)deletedBy: ID del usuario que eliminó el recurso (si aplica)