O que esse endpoint de API faz

Com a API de cursos, você pode obter uma lista de todos os cursos enviados (publicados e não publicados) em sua conta do Reach 360, bem como os detalhes de um único curso.

• Endpoints
• Objeto do curso
• Listar cursos
• Recuperar curso por ID

Endpoints

• GET /courses- listar cursos
• GET /courses/{courseId}- obter detalhes de um curso por ID do curso

Objeto do curso

• id(string) - o identificador exclusivo do curso
• title(string) - título do curso
• coverImageUrl(string) - URL da imagem da capa do curso (se houver)
• authorUrl(string) - URL para buscar os detalhes do usuário do autor na API
• courseReportUrl(string) - URL para buscar o relatório do curso na API
• url(string) - URL para buscar detalhes do curso na API
• contentType(string) - tipo de curso (pode ser um dos seguintes: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Listar cursos

GET /courses

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)
• contentType(string, opcional) - Filtre a resposta para um tipo de conteúdo específico. As opções disponíveis são rise, storyline, microlearning, imported, all

Exemplo de resposta

{
“courses”: [
{
“id”: “example-course-id-1", “title”: 
 “Título do 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 curso por ID

GET /courses/{courseId}

Exemplo de resposta

{
“id”: “example-course-id”, 
 “title”: “Título do 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 erro específicos do endpoint

• course_not_found- não é possível recuperar o curso porque o curso não existe