Manual Operacional da customização - Integração

...

Portal SESI

...

Objetivo

Este documento foi elaborado para informar aos usuários chave da área Educacional do SESI, sobre a Integração SGE x Portal SESI . A integração com o TOTVS Educacional Portal SESI é responsável pela exportação dos registrossincronização de algumas entidades, facilitando assim a gestão e acesso aos participantes (alunos, professores, funcionários)..

Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários chave do SESI.

...

Este material tem como base a visão prática e completa do Processo Customizado processo customizado da área Educacional através da Integração Portal SESI.

...

Expandir

title	Parâmetros da Integração

Table Excerpt

name	ParametrosIntegracao

Table Excerpt

name	ParametrosIntegracaoIntro

Além das premissas técnicas, é essencial realizar algumas configurações para garantir o sucesso da integração:

Acesse os Parâmetros através do seguinte caminho:

TOTVS Educacional > Sistema Indústria >Portal SESI> Parâmetros

A interface exibirá sete abas para serem configurados: Identificação, Reconhecimento de Saberes, Cursos (segmentos), Situações de matrícula, Validação de e-mail, Funcionários e Autenticação SSO.

Deck of Cards

history	false
id	Params

Card

label	Identificação

Table Excerpt

name	parametrosidentificacao

Nesta aba, são configurados os campos básicos para o funcionamento da integração.

Habilita Integração Portal SESI Educação - O processo de integração pode estar agendado, mas a integração apenas irá ocorrer se este parâmetro estiver marcado. Tal parâmetro é valido para os registros de Alunos, Responsáveis Acadêmico, Professores, Diretor(es), Secretário(s), Coordenador(es) e Orientador Pedagógico para que seja realizada a integração de usuários para o Portal SESI Educação.
Dados da Integração:
- Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
- Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
- Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.
Classificação de Municípios (IBGE): Campo com lista de classificação de municípios (DCLASSIFMUNICIPIO), para o usuário selecionar em qual classificação de Município corresponde a do IBGE.
Dias para envio de turma finalizada: Neste campo o usuário deverá informará a quantidade de dias (em números) em que uma turma já finalizada será considerada na exportação.

Card

label	Reconhecimento de Saberes

Table Excerpt

name	parametrosrecsabes

Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes.

Token para WS: Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE

Gerando...

Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação.

É importante utilizar um usuário exclusivo.

Os demais campos, são para configurar os status e motivos de alteração para indicar quando a situação do aluno for:

Reconhecimento de Saberes: Utilizado para identificar as disciplinas em Reconhecimento de Saberes, que precisam ser reconhecidas pelo Portal SESI Educação.

Competências reconhecidas: Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência Reconhecida automaticamente pelo processo.

Competências não reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes
Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência não Reconhecida automaticamente pelo processo.

Matricula no período letivo: Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.

Card

label	Cursos (Segmentos)

Table Excerpt

name	parametroscursos

Nesta aba deverá ser informado/cadastrado os cursos do SGE – Módulo Educacional (segmentos de ensino da Educação Básica indicadas no Portal SESI Educação (Educar Brasil)) para os quais somente alunos e professores/disciplinas de tais cursos serão integrados.

Junto a informação de cada curso deverá ser sinalizado se o e-mail do aluno (matriculado em tal curso) deverá ser obrigatório e também se alunos menores de 18 (dezoito) anos (matriculado em tal curso) deverão ter um responsável acadêmico informado.

Cursos (Segmentos).gif

Card

label	Situações de Matrícula

Table Excerpt

name	parametrossitmatric

Para integração dos alunos no Portal SESI, o status do aluno é definido de acordo com sua Situação de Matrícula no SGE.

Nesta aba o usuário deverá informar as situações de matricula no SGE, que o Portal SESI deve considerar como: Pré matriculado, Matriculado ou Inativo.

Ao incluir um novo registro será apresentado 3 campos para preenchimento:

Sit. Matricula: Lista das as situações de matrículas existentes na base.

