Wat dit API-eindpunt doet

Met de Group Memberships API kun je gebruikers toevoegen aan en verwijderen uit een groep. Beheerders zien dit terug op het tabblad Personen onder de individuele gebruikers- of groepsrecord. Alle cursussen die aan de groep zijn toegewezen, verschijnen in de bibliotheek van de gebruiker.

Je kunt deze API ook gebruiken om een lijst op te halen van groepsleden of groepen waarin een individuele gebruiker is ingeschreven.

• Eindpunten
• Maak een lijst van de leden van een groep
• De groepen van een gebruiker weergeven
• Een gebruiker aan een groep toevoegen
• Een gebruiker uit een groep verwijderen

Eindpunten

• GET /groups/{groupId}/users- maak een lijst van de leden van een groep
• GET /users/{userId}/groups - maak een lijst van gebruikersgroepen
• PUT /groups/{groupId}/users/{userId} - een gebruiker aan een groep toevoegen
• DELETE /groups/{groupId}/users/{userId}- een gebruiker uit een groep verwijderen

Maak een lijst van de leden van een groep

GET /groups/{groupId}/users

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)

Voorbeeldreactie

< https://api.reach360.com/reports/learners/example-user-id-1 > < https://api.reach360.com/users/example-user-id-1 >{ 
 „users”: [
{
„id”: „exampleuser-id-1", „email”: "foo@example.com 
 „, „groupsURL”: „”, 
 „< https://api.reach360.com/users/example-user-id-1/groups > 
 role”: „cursist”, „voornaam”: „Voorbeeld Voornaam 1", „Achternaam”: „Voorbeeld Achternaam 1", 
 „LastActiveAt”: „2021-10-28T 20:39:52.659 Z”, „LearnerReportUrl”: 
 „”, „url”: „” „Articulate360User”: onwaar 
 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 „NextURL”: „”} 

Endpoint-specifieke foutcodes:

• group_not_found- kan geen gebruikers vermelden omdat de groep niet bestaat

De groepen van een gebruiker weergeven

GET /users/{userId}/groups

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)

Voorbeeldreactie

< https://api.reach360.com/groups/example-group-id-1 >{ 
 „groups”: [
{
„id”: „voorbeeldgroep-id-1", 
 „membersURL”: „”, „< https://api.reach360.com/groups/example-group-id/users > name”: „Voorbeeldgroep”, 
 „url”: „”},
... 
 
< https://url-for-next-page-of-results >], 
 „NextURL”: „”} 

Endpoint-specifieke foutcodes:

• user_not_found- kan gebruikersgroepen niet weergeven omdat de gebruiker niet bestaat

Gebruiker aan groep toevoegen

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

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes:

• group_not_found- kan geen gebruiker aan de groep toevoegen omdat de groep niet bestaat
• user_not_found- kan geen gebruiker aan de groep toevoegen omdat de gebruiker niet bestaat

Gebruiker uit groep verwijderen

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

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes:

• group_not_found- kan de gebruiker niet uit de groep verwijderen omdat de groep niet bestaat
• user_not_found- kan de gebruiker niet uit de groep verwijderen omdat de gebruiker niet bestaat