Browse Articles

Browse Articles

Reach 360 : API d'adhésion à des groupes

Dernière mise à jour de l’article le

Cet article s'applique à :

Reach 360

Ce que fait ce point de terminaison d'API

L'API Group Memberships vous permet d'ajouter des utilisateurs à un groupe et d'en supprimer. Les administrateurs voient cela se refléter dans l'onglet Personnes, sous l'enregistrement de l'utilisateur individuel ou du groupe. Tous les cours assignés au groupe apparaîtront dans la bibliothèque de l'utilisateur.

Vous pouvez également utiliser cette API pour récupérer la liste des membres d'un groupe ou des groupes auxquels un utilisateur individuel est inscrit.

Points de terminaison

  • GET /groups/{groupId}/users- répertorie les membres d'un groupe
  • GET /users/{userId}/groups - répertorie 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

Répertorier les membres d'un groupe

GET /groups/{groupId}/users

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)

Exemple de réponse

{
« utilisateurs » : [
{
« id » : « example-user-id-1",
 « email » : « foo@example.com », « groupsURL » :
 « », « < https://api.reach360.com/users/example-user-id-1/groups > role » :
 « apprenant », « FirstName » :
 « Exemple de prénom 1 », « LastName » :
 « Exemple de nom de famille 1 »,
 « LastActiveAt » : « 2021-10-28T 20:39:52 .659Z »,
 « LearnerReportUrl » » : « < https://api.reach360.com/reports/learners/example-user-id-1 > »,
 « url » : « < https://api.reach360.com/users/example-user-id-1 > »
 « Articulate360User » : faux 
},... 
],
 « URL suivante » : « < https://url-for-next-page-of-results > »
}

Codes d'erreur spécifiques au terminal :

  • group_not_found- Impossible de répertorier les utilisateurs car le groupe n'existe pas

Répertorier les groupes d'un utilisateur

GET /users/{userId}/groups

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)

Exemple de réponse

{
« groupes » : [
{
« id » : « example-group-id-1",
 « MembersURL » : « < https://api.reach360.com/groups/example-group-id/users > »,
 « name » : « Exemple de groupe »,
 « url » : « < https://api.reach360.com/groups/example-group-id-1 > »
},... 
],
 « URL suivante » : « < https://url-for-next-page-of-results > »
}

Codes d'erreur spécifiques au terminal :

  • user_not_found- Impossible de répertorier les groupes d'utilisateurs car l'utilisateur n'existe pas

Ajouter un utilisateur au groupe

PUT /groups/{groupId}/users/{userId}

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au terminal :

  • group_not_found- Impossible d'ajouter un utilisateur au groupe car le groupe n'existe pas
  • user_not_found- Impossible d'ajouter un utilisateur au groupe car l'utilisateur n'existe pas

Supprimer un utilisateur du groupe

DELETE /groups/{groupId}/users/{userId}

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au terminal :

  • group_not_found- Impossible de supprimer l'utilisateur du groupe car le groupe n'existe pas
  • user_not_found- Impossible de supprimer l'utilisateur du groupe car l'utilisateur n'existe pas