1. Objetivo do Método:


Incluir informações de Declaração Adicional do Cfoc. 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.


  1. Pré-condição:


Declaração Adicional Certificado cadastrada

Cfoc cadastrado


  1. Campos de Entrada:


Atributo

Tipo de Dados

Chave

Regras

Valor Padrão

Observação

ID_DECLARACAO_ADICI_CFOC

NUMBER(10)

PK

RN02, RN05, RN09


Identificador único do Registro

ID_DECLARACAO_ADICIONAL

NUMBER(10)


RN02


Identificador da Declaração Adicional 

ID_PROTOCOLO_CFOC

NUMBER(10)


RN02


Identificador do CFOC

SYS_KEY

VARCHAR(39)


RN02, RN06


Chave de sistema do estado correspondente ao ambiente


  1. Campos de Saída:


Nome do Campo

Tipo de Dados

Observação

Mensagem

Mensagem de Retorno

Ver Item 3.1

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


  1. 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:gravarDeclaracaoAdicionalCfoc>

         <!--Optional:-->

         <idDeclaracaoAdicionalCfoc>5300000001</idDeclaracaoAdicionalCfoc>

         <!--Optional:-->

         <idDeclaracaoAdicional>5300000001</idDeclaracaoAdicional>

         <!--Optional:-->

         <idProtocoloCfoc>5307080905</idProtocoloCfoc>

         <!--Optional:-->

         <sysKey>{Syskey do Estado}</sysKey>

      </web:gravarDeclaracaoAdicionalCfoc>

   </soapenv:Body>

</soapenv:Envelope>


  1. Exemplo de XML de Saída:


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

   <S:Body>

      <ns2:gravarDeclaracaoAdicionalCfocResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">

         <return><mensagem>MS0001</mensagem><status>SUCESSO</status></return>

      </ns2:gravarDeclaracaoAdicionalCfocResponse>

   </S:Body>

</S:Envelope>