Browse Articles

Browse Articles

Reach 360 : API de cours

Dernière mise à jour de l’article le

Cet article s'applique à :

Reach 360

Ce que fait ce point de terminaison d'API

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

Points de terminaison

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

Objet du cours

  • id(chaîne) : identifiant unique du module
  • title(chaîne) - titre du module
  • coverImageUrl(chaîne) : 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 permettant de récupérer le rapport de module depuis l'API
  • url(string) - URL pour récupérer les détails du cours depuis l'API
  • contentType(chaîne) - type de module (peut être l'un des suivants : MICROLEARNING, STORYLINE, IMPORTED, RISE)

Liste des cours

GET /courses

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

  • limit(entier, facultatif) : 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 sontrise, storyline, microlearning, imported, all

Exemple de réponse

{
« module » : [
{
« id » : « example-course-id-1",
 « title » : « Titre du module »,
 « 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 cours par identifiant

GET /courses/{courseId}

Exemple de réponse

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

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