Status Indica: Status no Portal SESI, da situação de matricula selecionada. Podendo ser Pré matriculado, Matriculado ou Inativo.

Não enviar ao Portal SESI: Se o checkbox "Não enviar ao Portal SESI" estiver marcado as matrículas com tal situação serão desprezadas para a integração.

Estado

colour	Green
title	Exemplo:

Se a Escola considerar que a situação de matricula "cancelado" do SGE deve ser enviada ao Portal SESI como Inativo, o preenchimento será da seguinte:

Se em determinado momento a Escola determinar que essa situação de matrícula não deve ser considerada na Exportação ao Portal SESI é necessário marcar o checkbox:

Aviso

Se o usuário do aluno estiver Ativo, o processo customizado de exportação ao Porlta SESI busca a informação parametrizada nessa aba, para fazer a relação da situação de matricula do Aluno com status indica, identifcado se será ou não exportado.

Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Inativo.

Card

label	Validação de e-mail

Table Excerpt

name	parametrosvalidaemail

Essa aba refere-se a configurações para utilização de Consulta/validação de email pela Quickemail.

Os campos apresentados são:

URL API: Endereço de acesso à API para consulta de e-mail, disponibilizado pela Educar Brasil;

TOKEN: Token de acesso à API para consulta de e-mail, disponibilizado pela Educar Brasil.

Intervalo de horas: Este campo será considerado para validar novamente o e-mail na QuickeMail (somente daqueles que não tenham sido considerados "válidos") respeitando o intervalo de horas definido no parâmetro.

Card

label	Funcionários

Table Excerpt

name	parametrosfuncionarios

Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário.

Este cadastro deve ser utilizado para informar o perfil de cada Funcionário, que poderá ser:

Funcionário Administrativo (Perfil padrão do Portal SESI)
Funcionário Pedagógico e
Administrador de Unidade

Neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:

Código da filial/escola: utilizado para identificar para qual filial se destina o funcionário que terá um perfil diferenciado do padrão. Um funcionário pode estar em mais de uma filial e com perfis diferentes;
Código da Pessoa: mostrando apenas os funcionários a serem levados ao Portal SESI para filial selecionada no campo 1 que ainda não foram parametrizados, deve ser selecionado o funcionário ao qual se quer atribuir um perfil diferenciado para a filial selecionada;
Perfil no Portal SESI Educação: utilizado para identificar qual perfil enviar ao Portal SESI, combo que permite selecionar entre os perfis: Funcionário Administrativo, Funcionário Pedagógico e Administrador de Unidade.

Aviso
Somente os funcionários cuja o perfil padrão (Funcionário Administrativo) não atenda as necessidades da Unidade que devem ser parametrizados neste cadastro.

Card

label	Autenticação SSO

Table Excerpt

name	parametrossso

Aba destinada à configuração de logins via SSO (Single Sign-On).

Os campos são preenchidos automaticamente após a Importação do Arquivo (config_sesi.json) que é fornecido pelo Portal SESI

Abaixo descrição dos campos para conhecimento:

Endereço WebService: Endereço de acesso ao webservice disponibilizado pelo Portal SESI.
Public Key: chave pública para descriptografar o token JWT.
Client ID: usuáriode acesso ao webservice disponibilizado pelo Portal SESI.
Secret Key: Senhade acesso ao webservice disponibilizado pelo Portal SESI.
Importar arquivo (config_sesi.json): Botão para importação das configurações via arquivo JSON*.

*Arquivo disponibilizado pelo Portal SESI.

Aviso
Esse parâmetro deve ser preenchido exclusivamente via importação do arquivo. Qualquer manipulação manual dos campos, resultará em falhas da funcionalidade.

Expandir

title	DE I PARA

O SGE possui valores para as suas tabelas, campos, cadastros, tipos que divergem com os valores atuais cadastrados no Portal SESI Educação. Além das parametrizações descritas acima, é

