Páginas filhas
  • Manual Operacional da customização - Versão 2.0

Versões comparadas

Chave

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

...

Expandir
titleDados técnicos
Expandir
titleIntegração Pré cadastro de AlunoPessoa
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarAluno</div>

Realiza a gravação do aluno no SGE, conforme dados enviados pela API.

Importante: Caso o CPF enviado já exista no SGE, a API identifica a pessoa e o RA, e atualiza o cadastro com os dados enviados.

Tabelas Afetadas: SALUNO, PPESSOA, SALUNOCOMPL

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

Authorization - Basic Auth

Username <username>

Deverá ser utilizado antes do envio de uma pessoa (Aluno/Responsável/Docente/Funcionários) para o Portal SESI na intenção de identificar se reaproveita algum cadastro existente ou cria o pré-cadastro retornando o iduser correspondente.

Tabelas Afetadas: PPESSOA

Authorization - Basic Auth

Username <username>

Token <token>Password <password>

Body

Bloco de código
languagec#
titleRaw
{
  		"Nomeidred": "Teste Api 2 "7,
  		"EstadoNatalregional": "MGAC",
  		"NaturalidadecodigoExterno": "Belo Horizonte"1234567,
  		"DataNascimentocpf": "05/07/1978862.873.376-05",
  		"Cpfnome": "85763425022",
Adriano Duarte "Cep": "38700412"Cardoso",
  		"RuanomeSocial": "Pascoal Soares",
  "Numero": 10,
  "Complemento		"email": "102[email protected]",
  		"BairrodataNascimento": "Savassi22-04-2000",
  		"Estadonaturalidade": "SP"4110706,
  		"CidadenomeDaMae": "SãoIvone Duarte PauloCardoso"
	},
  "Pais"MensagemPSESI: "Brasil",
  "Tel_Residencial": "3333333333333",
  "Tel_Celular": "2312321312",
  "Tel_3": "13123132313",
  "Fax": "312321313131",
  "SitOcupacional": 1,
  "TipoEscola": 3,
  "CodColigada": 3,
  "IdMatrizAplicada": 4,
  "Email": "[email protected]",
  "NomeMae": "Nome da mãe do Aluno"
}

Content

{
		codigo (int, obrigatório),
		descricao (string, obrigatório)
}
RetornoPessoa: {
		iduser (int, obrigatório)
}

Content

  • Idred: Identificador enviado de forma fixa o valor ‘7’.
  • Regional: Estado do cadastro da Coligada.
  • Código Externo: Código da Pessoa.
  • CPF: CPF da pessoa no SGE 
  • Nome: Nome da pessoa Nome: Nome do Aluno no SGE (Campo Obrigatório);EstadoNatal: Estado Natal do Aluno no SGE .

  • Nome social: Nome social da pessoa.
  • E-mail: Endereço de e-mail, que será gravado no campo do cadastro da Pessoa. (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.

Retorno

Bloco de código
languagec#
titleConsole
{
   "Message": "Aluno: 205, existente em base, atualizado com Sucesso!\r\n",
   "Status": "Sucesso",
   "StatusCode": 200
}

Content

Quando Aluno: Caso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado.

Quando Responsável: E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Responsável é enviado. 

Quando Professor: Caso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado. 

Quando Funcionário: E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Funcionário é enviado. 

  • Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
  • Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
  • Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).

Retorno

Usuário Criado com Sucesso: HTTP Code 201 - Body:  RetornoPessoa

Campo de Dados

Tipo

Obrig

Descrição

Schema

idUser

Body | Json

Sim

Identificador do usuário

Int32


Usuário Atualizado com Sucesso: HTTP Code 200 - Body:  RetornoPessoa

Campo de Dados

Tipo

Obrig

Descrição

Schema

idUser

Body | Json

Sim

Identificador do usuário

