Qué hace este punto final de API

Con la API de cursos, puede obtener una lista de todos los cursos enviados (publicados y no publicados) en su cuenta de Reach 360, así como los detalles de un solo curso.

• Puntos finales
• Objeto del curso
• Listar cursos
• Recuperar el curso por ID

Puntos finales

• GET /courses- enumerar 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 la hay)
• authorUrl(cadena): URL para obtener los detalles de usuario del autor desde la API
• courseReportUrl(string): URL para obtener el informe del curso desde la API
• url(string): 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)

Listar cursos

GET /courses

Parámetros de solicitud (cadena de consulta)

• limit(entero, opcional): el número máximo de resultados que se devolverán 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 son rise, 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»},
... 
 
 
], «nextUrl»: "https://url-for-next-page-of-results"} 
 

Recuperar el 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 Endpoint

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