...
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.
Informações |
---|
Novo instalador disponibilizado em 21/08 - As alterações deste instalador, estão destacadas no manual nos Tópicos terá um: Atualizado e no texto com um: [Novo!] |
Expandir | ||
---|---|---|
| ||
Para utilização da Integração com o Portal SESI Educação é necessário observar alguns pontos:
|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Expandir | ||||||
---|---|---|---|---|---|---|
| ||||||
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. 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.
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).
|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Após as configurações descritas acimaApó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.
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informações | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Column | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Toggle Cloak | ||||
---|---|---|---|---|
|
Dados Enviados Toggle Cloak exclusive true id 20
Toggle Cloak | ||||
---|---|---|---|---|
|
width | 70 |
---|
visible | true |
---|---|
id | 10 |
Mensagem: descrição geral da execução do processo.
Exemplo: Criação do aluno realizada com sucesso.
visible | true |
---|---|
id | 20 |
Dados enviados: Aqui é possível verificar se todos os dados preenchidos foram enviados.
Exemplo de exportação de Pré Cadastro de Pessoa:
id | 30 |
---|
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:
title | Atualização 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.
Estado colour Green title 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):
title | Acesso ao Portal SESI via Portal do Aluno |
---|
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.
title | Acesso ao Portal SESI via Portal do Professor |
---|
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.
Expandir | ||
---|---|---|
| ||
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. |
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. |
Expandir | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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: |
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
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.
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):
|
Expandir | ||
---|---|---|
| ||
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. |
Expandir | ||
---|---|---|
| ||
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. |
Expandir | ||
---|---|---|
| ||
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. |
Expandir | ||
---|---|---|
| ||
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. |
Expandir | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Aviso | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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.
Expandir | ||
---|---|---|
| ||
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. |
title | Dados técnicos |
---|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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
Username <username>
Token <token>
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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.
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
Username <username>
Token <token>
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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-19702010", "idRaca": "2", "raca": "Branca", "naturalidade": 4124103, "nomeDaMae": "SôniaWanda MariaRibeiro Bravo" } } |
Content
,
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
Nome: Nome do Aluno no SGE (Campo Obrigatório).
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”).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 Criado com Sucesso: HTTP Code 201 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: Aluno Atualizado com Sucesso: HTTP Code 401 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 | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Body
|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 AuthUsername <username> Token <token> Body
Content
RetornoDocente Criado com Sucesso: HTTP Code 201 - Body: MensagemPSESI
Docente Atualizado com Sucesso: HTTP Code 200 - Body: MensagemPSESI
Possíveis retorno de erro: Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI
Regra não atendida: HTTP Code 403 - Body: MensagemPSESI
Erro geral: HTTP Code 50x - Body: MensagemPSESI
Importante: Caso já tenhamos enviado com o Docente com Sucesso, será utilizado o serviço de Atualização do Docente.
|
Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Authorization - Basic AuthUsername <username> Token <token> Body
Content
RetornoTurma Atualizada com Sucesso: HTTP Code 200 - Body: MensagemPSESI
Possíveis retorno de erro: Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI
Regra não atendida: HTTP Code 403 - Body: MensagemPSESI
Erro geral: HTTP Code 50x - Body: MensagemPSESI
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: 14px; 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> -->/div> O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO: <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div> --> |
Expandir | |||
---|---|---|---|
| |||
|