Was dieser API-Endpunkt macht

Mit der Learning Paths API können Sie eine Liste aller Lernpfade in Reach 360 sowie die Details eines einzelnen Lernpfads und der Kurse, aus denen ein Lernpfad besteht, abrufen.

• Endpunkte
• Objekt „Lernpfad“
• Lernpfad-Kursobjekt
• Lernpfade auflisten
• Lernpfad nach ID abrufen
• Kurse im Lernpfad auflisten

Endpunkte

• 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

Lernpfad-Objekt

• id(string) — die eindeutige Kennung des Lernpfads
• title(string) — Titel des Lernpfads
• description(string) — Beschreibung des Lernpfads
• coverImageUrl(string) — URL für das Titelbild des Lernpfads (falls vorhanden)
• coursesUrl(string) — URL zum Abrufen der Liste der Kurse im Lernpfad von der API
• coursesReportUrl(string) — URL zum Abrufen des Lernpfad-Kursberichts von der API
• learnersReportUrl(string) — URL zum Abrufen des Lernpfad-Lernberichts von der API
• url(string) — URL zum Abrufen der Details des Lernpfads von der API

Lernpfad — Kursobjekt

• 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 Benutzerdaten des Autors von der API
• courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
• url(string) — URL zum Abrufen der Kursdetails von der API
• order(Ganzzahl) — Reihenfolge eines Kurses in einem Lernpfad (die Nummerierung beginnt bei 0)
• contentType(Zeichenfolge) — Kurstyp (kann einer der folgenden sein: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Lernpfade auflisten

GET /learning-paths

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)

Beispiel für eine Antwort

{
„learningPaths“: [
{
„id“: „example-learning-path-1", „title“: „Titel des Lernpfads“, 
 „description“: „Ein einfacher Lernpfad“, 
 „coverImageUrl“: null, „coursesUrl“: "https://api.reach360.com/learning-paths/example-learning-path-1/courses 
 „, „coursesreportUrl“: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/courses 
 „, „learnersreportUrl“: "https://api.reach360.com/reports/learning-paths/example-learning-path-1/learners 
 „, „url“:“ 
 
 https://api.reach360.com/learning-paths/example-learning-path-1 "
},... 
], 
 „nächste URL“: "https://url-for-next-page-of-results"} 
 

Lernpfad anhand der ID abrufen

GET /learning-paths/{learningPathId}

Beispiel für eine Antwort

{
„id“: „example-learning-path“, 
 „title“: „Titel des Lernpfads“, „description“: 
 „Ein einfacher Lernpfad“, „coverImageUrl“: null, 
 „coursesUrl“: "https://api.reach360.com/learning-paths/example-learning-path/courses 
 „, „coursesreportUrl“: "https://api.reach360.com/reports/learning-paths/example-learning-path/courses „, 
 „learnersreportUrl“: "https://api.reach360.com/reports/learning-paths/example-learning-path/learners „, 
 „url“: "https://api.reach360.com/learning-paths/example-learning-path"} 
 

Endpunktspezifische Fehlercodes

• learning_path_not_found- der Lernpfad kann nicht abgerufen werden, da der Lernpfad nicht existiert

Kurse im Lernpfad auflisten

GET /learning-paths/{learningPathId}/courses

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)

Beispiel für eine Antwort

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

Endpunktspezifische Fehlercodes

• learning_path_not_found- kann keine Kurse auflisten, da es keinen Lernpfad gibt