Para a integração é necessário ter valores equivalentes aos do Portal SESI Educação, antes de acionar o serviço que efetiva a integração.
A funcionalidade 'Cadastro de DE/PARA' foi disponibilizada para criar esse relacionamento e equivalência entre os sistemas.

O Cadastro está disponível no Menu: TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração

A tela de cadastro do DE I PARA é composta por 4 campos que devem ser preenchidos seguindo a ordem:

1- Entidade (Cadastro): Lista com 6 entidades que devem ter equivalências com o Portal SESI informada. Sendo elas:

- Curso/segmento,
- Disciplina
- Habilitação/Serie
- Área - Grupo de complemento
- Área Itinerário
- Itinerário

2- Curso: Lista com todos os cursos cadastrados na base.

Informações
O campo Curso, ficará desabilitado caso tenha selecionado as seguintes entidades: Cursos/Segmentos ou Área itinerário.

3- Valor no TOTVS Educacional: Lista da Entidade e Curso selecionado anteriormente. (No exemplo acima, foi selecionado a Entidade: Disciplina e o Curso: EF II, neste caso o valor no TOTVS Educacional trará todas as disciplinas do EF II).

4- Valor no Portal SESI Educação: Onde deve ser informado o código equivalente no Portal SESI Educação (validar com responsável pelo portal).

Aviso
O Portal SESI Educação disponibiliza uma documentação Online para facilitar a identificação das Entidades a serem parametrizadas no De/Para. Para acessar, entre em contato com o SESI DN.

...

Expandir

title	Oficinas - SESI Paraná

Expandir

title	Exportação de Dados - Oficinas

Acesse o menu: TOTVS Educacional | Sistema Indústria | Integrações | Integração Portal SESI. Dentro da opção, selecione o processo de Exportação de Dados do Portal SESI.

O processo de Exportação de Dados do Portal SESI será modificado para incluir o envio das informações das Oficinas da Regional Paraná. Será adicionado um novo checkbox chamado "Oficinas" na interface, permitindo que o usuário marque quando desejar enviar esses dados.

Este processo poderá ser executado manualmente pelo usuário, ou agendado.

Ao executar o processo a customização irá considerar para envio as seguintes regras:

Para que a Oficina seja enviada para o Portal SESI, é necessário que haja pelo menos um aluno matriculado nela e que sua data final + o número de “Dias para envio da Turma/Oficina Finalizada” (parâmetro) seja maior que a data corrente. Neste momento, serão enviados os dados da Oficina e seus respectivos professores: responsáveis e associados à Oficina.
O envio contempla apenas professores que já estão previamente integrados ao Portal SESI, devendo ter sido integrados por meio do processo atual.
Serão enviadas apenas Oficinas do Tipo Formação Geral Básica (Ensino Médio)e Interseriado (Ensino Fundamental), definido no cadastro da oficina.

Será utilizado o parâmetro “Dias para envio da Turma Finalizada”, que terá seu nome alterado para “Dias para envio da Turma/Oficina Finalizada” para o Regional Paraná. Ele armazena o número de dias considerados após o final da Oficina para identificar se ela deverá ser enviada. Será utilizado como base a Data final da Etapa Principal da Oficina.

Dicawarning

title	Exemplo	Importante:

Antes de enviar uma Oficina (seja inclusão ou alteração) ao Portal SESI, verificar o status dos professores vinculados.
Professores com status inativo no Portal SESI não devem ser enviados.

A mesma regra deve ser aplicada para o professor responsável pela Oficina. Porém, quando o responsável estiver inativo, será gerada mensagem no log informando que a Oficina não foi exportada por esse motivo.

Se não existir nenhum professor ativo vinculado à Oficina, ela deverá ser enviada com a lista de professores vazia.

Dica

title	Exemplo

Dias para envio da Turma/Oficina Finalizada: 30

Data corrente de execução do processo: 10/01/2024

Data calculada: 10/01/2024 - 30: 11/12/2023 (desconsidera as finalizadas até essa data)

Oficina ABC

