Ce que fait ce point de terminaison d'API

Avec l'API Group Memberships, vous pouvez ajouter des utilisateurs à un groupe et en supprimer. Les administrateurs voient cela se refléter dans l'onglet Personnes, sous l'enregistrement individuel de l'utilisateur ou du groupe. Tous les modules 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
• Répertorier les membres d'un groupe
• Répertorier les groupes d'un utilisateur
• Ajouter un utilisateur à un groupe
• Supprimer un utilisateur d'un groupe

Points de terminaison

• 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

Répertorier les membres d'un groupe

GET /groups/{groupId}/users

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

• limit(entier, facultatif) - le 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

< https://api.reach360.com/reports/learners/example-user-id-1 > < https://api.reach360.com/users/example-user-id-1 >{ 
 « users » : [
{
« 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 » : 
 « Example Last Name 1", « lastActiveAt » : 
 « 2021-10-28T 20:39:52.659 Z », 
 « LearnerReportURL » : « », « url » : « » « Articulate360User » : faux 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 « URL suivante » : « »} 

Codes d'erreur spécifiques au point de terminaison :

• 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) - le 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

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

Codes d'erreur spécifiques au point de terminaison :

• 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 positive

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison :

• 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 positive

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison :

• 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