Was dieser API-Endpunkt macht

Mit der API für Gruppenmitgliedschaften können Sie Benutzer zu einer Gruppe hinzufügen und Benutzer aus einer Gruppe entfernen. Für Administratoren wird dies auf der Registerkarte „Personen“ entweder unter dem Datensatz für einzelne Benutzer oder Gruppen angezeigt. Alle Kurse, die der Gruppe zugewiesen sind, werden in der Bibliothek des Benutzers angezeigt.

Sie können diese API auch verwenden, um eine Liste der Mitglieder einer Gruppe oder der Gruppen, in denen ein einzelner Benutzer registriert ist, abzurufen.

• Endpunkte
• Listet die Mitglieder einer Gruppe auf
• Listen Sie die Gruppen eines Benutzers auf
• Einen Benutzer zu einer Gruppe hinzufügen
• Einen Benutzer aus einer Gruppe entfernen

Endpunkte

• GET /groups/{groupId}/users- listet die Mitglieder einer Gruppe auf
• GET /users/{userId}/groups - listet die Gruppen eines Benutzers auf
• PUT /groups/{groupId}/users/{userId} - fügt einen Benutzer zu einer Gruppe hinzu
• DELETE /groups/{groupId}/users/{userId}- einen Benutzer aus einer Gruppe entfernen

Listet die Mitglieder einer Gruppe auf

GET /groups/{groupId}/users

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 100 liegen (standardmäßig 50)

Beispiel für eine Antwort

< 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“: „learner“, 
 „firstName“: „Beispiel Vorname 1", 
 „lastName“: „Beispiel Nachname 1", „lastActiveAt“: 
 „2021-10-28T 20:39:52.659 Z“, 
 „learnerReportUrl“: „2021-10-28T 20:39:52.659 Z“, 
 „learnerReportUrl“: „“, „url“: „“ 
 „Articulate360User“: falsch 
 
 
},... 
< https://url-for-next-page-of-results >], 
 „nächste URL“: „“} 

Endpunktspezifische Fehlercodes:

• group_not_found- Benutzer können nicht aufgelistet werden, da die Gruppe nicht existiert

Listet die Gruppen eines Benutzers auf

GET /users/{userId}/groups

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 100 liegen (standardmäßig 50)

Beispiel für eine Antwort

< 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“: „Beispielgruppe“, 
 „url“: „“},
... 
 
< https://url-for-next-page-of-results >], „nächste URL“: „“} 
 

Endpunktspezifische Fehlercodes:

• user_not_found- Benutzergruppen können nicht aufgelistet werden, da der Benutzer nicht existiert

Benutzer zur Gruppe hinzufügen

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

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

• group_not_found- Benutzer kann nicht zur Gruppe hinzugefügt werden, da die Gruppe nicht existiert
• user_not_found- Benutzer kann nicht zur Gruppe hinzugefügt werden, da der Benutzer nicht existiert

Benutzer aus Gruppe entfernen

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

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

• group_not_found- Der Benutzer kann nicht aus der Gruppe entfernt werden, da die Gruppe nicht existiert
• user_not_found- Der Benutzer kann nicht aus der Gruppe entfernt werden, da der Benutzer nicht existiert