Páginas filhas
  • Manual Operacional - WebService - Consulta Dados Aluno (Emprega SENAI)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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.


Parâmetros:

  • Usuário/Senha TOTVS

Procedimentos para obtenção do Token

Expandir
titleAPI Customizada
HTML
<div class="get">GET</div>
<div class="endereco">/api/connect/token</div>

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:

html

<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/AtualizarServicoCRM</div>
Expandir
titleCritérios de busca do Curso

Expandir
titleBusca Currículo

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.

HTML
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarAluno</div>

Parâmetros

  • Filter na URL: CODCOLIGADA (OBRIGATÓRIO), CPF , RG , PASSAPORTE, RNE,RNM

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:

  • Cod. Coligada- Obrigatório
  • CPF
  • Carteira de Identidade
  • Número do Passaporte
  • RNE (Registro Nacional de Estrangeiro)
  • RNM (Registro Nacional de Migração)


Informações
titleImportante

Serão enviados os códigos dos registros conforme cadastrado no SGE. Não serão realizados DE/PARA de campos, como por exemplo: Cor/Raca, Estado Civil, Grau Instrução, Código de Curso, Código de disciplinas, códigode período letivo.

Authorization - Basic Auth

Username <username>

Password <password>

Retorno

Bloco de código
languagec#
titleRaw
{
	"dadosPessoais": {
	"nome": "Lionel Andres Messi",
	"nomesocial": "Messi",
	"estadonatal": "Santa Fe",
	"naturalidade": "Argentina"
	"grauInstrucao": "6"
	"corraca": "2"
	"estadocivil": "S"
	“XXXXXXX": "YYYYYYY"
	“XXXXXXX": "YYYYYYY"
	“XXXXXXX":"YYYYYYY"
},
	"passaporte": {
	"datachegadabrasil": "2022-06-08T14:23:31.987Z",
	"tipovisto": "12345",
	"cartamodelo19": {}
},
	"documentos": {
	"CPF": "04368427678",
	"RG": "MG1289789"
},
	"endereco": {
	"CEP": "31165789",
	"logradouro": "Avenida Afonso Penas",
	"Numero": "10",
	"complemento": "Ap.502",
	"Bairro": "Funcionários",
	"tipoBairro": "1",
	"cidade": "Belo Horizonte",
	"estado": "MG",
	"pais": "Brasil",
	"telefonecelular": "319898989"
},
	"deficiencia": {
	"auditiva": "1",
	"fisica": "0",
	"fala": "0",
	"mental": "0",
	"reabilitado": "0",
	"intelectual": "0",
	"visual": "0"
},
	"curriculo": {
	"codcoligada": "1",
	"codcurso": "34",
	"nomecurso": "Sustentabilidade Social CH 8",
	"status": "Concluído"
	"disciplinas": 
	[
	{
		"coddisc": "APB.020.0087",
		"nomedisc": "Metodologia",
	},
	{
		"coddisc": "137",
		"nomedisc": "Prática de Formação (Est.Supe.)",
	}
]

Content

  • Dados Pessoais:
    • Nome
    • Nome Social
    • Estado Natal
    • Naturalidade
    • Data Nascimento
    • Sexo
    • Estado Civil
    • Cor/Raça
    • E-mail
    • Grau de Instrução
    • Nacionalidade
  • Passaporte
    • Numero Passaporte
    • Data chegada ao brasil
    • tipo de visto
    • Carta Mod 19
    • Nº Filhos no brasil
    • RNM
    • Decreto Imigração
    • UF emissor
    • Data Emissão RNM
    • Data Vencimento RNM
    • Data Vencimento CTPS
  • Documentos
    • CPF
    • RG
  • Endereço
    • CEP
    • Tipo Rua
    • Logradouro
    • Número
    • Complemento
    • Tipo Bairro
    • Bairro
    • Estado
    • Cidade
    • Pais
    • Telefone Celular
  • Deficiência
    • Física
    • Auditiva
    • Fala
    • Mental
    • Reabilitado
    • Intelectual
    • Visual
  • Currículo
    • Codcurso
    • Nome Curso
    • Cod Disciplina
    • Nome Disciplina
    • Área
    • Eixo Tecnológico
    • Status 
    • Cod Período Letivo
    • Descrição Período Letivo


Expandir
titleWeb Service de Consulta de Dados da Turma

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>
-->