Método gravarPessoaFisica
- Objetivo do Método:
Inscrever uma Pessoa Física. Para realizar uma alteração em um registro, basta que o método de inserção seja usado. O WS ao localizar um registro já existente irá realizar o merge (mescla) das informações, atualizando os dados.
- Pré-condição:
Não existem.
- Campos de Entrada:
|
Atributo |
Tipo de Dados |
Chave |
Valor Padrão |
Observação |
|
|
NR_CPF |
VARCHAR(14) |
PK |
|
CPF/Identificador Único |
|
|
NM_PESSOA |
VARCHAR(100) |
|
|
Nome |
|
|
NM_SEXO |
VARCHAR(1) |
|
|
Sexo (Item 3.2.1) |
|
|
NM_ORG_EXPEDITOR |
VARCHAR(10) |
|
|
|
Nome do órgão expedidor do RG |
|
NR_RG |
VARCHAR(15) |
|
|
|
Número do Registro Geral (RG) |
|
UF_RG |
NUMBER(2) |
|
|
Identificação da UF de emissão do RG (Item 3.2.2) |
|
|
NR_RGP |
VARCHAR(11) |
|
|
|
Registro Geral de Atividade Pesqueira - RGP |
|
NM_EMAIL |
VARCHAR(250) |
|
|
|
E-mail para contato |
|
NR_CEP_RESIDENCIA |
VARCHAR(10) |
|
|
|
Código Postal do endereço residencial |
|
DS_COMPLE_END_RES |
VARCHAR(300) |
|
|
|
Descrição do Complemento de endereço residencial |
|
NR_END_RES |
VARCHAR(10) |
|
|
|
Número do endereço residencial |
|
NR_CEP_CORRESPONDENCIA |
VARCHAR(10) |
|
|
|
Código Postal do endereço de correspondência |
|
DS_COMPLE_END_CORR |
VARCHAR(300) |
|
|
|
Descrição do Complemento de endereço de correspondência |
|
NR_END_CORR |
VARCHAR(10) |
|
|
|
Número do endereço de correspondência |
|
NR_UF |
NUMBER(2) |
|
|
Número IBGE da UF (Item 3.2.2) |
|
|
IN_CPF_PROVISORIO |
NUMBER(1) |
|
0 |
Identificador do código provisório para pessoas físicas que não possuem CPF válido |
|
|
DS_SITUACAO |
VARCHAR(7) |
|
|
Especifica se o registro está ativo ou inativo (Item 3.2.38) |
|
|
SYS_KEY |
VARCHAR(39) |
|
|
Chave de sistema do estado correspondente ao ambiente |
- Campos de Saída:
|
Nome do Campo |
Tipo de Dados |
Observação |
|
Mensagem |
Mensagem de Retorno |
|
|
Status |
Status do Retorno |
ERRO: Quando há alguma falha no resultado, ou o resultado esperado não é alcançado SUCESS: Quando o resultado esperado é alcançado |
- Exemplo de XML de Entrada:
O XML do método, gerado pelo WSDL, apresentará o sinal “?” para as tags. O “?” deverá ser substituído pelo valor do campo correspondente.
IMPORTANTE: Caso o campo não tenha valor, o mesmo não deverá ser enviado, sob pena de geração de erro na tentativa de consumo do método.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.ws.pga.id2.inf.br/">
<soapenv:Header/>
<soapenv:Body>
<web:gravarPessoaFisica>
<!--Optional:-->
<nrCpf>33456871198</nrCpf>
<!--Optional:-->
<nmPessoa>Teste de Req PF 3</nmPessoa>
<!--Optional:-->
<nmSexo>M</nmSexo>
<!--Optional:-->
<nmOrgExpedidor>?</nmOrgExpedidor>
<!--Optional:-->
<nrRg>?</nrRg>
<!--Optional:-->
<nrRgp>?</nrRgp>
<!--Optional:-->
<ufRg>?</ufRg>
<!--Optional:-->
<nmEmail>testePF3@teste.com</nmEmail>
<!--Optional:-->
<nrCepResidencia>?</nrCepResidencia>
<!--Optional:-->
<dsCompleEndRes>?</dsCompleEndRes>
<!--Optional:-->
<nrEndRes>?</nrEndRes>
<!--Optional:-->
<nrCepCorrespondencia>?</nrCepCorrespondencia>
<!--Optional:-->
<dsCompleEndCorr>?</dsCompleEndCorr>
<!--Optional:-->
<nrEndCorr>?</nrEndCorr>
<!--Optional:-->
<nrUf>53</nrUf>
<!--Optional:-->
<inCpfProvisorio>1</inCpfProvisorio>
<!--Optional:-->
<dsSituacao>?</dsSituacao>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:gravarPessoaFisica>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:gravarPessoaFisicaResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return><mensagem>MS0002</mensagem>
<status>SUCESSO</status></return>
</ns2:gravarPessoaFisicaResponse>
</S:Body>
</S:Envelope>