Int32


Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Erro geral: HTTP Code 50x - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Importante: Caso já tenhamos o idUser para o Cadastro de Pessoa utilizaremos o que já tivermos gravado e não chamaremos a API de Pré-Cadastro da Pessoa.

Expandir
titleIntegração de Aluno / responsável
HTML
<div class="post">POST</div>

Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do aluno informando o correspondente a pessoa do aluno e o correspondente ao Responsável, os quais serão enviados todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de aluno.

Tabelas Afetadas: SALUNO, PPESSOA

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

Authorization - Basic Auth

Username <username>

Token <token>

Body

Bloco de código
languagec#
titleRaw
{
		"iduser": 9999999,
		"idred": 7,
		"regional": "MG",
		"codigoExterno": 7654321,
		"dadosCadastrais": {
			"nome": "Rafaela Ribeiro Bravo",
			"nomeSocial": "",
			"email": "[email protected]",
			"codigoExterno": 7654321,
			"codUsuario": "14139508922",
			"cpf": "141.395.089-22",
			"senha": "MDQxMTE5zY=",
			"emailcomplementar": null,
			"sexo": "feminino",
			"dataNascimento": "05-11-2010",
			"idRaca": "2",
			"raca": "Branca",
			"naturalidade": 4124103,
			"nomeDaMae": "Wanda Ribeiro Bravo"
		},
		responsavel: {
  		"iduser": 8888888,
  		"nome": "Wanda Ribeiro Bravo",
		"nomeSocial": "",
  		"cpf": "187.685.859-18",
  		"codUsuario": "18768585918",
  		"email": "[email protected]",
 		"sexo": "feminino",
  		"codigoExterno": 7654321,
 		"senha": "MDQxMTE5zY=",
  		"dataNascimento": "05-11-1970",
		"idRaca": "2",
		"raca": "Branca",
		"naturalidade": 4124103,
		"nomeDaMae": "Sônia Maria Bravo"
	}
}

Content

  • Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
  • Idred: Identificador enviado de forma fixa o valor ‘7’.
  • Regional: Estado do cadastro da Coligada.
  • Código Externo: Código da Pessoa.
  • Nome: Nome do Aluno no SGE (Campo Obrigatório).

  • Nome social: Nome social do cadastro
  • E-mail: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório);
  • Código do usuário: Código do usuário no SGE.
  • CPF: CPF do Aluno no SGE 
  • Senha: Senha do usuário no SGE
  • E-mail complementar: Caso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como e-mail complementar, do contrário nenhum e-mail é enviado como complementar.
  • Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
  • Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
  • Raça: Identificador da raça
  • Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
  • Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).
  • Email: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa.

Retorno

Aluno Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador da mensagem

Int32

descricao

Body | Json

Sim

Descrição da mensagem

String


Aluno Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador da mensagem

Int32

descricao

Body | Json

Sim

Descrição da mensagem

String


Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Erro geral: HTTP Code 50x - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Importante: Caso já tenhamos enviado com o Aluno com Sucesso, será utilizado o serviço de Atualização do Aluno.


Expandir
titleAtualização do aluno
HTML
<div class="put">PUT</div>

Body

Bloco de código
languagec#
titleRaw
{
		"iduser": 9999999,
		"idred": 7,
		"regional": "MG",
		"codigoExterno": 7654321,
		"dadosCadastrais": {
			"nome": "Rafaela Ribeiro Bravo",
			"nomeSocial": "RAFAEL",
			"email": "[email protected]",
			"codigoExterno": 7654321,
			"codUsuario": "14139508922",
			"cpf": "141.395.089-22",
			"senha": "MDQxMTE5zY=",
			"emailcomplementar": null,
			"sexo": "feminino",
			"dataNascimento": "05-11-2010",
			"idRaca": "2",
			"raca": "Branca",
			"naturalidade": 4124103,
			"nomeDaMae": "Wanda Ribeiro Bravo"
		},
		responsavel: {
  		"iduser": 8888888,
  		"nome": "Wanda Ribeiro Bravo",
		"nomeSocial": "",
  		"cpf": "187.685.859-18",
  		"codUsuario": "18768585918",
  		"email": "[email protected]",
 		"sexo": "feminino",
  		"codigoExterno": 7654321,
 		"senha": "MDQxMTE5zY=",
  		"dataNascimento": "05-11-1970",
		"idRaca": "2",
		"raca": "Branca",
		"naturalidade": 4124103,
		"nomeDaMae": "Sônia Maria Bravo"
	}
}
Expandir
titleDocente
HTML
<div class="post">POST</div>

Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do docente informando o correspondente a pessoa do docente, o qual será enviado todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de docente.

