...
Obtener acciones formativas (v4)
Método: GET
URL:
- Obtener por id:
- /admin/rest/administration/api/courses/id/{id}/sessions
- Obtener por external id:
- /admin/rest/administration/api/courses/externalid/{externalid}/sessions
Note
Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /
Ejemplo:
Campos devueltos en el Json
Listado de acciones formativas, cada acción formativa consta de los siguientes campos:
- id = Identificador
- external_id = Id externo
- sessionType = Tipo de actividad asociado a la acción formativa. Valores posibles: classroom, externalLink, externalwebconference, file, practicalCase, performanceReview, scorm, video, webconference.
- name = Nombre de la acción formativa
startDate = Fecha de inicio de acción formativa (UTC)
endDate = Fecha de fin de acción formativa (UTC)
capacity = Capacidad de alumnos
estimateDuration = Duración estimada
confirmed = Valor true/false. Indica si la acción está confirmada
description = Descripción de la acción formativa
objectives = Objetivos de la acción formativa
comments = Comentarios de la acción formativa
status = Estado de la acción formativa.
- moduleActivity = Objeto de relación de actividad y módulo
- id = Identificador
- moduleId = Identificador de módulo
activityId = Identificador de actividad
- extendedFields = Campos extensibles en lista con clave extendedFieldName y valor extendedFieldValues
- moderatorUrl = Url de acceso para el formador (* Solo para el caso de sessionType = externalwebconference)
- studentUrl = Url de acceso para el estudiante (* Solo para el caso de sessionType = externalwebconference)
- trainers = Formadores de la acción formativa (* Solo pasa el caso de sessionType = classroom o externalwebconference o practicalCase o webconference)
- id = Identificador del formador
- firstName = Nombre del formador
- lastName = Apellidos del formador
- username = Nombre de usuario del formador
- email = Email del formador
- rooms rooms = Salas vinculadas a la acción formativa (* Solo para el caso de sessionType = classroom)
- id = Identificador de la sala
- name = Nombre de la sala
- scorable = Acción formativa evaluableevaluable
- minScore = Nota mínima para superarsuperar
- maxScore = Nota máxima que se puede obtenerobtener
- scoreToPass = Nota de superaciónsuperación
- weightInModule = Peso dentro del curso (* Solo tendrá valor para el caso de evaluación por puntuación mínima)
- percentageWeightInModule = Porcentaje del peso dentro del curso (* Solo tendrá valor para el caso de evaluación por puntuación mínima)
Parámetros
- startindex = índice inicial para la paginación (Integer, opcional)
- count = total de elementos a recuperar para la paginación (Integer, opcional)
- personId= filtra por el id de un alumno (Long, opcional)
- personExternalId=filtra por el id externo de un alumno (String, opcional)
- username= filtra por el nombre de usuario de un alumno (String, opcional)
- activityId= filtra por el id de una actividad (Long, opcional)
- moduleActivityId= filtra por el id de una actividad de curso (Long, opcional)
Validaciones
- Id. de curso inexistente --> Error ERR004 / 404 (Not Found)
- Id. externo de curso inexistente --> Error ERR005 / 404 (Not Found)
- Error en la generación del Json --> Error 503 (Service Unavailable)
- Todo OK --> 200 (OK) + JSON
- Todo OK sin contenido --> 204 (No content)
- Si hay paginación --> 206 (Partial Content) + JSON
...