Wat dit API-eindpunt doet

Met de Courses API kunt u een lijst krijgen van alle ingezonden cursussen (gepubliceerd en ongepubliceerd) in uw Reach 360-account, evenals de gegevens van een enkele cursus.

• Eindpunten
• Object van de cursus
• Cursussen opsommen
• Cursus met ID ophalen

Eindpunten

• GET /courses- lijst van cursussen
• GET /courses/{courseId}- bekijk de details van een cursus op cursus-ID

Object van de cursus

• 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
• contentType(string) - soort cursus (kan een van de volgende zijn: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Cursussen opsommen

GET /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)
• contentType(tekenreeks, optioneel) - Filterreactie op een specifiek inhoudstype. Beschikbare opties zijn rise, storyline, microlearning, imported, all

Voorbeeldreactie

{
„courses”: [
{
„id”: „voorbeeld-course-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" „contentType”: „RISE”},
... 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Cursus met ID ophalen

GET /courses/{courseId}

Voorbeeldreactie

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

Endpoint-specifieke foutcodes

• course_not_found- kan de cursus niet ophalen omdat de cursus niet bestaat