Browse Articles

Browse Articles

Reach 360: API de cursos

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este terminal de API

Con la API de cursos, puedes obtener una lista de todos los cursos enviados (publicados e inéditos) en tu cuenta de Reach 360, así como los detalles de un solo curso.

Puntos finales

  • GET /courses- lista de cursos
  • GET /courses/{courseId}- obtener detalles de un curso por identificador de curso

Objeto del curso

  • 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
  • contentType(cadena): tipo de curso (puede ser uno de los siguientes: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Lista de cursos

GET /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)
  • contentType(cadena, opcional): filtra la respuesta a un tipo de contenido específico. Las opciones disponibles sonrise, storyline, microlearning, imported, all

Ejemplo de respuesta

{
«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"
 «contentType»: «RISE»
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Recuperar curso por ID

GET /courses/{courseId}

Ejemplo de respuesta

{
«id»: «example-course-id»,
 «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 «,
 «url»: "https://api.reach360.com/courses/example-course-id"
 «contentType»: «RISE»
}

Códigos de error específicos de endpoints

  • course_not_found- no se puede recuperar el curso porque el curso no existe