WSConsultarProtocolo - Consulta do status do processamento das informações
O web service WSConsultarProtocolo, permite retornar o status do processamento dos documentos que estão sendo enviados ao e-Forms. Após emitir o documento via (WSInserirDocumento), é possível acompanhar o andamento do processo do serviço através do WSConsultarProtocolo. O método chamado por este web service é denominado ConsultarProtocolo, como apresentado abaixo:
<XML retorno> ConsultarProtocolo(<XML consulta>) |
A consulta do protocolo pode ser realizada de duas formas distintas mapeadas no parâmetro <Xml consulta>. A primeira é enviando o próprio protocolo, recebido no retorno do WSInserirDocumento ou, através da composição de valores (CNPJ, número do documento e série do documento).
Esta segunda abordagem é utilizada quando o ERP, por algum motivo, não consegue receber o protocolo. Desta forma, pode acontecer que seja retornado mais de um protocolo, pois o mesmo documento pode ter sido enviado mais de uma vez e, portanto, pode existir mais de um protocolo para atender a mesma composição de valores.
Para efetuar o download do schema xsd clique aqui!
Exemplo XML de Consulta |
<eformsConsultarProtocolo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.nddigital.com.br/connector"> <versao></versao> <listaconsulta> <consulta> <protocolo></protocolo> </consulta> </listaconsulta> </eformsConsultarProtocolo> |
Detalhamento do schema eformsConsultarProtocolo |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
O retorno obtido através deste web service exibe as informações sobre os protocolos, informando se os documentos foram enviados ao e-Forms e-Connector, para transação com a SEFAZ, ou apresentou erro. Para cada protocolo ou composição de valores consultados, pode ser retornada a chave de acesso ou, uma lista de erros vindos do processo de validação do arquivo texto ou do XML.