Reach 360: API de inscripciones a cursos
Artículo actualizado el
Este artículo se aplica a:
Qué hace este punto final de API
La API de inscripciones a cursos permite inscribir o anular la inscripción de un usuario o grupo en un curso. Cuando se usa, los administradores ven al usuario o grupo agregado o eliminado de la pestaña correspondiente de la página de detalles del curso. Los alumnos ven el curso agregado o eliminado de su pestaña Asignado a mí.
- Puntos finales
- Grupo de todos
- Inscribir usuario
- Inscribir grupo
- Cancelar la inscripción de un usuario
- Anular la inscripción de un grupo
Puntos finales
PUT /courses/{courseId}/users/{userId}
- inscribir a un solo usuario en un cursoPUT /courses/{courseId}/groups/{groupId}
- inscribir a un grupo de usuarios en un cursoDELETE /courses/{courseId}/users/{userId}
- anular la inscripción de un solo usuario de un cursoDELETE /courses/{courseId}/groups/{groupId}
- anular la inscripción de un grupo de usuarios de un curso
Grupo de todos
Para inscribir al grupo Todos (es decir, a todos los usuarios de su cuenta de Reach 360) en un curso, utilice everyone
groupId
Inscribir usuario
PUT /courses/{courseId}/users/{userId}
Respuesta de éxito
204 «Sin contenido»
Códigos de error específicos de un terminal
course_not_found
- no se puede inscribir al usuario en el curso porque el curso no existeuser_not_found
- no puede inscribir al usuario en el curso porque el usuario no existe
Inscribir grupo
PUT /courses/{courseId}/groups/{groupId}
Respuesta de éxito
204 «Sin contenido»
Códigos de error específicos de un terminal
course_not_found
- no se puede inscribir al grupo en el curso porque el curso no existegroup_not_found
- no puede inscribir un grupo en el curso porque el grupo no existe
Cancelar la inscripción del usuario
DELETE /courses/{courseId}/users/{userId}
Respuesta de éxito
204 «Sin contenido»
Códigos de error específicos de un terminal
course_not_found
- no se puede anular la inscripción del usuario del curso porque el curso no existeuser_not_found
- no puede anular la inscripción del usuario del curso porque el usuario no existe
Cancelar la inscripción del grupo
DELETE /courses/{courseId}/groups/{groupId}
Respuesta de éxito
204 «Sin contenido»
Códigos de error específicos de un terminal
course_not_found
- no se puede anular la inscripción de un grupo del curso porque el curso no existegroup_not_found
- no puede anular la inscripción de un grupo del curso porque el grupo no existe