Reach 360: API de inscripciones de Learning Path

Artículo actualizado el

Este artículo se aplica a:

Qué hace este terminal de API

La API de inscripciones de la ruta de aprendizaje inscribe o anula la inscripción de un usuario o grupo en una ruta de aprendizaje. Cuando se usa, los administradores ven cómo el usuario o el grupo se agregan o eliminan de la pestaña correspondiente en la página de detalles de la ruta de aprendizaje. Los alumnos ven la ruta de aprendizaje añadida o eliminada de la pestaña Asignada a mí.

Puntos finales

  • PUT /learning-paths/{learningPathId}/users/{userId}- inscribir a un solo usuario en una ruta de aprendizaje
  • PUT /learning-paths/{learningPathId}/groups/{groupId}- inscribir a un grupo de usuarios en una ruta de aprendizaje
  • DELETE /learning-paths/{learningPathId}/users/{userId}- anular la inscripción de un solo usuario de una ruta de aprendizaje
  • DELETE /learning-paths/{learningPathId}/groups/{groupId}- anular la inscripción de un grupo de usuarios de una ruta de aprendizaje

Grupo Everyone

Para inscribir al grupo Todos (es decir, a todos los usuarios de su cuenta de Reach 360) en una rutaeveryone de aprendizaje, utilicegroupId

Inscribir usuario

PUT /learning-paths/{learningPathId}/users/{userId}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints

  • learning_path_not_found- no se puede inscribir al usuario en la ruta de aprendizaje porque la ruta de aprendizaje no existe
  • user_not_found- no se puede inscribir al usuario en la ruta de aprendizaje porque el usuario no existe

Grupo de inscripción

PUT /learning-paths/{learningPathId}/groups/{groupId}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints

  • learning_path_not_found- no se puede inscribir el grupo en la ruta de aprendizaje porque la ruta de aprendizaje no existe
  • group_not_found- no se puede inscribir el grupo en la ruta de aprendizaje porque el grupo no existe

Anular la inscripción de un usuario

DELETE /learning-paths/{learningPathId}/users/{userId}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints

  • learning_path_not_found- no puede anular la inscripción del usuario de la ruta de aprendizaje porque la ruta de aprendizaje no existe
  • user_not_found- no se puede anular la inscripción del usuario de la ruta de aprendizaje porque el usuario no existe

Grupo de cancelación de inscripción

DELETE /learning-paths/{learningPathId}/groups/{groupId}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints

  • learning_path_not_found- no puede anular la inscripción del grupo de la ruta de aprendizaje porque la ruta de aprendizaje no existe
  • group_not_found- no puede anular la inscripción del grupo de la ruta de aprendizaje porque el grupo no existe