Swagger

Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo:http://localhost:8080/swagger/ui/index).

O serviços da customização de Cadastro de Pessoa Física estão disponíveis em CstAtualizacaoPessoa, nos métodos AtualizarPessoa e AtualizarResponsavelFinanceiro, ambos do tipo PUT.

Pré-requisitos

Não se aplica.

Detalhamento do processo

Foi desenvolvido uma rotina customizada para manter os dados do cadastro do Aluno atualizados entre o SGE e o sistema corporativo.

No momento do cadastro, o usuário irá verificar se o aluno já existe na tabela da Pessoa, utilizando a função nativa de "Localizar Aluno/Registro Preliminar". Se o registro for localizado, os dados serão preenchidos na tela do Aluno e o usuário poderá finalizar o cadastro. Caso não seja localizado, o usuário deverá preencher todos os dados antes de salvar o registro.

Image Added

No momento de salvar o cadastro do aluno, a customização verificará se a pessoa já foi integrada com o sistema corporativo. Se estiver sido integrada, o registro será salvo normalmente. Caso ainda não tenha sido exportado, uma mensagem será exibida informado o usuário que é necessário realizar a integração entre os dois sistemas e orientando para a utilização da função "Consultar Aluno", acessível através de botão com mesmo nome na tela de cadastro do Aluno.

--imagem aqui--

Tela Consultar Aluno

Na tela de consultar o Aluno, os dados de Data Nascimento, Nome e CPF já virão preenchidos com os dados do mesmo, e o usuário poderá realizar a busca ao sistema corporativo. O usuário deverá, então, realizar a busca, e caso sejam retornado registros, selecionar o adequado e clicar em "Preencher Dados". Nesse momento, os dados do SGE serão sincronizados com os dados recebidos do sistema corporativo e o cadastro do Aluno poderá ser finalizado.

Caso não sejam localizados registros na busca, o usuário deverá clicar em "Integrar" para enviar a Pessoa para o sistema corporativo, para que os dois sistemas possam ser sincronizados. O cadastro poderá, então, ser finalizado.

Pré-requisitos

Não se aplica.

Detalhamento do processo

Foi desenvolvido um WebService para realizar a integração de Pessoa entre o Sistema Corporativo e o SGE, que está disponível no swagger com o nome AtualizarPessoa.

O método de atualização de pessoa recebe um objeto como parâmetro no corpo da requisição, que são vinculados aos campos no SGE de acordo com a tabela abaixo:

Serão atualizados as pessoas que sejam aluno, professores ou responsáveis acadêmicos. Apenas professores do quadro (campo complementar SPROFESSORCOMPL.QUADRO = 0) não serão atualizados, e uma mensagem de erro será retornada pelo webservice.

Status de retorno do Webservice

O webservice poderá retornar os seguintes status HTTP:

Pré-requisitos

Não se aplica.

Detalhamento do processo

Foi desenvolvido um WebService para realizar a integração de Responsável Financeiro entre o Sistema Corporativo e o SGE, que está disponível no swagger com o nome AtualizarResponsavelFinanceiro.

O método de atualização de responsável financeiro recebe um objeto como parâmetro no corpo da requisição, que são vinculados aos campos no SGE, realiza a busca através do CPF (FCFCO.CGCCFO) e caso seja localizado o registro, atualiza os dados de acordo com a tabela abaixo:

Status de retorno do Webservice

O webservice poderá retornar os seguintes status HTTP: