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
titleProcesso de Exportação [Atualizado]
Aviso

Antes de realizar a exportação das entidades ao Portal SESI, certifique-se que todos os parâmetros e configurações citadas acima, estejam preenchidas e com os valores corretos.

Após as configurações descritas acima, o usuário poderá executar o processo de Exportação.

A exportação de dados é responsável pelo envio das seguintes Entidades:

  • Alunos (e responsáveis acadêmicos)
  • Docentes
  • Funcionários (Diretores escolares, secretários Escolares, orientadores, comissão coordenadores)
  • Turmas
  • Matriculas
  • Aulas Docentes
  • Oficinas (apenas para o Regional Paraná)

Antes de executar o processo é necessário que o usuário entenda as regras de cada Entidade que será integrada.

Aviso

Para que os alunos integrados com sucesso sejam visualizados no Portal SESI Educação, é premissa que também tenham sido integradas as entidades: Turmas e Matrículas.

Informações
titleClique na entidade e veja as regras ao lado
Section
bordertrue
Column
width30

Toggle Cloak
exclusivetrue
id1
Pré Cadastro de Pessoa

Toggle Cloak
exclusivetrue
id2
Integração de Alunos/responsáveis

Toggle Cloak
exclusivetrue
id3
Integração de Turmas [Novo!] 

Toggle Cloak
exclusivetrue
id4
Integração de Matrículas

Toggle Cloak
exclusivetrue
id5
Integração de Docentes

Toggle Cloak
exclusivetrue
id6
Integração de Aulas do Docente

Toggle Cloak
exclusivetrue
id7
Integração de Funcionários

Toggle Cloak
exclusivetrue
id8
Integração de Oficinas

Column
width70
Cloak
visibletrue
id1

Essa integração antecede o envio de Aluno, Responsável, Docente e Funcionários para o Portal SESI, na intenção de identificar se será aproveitado algum cadastro existente ou criado o pré-cadastro. 

Para integração de alunos e responsáveis acadêmicos (para alunos menores de 18 anos), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

Campos obrigatórios para integração
  • Nome
  • Estado Natal e Naturalidade
  • Data de nascimento
  • Sexo
  • E-mail 
  • Nome da mãe (caso não possua CPF informado)
Campos de envio opcional
  • CPF
  • Nome Social
  • E-mail Complementar (caso o email O365  Esteja preenchido ele será enviado como principal).
Outras validações

Sendo encontrado um registro, o Portal SESI retornará o Iduser* correspondente. *Identificar único da pessoa no Portal SESI.

Cloak
visibletrue
id2

Para integração de alunos e responsáveis acadêmicos (para alunos menores de 18 anos), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

Campos obrigatórios para integração
  • Nome
  • Estado Natal e Naturalidade
  • Data de nascimento
  • Sexo
  • E-mail 
  • Usuário* (caso o usuário esteja inativo será enviado o comando de inativação ao Portal SESI)
  • Senha do usuário
  • Nome da mãe (caso não possua CPF informado)

*Ao instalar a customização no ambiente de produção é necessário executar o processo de geração de usuário selecionando todos os alunos para que os mesmos realizem a troca de senhas ao fazer login no sistema.

Campos de envio opcional
  • CPF
  • Nome Social
  • E-mail Complementar (caso o email O365  Esteja preenchido ele será enviado como principal)
  • Raça
Outras validações
  • E-mail do responsável acadêmico:  Será verificado se o responsável  acadêmico é também um aluno ou Professor. Caso seja, consultamos se o e-mail do responsável acadêmico (PPESSOA) é o mesmo e-mail do campo complementar a Office 365 (aluno ou professor). Se os e-mails forem idênticos, a validação na Quickemail não será necessária, se forem divergentes, a validação na Quickemail será aplicada respeitando os parâmetros cadastrados.
  • Notificação de Alerta para E-mail Inválido: Será exibida notificação no cadastro de Aluno, caso seja realizada inclusão ou alteração no e-mail, para validar a sintaxe*   do e-mail (*se tem domínio, o @ e ponto caracteres validos)  e alertar da importância de um e-mail válido. 
  • Matrículas do aluno: Caso o aluno possua matrícula, é necessário que a mesma esteja com a flag "Enviar ao Portal Sesi" para que o aluno seja integrado.
