Projeto:FS008693 - Webservice Customizado de Consulta a Dados de Alunos
Nome do cliente: FIEP
Objetivo
Este manual visa demonstrar as funcionalidades do WebService customizado, para consulta de dados de alunos referente aos cursos realizados por eles no TOTVS Educacional (SGE).
Público Alvo
Este manual é destinado aos colaboradores selecionados como multiplicadores e usuários chave para o Programa SGE.
Expandir | ||
---|---|---|
| ||
Descrição do processo A API customizada é disponibiliza o histórico de cursos já realizados ou em andamento por alunos da FIEP registrados no TOTVS Educacional (SGE). Detalhamento do processo - Autenticação A autenticação nas API’s TOTVS será realizada através do seguinte API: Parâmetros
|
Expandir | ||
---|---|---|
| ||
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Descrição do processo API customizada buscaCurriculo realiza a busca do currículo dos Alunos. Serão listados todos os cursos realizados pelo aluno e seus respectivos status. Parâmetros
Exemplo: &$filter = CPF eq '0556987899' or RG eq 'MG1106897' A busca do histórico de cursos concluídos e em andamento será realizada pelos dados do aluno, individualmente. Os seguintes campos serão passados como parâmetro de entrada da API:
Autenticação A autenticação nas API’s TOTVS será realizada através do seguinte API: <div class="get">GET</div>
Parâmetros:
Authorization - Basic AuthUsername <username> Password <password> Retorno
Content
|
Expandir | ||
---|---|---|
| ||
Descrição do processo Através da busca pelos dados do aluno o WebService irá disponibilizar o histórico de cursos já realizados e/ou cursos que estejam em andamento. Esses dados serão consumidos por uma página Web desenvolvida pela FIEP, ou terceiros, com a finalidade de apoiar os alunos na identificação de vagas disponibilizadas no Linkedin que sejam compatíveis com sua área de formação/atuação. Detalhamento do processo O método “consultaVagas” consumido pelo CRM de consulta de vagas disponibiliza os dados de carga horária do período da turma. Ao ser consumida, a API disponibiliza o valor da carga horária dos períodos da turma com base nas disciplinas obrigatórias cadastradas para o período. |
HTML |
---|
<style>
.post {
background-color: #378000;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.get {
background-color: #004fd6;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.put {
background-color: #ffa200;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.delete {
background-color: #cf0000;
color: #ffffff;
display: inline-block;
padding: 5px;
border-radius: 5px;
font-weight: bold;
}
.endereco{
display: inline-block;
padding: 5px;
font-weight: bold;
}
</style>
<!--
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>
O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
--> |