Disponibilizamos um novo endpoint na API do LMS que centraliza as informações de treinamentos online e presenciais de todos os colaboradores em um único ponto de consumo.
Os dados são padronizados e atualizados no modelo D-1 (dia anterior), prontos para integração com ferramentas de BI.
Método GET:
/api/conteudos/ObterCursosBIComo acessar e testar via Swagger
O Swagger é a interface de documentação interativa da API, onde é possível visualizar os campos de retorno e realizar chamadas de teste diretamente pelo navegador, sem necessidade de ferramentas externas.
- URL de acesso ao Swagger:
{URL base do cliente}/webapi/Swagger/ui/index
Substitua {URL base do cliente} pelo endereço da plataforma LMS do seu ambiente. A URL base é a mesma usada para acessar o sistema normalmente.
- URL base
https://suaempresa.lgsistemas.com.br - Swagger →
https://suaempresa.lgsistemas.com.br/webapi/Swagger/ui/index - Endpoint BI →
https://suaempresa.lgsistemas.com.br/api/conteudos/ObterCursosBI
No Swagger, localize o endpoint ObterCursosBI, clique em "Try it out!" e preencha o parâmetro dias se desejar sobrescrever o período padrão.
Parâmetro de requisição
- Tipo: integer | Onde: query string | Obrigatório: não
- Define a janela de dias a considerar para data de inscrição e data de conclusão. Se não informado, o comportamento padrão é últimos 10 dias.
- Exemplo:
?dias=30retorna dados dos últimos 30 dias.
Campos retornados
Cada item do array representa a relação de um colaborador com um curso específico:
| Campo | Descrição | Valores possíveis |
|---|---|---|
| Nome | Nome do colaborador | — |
| StatusUsuario | Situação do colaborador na plataforma | Ativo, Inativo |
| Empresa | Empresa do colaborador | — |
| EmpresaUnidade | Unidade da empresa | — |
| Departamento | Departamento do colaborador | — |
| Cargo | Cargo do colaborador | — |
| DataAdmissao | Data de admissão | — |
| IdCurso | Identificador numérico do curso | Inteiro |
| Titulo | Nome do curso | — |
| CargaHoraria | Duração do curso em horas | Ex: 8.00 |
| TipoCurso | Modalidade do treinamento | Presencial e CursoOnline |
| StatusCurso | Status do colaborador no curso | Concluído, Em Andamento, Inscrito, Não Inscrito e Expirado |
| Certificado | Situação do certificado | Ativo, Expirado, Não Inscrito e Sem Certificado |
| Obrigatorio | Indica se o curso é obrigatório para o colaborador | true, false |
Regras de negócio
1. Cursos com matrícula: a API retorna todos os cursos nos quais o colaborador possui vínculo de matrícula, independentemente do status atual.
2. Obrigatoriedade tem precedência: cursos obrigatórios aparecem mesmo sem matrícula, com StatusCurso = Não Inscrito e Obrigatorio = true.
3. Filtro de período padrão — 10 dias: aplicado tanto à data de inscrição quanto à data de conclusão. Pode ser sobrescrito informando o parâmetro dias na requisição.
4. Cursos obrigatórios sem matrícula ignoram o filtro de período: são sempre retornados, independentemente da janela de dias configurada.
Atenção
A API não armazena histórico interno de entregas. O LMS não controla quais registros já foram retornados anteriormente. O controle da janela de dias fica sob responsabilidade do cliente, que deve ajustá-la conforme a rotina de atualização do BI.
Comentários
0 comentário
Por favor, entre para comentar.