Reach 360: Referenzhandbuch für API-Endpunkte

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

In diesem Artikel werden alle Reach 360 360-Endpunkte aufgeführt. Die vollständigen, individuellen APIs sind in jedem Abschnitt verlinkt.

Kurs-API

  • GET /courses- Kurse auflisten
  • GET /courses/{courseId}- Details zu einem Kurs anhand der Kurs-ID abrufen

API für die Kursanmeldung

  • PUT /courses/{courseId}/users/{userId}- einen einzelnen Benutzer für einen Kurs anmelden
  • PUT /courses/{courseId}/groups/{groupId}- eine Gruppe von Benutzern für einen Kurs anmelden
  • DELETE /courses/{courseId}/users/{userId}- melden Sie einen einzelnen Benutzer von einem Kurs ab
  • DELETE /courses/{courseId}/groups/{groupId}- meldet eine Gruppe von Benutzern für einen Kurs ab

Favoriten-API

  • GET /users/{userId}/favorites- listet Kurse und Lernpfade in den Favoriten eines Benutzers auf

Gruppen-API

  • POST /groups- eine neue Gruppe erstellen
  • GET /groups- Gruppen auflisten
  • GET /groups/{groupId}- Details zu einer Gruppe anhand der Gruppen-ID abrufen
  • PUT /groups/{groupId}- aktualisiert eine Gruppe anhand der Gruppen-ID
  • DELETE /groups/{groupId}- lösche eine Gruppe nach Gruppen-ID

API für Gruppenmitgliedschaften

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

Importiere die API für den Kursabschluss

  • POST /courses/{courseId}/users/{userId}/completions- Importiert Abschlussdaten für ein einzelnes Kurs-/Benutzerpaar in Reach 360.

Einladungs-API

  • POST /invitations—Senden Sie eine Einladung an einen Benutzer, Ihrem Team beizutreten
  • GET /invitations— listet ausstehende Einladungen auf
  • GET /invitations/{invitationId}— Informationen zu ausstehenden Einladungen anhand der Einladungs-ID abrufen
  • DELETE /invitations/{invitationId}— löscht eine ausstehende Einladung anhand der Einladungs-ID

API für Lernpfade

  • GET /learning-paths- Lernpfade auflisten
  • GET /learning-paths/{learningPathId}- Details zu einem Lernpfad anhand der Lernpfad-ID abrufen
  • GET /learning-paths/{learningPathId}/courses- Kurse in einem Lernpfad nach Lernpfad-ID auflisten

API für Lernpfad-Registrierungen

  • PUT /learning-paths/{learningPathId}/users/{userId}- einen einzelnen Benutzer für einen Lernpfad anmelden
  • PUT /learning-paths/{learningPathId}/groups/{groupId}- eine Gruppe von Benutzern für einen Lernpfad anmelden
  • DELETE /learning-paths/{learningPathId}/users/{userId}- einen einzelnen Benutzer von einem Lernpfad abmelden
  • DELETE /learning-paths/{learningPathId}/groups/{groupId}- eine Gruppe von Benutzern von einem Lernpfad abmelden

Berichts-API

  • GET /reports/activity- Bericht über Benutzeraktivitäten (Liste der Benutzersitzungen)
  • GET /reports/courses/{courseId}- Bericht über Kursteilnehmer (Liste der Lernsitzungen für einen Kurs)
  • GET /reports/learners/{userId}- Kursbericht für Teilnehmer (Liste der Kurseinheiten für einen Lernenden)
  • GET /reports/learning-paths/{learningPathId}/courses- Bericht über Lernpfad-Kurse (Liste der Kurseinheiten in einem Lernpfad)
  • GET /reports/learning-paths/{learningPathId}/learners- Bericht der Lernenden über den Lernpfad (Liste der Lernsitzungen in einem Lernpfad)

Benutzer-API

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

Webhooks-API

  • POST /webhooks- einen neuen Webhook erstellen
  • GET /webhooks- listet Webhooks auf
  • GET /webhooks/{webhookId}- Details eines Webhooks anhand der Webhook-ID abrufen
  • DELETE /webhooks/{webhookId}- lösche einen Webhook anhand der Webhook-ID