Cadastro de Pessoa Física

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