WS501 - Consulta de protocolo da importação

Objetivo

Consultar o status dos protocolos criados na importação

Características

  • As chamadas serão realizadas via "SOAP" sobre HTTPS;
  • A origem do chamado do web service será o sistema do cliente;

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication);
  • Solicite o user / password ao administrador da conta.

POST https://soap.comprovei.com.br/importQueue/index.php HTTP/1.1

Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#getImportProtocolStatus"
Authorization: Basic {* user/password codificado em BASE64}
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Descrição do método

 Método  

 getImportProtocolStatus

 Endereço de acesso

 https://soap.comprovei.com.br/importQueue/index.php?wsdl

 Versão atual

 1.0 (22/02/2017)

 

Parâmetros de entrada

 Atributo

 Tipo

 Descrição

 protocolo

 string

 Protocolo para consultar a evolução do pedido de importação.


Exemplo da requisição


<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:getImportProtocolStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <protocolo xsi:type="xsd:string">2017022258ade8611f302</protocolo>
      </urn:getImportProtocolStatus>
   </soapenv:Body>
</soapenv:Envelope>


Parâmetros de saída

 

 Atributo

 Tipo

 Descrição

 status

 String

 Mensagem de sucesso ou de erro para o protocolo informado.

 protocolo

 String

 Protocolo informado na requisição.

 metodo

 String

 Método requisitado na geração da importação.

 dataCriacao

 String

 Data e hora da requisição da importação.

 dataConclusao

 String

 Data e hora que a importação foi concluída.

 processado

 String

 Sim ou Não indicando que a já importação foi processada.

 resultado

 String

 Mensagem de sucesso ou erro da importação.


Exemplos da resposta


<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:getImportProtocolStatusResponse>
         <status xsi:type="xsd:string">Protocolo encontrado.</status>
         <protocolo xsi:type="xsd:string">2017022258ade8611f302</protocolo>
         <dataCriacao xsi:type="xsd:string">22/02/2017 16:37:05</dataCriacao>
         <dataConclusao xsi:type="xsd:string">22/02/2017 16:37:14</dataConclusao>
         <processado xsi:type="xsd:string">Sim</processado>
         <resultado xsi:type="xsd:string">Documentos importados com sucesso!</resultado>
      </ns1:getImportProtocolStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Comments