Wat dit API-eindpunt doet

Met de Learning Paths API kunt u een lijst krijgen van alle leertrajecten in Reach 360, evenals de details van een enkel leertraject en de cursussen die samen een leerpad vormen.

• Eindpunten
• Object van het leerpad
• Cursusobject van het leerpad
• Leerpaden opsommen
• Leerpad ophalen op basis van ID
• Maak een lijst van cursussen in Learning Path

Eindpunten

• GET /learning-paths- leertrajecten opsommen
• GET /learning-paths/{learningPathId}- verkrijg informatie over een leertraject met behulp van het leerpad-ID
• GET /learning-paths/{learningPathId}/courses- geef cursussen in een leertraject weer op basis van het leerpad-ID

Object van het leerpad

• id(string) - de unieke identificator van de leerweg
• title(string) - titel van de leerweg
• description(string) - beschrijving van de leerweg
• coverImageUrl(string) - URL voor de omslagafbeelding van het leerpad (indien aanwezig)
• coursesUrl(string) - URL om de lijst met cursussen in de leerweg op te halen uit de API
• coursesReportUrl(string) - URL om het rapport over leertrajectcursussen op te halen uit de API
• learnersReportUrl(string) - URL om het rapport voor leertrajectcursisten op te halen uit de API
• url(string) - URL om de details van het leerpad op te halen uit de API

Cursusobject van het leerpad

• id(string) - de unieke identificator van de cursus
• title(string) - titel van de cursus
• coverImageUrl(string) - URL voor de omslagafbeelding van de cursus (indien aanwezig)
• authorUrl(string) - URL om gebruikersgegevens van de auteur op te halen uit de API
• courseReportUrl(string) - URL om het cursusrapport op te halen uit de API
• url(string) - URL om cursusgegevens op te halen uit de API
• order(integer) - volgorde van een cursus in een leerweg (nummering begint bij 0)
• contentType(string) - soort cursus (kan een van de volgende zijn: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Leerpaden opsommen

GET /learning-paths

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)

Voorbeeldreactie

{
„learningPaths”: [
{
„id”: „examplelearning-path-1", „title”: 
 „Titel van het leerpad”, „description”: „Een eenvoudige leerweg”, 
 „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 "
},... 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 
 

Leerpad ophalen op basis van ID

GET /learning-paths/{learningPathId}

Voorbeeldreactie

{
„id”: „examplelearning-path”, „title”: 
 „Titel van het leerpad”, „description”: 
 „Een eenvoudige leerweg”, „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"} 
 

Endpoint-specifieke foutcodes

• learning_path_not_found- kan het leerpad niet ophalen omdat het leerpad niet bestaat

Maak een lijst van cursussen in Learning Path

GET /learning-paths/{learningPathId}/courses

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)

Voorbeeldreactie

{
„learningPathUrl”: "https://api.reach360.com/learning-paths/example-learning-path-id-1 „, 
 „courses”: [
{
„id”: „examplecourse-id-1", „title”: „Cursustitel”, 
 „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”},... 
 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Endpoint-specifieke foutcodes

• learning_path_not_found- kan geen cursussen vermelden omdat er geen leerweg bestaat