Ce que fait ce point de terminaison d'API

Avec l'API Learning Paths, vous pouvez obtenir une liste de tous les parcours d'apprentissage dans Reach 360 ainsi que les détails d'un seul parcours d'apprentissage et les modules qui le composent.

• Points de terminaison
• Objet du parcours d'apprentissage
• Objet du cours relatif au parcours d'apprentissage
• Répertorier les parcours pédagogiques
• Récupérez le parcours de formation par identifiant
• Répertorier les cours dans le parcours d'apprentissage

Points de terminaison

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

Objet du parcours d'apprentissage

• id(chaîne) - l'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 d'apprentissage (le cas échéant)
• coursesUrl(string) - URL pour récupérer la liste des modules du chemin d'apprentissage à partir de l'API
• coursesReportUrl(string) - URL pour récupérer le rapport des modules de chemin d'apprentissage à partir de l'API
• learnersReportUrl(string) - URL pour 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

Objet du cours relatif au parcours d'apprentissage

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

Répertorier les parcours pédagogiques

GET /learning-paths

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)

Exemple de réponse

{
« learningPaths » : [
{
« id » : « example-learning-path-1", « title » : 
 « Titre du parcours pédagogique », « 
 description » : « Un parcours d'apprentissage simple », « 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 "
},... 
], 
 « URL suivante » : "https://url-for-next-page-of-results"} 
 

Récupérez le parcours de formation par identifiant

GET /learning-paths/{learningPathId}

Exemple de réponse

{
« id » : « example-learning-path », 
 « title » : « Titre du parcours pédagogique », « description » : 
 « Un parcours d'apprentissage simple », « 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"} 
 

Codes d'erreur spécifiques au point de terminaison

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

Répertorier les cours dans le parcours d'apprentissage

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

Exemple de réponse

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

Codes d'erreur spécifiques au point de terminaison

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