| Panel | ||||||
|---|---|---|---|---|---|---|
|
| Info |
|---|
Usar codificación de caracteres UTF-8 en el envío de datos Manual de autenticación y versionado: manual (autenticación y versionado) |
| Note |
|---|
Por motivos de seguridad el external_id no puede contener los caracteres \ ni / (http://tomcat.apache.org/security-6.html). |
Obtener acción formativa (v1)
Método: GET
URL:
- Obtener por id:
- /admin/rest/administration/api/sessions/id/{id}
- Obtener por external id:
- /admin/rest/administration/api/sessions/externalid/{externalid}
| Note |
|---|
Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni / |
Ejemplo:
...
| Panel | ||||||
|---|---|---|---|---|---|---|
|
| Info |
|---|
Usar codificación de caracteres UTF-8 en el envío de datos Manual de autenticación y versionado: manual (autenticación y versionado) |
| Note |
|---|
Por motivos de seguridad el external_id no puede contener los caracteres \ ni / (http://tomcat.apache.org/security-6.html). |
Obtener acción formativa (v1)
Método: GET
URL:
- Obtener por id:
- /admin/rest/administration/api/sessions/id/
Cabeceras
- NLC-datesFormat. Opcional, valores permitidos:
milliseconds. Las fechas se devolverán en milisegundos- en {id}
- Obtener por external id:
- /admin/rest/administration/api/sessions/externalid/{externalid}
| Note |
|---|
Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni / |
Ejemplo:
Cabeceras
- NLC-datesFormat. Opcional, valores permitidos:
milliseconds. Las fechas se devolverán en milisegundos- en otro caso se seguirá el formato de texto: "yyyy-MM-dd HH:mm:ss"
...
- Obtener por id:
- /admin/rest/administration/api/sessions/id/{id}/students
- Obtener por external id:
- /admin/rest/administration/api/sessions/externalid/{external_id}/students
Ejemplo:
https://demo.central-lms.com/admin/rest/administration/api/sessions/id/2004/students
| Code Block | ||
|---|---|---|
| ||
{
"ids":[1,2,3],
"externalIds":["ext1", "ext2", "ext4"]
}
|
Cabeceras
- NLC-enrolInCourseIfNeeded. Opcional, valores permitidos:
true. Si el alumno no está inscrito en el curso/plan, lo inscribirá también.- en otro caso no se creará nada y devolverá error en el caso de que haya al menos un alumno que no esté inscrito en el curso.
Parámetros
Objeto json con dos listados:
- ids = Listado de identificadores de alumnos.
- externalIds = Listado de identificadores externos de alumnos.
Validaciones
- No existe una acción formativa con ese id/externalid --> Error 404 (Not Found) código de error ERR004/ERR005 dependiendo de si es id o externalid.
- El estado de la acción formativa es incorrecto --> Error SEV001 / 400 (Bad Request)
- Errores que provocan un estado 200, se devuelve un listado de json con códigos de errores y se inscriben el resto de alumnos que no dieron error (si no queda ninguno también devuelve un 200).
- Alumno no inscrito en el curso (no está a true la cabecera de inscribir también al alumno en el curso) --> Error SEV010 / 200.
- Id de alumno no encontrado --> Error SEV012 / 200
- Id externo de alumno no encontrado --> Error SEV011 / 200
- El alumno ya está incrito en la acción formativa --> Error SEV013 / 200/students
Ejemplo:
https://demo.central-lms.com/admin/rest/administration/api/sessions/id/2004/students
| Code Block | ||
|---|---|---|
| ||
{
"ids":[1,2,3],
"externalIds":["ext1", "ext2", "ext4"]
}
|
Cabeceras
- NLC-enrolInCourseIfNeeded. Opcional, valores permitidos:
true. Si el alumno no está inscrito en el curso/plan, lo inscribirá también.- en otro caso no se creará nada y devolverá error en el caso de que haya al menos un alumno que no esté inscrito en el curso.
Parámetros
Objeto json con dos listados:
- ids = Listado de identificadores de alumnos.
- externalIds = Listado de identificadores externos de alumnos.
Validaciones
- No existe una acción formativa con ese id/externalid --> Error 404 (Not Found) código de error ERR004/ERR005 dependiendo de si es id o externalid.
- El estado de la acción formativa es incorrecto --> Error SEV001 / 400 (Bad Request)
- Errores que provocan un estado 200, se devuelve un listado de json con códigos de errores y se inscriben el resto de alumnos que no dieron error (si no queda ninguno también devuelve un 200).
- Alumno no inscrito en el curso (no está a true la cabecera de inscribir también al alumno en el curso) --> Error SEV010 / 200.
- Id de alumno no encontrado --> Error SEV012 / 200
- Id externo de alumno no encontrado --> Error SEV011 / 200
- El alumno ya está incrito en la acción formativa --> Error SEV013 / 200
- Error inesperado –> Error 500
- Todo OK --> 200 (OK)
Actualizar urls de acceso (v3)
Método: PUT
URL:
- Actualizar por id:
- /admin/rest/administration/api/sessions/id/{id}/webconferenceurls
- Actualizar por external id:
- /admin/rest/administration/api/sessions/externalid/{external_id}/webconferenceurls
Ejemplo:
BODY - application/json
Parámetros
Objeto json con dos posibles parámetros:
- trainerUrl = Url de acceso del formador a la videoconferencia.
- studentUrl = Url de acceso del estudiante a la videoconferencia.
Validaciones
- No existe una acción formativa con ese id/externalid --> Error 404 (Not Found) código de error ERR004/ERR005 dependiendo de si es id o externalid.
- El estado de la acción formativa es incorrecto --> Error SES002 / 400 (Bad Request)
- La acción formativa no es de tipo videoconferencia externa --> Error SES001 / 400 (Bad Request)
- No se pasan ninguno de los parámetros (al menos uno es obligatorio) --> Error 404 (Not Found) código de error ERR001
- Error inesperado –> Error 500
- Todo OK --> 200 (OK)