Browse Articles

Browse Articles

Reach 360: Benutzer-API

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Benutzer-API können Sie eine Liste aller Benutzer in Ihrem Reach 360 360-Konto sowie die Details eines einzelnen Benutzers abrufen. Sie können Benutzer auch aus dem Training löschen.

Endpunkte

  • GET /users- Benutzer auflisten
  • GET /users/{userId}- Ruft die Details eines Benutzers anhand der Benutzer-ID ab
  • DELETE /users/{userId}- Benutzer anhand der Benutzer-ID löschen

Benutzerobjekt

  • id(string) — die eindeutige Kennung des Benutzers
  • email(string) — die E-Mail-Adresse des Benutzers
  • groupsUrl(string) — URL zum Auflisten der Benutzergruppen aus der API
  • role(string) — die Rolle des Benutzers (eine von learnerauthor,reporter, oderadmin)
  • firstName(string) — der Vorname des Benutzers
  • lastName(string) - der Nachname des Benutzers
  • lastActiveAt(string) — Datum und Uhrzeit der letzten aktiven Aktivität des Benutzers
  • learnerReportUrl(string) — URL zum Abrufen des Lernerberichts des Benutzers von der API
  • favoritesUrl(string) — URL zum Abrufen der Favoritenliste des Benutzers von der API
  • url(string) — URL zum Abrufen der Benutzerdetails von der API
  • articulate360User(boolean) — ob der Benutzer in Articulate 360 verwaltet wird oder nicht

Eine Benutzerliste wird abgerufen

GET /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)
  • email(string, optional) — falls angegeben, werden nur Benutzer mit dieser E-Mail-Adresse zurückgegeben

Beispiel für eine Antwort

{
„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“: "https://api.reach360.com/reports/learners/example-user-id-1 „, „favoritesUrl“: "https://api.reach360.com/users/example-user-id-1/favorites 
 „, „url“:“ 
 
 https://api.reach360.com/users/example-user-id-1 "
„Articulate360User“: falsch
},... 
], 
 „nächste URL“: "https://url-for-next-page-of-results"}

Spezifische Benutzerdetails werden abgerufen

GET /users/{userId}

Beispiel für eine Antwort

{
„id“: „example-user-id“, 
 „email“: "example@example.com „, „groupsUrl“: "https://api.reach360.com/users/example-user-id-1/groups 
 „, „role“: „learner“, 
 „firstName“: „Beispiel Vorname“, 
 „lastName“: „Beispiel Nachname“, „lastActiveAt“: 
 „2021-10-28T 20:39:52.659 Z“, 
 „learnerReportUrl“: "https://api.reach360.com/reports/learners/example-user-id „, „FavoritesUrl“: "https://api.reach360.com/users/example-user-id/favorites 
 „, „url“: "https://api.reach360.com/users/example-user-id" „articulate360 
 
 
 Benutzer“: false
}

Endpunktspezifische Fehlercodes

  • user_not_found- Der Benutzer kann nicht abgerufen werden, da der Benutzer nicht existiert

Benutzer nach ID löschen

DELETE /users/{userId}

  • Nur Lernende, die nicht mit SSO verwaltet werden und keine Articulate-ID haben, können mit der API gelöscht werden.

Beispiel für eine Erfolgsantwort

204 Kein Inhalt

Beispiel für Antworten auf Fehler (nur Lernende können gelöscht werden)

{
„errors“: [
{
„message“: „Sie können einen Benutzer, der von 360 verwaltet wird, nicht löschen“, 
 „code“: „validation_failed“}]}

Beispiel für eine Fehlerreaktion (SSO-Benutzer können nicht gelöscht werden)

{
„Fehler“: [
{
„Nachricht“: „Kein Benutzer gefunden“, 
 „Code“: „nicht gefunden“
}]}

Beispiel für eine Fehlerreaktion (Besitzer können nicht gelöscht werden)

{
„errors“: [
{
„message“: „Sie können einen Benutzer, der der Eigentümer ist, nicht löschen“, 
 „code“: „validation_failed“}]}

Beispiel für eine Fehlerreaktion (Okta-Benutzer können nicht gelöscht werden)

{
„Fehler“: [
{
„Nachricht“: „Kein Benutzer gefunden“, 
 „Code“: „nicht gefunden“
}]}