Co robi ten punkt końcowy interfejsu API

Za pomocą interfejsu API użytkowników możesz uzyskać listę wszystkich użytkowników na swoim koncie Reach 360, a także dane jednego użytkownika. Możesz także usunąć użytkowników ze szkolenia.

• Punkty końcowe
• Obiekt użytkownika
• Pobieranie listy użytkowników
• Pobieranie szczegółowych informacji o użytkowniku

Punkty końcowe

• GET /users- lista użytkowników
• GET /users/{userId}- uzyskać dane użytkownika według identyfikatora użytkownika
• DELETE /users/{userId}- usuń użytkownika według identyfikatora użytkownika

Obiekt użytkownika

• id(string) - unikalny identyfikator użytkownika
• email(string) - adres e-mail użytkownika
• groupsUrl(string) - URL do listy grup użytkowników z API
• reportingGroupsUrl(string) - URL do listy grup, dla których użytkownik jest reporterem z API (uwaga: ustawiana tylko wtedy, gdy użytkownik ma rolę) reporter
• managingGroupsUrl(string) - URL do listy grup, dla których użytkownik jest menedżerem z API (uwaga: ustawiana tylko wtedy, gdy użytkownik ma rolęmanager)
• role(string) - rola użytkownika (jedna zlearner,author, reportermanager, lubadmin)
• firstName(string) - imię użytkownika
• lastName(string) - nazwisko użytkownika
• lastActiveAt(string) - data i godzina ostatniej aktywności użytkownika
• learnerReportUrl(string) - URL do pobrania raportu uczestnika użytkownika z interfejsu API
• favoritesUrl(string) - URL, aby pobrać listę ulubionych użytkownika z interfejsu API
• url(string) - URL do pobierania danych użytkownika z API
• articulate360User(boolean) - czy użytkownik jest zarządzany w Articulate 360

Pobieranie listy użytkowników

GET /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)
• email(string, opcjonalnie) - jeśli podano, zwracają tylko użytkowników z tym adresem e-mail

Przykładowa odpowiedź

{
„users”: [
{
„id”: „example-user-id-1", „email”: "foo@example.com 
 „, „GroupSurl”: "https://api.reach360.com/users/example-user-id-1/groups „, „ReportingGroupSurl”: null, 
 „ManagingGroupSurl”: null, 
 „role”: „uczestnik”, 
 „FirstName”: „Example First Name 1", 
 „LastName”: „Przykładowe imię 1" „lastActiveAT”
: „2021-10-28T 20:39:52.659 Z”
, „learnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id-1 „, „Ulubionych URL”:” 
 
 
 https://api.reach360.com/users/example-user-id-1/favorites „, 
 „url”: "https://api.reach360.com/users/example-user-id-1" 
 „articulate360user”: false},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 
 

Pobieranie szczegółowych informacji o użytkowniku

GET /users/{userId}

Przykładowa odpowiedź

{
„id”: „example-user-id”, „email”: "example@example.com 
 „, „GroupSurl”: "https://api.reach360.com/users/example-user-id-1/groups „, 
 „ReportingGroupSurl”: null, 
 „
ManagingGroupSurl”: null, „
role”: „uczestnik”, „FirstName”: „Przykładowe imię”, „LastActiveAT”: „Przykładowe imię”, 
 „LastActiveAT”: 2021-10-28T 20:39:52.659 Z”, 
 „learnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id „, „Ulubionych URL”: "https://api.reach360.com/users/example-user-id/favorites 
 „, 
 
 
„url”: "https://api.reach360.com/users/example-user-id" 
 „articulate360user”: false} 

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

• user_not_found- nie można pobrać użytkownika, ponieważ użytkownik nie istnieje

Usuwanie użytkowników według identyfikatora

DELETE /users/{userId}

• Tylko uczestnicy, którzy nie są zarządzani za pomocą SSO i którzy nie mają identyfikatora Articulate ID, mogą zostać usunięci za pomocą interfejsu API.

Przykład odpowiedzi na sukces

204 Brak treści

Przykładowe odpowiedzi na niepowodzenia (tylko uczestnicy mogą zostać usunięci)

{
„errors”: [
{
„message”: „Nie można usunąć użytkownika zarządzanego przez 360", 
 „code”: „validation_failed”}]} 
 
 

Przykładowa reakcja na awarię (użytkownicy SSO nie mogą zostać usunięci)

{
„errors”: [
{
„message”: „Nie znaleziono użytkownika”, 
 „code”: „not_found”
}]} 
 

Przykładowa odpowiedź na awarię (właścicieli nie można usunąć)

{
„errors”: [
{
„message”: „Nie możesz usunąć użytkownika, który jest właścicielem”, 
 „code”: „validation_failed”}]} 
 
 

Przykładowa reakcja na awarię (użytkowników Okta nie można usunąć)

{
„errors”: [
{
„message”: „Nie znaleziono użytkownika”, 
 „code”: „not_found”
}]}