Os serviços são requests XML, não requerendo parâmetros no cabeçalho, usando o protocolo Soap 1.1 .


  • XML: extensible Markup Language
  • SOAP 1.1: é o tipo de envelopamento baseado em XML 1.0. O conjunto de informações XML (infoset) fornece uma maneira de descrever o documento XML com esquema XSD. Esta maneira de descrever o documento XML ajuda revelar outros formatos de "serialização", como por exemplo, um protocolo de formato binário.



MÉTODOS E REGRAS DISPONÍVEIS


Todas as entidades do WS disponibilizam métodos para realizar as operações, em geral, seguindo um padrão como “gravar”, “consultar”, dentre outras. Os métodos são formados por um metadado XML para envio, e têm como resposta outro metadado XML no retorno, podendo ser uma entidade como resposta, como é o caso dos métodos “obter”.


Nesse manual estarão listados os métodos de Consulta de forma ampla, sendo que, através do WSDL dos Serviços, é possível identificar outros métodos de consulta, como é o caso da entidade GTA, que possui métodos como obterGtaInterestadualPorChave e obterGtaInterestadualporEspécie.


O tratamento do WS é diferente para tags (<tag></tag>) enviadas sem conteúdo ou vazias (<tag></tag>) e o NÃO ENVIO da mesma. Portanto, se o parâmetro ou atributo, for permitido com valor vazio (ou não obrigatório), como descrito nas tabelas do Item COMUM, ÁREA ANIMAL e ÁREA VEGETAL, e o mesmo não possuir informação na origem, é relevante que o mesmo não seja enviado, ao contrário de enviá-lo vazio.


Além disso, como o envio das informações é com base em uma estrutura XML, caracteres especiais como "&" devem ser encapsulados junto com o conteúdo do campo que será enviado, conforme exemplo abaixo:



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.ws.pga.id2.inf.br/">
<soapenv:Header/>
<soapenv:Body>
 <web:gravarPessoaJuridica>
<nrCnpj>{numero}</nrCnpj>
<nmEmpresarial><![CDATA[nome 1 & nome 2]]></nmEmpresarial>
<nmFantasia></nmFantasia>
<nrInscricaoEstadual>00000000</nrInscricaoEstadual>
<nmEmail>email@dominio.com</nmEmail>
</web:gravarPessoaJuridica>
</soapenv:Body>
</soapenv:Envelope>