WS502 - Consulta de protocolo da exportação

Objetivo

Consultar o status dos protocolos criados na exportaçã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/exportQueue/index.php HTTP/1.1

Accept-Encoding: gzip,deflate

Content-Type: text/xml;charset=UTF-8

SOAPAction: "urn:WebServiceComprovei#getExportProtocolStatus"

Authorization: Basic {* user/password codificado em BASE64}

Content-Length: 117

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  

 getExportProtocolStatus

 Endereço de acesso

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

 Versão atual

 1.0 (09/01/2017)

 

Parâmetros de entrada

 Atributo

 Tipo

 Descrição

 protocolo

 string

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


Exemplo da requisição


<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
    <x:Header/>
    <x:Body>
        <urn:getExportProtocolStatus>
            <urn:protocolo>201701105874d00016685</urn:protocolo>
        </urn:getExportProtocolStatus>
    </x:Body>
</x: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 exportação.

 dataCriacao

 string

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

 dataConclusao

 string

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

 processado

 string

 Sim ou não indicando que a exportação foi processada.

 resultado

 string

 Mensagem de sucesso ou erro da exportação

 url

 string

 URL para fazer o download do arquivo gerado na exportação, em caso de sucesso e existência de dados. (Válida por 1 dia)


Exemplos da resposta

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope 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:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:getExportProtocolStatusResponse>
            <status xsi:type="xsd:string">Protocolo encontrado.</status>
            <protocolo xsi:type="xsd:string">201701095873c49529401</protocolo>
            <metodo xsi:type="xsd:string">getDocumentsStatusV2</metodo>
            <dataCriacao xsi:type="xsd:string">09/01/2017 15:12:53</dataCriacao>
            <dataConclusao xsi:type="xsd:string">09/01/2017 15:12:59</dataConclusao>
            <processado xsi:type="xsd:string">Sim</processado>
            <resultado xsi:type="xsd:string">Sem ocorrências para retornar</resultado>
            <url xsi:nil="true"/>
        </ns1:getExportProtocolStatusResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

____________________________________________________________________________________________________________________________________

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope 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:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:getExportProtocolStatusResponse>
            <status xsi:type="xsd:string">Protocolo encontrado.</status>
            <protocolo xsi:type="xsd:string">201701105874d00016685</protocolo>
            <metodo xsi:type="xsd:string">getDocumentsStatusV2</metodo>
            <dataCriacao xsi:type="xsd:string">10/01/2017 10:13:52</dataCriacao>
            <dataConclusao xsi:type="xsd:string">10/01/2017 10:14:01</dataConclusao>
            <processado xsi:type="xsd:string">Sim</processado>
            <resultado xsi:type="xsd:string">Exportação realizado com sucesso!</resultado>
            <url>               <![CDATA[https://s3.amazonaws.com/comprovei/exports/2017/01/10/48/getDocumentsStatusV2/201701105874d00016685.xml?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=FQoDYXdzEHQaDMwxYGQxb%2B7CAjlHKSKcA%2FeGAk9dtGsaCRwPIdBBN8NV8cWKoZZzDhsjaHpnae%2BLyF7NxFabCzSd2x%2B98OSh1k%2BJCOug8EJ7BGsonx83mU4B4AkC5Y3vFmx3emJtoH48VVzdglp8G7cfl%2BBHteHXG1uk0Jr0wVvQ4qL40HWctfv1msKfM1ZQmXeiKTr8GLZ6vSzw5g1ly45kDFazkAFm%2Fya4IWIhjZkL4%2F82h4P%2B2u8ZcrabUpwJ3Xf7rFk%2BLxbiyhufikq0juUE69%2FhNV7JxNK71Q3BRqe9gtSMCvsHO0ZmepaC6kq7KxU4YzyVvlgSS2%2BGp5Yu9KQlTISIRmA95Vod7O038g1%2Bp0UYnLzuLMPeDyDuQ3osvFSacO8VA2eaYIvoRhiHgCbhVAkgF5BynXl%2Fjekjy5dBge92l3ja1IEGMYTEL8E6g2RGWlc9d4N1NaoLK2hDHp05mMBKSlSf24DSgyNdwdK%2BdG%2B8F6uYcX0GmJ4yDBPTl0kPfmvSn%2F%2BMVSDf5MmLC0oeaNPv3%2B%2B2jGbD6jDxLD%2Fy6zxriBCp43pShHutXcuE2vbTYmAou4bTwwU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAJUHAW2BUL7XB6GLQ%2F20170110%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170110T121359Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Signature=899de32b73d1b6933a05a275d5ea9905f7d2a3df89146d7fd0ed197d4c4f0ddb]]>
            </url>
        </ns1:getExportProtocolStatusResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>



Comments