Dias para envio da Turma/Oficina Finalizada: 30

Data corrente de execução do processo: 10/01/2024

Data calculada: 10/01/2024 - 30: 11/12/2023 (desconsidera as finalizadas até essa data)

Oficina ABC - Data início: 01/10/2023 e Data fim: 02/12/2023 - Não enviada

Oficina 321 - Data início: 01/12/2023 e Data fim: 11/12/2023 - Enviada

Oficina DEF - Data início: 01/0110/2024 2023 e Data fim: 3002/0312/2024 2023 - EnviadaNão enviada

Oficina 321 - Data início: 01/12/2023 e Data fim: 11/12/2023 - Enviada

Oficina DEF - Data início: 01/01/2024 e Data fim: 30/03/2024 - Enviada

Ao ocorrer qualquer alteração nos dados das oficinas enviadas ou inclusão/exclusão de professores vinculados à sala oficina, os dados atualizados serão enviados ao Portal SESI ao rodar o processo de exportação novamente.

Expandir

title	Exportação de Dados - Matrículas

Os dados das oficinas na matrícula serão enviados para o Portal SESI quando o processo de exportação for executado ou quando uma matrícula em oficina for efetuada.

Processo existente de Exportação de Dados disponível no menu: TOTVS Educacional | Sistema Indústria | Integrações | Integração Portal SESI.

Ao realizar uma nova matrícula em Oficina, através dos menus:

Portal Oficinas - Aluno: Oficinas | Inscreva-se
Portal Oficinas - Pedagogo: Matrícula na Oficina

O processo atual de envio de matrículas do SGE para o Portal SESI será modificado para incluir informações das oficinas. Quando uma matrícula é enviada e contém informações de matrícula em oficina, essas informações serão enviadas na mesma requisição.

A API de Matrícula atual será ajustada pelo Portal SESI para considerar uma nova lista chamada "Oficinas", permitindo o envio desses dados pelo SGE.

Se não houver oficinas vinculadas, o processo de envio de matrícula continuará enviando apenas os dados da matrícula do aluno, conforme o fluxo padrão da integração do Portal SESI.

Durante o ano, um aluno pode estar vinculado a mais de uma oficina, portanto, todas as oficinas associadas à matrícula do aluno devem ser informadas ao Portal SESI. Sempre que ocorrer uma matrícula no Portal Oficina, o processo será acionado para atualizar as informações da matrícula do aluno com todas as oficinas associadas.

Serão consideradas apenas as oficinas do tipo Formação Geral e Básica e Interseriado.

Expandir

title	Dados técnicos

Expandir

title	Pré cadastro de Pessoa

HTML
<div class="post">POST</div>

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>

Body

Bloco de código

language	c#
title	Raw

{
		"idred": 7,
		"regional": "AC",
		"codigoExterno": 1234567,
		"cpf": "862.873.376-05",
		"nome": "Adriano Duarte Cardoso",
		"nomeSocial": "",
		"email": "[email protected]",
		"dataNascimento": "22-04-2000",
		"naturalidade": 4110706,
		"nomeDaMae": "Ivone Duarte Cardoso"
	},
MensagemPSESI: {
		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 no SGE (Campo Obrigatório).
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).

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

title	Integraçã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

language	c#
title	Raw

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

title	Atualização do aluno

HTML
<div class="put">PUT</div>

Body

Bloco de código

language	c#
title	Raw

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

title	Docente

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

language	c#
title	Raw

