Objetivo
Este documento foi elaborado para informar aos usuários chave da área Educacional do SESI, sobre a Integração Portal SESI . A integração com o Portal SESI é responsável pela sincronizaçã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.
Metodologia
Este material tem como base a visão prática e completa do processo customizado da área Educacional através da Integração Portal SESI.
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional. Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.
Para utilização da Integração com o Portal SESI Educação é necessário observar alguns pontos:
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.
Nesta aba, são configurados os campos básicos para o funcionamento da integração.
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.
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
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:
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.
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.
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:
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.
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.
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:
Neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:
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.
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:
*Arquivo disponibilizado pelo Portal SESI.
Esse parâmetro deve ser preenchido exclusivamente via importação do arquivo. Qualquer manipulação manual dos campos, resultará em falhas da funcionalidade.
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:
2- Curso: Lista com todos os cursos cadastrados na base.
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).
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.
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:
Antes de executar o processo é necessário que o usuário entenda as regras de cada Entidade que será integrada.
Clique na entidade e veja as regras ao lado
Pré Cadastro de Pessoa
Integração de Alunos/responsáveis
Integração de Turmas
Integração de Matrículas
Integração de Docentes
Integração de Aulas do Docente
Integração de Funcionários
Integração de Oficinas
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
Campos de envio opcional
Outras validações
Sendo encontrado um registro, o Portal SESI retornará o Iduser* correspondente. *Identificar único da pessoa no Portal SESI.
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
*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
Outras validações
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:
Para o Novo Ensino Médico considerar também:
Outras validações
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:
Importante:
Outras validações
Para integração de Docentes (Professores), tem como base o cadastro de Pessoa. Sendo assim consideramos:
Campos obrigatórios para integração
Campos de envio opcional
Para integração de Aulas do Docente, será enviado a relação do Docente com as turmas/disciplinas:
Validações
Verificar as regras de envia das turmas e turmas/disciplinas.
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
Campos de envio opcional
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:
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
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.
Após a exportação dos dados, cada exportação gera um determinado registro de Log.
O Monitor de Log, possibilita uma visão dos dados que foram enviados e o retorno de cada exportação. Ele estará disponível no Menu:
TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração
Ao acessar a tela é apresentado todos os Registros da Exportação. Para facilitar o entendimento vamos apresenta-lo por Funcionalidade.
Cada Funcionalidade integrada, traz as informações de Log:
No anexo Item de log, é possível visualizar com mais detalhes os dados exportados:
Na tela do anexo temos acesso a:
Clique no item a esquerda e veja a descrição a direita
Mensagem
Dados Enviados
Dados Recebidos
Mensagem: descrição geral da execução do processo.
Exemplo: Criação do aluno realizada com sucesso.
Dados enviados: Aqui é possível verificar se todos os dados preenchidos foram enviados.
Exemplo de exportação de Pré Cadastro de Pessoa:
Dados recebidos: retorno da exportação.
Exemplo: “cadastro realizado com sucesso’’
Caso seja apresentado algum erro na exportação, é possível identificar qual regra foi violada, a partir da mensagem apresentada:
No exemplo acima, o Pré cadastro de pessoa nao foi exportado porque o "O campo Email não é um endereço de email válido."
Nesta situação, o usuário poderá corrigir o campo e realizar o reenvio desse log, através do Processo: Reenvio de dados:
Os dados referentes a alunos, docentes e funcionários estão sujeitos a modificações após a exportação inicial. Quando essas alterações ocorrerem, ao realizar o processo de exportação novamente, a customização enviará ao Portal SESI apenas os campos que foram modificados.
Vale ressaltar que os campos que foram alterados não serão exportados novamente.
EXEMPLO:
Aluno na criação (Method =POST) não tinha registro de nome social. Atualizando o cadastro do aluno com a inclusão do nome social e realizado a exportação novamente, foi enviada a atualização (Method = PUT) com o nome social cadastrado (JULIO):
Foi incluído no Portal do aluno, um menu para que ele acesse o Portal SESI.
Quando os alunos clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.
Também foi incluído no Portal do professor, um menu para que ele acesse o Portal SESI.
Quando os professores clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.
Sempre que houver a necessidade de Inativação de um docente no Portal SESI, o usuário deverá seguir o processo para inativação, conforme descrito abaixo:
Os registros desse processo são gravados no Monitor de log.
O processo para Inativação de usuários - Portal SESI, possibilita inativação por completo do usuário no Portal SESI.
O processo estará disponível no Menu: TOTVS Educacional | Sistema Industria | Integradores | Portal SESI:
Ao ser acionado o processo apresentará na tela um lookup com a lista de usuários já integrados como Ativo no Portal SESI, para que o usuário selecione o que será inativado.
É permita a seleção de apenas um usuário por vez.
Atenção a mensagem exibida na tela:
“ATENÇÃO: Certifique-se que o usuário selecionado esteja correto.
Ao executar o processo, o mesmo será inativado por completo no Portal SESI.”
Ao final da execução será exibido o log com o número de registros afetados, informando o sucesso da operação. Esse registro ficará gravado no Log Integração Portal SESI Educação.
Esse processo gera duas ações:
2. Na próxima exportação de dados, o usuário será atualizado e enviado ao Portal SESI com o comando de inativação.
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:
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.
Importante:
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.
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 - 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/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.
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.
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.
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
Username <username>
Token <token>
{ "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
Nome: Nome da pessoa no SGE (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. |
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.
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
Username <username>
Token <token>
{ "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
Nome: Nome do Aluno no SGE (Campo Obrigatório).
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.
{ "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" } }
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
Username <username>
Token <token>
{ "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
Nome: Nome do professor no SGE (Campo Obrigatório).
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.
{ "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": "" }
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
Username <username>
Token <token>
{ "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
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.