Reach 360: API für Kursanmeldungen

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Was dieser API-Endpunkt macht

Die API für Kursanmeldungen meldet einen Benutzer oder eine Gruppe für einen Kurs an oder meldet sie ab. Wenn sie verwendet wird, sehen Administratoren, dass der Benutzer oder die Gruppe auf der entsprechenden Registerkarte auf der Seite mit den Kursdetails hinzugefügt oder daraus entfernt wurde. Den Teilnehmern wird angezeigt, dass der Kurs zu ihrem Tab „Mir zugewiesen“ hinzugefügt oder entfernt wurde.

Endpunkte

  • 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

Jeder — Gruppe

Um die Gruppe Jeder (d. h. jeden Benutzer in Ihrem Reach 360 360-Konto) für einen Kurs anzumelden, verwenden Sie everyone für groupId

Benutzer registrieren

PUT /courses/{courseId}/users/{userId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

  • course_not_found- Der Benutzer kann nicht für den Kurs angemeldet werden, da der Kurs nicht existiert
  • user_not_found- Der Benutzer kann nicht für den Kurs angemeldet werden, da der Benutzer nicht existiert

Gruppe anmelden

PUT /courses/{courseId}/groups/{groupId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

  • course_not_found- Die Gruppe kann nicht für den Kurs angemeldet werden, da der Kurs nicht existiert
  • group_not_found- Die Gruppe kann nicht für den Kurs angemeldet werden, da die Gruppe nicht existiert

Benutzer deregistrieren

DELETE /courses/{courseId}/users/{userId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

  • course_not_found- Der Benutzer kann nicht vom Kurs abgemeldet werden, da der Kurs nicht existiert
  • user_not_found- Der Benutzer kann nicht vom Kurs abgemeldet werden, da der Benutzer nicht existiert

Gruppe deregistrieren

DELETE /courses/{courseId}/groups/{groupId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

  • course_not_found- Die Gruppe kann nicht vom Kurs abgemeldet werden, da der Kurs nicht existiert
  • group_not_found- Die Gruppe kann nicht vom Kurs abgemeldet werden, da die Gruppe nicht existiert