Reach 360 : API Favoris
Dernière mise à jour de l’article le
Cet article s'applique à :
Ce que fait ce point de terminaison d'API
L'API Favorites vous permet de récupérer la liste des cours et des parcours d'apprentissage qu'un utilisateur a enregistrés dans sa liste de favoris.
Points de terminaison
-
GET /users/{userId}/favorites- répertorie les cours et les parcours d'apprentissage dans les favoris d'un utilisateur
Répertorier les favoris d'un utilisateur
GET /users/{userId}/favorites
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
{
« UserUrl » : « https://api.rise.com/users/example-user-id-1 »,
« favoris » : [
{
« CompletedAt » : « 2020-11-15T 19:19:19 .019Z »,
« CourseID » : « example-course-id »,
« CourseUrl » : "https://api.reach360.com/courses/example-course-id «,
« CoverImageUrl » : "https://images.riseusercontent.com/versions/example-version-id/image-name.jpg «,
« EstimatedTimeToCompleTems » : « 360000",
« EstimatedTimeToCompleTems » » : « 360000",
« HasCertificateDownload » : vrai,
« LearnURL » : » https://example.reach360.com/learn/course/example-course-id «,
« LearningPathId » : null,
« LearningPathUrl » : null,
« NumberOfCourses » : null,
« NumberOfLessons » : 5,
« ProgressPercent » : 40,
« QuizScorePercent » : null,
« title » : « Exemple de titre de module »,
« ContentType » : « RISE »
},
{
« CompletedAt » : « 2020-1711-T 19:19:19 .019Z »,
« CourseId » : nul,
« CourseUrl » : null,
« CoverImageUrl » : » https://images.riseusercontent.com/lp-cover-photos/example-learning-path-id/image-name.jpg «,
« Temps estimé pour compléter les éléments » : « 3600000 »,
« HasCertificateDownload » : false, « Learning-PathURL » :
« https://example.reach360.com/learning-path/example-learning-path-id »,
« LearningPathId » : « example-learning-path-id »,
« LearningPathUrl » : « /learning-paths/example-learning-path-id »,
« Nombre de cours » : 1, « Nombre de cours » : 1,
« Nombre de cours » OnS » : null,
« ProgressPercent » : 100,
« QuizScorePercent » : 85,
« title » : « Exemple d'apprentissage Titre du chemin »,
« type » : « parcours d'apprentissage »,
« ContentType » : « null »
},...
],
« URL suivante » : "https://url-for-next-page-of-results"
}
Codes d'erreur spécifiques au terminal :
-
user_not_found- impossible de répertorier les favoris de l'utilisateur car l'utilisateur n'existe pas