Reach 360 : guide de référence sur les points de terminaison des API

Dernière mise à jour de l’article le

Cet article s'applique à :

Cet article répertorie tous les points de terminaison Reach 360. Les API complètes et individuelles sont liées dans chaque section.

Modules API

  • GET /courses- liste des modules
  • GET /courses/{courseId}- obtenir les détails d'un module par identifiant de cours

API d'inscription aux modules

  • PUT /courses/{courseId}/users/{userId}- inscrire un seul utilisateur à un module
  • PUT /courses/{courseId}/groups/{groupId}- inscrire un groupe d'utilisateurs à un module
  • DELETE /courses/{courseId}/users/{userId}- désinscrire un seul utilisateur d'un module
  • DELETE /courses/{courseId}/groups/{groupId}- désinscrire un groupe d'utilisateurs d'un module

API Favoris

  • GET /users/{userId}/favorites- répertorier les modules et les parcours d'apprentissage dans les favoris d'un utilisateur

API de groupes

  • POST /groups- créer un nouveau groupe
  • GET /groups- groupes de listes
  • GET /groups/{groupId}- obtenir les détails d'un groupe par identifiant de groupe
  • PUT /groups/{groupId}- mettre à jour un groupe par identifiant de groupe
  • DELETE /groups/{groupId}- supprimer un groupe par identifiant de groupe

API d'adhésion à des groupes

  • GET /groups/{groupId}/users- liste les membres d'un groupe
  • GET /users/{userId}/groups - liste les groupes d'un utilisateur
  • PUT /groups/{groupId}/users/{userId} - ajouter un utilisateur à un groupe
  • DELETE /groups/{groupId}/users/{userId}- supprimer un utilisateur d'un groupe

Importer l'API de fin de cours

  • POST /courses/{courseId}/users/{userId}/completions- importer les données d'achèvement pour une seule paire cours/utilisateur dans Reach 360.

API d'invitations

  • POST /invitations—envoyer une invitation à un utilisateur pour qu'il rejoigne votre équipe
  • GET /invitations—liste les invitations en attente
  • GET /invitations/{invitationId}—obtenir les détails d'une invitation en attente par identifiant d'invitation
  • DELETE /invitations/{invitationId}—supprimer une invitation en attente par identifiant d'invitation

API Learning Paths

  • GET /learning-paths- répertorier les parcours d'apprentissage
  • GET /learning-paths/{learningPathId}- obtenir les détails d'un parcours d'apprentissage par identifiant de chemin d'apprentissage
  • GET /learning-paths/{learningPathId}/courses- liste les modules d'un parcours d'apprentissage par identifiant de chemin d'apprentissage

API d'inscription aux parcours de formation

  • PUT /learning-paths/{learningPathId}/users/{userId}- inscrire un seul utilisateur à un chemin d'apprentissage
  • PUT /learning-paths/{learningPathId}/groups/{groupId}- inscrire un groupe d'utilisateurs à un chemin d'apprentissage
  • DELETE /learning-paths/{learningPathId}/users/{userId}- désinscrire un seul utilisateur d'un chemin de formation
  • DELETE /learning-paths/{learningPathId}/groups/{groupId}- désinscrire un groupe d'utilisateurs d'un chemin d'apprentissage

API de rapports

  • GET /reports/activity- rapport d'activité utilisateur (liste des sessions utilisateur)
  • GET /reports/courses/{courseId}- rapport de l'apprenant (liste des sessions des apprenants pour un cours)
  • GET /reports/learners/{userId}- rapport de cours de l'apprenant (liste des sessions de cours bien sûres pour un apprenant)
  • GET /reports/learning-paths/{learningPathId}/courses- rapport sur les modules du chemin d'apprentissage (liste des sessions de cours d'un parcours d'apprentissage)
  • GET /reports/learning-paths/{learningPathId}/learners- rapport sur les apprenants du chemin d'apprentissage (liste des sessions des apprenants dans un parcours d'apprentissage)

API pour utilisateurs

  • GET /users- liste des utilisateurs
  • GET /users/{userId}- obtenir les détails d'un utilisateur par nom d'utilisateur
  • DELETE /users/{userId} - supprimer un utilisateur par nom d'utilisateur

API Webhooks

  • POST /webhooks- créer un nouveau webhook
  • GET /webhooks- liste les webhooks
  • GET /webhooks/{webhookId}- obtenir les détails d'un webhook par identifiant de webhook
  • DELETE /webhooks/{webhookId}- supprimer un webhook par identifiant de webhook