Contenido
Documentación detallada del módulo de Contenidos para la gestión de contenidos dentro de unidades de planificación en RedCollege.
Introducción
El módulo ContenidoModule proporciona métodos para gestionar contenidos educativos dentro de las unidades de planificación en el sistema RedCollege. Este módulo permite realizar operaciones CRUD sobre contenidos, gestionar recursos asociados, relacionar ítems curriculares y administrar archivos adjuntos.
Métodos
obtenerContenidosPorPlanificacion
Obtiene todos los contenidos asociados a una planificación específica.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| planificacionId | number | ID de la planificación | Sí |
Retorna:
- Promise con un array de objetos
IContenido
Ejemplo de uso:
obtenerContenidosPorUnidad
Obtiene todos los contenidos asociados a una unidad específica.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| unidadId | number | ID de la unidad | Sí |
Retorna:
- Promise con un array de objetos
IContenido
Ejemplo de uso:
obtenerContenidoPorId
Obtiene un contenido específico por su ID.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
Retorna:
- Promise con un objeto
IContenidocon los detalles del contenido
Ejemplo de uso:
crearNuevoContenido
Crea un nuevo contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| data | IContenidoForm | Datos del contenido a crear | Sí |
Propiedades de IContenidoForm:
| Propiedad | Tipo | Descripción | Requerido |
|---|---|---|---|
| unidadId | number | null | ID de la unidad | Sí |
| titulo | string | null | Título del contenido | Sí |
| fechaInicio | Date | null | Fecha de inicio | Sí |
| fechaFin | Date | null | Fecha de finalización | Sí |
| contenidoPlanificado | string | null | Descripción del contenido planificado | No |
| evaluacion | string | null | Descripción de la evaluación | No |
| isCumplido | boolean | Indica si el contenido está cumplido | Sí |
| isVisible | boolean | Indica si el contenido es visible | Sí |
| haveAdecuaciones | boolean | Indica si tiene adecuaciones curriculares | No |
| itemsEntrada | IItemEntradaCurricular | Ítems de entrada curricular | No |
Retorna:
- Promise con un objeto
IContenidodel contenido creado
Ejemplo de uso:
actualizarContenido
Actualiza un contenido existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido a actualizar | Sí |
| data | Partial | Datos parciales para actualizar | Sí |
Retorna:
- Promise con un objeto
IContenidocon los datos actualizados
Ejemplo de uso:
eliminarContenido
Elimina un contenido existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido a eliminar | Sí |
Retorna:
- Promise con un objeto
IContenidodel contenido eliminado
Ejemplo de uso:
obtenerItemsEntrada
Obtiene los ítems de entrada curricular asociados a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
Retorna:
- Promise con un array de objetos
IItemEntradaCurricular
Ejemplo de uso:
asociarItemsAContenido
Asocia ítems de entrada curricular a un contenido existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
| itemsIds | number | Array de IDs de ítems a asociar | Sí |
Retorna:
- Promise con un objeto
IContenidoactualizado
Ejemplo de uso:
asociarArchivoAContenido
Asocia un archivo existente a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
| archivoId | number | ID del archivo a asociar | Sí |
Retorna:
- Promise con un objeto
IArchivocon los datos del archivo asociado
Ejemplo de uso:
softDeleteArchivoAsociado
Elimina temporalmente (soft delete) un archivo asociado a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
| archivoId | number | ID del archivo a eliminar | Sí |
Retorna:
- Promise con un objeto
IArchivodel archivo eliminado
Ejemplo de uso:
destroyArchivo
Elimina permanentemente un archivo asociado a un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | number | ID del contenido | Sí |
| archivoId | number | ID del archivo a eliminar permanentemente | Sí |
Retorna:
- Promise con un objeto
IArchivodel archivo eliminado
Ejemplo de uso:
obtenerDiasHabilesContenido
Obtiene los días hábiles disponibles para un contenido.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| contenidoId | number | ID del contenido | Sí |
Retorna:
- Promise con un array de objetos
DateTimerepresentando días hábiles
Ejemplo de uso:
duplicarContenido
Duplica un contenido existente.
Parámetros:
| Nombre | Tipo | Descripción | Requerido |
|---|---|---|---|
| contenidoId | number | ID del contenido a duplicar | Sí |
Retorna:
- Promise con un objeto
IContenidodel nuevo contenido duplicado
Ejemplo de uso:
Consideraciones importantes
- La mayoría de los métodos requieren autenticación previa en el sistema.
- Los contenidos están organizados jerárquicamente: Planificación > Unidad > Contenido.
- Las fechas deben proporcionarse como objetos
DateoDateTimeen el formato adecuado. - Al crear o actualizar contenidos, se pueden especificar propiedades parciales según la necesidad.
- Las operaciones de duplicación copian tanto el contenido principal como sus relaciones y archivos asociados.
Errores comunes
- 404 Not Found: El contenido o recurso solicitado no existe
- 403 Forbidden: El usuario no tiene permisos para acceder o modificar el contenido
- 400 Bad Request: Datos enviados incorrectos o incompletos
- 500 Internal Server Error: Error en el servidor, intentar más tarde
Interfaces relacionadas
Las principales interfaces utilizadas por este módulo son:
IContenido: Representa un contenido completo con todas sus relacionesIContenidoForm: Formato para crear o actualizar contenidosIItemEntradaCurricular: Representa un ítem de entrada curricularIArchivo: Representa un archivo asociado a un contenidoIContenidoActividad: Representa una actividad asociada a un contenidoIContenidoRecurso: Representa un recurso asociado a un contenido