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.

Expandir
titleAPI Customizada

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>

Parâmetros:

  • Usuário/Senha TOTVS

Procedimentos para obtenção do Token

Expandir
titleCritérios de busca do Curso

Image Added

Image Added

Image Added

Expandir
titleBusca Currículo
HTML
<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarAluno</div>

API customizada buscaCurriculo realiza a busca do currículo dos Alunos.

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)

Tabelas Afetadas: SALUNO, PPESSOA, SALUNOCOMPL

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

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

  • Nome: Nome do Aluno no SGE (Campo Obrigatório);

  • EstadoNatal: Estado Natal do Aluno no SGE (Campo Obrigatório);

  • Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório);
  • DataNascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório);
  • Cpf: CPF do Aluno no SGE (Campo Obrigatório);
  • Cep: CEP do Aluno no SGE;
  • Rua: Rua do Aluno no SGE;
  • Numero: Número do Aluno no SGE;
  • Complemento: Complemento do Aluno no SGE;
  • Bairro: Nome do bairro do Aluno;
  • Estado: Sigla do Estado do Aluno;
  • Cidade: Nome da Cidade do Aluno;
  • Pais: Nome do País do Aluno;
  • Tel_Residencial: Telefone Residencial do Aluno no SGE;
  • Tel_Celular: Telefone Celular do Aluno no SGE;
  • Tel_3: Telefone 3 do Aluno no SGE;
  • Fax: Fax do Aluno no SGE;
  • SitOcupacional: Situação ocupacional do Aluno no SGE;

       Valores possíveis:
               1 = Empregado
               2 = Desempregado
               3 = Empregador
               4 = Autônomo/Conta Própria
               5 = Profissional Liberal
               6 = 1º Emprego
               7 = Aposentado
               8 = Microempreendedor Individual - MEI
               9 = Aprendiz com contrato   

  • TipoEscola: Tipo de escola de Origem do Aluno no SGE;

             Valores possíveis:
               1 = Particular
               2 = Pública - Municipal
               3 = Pública - Estadual
               4 = Pública - Federal
               9 = Não Declarado

  • CodColigada: Código da Coligada no SGE (Campo Obrigatório);
  • IdMatrizAplicada: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (Campo Obrigatório);
  • NomeMae:  Nome da mãe do aluno, que será gravado em campo complementar do cadastro do aluno (não obrigatório na API).
  • Email: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa.


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.