Browse Articles

Browse Articles

Reach 360: API für Gruppenmitgliedschaften

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Group Memberships API können Sie Benutzer zu einer Gruppe hinzufügen und Benutzer aus einer Gruppe entfernen. Admins sehen, dass sich dies auf der Registerkarte „Personen“ entweder unter dem einzelnen Benutzer- oder Gruppendatensatz widerspiegelt. Alle der Gruppe zugewiesenen Kurse werden in der Bibliothek des Benutzers angezeigt.

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

Endpunkte

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

Mitglieder einer Gruppe auflisten

GET /groups/{groupId}/users

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 100 liegen (der Standardwert ist 50)

Beispiel für eine Antwort

{
„users“: [
{
„id“: „example-user-id-1",
 „email“: "foo@example.com „,
 „groupsURL“: „groupsURL < https://api.reach360.com/users/example-user-id-1/groups >“: „learner“,
 „firstName“: „Beispiel Vorname 1",
 „LastName“: „Beispiel Nachname 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“: falsch
 
},... 
],
 „nächste URL“: „< https://url-for-next-page-of-results >“
}

Endpunktspezifische Fehlercodes:

  • group_not_found- kann Benutzer nicht auflisten, da die Gruppe nicht existiert

Gruppen eines Benutzers auflisten

GET /users/{userId}/groups

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 100 liegen (der Standardwert ist 50)

Beispiel für eine Antwort

{
„groups“: [
{
„id“: „example-group-id-1",
 „membersURL“: „< https://api.reach360.com/groups/example-group-id/users >“,
 „name“: „Beispielgruppe“,
 „url“: „< https://api.reach360.com/groups/example-group-id-1 >“
},... 
],
 „nächste URL“: „< https://url-for-next-page-of-results >“
}

Endpunktspezifische Fehlercodes:

  • user_not_found- kann Benutzergruppen nicht auflisten, da der Benutzer nicht existiert

Benutzer zur Gruppe hinzufügen

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

Antwort auf Erfolg

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}

Antwort auf Erfolg

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

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