Cloak
id3

Para integração é necessário de as Turmas e Turmas/disciplinas sejam cadastras considerando:

Campos obrigatórios para integração

Para turmas e turmas Disciplinas:

  • Turno 
  • Data inicial
  • Data final
  • Código turma¹ 

Para o Novo Ensino Médico considerar também:

  • Itinerário Formativo[Novo!] 

No caso do Itinerário Formativo, serão consideradas as turmas/disciplinas que fizerem parte da matriz curricular e estejam definidas como parte do Itinerário. As disciplinas do itinerário formativo podem ou não fazer parte da grade de disciplinas, mas para efeito de considerar que elas são do Itinerário Formativo será verificado se o campo "Itinerário Formativo" da Turma/Disciplina está preenchido.

true@TITRequisitos da integração de Turmas/Disciplinas do Itinerário Formativo [Novo!]

@TIT
    Teste
    • Serão consideradas como disciplinas do Itinerário Formativo aquelas que estiverem vinculadas à Matriz Curricular no anexo de Itinerários Formativos


    • No anexo de Disciplinas do Itinerário o campo "Grupo de complemento" será considerado para o DE/PARA 

    Outras validações
    • [Novo!] ¹Será verificado se o parâmetro 'Utiliza campo complementar Turma SESI Educação' está marcado.
      • Este campo marcado indica que no processo de exportação de turmas ao Portal SESI Educação, será considerado como código da turma, o valor informado no campo complementar mencionado.
      • Caso desmarcado será considerado o valor do campo nativo da turma 'Código da turma' (STURMA.CODTURMA).
        • RedAtenção  Caso o parâmetro esteja marcado o envio do código da turma para o Portal SESI será o campo complementar “Turma Sesi Educação”  desde que esteja preenchido. Quando ele não está preenchido a customização envia o Código da Turma (STURMA.CODTURMA).
    • Campo complementar Enviar ao Portal SESI no cadastro da Turma: Este campo, por padrão estará marcado. Caso seja desmarcado a Turma e seus vínculos  não serão considerados na integração com o Portal SESI.
    Reenvio de turmas já exportadas [Novo!] 

    [Novo!] Para as Turmas que já foram enviadas com sucesso para o Portal SESI com o código da Turma, e o Regional necessite reenviar o registro alterando para o envio da informação existente no campo complementar Turma SESI Educação, será necessário:

    1. Alterar/incluir os registros das Turmas para que a integração entenda que o registro sofreu atualização e precisa ser reenviado ao Portal SESI, nesse reenvio serão consideradas as novas regras implementadas neste escopo.
      O fato de preencher o campo complementar Turma SESI educação já é uma alteração válida para o reenvio.
    2. Executar o processo de exportação de Turmas.
Cloak
id4

Serão exportadas as Matriculas dos alunos considerando:


Itens que serão integrados

Alunos já exportados ao Portal SESI e que estejam matriculados com algum dos Status abaixo:

  • Pré-matrícula: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Pré-Matriculado” ou “Matriculado” e a Data corrente é menor que a Data Início da Turma;
  • Matriculado: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Matriculado” e não forem identificados como Concluinte ou Pré-Matriculado;
  • Inativo: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Inativo”.


Importante:

  • Passaremos a enviar todas as matrículas elegíveis ao Portal SESI educação e não mais somente a última, porém atualizações serão enviadas somente em caso de alteração de situação de matrícula ou resultado, pois estes são os campos enviados que não fazem parte da chave da matrícula.
  • Considerando que a situação de matrícula ‘Pré matriculado’, possivelmente são de alunos cuja turma em que está vinculado ainda não foi iniciada, caso o aluno não tenha situação de matrícula considerada “Matriculado”, no Portal SESI o aluno permanecerá Inativo, até que esta “Pré-matrícula” tenha mudado para “Matriculado”.
Outras validações
  • Campo complementar Enviar ao Portal SESI na Matrícula do Período letivo: Este campo, por padrão estará marcado. Caso seja desmarcado essa matrícula não será considerada na integração com o Portal SESI.
  • A data de início daturma não é considerada um pré-requisito para exportação. Consideramos a data da entrada da pré-matrícula no SGE (exceto para alunos da EJA).
