Método gravarResponsavelAglomeracao
- Objetivo do Método:
Inscrever informações de responsável por aglomeração. 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:
Pessoa Física cadastrada.
Aglomeração cadastrada.
- Campos de Entrada:
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
ID_TEC_RESP_AGLOMERACAO |
NUMBER(13) |
PK |
|
Identificador único |
|
NR_CPF |
VARCHAR(14) |
|
|
CPF/Identificador Único |
|
ID_AGLOMERACAO |
NUMBER(10) |
|
|
Identificador de Aglomeração |
|
IN_PRINCIPAL |
VARCHAR(1) |
|
0 |
Identifica como Principal ou não |
|
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:gravarResponsavelAglomeracao>
<!--Optional:-->
<idTecRespAglomeracao>5300010001</idTecRespAglomeracao>
<!--Optional:-->
<nrCpf>38577818071</nrCpf>
<!--Optional:-->
<idAglomeracao>5300000001</idAglomeracao>
<!--Optional:-->
<inPrincipal>0</inPrincipal>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:gravarResponsavelAglomeracao>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:gravarResponsavelAglomeracaoResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return><mensagem>MS0001</mensagem><status>SUCESSO</status></return>
</ns2:gravarResponsavelAglomeracaoResponse>
</S:Body>
</S:Envelope>