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:

NombreTipoDescripciónRequerido
contenidoIdnumberID del contenido

Retorna:

  • Promise con un array de objetos IContenidoRecurso

Ejemplo de uso:

const { planificaciones } = useNuxtApp().$apis
const recursos = await planificaciones.contenidoRecursos.obtenerRecursosPorContenido(789)

crearNuevoRecurso

Crea un nuevo recurso asociado a un contenido.

Parámetros:

NombreTipoDescripciónRequerido
dataObjectDatos del recurso a crear
data.contenidoIdnumberID del contenido asociado
data.descripcionstringDescripción detallada del recurso

Retorna:

  • Promise con un objeto IContenidoRecurso del recurso creado

Ejemplo de uso:

const { planificaciones } = useNuxtApp().$apis
const nuevoRecurso = await planificaciones.contenidoRecursos.crearNuevoRecurso({
  contenidoId: 789,
  descripcion: 'Libro de texto "Geometría Aplicada Vol. 1" - Editorial Educativa'
})

obtenerRecursoPorId

Obtiene un recurso específico por su ID.

Parámetros:

NombreTipoDescripciónRequerido
idnumberID del recurso

Retorna:

  • Promise con un objeto IContenidoRecurso con los detalles del recurso

Ejemplo de uso:

const { planificaciones } = useNuxtApp().$apis
const recurso = await planificaciones.contenidoRecursos.obtenerRecursoPorId(101)

actualizarRecurso

Actualiza un recurso existente.

Parámetros:

NombreTipoDescripciónRequerido
idnumberID del recurso a actualizar
dataObjectDatos actualizados del recurso
data.descripcionstringDescripción actualizada del recurso

Retorna:

  • Promise con un objeto IContenidoRecurso con los datos actualizados

Ejemplo de uso:

const { planificaciones } = useNuxtApp().$apis
const recursoActualizado = await planificaciones.contenidoRecursos.actualizarRecurso(
  101,
  {
    descripcion: 'Libro de texto "Geometría Aplicada Vol. 1" (3ra Edición) - Editorial Educativa, 2023'
  }
)

eliminarRecurso

Elimina un recurso existente.

Parámetros:

NombreTipoDescripciónRequerido
idnumberID del recurso a eliminar

Retorna:

  • Promise con un objeto IContenidoRecurso del recurso eliminado

Ejemplo de uso:

const { planificaciones } = useNuxtApp().$apis
const recursoEliminado = await planificaciones.contenidoRecursos.eliminarRecurso(101)

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 contenido
    • id: Identificador único del recurso
    • contenidoId: ID del contenido al que está asociado
    • descripcion: Descripción detallada del recurso
    • createdAt: Fecha de creación
    • updatedAt: Fecha de última actualización
    • deletedAt: Fecha de eliminación (si aplica)
    • deletedBy: ID del usuario que eliminó el recurso (si aplica)