Browse Articles

Browse Articles

Reach 360: Kurs-API

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Courses API können Sie eine Liste aller eingereichten Kurse (veröffentlicht und unveröffentlicht) in Ihrem Reach 360-Konto sowie die Details eines einzelnen Kurses abrufen.

Endpunkte

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

Objekt des Kurses

  • id(string) - die eindeutige Kennung des Kurses
  • title(string) - Titel des Kurses
  • coverImageUrl(string) — URL für das Titelbild des Kurses (falls vorhanden)
  • authorUrl(string) — URL zum Abrufen der Benutzerdetails des Autors aus der API
  • courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
  • url(string) — URL zum Abrufen der Kursdetails von der API
  • contentType(string) — Kurstyp (kann einer der folgenden sein: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Kurse auflisten

GET /courses

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 100 liegen (der Standardwert ist 50)
  • contentType(Zeichenfolge, optional) — Filtert die Antwort auf einen bestimmten Inhaltstyp. Verfügbare Optionen sindrise, storyline, microlearning, imported, all

Beispiel für eine Antwort

{
„courses“: [
{
„id“: „example-course-id-1",
 „title“: „Kurstitel“,
 „coverImageUrl“: null,
 „authorUrl“: "https://api.reach360.com/users/author-user-id
 „, „courseportUrl“: "https://api.reach360.com/reports/courses/example-course-id-1 „,
 „url“: "https://api.reach360.com/courses/example-course-id-1"
 „contentType“: „RISE“
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Kurs anhand der ID abrufen

GET /courses/{courseId}

Beispiel für eine Antwort

{
„id“: „example-course-id“,
 „title“: „Kurstitel“,
 „coverImageUrl“: null,
 „authorUrl“: "https://api.reach360.com/users/author-user-id
 „, „courseportUrl“: "https://api.reach360.com/reports/courses/example-course-id „,
 „url“: "https://api.reach360.com/courses/example-course-id"
 „contentType“: „RISE“
}

Endpunktspezifische Fehlercodes

  • course_not_found- Kurs kann nicht abgerufen werden, da der Kurs nicht existiert