Ce que fait ce point de terminaison d'API

Avec l'API Courses, vous pouvez obtenir une liste de tous les modules soumis (publiés et non publiés) sur votre compte Reach 360 ainsi que les détails d'un seul cours.

• Points de terminaison
• Objet du module
• Modules de liste
• Récupérer le module par identifiant

Points de terminaison

• GET /courses- liste des modules
• GET /courses/{courseId}- obtenir les détails d'un module par identifiant de cours

Objet du module

• id(chaîne) - l'identifiant unique du module
• title(string) - titre du module
• coverImageUrl(string) - URL de l'image de couverture du module (le cas échéant)
• authorUrl(string) - URL pour récupérer les informations utilisateur de l'auteur depuis l'API
• courseReportUrl(string) - URL pour récupérer le rapport du module depuis l'API
• url(string) - URL pour récupérer les détails du cours depuis l'API
• contentType(chaîne) - type de cours (peut être l'un des suivants : MICROLEARNING, STORYLINE, IMPORTED, RISE)

Modules de liste

GET /courses

Paramètres de demande (chaîne de requête)

• limit(entier, facultatif) - le nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)
• contentType(chaîne, facultatif) - Filtrez la réponse à un type de contenu spécifique. Les options disponibles sont rise, storyline, microlearning, imported, all

Exemple de réponse

{
« modules » : [
{
« id » : « example-course-id-1", « 
 title » : « Titre du cours », « 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 »},... 
 
 
], 
 « URL suivante » : "https://url-for-next-page-of-results"} 

Récupérer le module par identifiant

GET /courses/{courseId}

Exemple de réponse

{
« id » : « example-course-id », 
 « title » : « Titre du cours », « 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 »} 
 

Codes d'erreur spécifiques au point de terminaison

• course_not_found- Impossible de récupérer le module car le cours n'existe pas