Cadastro de Pessoa Física


O manual a seguir visa detalhar as customizações realizadas neste projeto para atender as necessidades da integração entre o SGE e Sistema Corporativo no que diz respeito ao 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:


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:

Campo WebServiceSGE
IDSALUNOCOMPL.CODALUNOSCOP( Coligada 3) ou SALUNOCOMPL.CODALUNOSCAE (Coligada 2)
NomePPESSOA.NOME
DataNascimentoPPESSOA.DTNASCIMENTO
EstadoCivilPPESSOA.ESTADOCIVIL
SexoPPESSOA.SEXO
CorPPESSOA.CORRACA
NomeMaeSALUNOCOMPL.NOMEMAE (Coligada 3) e VPCOMPL.NOMEMAE
NomePaiVPCOMPL.NOMEPAI
CPFPPESSOA.CPF
IdentidadePPESSOA.CARTIDENTIDADE
OrgaoEmissorPPESSOA.ORGEMISSORIDENT
DataEmissaoPPESSOA.DTEMISSAOIDENT
TituloEleitorPPESSOA.TITULOELEITOR
PassaportePPESSOA.NPASSAPORTE
Nacionalidade

PPESSOA.NACIONALIDADE

CidadeEnderPPESSOA.CODMUNICIPIO
BairroEnderPPESSOA.BAIRRO
UFEnderPPESSOA.ESTADO OU SALUNO.ESTADO
EstrangeiroInformação inexistente no SGE. Existe o campo de nacionalidade (PPESSOA.NACIONALIDADE) que suprime esta informação.
EmailPPESSOA.EMAIL
DDD

Informação não existe separada do telefone no SGE. Será concatenada ao Telefone.
(PPESSOA.TELEFONE1).

TelefonePPESSOA.TELEFONE1
DDDCel

Informação não existe separada do telefone no SGE. Será concatenada ao Celular.
( PPESSOA.TELEFONE2).

CelularPPESSOA.TELEFONE2
LogradouroPPESSOA.RUA
ComplementoPPESSOA.COMPLEMENTO
NumeroPPESSOA.NUMERO
CEPPPESSOA.CEP
Municipio_IBGEPPESSOA.CODNATURALIDADE
TipoBeneficiarioVPCOMPL.TIPOBENEFICIARIO (Esta informação será adicionada no campo complementar “Tipo Beneficiário” e preenchido por tabela dinâmica T= Titular e D= Dependente).


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:

StatusDescrição
204 - No ContentSerá retornado quando ocorrer sucesso na atualização dos dados da Pessoa.
400 - Bad RequestÉ retornado quando ocorre algum erro de validação e a atualização não é processada. Um objeto com os detalhes do erro é retornado.
500 - Internal Server ErrorÉ retornado quando ocorre algum erro não tratado no webservice, e os detalhes do problema são retornados.

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:

Campo WebServiceSGE
IDNão se aplica para Responsável Financeiro.
NomeFCFO.NOME
DataNascimentoFCFO.DTNASCIMENTO
EstadoCivilFCFO.ESTADOCIVIL
SexoInformação inexistente no SGE para Responsável Financeiro.
CorInformação inexistente no SGE para Responsável Financeiro.
NomeMaeFCFOCOMPL.NOMEMAE
NomePaiFCFOCOMPL.NOMEPAI
CPFFCFO.CGCCFO
IdentidadeFCFO.CIDENTIDADE
OrgaoEmissorFCFO.CI_ORGAO
DataEmissaoInformação inexistente no SGE para Responsável Financeiro.
TituloEleitorInformação inexistente no SGE para Responsável Financeiro.
PassaporteInformação inexistente no SGE para Responsável Financeiro.
Nacionalidade

FCFO.NACIONALIDADE (Se enviar S, gravar 1, se enviar N, gravar 0).

CidadeEnderFCFO.CODMUNICIPIO
BairroEnderFCFO.BAIRRO
UFEnderFCFO.CODETD
EstrangeiroFCFO.NACIONALIDADE (Se enviar S, gravar 1, se enviar N, gravar 0).
EmailFCFO.EMAIL
DDD

Informação não existe separada do telefone no SGE. Será concatenada ao Telefone.
(FCFO.TELEFONE).

TelefoneFCFO.TELEFONE
DDDCel

Informação não existe separada do telefone no SGE. Será concatenada ao Celular.
( FCFO.TELEX).

CelularFCFO.TELEX
LogradouroFCFO.RUA
ComplementoFCFO.COMPLEMENTO
NumeroFCFO.NUMERO
CEPFCFO.CEP
Municipio_IBGEInformação inexistente no SGE para Responsável Financeiro.
TipoBeneficiarioVPCOMPL.TIPOBENEFICIARIO (Esta informação será adicionada no campo complementar “Tipo Beneficiário” e preenchido por tabela dinâmica T= Titular e D= Dependente).


Status de retorno do Webservice

O webservice poderá retornar os seguintes status HTTP:

StatusDescrição
204 - No ContentSerá retornado quando ocorrer sucesso na atualização dos dados do Responsável Financeiro.
400 - Bad RequestÉ retornado quando ocorre algum erro de validação e a atualização não é processada. Um objeto com os detalhes do erro é retornado.
500 - Internal Server ErrorÉ retornado quando ocorre algum erro não tratado no webservice, e os detalhes do problema são retornados.