Tabelas Afetadas: SALUNO, PPESSOA

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

Authorization - Basic Auth

Username <username>

Token <token>

Body

Bloco de código
languagec#
titleRaw
{
		"iduser": 10012345,
		"idred": 7,
		"regional": "MG",
		"statusgeral": 1,
		"codigoExterno": 1919191,
		"escolas": [
			{
				"codigoIntegrador": "1234567",
				"ativo": 1
			}
		],
		"dadosCadastrais": {
			"nome": "Tiago Silva Salles",
			"nomeSocial": "",
			"email": "[email protected]",
			"codigoExterno": 1919191,
			"codUsuario": "36718678171",
			"cpf": "367.186.781-71",
			"senha": "MTIzNffNzg=",
			"emailcomplementar": null,
			"sexo": "masculino",
			"dataNascimento": "01-10-1978",
			"idRaca": "10",
			"raca": "Não declarado",
			"naturalidade": 4124400,
			"nomeDaMae": ""
		}
  

Content

  • Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
  • Idred: Identificador enviado de forma fixa o valor ‘7’.
  • Regional: Estado do cadastro da Coligada.
  • Código integrador: Cadastro de Filial (DFILIAL.CAMPOLIVRE1)
  • Ativo: Correspondente ao status do usuario no SGE (Verificamos o GUSUARIO.STATUS para definição de Ativo (1) e Inativo(0).
  • Código Externo: Código da Pessoa.
  • Nome: Nome do professor no SGE (Campo Obrigatório).

  • Nome social: Nome social do cadastro
  • E-mail: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório). Caso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado.
  • Código do usuário: Código do usuário no SGE.
  • CPF: CPF do professor no SGE 
  • Senha: Senha do usuário no SGE
  • E-mail complementar: Caso o email O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado como email complementar, do contrário nenhum email é enviado como complementar.
  • Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
  • Data de Nascimento: Data de Nascimento do professor no SGE (Campo Obrigatório).
  • Raça: Identificador da raça
  • Naturalidade: Naturalidade do professor no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
  • Nome da Mae:  Nome da mãe do professor. ( Obrigatório caso não possua CPF informado).
  • Email: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa.

Retorno

Docente Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador da mensagem

Int32

descricao

Body | Json

Sim

Descrição da mensagem

String


Docente Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador da mensagem

Int32

descricao

Body | Json

Sim

Descrição da mensagem

String


Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Regra não atendida: HTTP Code 403 - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Erro geral: HTTP Code 50x - Body: MensagemPSESI

Campo de Dados

Tipo

Obrig

Descrição

Schema

codigo

Body | Json

Sim

Identificador do erro

Int32

descricao

Body | Json

Sim

Descrição do Erro

string


Importante: Caso já tenhamos enviado com o Docente com Sucesso, será utilizado o serviço de Atualização do Docente.

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • StatusCode: Código de status do processamento da requisição;

    HTML
    <style>
    	.expand-control {
        	cursor: pointer;
        	text-decoration: none;
    	    margin-bottom: 10px;
    	    background-color: #ededed;
    	    height: 30px;
    	    font-size: 20px;
    	    padding: 5px;
    	}
    	.expand-control-text {
        	vertical-align: top;
    	    font-weight: bold;
    		color: #242424;
    	}
    	.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>
    -->