Reach 360: API de favoritos

Artículo actualizado el

Este artículo se aplica a:

Qué hace este terminal de API

Con la API de favoritos, puede recuperar una lista de los cursos y rutas de aprendizaje que un usuario ha guardado en su lista de favoritos.

Puntos finales

  • GET /users/{userId}/favorites- enumere los cursos y las rutas de aprendizaje en los favoritos de un usuario

Listar los favoritos de un usuario

GET /users/{userId}/favorites

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«userURL»: "https://api.rise.com/users/example-user-id-1 «,
 «favorites»: [
{
«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»: true,
 «learnURL»:» https://example.reach360.com/learn/course/example-course-id «,
 «learningPathID»: null,
 «learningPathURL»: null,
 «numberOfCourses»: null,
 «numberOfLessons»: 5,
 «progressPercent»: 40,
 «quizScorePercent»: null,
 «title: «Ejemplo de título de curso»,
 «type»: «course»,
 «contentType»: «RISE»
},
 {
«completedAT»: «2020-11-17T 19:19:19 .019Z»,
 «courseId»: nulo,
 «courseURL»: nulo,
 «coverImageURL»:» https://images.riseusercontent.com/lp-cover-photos/example-learning-path-id/image-name.jpg «,
 «EstimatedTimeToCompleteMS»: «3600000",
 «hasCertificateDownload»: false,
 «learningURL»:» https://example.reach360.com/learning-path/example-learning-path-id «,
 «learningPathID»: «example-learning-path-id»,
 «learningPathURL»: «/learning-paths/example-learning-path-id»,
 «numberOfCourses»: 1,
 «numberOfLessons»: null,
 «ProgressPercent»: 100,
 «QuizScorePercent»: 85,
 «title»: «Ejemplo de aprendizaje Título de ruta»,
 «tipo»: «ruta de aprendizaje»,
 «contentType»: «null»
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints:

  • user_not_found- no puede enumerar los favoritos del usuario porque el usuario no existe