Cloak
id5

Para integração de Docentes (Professores), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

Campos obrigatórios para integração
  • Nome
  • Estado Natal e Naturalidade
  • Data de nascimento
  • Sexo
  • E-mail 
  • Usuário (Ativo)
  • Senha do usuário
  • Nome da mãe (caso não possua CPF informado)
Campos de envio opcional
  • CPF
  • Nome Social
  • E-mail Complementar (caso o e-mail O365  Esteja preenchido ele será enviado como principal)
  • Raça
Atenção!

Para que o professor seja exportado, é necessário que ele tenha um usuário cadastrado no SGE e esteja ministrando aula em uma Turma/Disciplina que tenha sido informada no cadastro De/Para para disciplinas.

Cloak
id6

Para integração de Aulas do Docente, será enviado a relação do Docente com as turmas/disciplinas:


Validações
  • Professores vinculados a turmas/disciplina, já integradas

Verificar as regras de envio das turmas e turmas/disciplinas.

Cloak
id7

O termo 'funcionários' se refere às pessoas designadas a determinadas funções no SGE – Módulo Educacional (secretários escolares, membros da comissão coordenadora e diretores escolares). 

Sendo assim, consideramos:

Campos obrigatórios para integração
  • Nome
  • Estado Natal e Naturalidade
  • Data de nascimento
  • Sexo
  • E-mail 
  • Usuário* (caso o usuário esteja inativo será enviado o comando de inativação ao Portal SESI)
  • Senha do usuário
  • Perfil de funcionário (Cadastrado nos parâmetros)
  • Nome da mãe (caso não possua CPF informado)
Campos de envio opcional
  • CPF
  • Nome Social
  • E-mail Complementar (caso o e-mail O365  Esteja preenchido ele será enviado como principal)
  • Raça
Outras validações

Tais registros de 'funcionários' do SGE – Módulo Educacional são pessoas (PPESSOA) associados às funções através dos Menus:

  • Filial | Dados Educacionais | <anexo> Diretores por Filial 
  • Módulo Educacional | Currículo e Oferta | Estrutura Curricular | Matrizes curriculares | <anexo> Matriz aplicada | <anexo> Comissão Coordenadora'.
Cloak
id8

A integração das Oficinas será tratada em tópico a parte deste manual.


Conhecendo a regra de cada Entidade que será exportada.  O usuário poderá executar o processo de Exportação através do Menu:

TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | Exportação de Entidades


Informações
  • Esse processo poderá ser agendado conforme recurso nativo.
  • O processo de exportação acontece de formar síncrona. 
  • O primeiro envio pode levar mais tempo para ser concluído. 

Executando manualmente o processo o usuário poderá selecionar uma ou mais entidades.


O resultado da exportação é registrado  no Monitor de log da integração, descrito no próximo tópico deste manual.


...

Expandir
titleDados técnicos
Expandir
titlePré 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
languagec#
titleRaw
{
		"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
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.



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

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": [email protected],
			"sexo": "masculino",
			"dataNascimento": "01-10-1978",
			"idRaca": "10",
			"raca": "Não declarado",
			"naturalidade": 4124400,
			"nomeDaMae": ""
		}
Expandir
titleTurma
HTML
<div class="put">PUT</div>

Deverá ser enviado as Turmas e Turmas/Disciplina Criando ou Atualizando - Sendo que na criação a chave é o conjunto idred|regional|turno|segmento|serie|turma e para atualização utilizar o idturma (a ser retornado pela API).

Tabelas Afetadas: STURMA , STURMADISC


[Novo!] Para Turmas do Itinerário Formativo a estrutura do JSON é diferente da Turma que não é do Itinerário Formativo.


Authorization - Basic Auth

Username <username>

Token <token>

Body [Novo!]

Bloco de código
languagec#
titleRaw
{
		"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,
				"disciplinagrupo": "9",
				"area": "5"
			},
			{
				"idTurmaDisc": 86538,
				"grupo": "10",
			    "disciplinaitinerario": "11001",
				"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.

...