{
		"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.

Expandir

title	Atualização do Docente

HTML
<div class="put">PUT</div>

Body

Bloco de código

language	c#
title	Raw

{
		"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": [email protected],
			"sexo": "masculino",
			"dataNascimento": "01-10-1978",
			"idRaca": "10",
			"raca": "Não declarado",
			"naturalidade": 4124400,
			"nomeDaMae": ""
		}

Expandir

title	Turma

HTML
<div class="put">PUT</div>

Tabelas Afetadas: STURMA , STURMADISC

Authorization - Basic Auth

Username <username>

Token <token>

Body

Bloco de código

language	c#
title	Raw

{
		"idturma": "223344EMNEM-M-3C/2024",
		"idred": 7,
		"regional": "MG",
		"codigoIntegrador": "1234567",
		"turno": 1,
		"segmento": "18",
		"dataInicio": "29-01-2024",
		"dataFim": "11-12-2024",
		"serie": "3",
		"codTurma": "EMNEM-M-3C/2024",
		"itinerario": {
			"itinerario": "56"
			"grupo": "55"
		},
		"turmaDisciplina": [
			{
				"idTurmaDisc": 86537,
				"disciplina": "9",
				"area": "5"
			},
			{
				"idTurmaDisc": 86538,
				"disciplina": "11",
				"area": "5"
			},
			{
				"idTurmaDisc": 86539,
				"disciplina": "10",
				"area": "5"
			},
			{
				"idTurmaDisc": 86540,
				"disciplina": "6",
				"area": "20"
			},
			{
				"idTurmaDisc": 86541,
				"disciplina": "2",
				"area": "20"
			},
			{
				"idTurmaDisc": 86542,
				"disciplina": "1",
				"area": "10"
			},
			{
				"idTurmaDisc": 86549,
				"disciplina": "183",
				"area": "15"
			},
			{
				"idTurmaDisc": 86550,
				"disciplina": "187",
				"area": "15"
			},
			{
				"idTurmaDisc": 86551,
				"disciplina": "8",
				"area": "15"
			},
			{
				"idTurmaDisc": 86552,
				"disciplina": "188",
				"area": "10"
			},
			{
				"idTurmaDisc": 90266,
				"disciplina": "",
				"area": "5"
			},
			{
				"idTurmaDisc": 86543,
				"disciplina": "3",
				"area": "15"
			},
			{
				"idTurmaDisc": 86544,
				"disciplina": "24",
				"area": "15"
			},
			{
				"idTurmaDisc": 86545,
				"disciplina": "25",
				"area": "15"
			},
			{
				"idTurmaDisc": 86546,
				"disciplina": "77",
				"area": "20"
			},
			{
				"idTurmaDisc": 86547,
				"disciplina": "184",
				"area": "15"
			},
			{
				"idTurmaDisc": 86548,
				"disciplina": "186",
				"area": "10"
			}
		]
	}

Content

Id. Turma: Identificador enviado de forma fixa o valor ‘7’.
Idred: Identificador enviado de forma fixa o valor ‘7’.
Regional: Estado do cadastro da Coligada.
Código integrador: Cadastro de Filial (DFILIAL.CAMPOLIVRE1).
Turno: Correspondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'.
Segmento: De/Para de Segmento correspondente ao Campo.
Data início: Data de Inicial da Turma formatado em “dd-MM-yyyy”.
Data fim: Data de Final da Turma formatado em “dd-MM-yyyy”.
Serie: De/Para de Serie correspondente ao Campo.
Código da turma: Código da Turma.
Grupo: De/Para de Área do Itinerário da Turma correspondente ao Campo.
Itinerário: De/Para de Itinerário correspondente ao Campo.
Id. Turmadisc: identificador da Turma/Disciplina.
Área: De/Para de Área - Grupo de Complemento correspondente ao Campo.

Retorno

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

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

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: Todas as Turmas pertinentes a integração com Portal SESI educação que tiverem ao menos um aluno matriculado ou professor em turma/disciplina serão enviadas por completo.

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 60

Nova versão Atual

Chave

Manual Operacional da customização - Integração

Portal SESI

Gerando...

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Body

Authorization - Basic Auth

Body

Retorno

Body

Authorization - Basic Auth

Body

Retorno

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 60

Nova versão Atual

Chave

Manual Operacional da customização - Integração

Portal SESI

Gerando...

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Body

Authorization - Basic Auth

Body

Retorno

Body

Authorization - Basic Auth

Body

Retorno