Browse Articles

Browse Articles

Reach 360 : API de parcours de formation

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 Learning Paths, vous pouvez obtenir une liste de tous les parcours de formation dans Reach 360, ainsi que les détails d'un chemin d'apprentissage unique et des cours qui le constituent.

Points de terminaison

  • GET /learning-paths- liste des parcours d'apprentissage
  • GET /learning-paths/{learningPathId}- obtenir les détails d'un chemin de formation par identifiant de chemin d'apprentissage
  • GET /learning-paths/{learningPathId}/courses- répertorie les cours d'un chemin de formation par identifiant de chemin d'apprentissage

Objet du parcours d'apprentissage

  • id(chaîne) : identifiant unique du chemin d'apprentissage
  • title(chaîne) - titre du chemin d'apprentissage
  • description(chaîne) - description du chemin d'apprentissage
  • coverImageUrl(string) : URL de l'image de couverture du chemin de formation (le cas échéant)
  • coursesUrl(string) - URL permettant de récupérer la liste des cours du chemin de formation depuis l'API
  • coursesReportUrl(string) : URL permettant de récupérer le rapport sur les chemin de formation depuis l'API
  • learnersReportUrl(string) : URL permettant de récupérer le rapport sur le chemin d'apprentissage des apprenants depuis l'API
  • url(string) - URL pour récupérer les détails du parcours d'apprentissage depuis l'API

Parcours de formation et 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 permettant de 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
  • order(entier) : ordre d'un module dans un chemin d'apprentissage (la numérotation commence à 0)
  • contentType(chaîne) - type de module (peut être l'un des suivants : MICROLEARNING, STORYLINE, IMPORTED, RISE)

Liste des parcours de formation

GET /learning-paths

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)

Exemple de réponse

{
« LearningPaths » : [
{
« id » : « example-learning-path-1",
 « title » : « Titre du chemin de formation »,
 « description » : « Un chemin d'apprentissage simple »,
 « coverImageURL » : « https://api.reach360.com/reports/learning-paths/example-learning-path-1/learners
 «, « url » : "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 » : "«,
 « url » : » https://api.reach360.com/learning-paths/example-learning-path-1 "
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Récupérer le parcours de formation par identifiant

GET /learning-paths/{learningPathId}

Exemple de réponse

{
« id » : « example-learning-path »,
 « title » : « Titre du chemin de formation »,
 « description » : « Un chemin d'apprentissage simple »,
 « coverImageURL » :
 « 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 «
}

Codes d'erreur spécifiques au terminal

  • learning_path_not_found- impossible de récupérer chemin d'apprentissage car chemin d'apprentissage n'existe pas

Répertorier les cours dans Learning Path

GET /learning-paths/{learningPathId}/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)

Exemple de réponse

{
« LearningPathUrl » : "https://api.reach360.com/learning-paths/example-learning-path-id-1
 «, « 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
 « « order » : 3
 « ContentType » : « RISE »
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Codes d'erreur spécifiques au terminal

  • learning_path_not_found- Impossible de répertorier les cours car chemin d'apprentissage n'existe pas