O que esse endpoint de API faz

Com a API Learning Paths, você pode obter uma lista de todos os caminhos de aprendizado no Reach 360, bem como os detalhes de um único plano de aprendizado e os cursos que compõem um plano de aprendizado.

• Endpoints
• Objeto do caminho de aprendizagem
• Caminho de aprendizagem Objeto do curso
• Listar caminhos de aprendizagem
• Recupere o caminho de aprendizado por ID
• Listar cursos no Learning Path

Endpoints

• GET /learning-paths- listar caminhos de aprendizagem
• GET /learning-paths/{learningPathId}- obtenha detalhes de um plano de aprendizado por meio do id do caminho de aprendizado
• GET /learning-paths/{learningPathId}/courses- listar cursos em um plano de aprendizado por ID do caminho de aprendizado

Objeto do caminho de aprendizagem

• id(string) - o identificador exclusivo do plano de aprendizado
• title(string) - título do plano de aprendizagem
• description(string) - descrição do caminho de aprendizagem
• coverImageUrl(string) - URL da imagem da capa do plano de aprendizagem (se houver)
• coursesUrl(string) - URL para buscar a lista de cursos no caminho de aprendizado a partir da API
• coursesReportUrl(string) - URL para obter o relatório dos cursos do plano de aprendizagem da API
• learnersReportUrl(string) - URL para buscar o relatório dos alunos do plano de aprendizagem da API
• url(string) - URL para buscar os detalhes do caminho de aprendizado na API

Caminho de aprendizagem 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
• order(inteiro) - ordem de um curso em um plano de aprendizado (a numeração começa em 0)
• contentType(string) - tipo de curso (pode ser um dos seguintes: MICROLEARNING, STORYLINE, IMPORTED, RISE)

Listar caminhos de aprendizagem

GET /learning-paths

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)

Exemplo de resposta

{
“learningPaths”: [
{
“id”: “example-learning-path-1", “title”: “Learning Path Title”, 
 “description”: “Um caminho de aprendizado simples”, 
 “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 "
},... 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 
 

Recupere o caminho de aprendizado por ID

GET /learning-paths/{learningPathId}

Exemplo de resposta

{
“id”: “example-learning-path”, 
 “title”: “Título do plano de aprendizagem”, “description”: 
 “Um caminho de aprendizado simples”, “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 erro específicos do endpoint

• learning_path_not_found- não é possível recuperar o caminho de aprendizado porque o caminho de aprendizado não existe

Listar cursos no Learning Path

GET /learning-paths/{learningPathId}/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)

Exemplo de resposta

{
“learningPathURL”: "https://api.reach360.com/learning-paths/example-learning-path-id-1 “, “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" 
 “order”: 3 “contentType”: “RISE”},
... 
 
 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Códigos de erro específicos do endpoint

• learning_path_not_found- não é possível listar cursos porque o plano de aprendizado não existe