Co robi ten punkt końcowy API

Za pomocą interfejsu API członkostwa w grupie możesz dodawać użytkowników i usuwać użytkowników z grupy. Administratorzy widzą to odzwierciedlone na karcie Osoby w rekordzie indywidualnego użytkownika lub grupy. Wszystkie kursy przypisane do grupy pojawią się w bibliotece użytkownika.

Za pomocą tego interfejsu API można również pobrać listę członków grupy lub grup, w których zarejestrowany jest indywidualny użytkownik.

• Punkty końcowe
• Lista członków grupy
• Lista grup użytkowników
• Dodawanie użytkownika do grupy
• Usuwanie użytkownika z grupy

Punkty końcowe

• GET /groups/{groupId}/users- lista członków grupy
• GET /users/{userId}/groups - lista grup użytkownika
• PUT /groups/{groupId}/users/{userId} - dodaj użytkownika do grupy
• DELETE /groups/{groupId}/users/{userId}- usunąć użytkownika z grupy

Lista członków grupy

GET /groups/{groupId}/users

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)

Przykładowa odpowiedź

< 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”: 
 „uczestnik”, „FirstName”: „Przykładowe imię 1", „lastName”: „Przykład Nazwiska 1", 
 „lastActiveAT”: „2021-10-28T 20:39:52.659 Z”, „learnEat ReportUrl”: 
 „”, „url”: „” „articulate360User”: false 
 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 „nextURL”: „”} 

Kody błędów specyficzne dla punktu końcowego:

• group_not_found- nie można wyświetlić listy użytkowników, ponieważ grupa nie istnieje

Lista grup użytkowników

GET /users/{userId}/groups

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)

Przykładowa odpowiedź

< 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”: „Przykładowa grupa”, 
 „url”: „”},
... 
 
< https://url-for-next-page-of-results >], 
 „nextURL”: „”} 

Kody błędów specyficzne dla punktu końcowego:

• user_not_found- nie można wyświetlić listy grup użytkowników, ponieważ użytkownik nie istnieje

Dodaj użytkownika do grupy

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

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego:

• group_not_found- nie można dodać użytkownika do grupy, ponieważ grupa nie istnieje
• user_not_found- nie można dodać użytkownika do grupy, ponieważ użytkownik nie istnieje

Usuń użytkownika z grupy

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

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego:

• group_not_found- nie można usunąć użytkownika z grupy, ponieważ grupa nie istnieje
• user_not_found- nie można usunąć użytkownika z grupy, ponieważ użytkownik nie istnieje