Browse Articles

Browse Articles

API Reach 360: Rutas de aprendizaje

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este terminal de API

Con la API de rutas de aprendizaje, puede obtener una lista de todas las rutas de aprendizaje de Reach 360, así como los detalles de una única ruta de aprendizaje y los cursos que componen una ruta de aprendizaje.

Puntos finales

  • GET /learning-paths- enumerar las rutas de aprendizaje
  • GET /learning-paths/{learningPathId}- obtener detalles de una ruta de aprendizaje mediante el identificador de la ruta de aprendizaje
  • GET /learning-paths/{learningPathId}/courses- enumere los cursos de una ruta de aprendizaje por identificador de ruta de aprendizaje

Objeto Learning Path

  • id(cadena): el identificador único de la ruta de aprendizaje
  • title(cadena): título de la ruta de aprendizaje
  • description(cadena): descripción de la ruta de aprendizaje
  • coverImageUrl(cadena): URL de la imagen de portada de la ruta de aprendizaje (si existe)
  • coursesUrl(cadena): URL para obtener la lista de cursos de la ruta de aprendizaje desde la API
  • coursesReportUrl(cadena): URL para obtener el informe de los cursos sobre la ruta de aprendizaje desde la API
  • learnersReportUrl(cadena): URL para obtener la ruta de aprendizaje que los alumnos informan desde la API
  • url(cadena): URL para obtener los detalles de la ruta de aprendizaje de la API

Objeto del curso Learning Path

  • id(cadena): el identificador único del curso
  • title(cadena): título del curso
  • coverImageUrl(cadena): URL de la imagen de portada del curso (si existe)
  • authorUrl(cadena): URL para obtener los detalles del usuario del autor de la API
  • courseReportUrl(cadena): URL para obtener el informe del curso desde la API
  • url(cadena): URL para obtener los detalles del curso desde la API
  • order(entero): orden de un curso en una ruta de aprendizaje (la numeración comienza en 0)
  • contentType(cadena): tipo de curso (puede ser uno de los siguientes: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Enumere las rutas de aprendizaje

GET /learning-paths

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

{
«learningPaths»: [
{
«id»: «example-learning-path-1",
 «title»: «Título de la ruta de aprendizaje»,
 «description»: «Una ruta de aprendizaje sencilla»,
 «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 de texto»: "https://url-for-next-page-of-results"
}

Recuperar la ruta de aprendizaje por ID

GET /learning-paths/{learningPathId}

Ejemplo de respuesta

{
«id»: «example-learning-path»,
 «title»: «Título de la ruta de aprendizaje»,
 «description»: «Una ruta de aprendizaje sencilla»,
 «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"
}

Códigos de error específicos de endpoints

  • learning_path_not_found- no puede recuperar la ruta de aprendizaje porque la ruta de aprendizaje no existe

Listar cursos en Learning Path

GET /learning-paths/{learningPathId}/courses

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

{
«learningPathURL»: "https://api.reach360.com/learning-paths/example-learning-path-id-1 «,
 «courses»: [
{
«id»: «example-course-id-1",
 «title»: «Título del curso»,
 «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»: 3
 «contentType»: «RISE»
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints

  • learning_path_not_found- no puede enumerar los cursos porque la ruta de aprendizaje no existe