WS113A - Receber ocorrências dos documentos (foto como link)

Objetivo

Receber as informações dos status e ocorrências de documentos conforme forem apontados pelos motoristas. 

Uma vez consumido, uma ocorrência NÃO será consumida por este método novamente.

Características

  • As chamadas serão realizadas via "SOAP" sobre HTTPS;
  • A origem do chamado do web service será o sistema do cliente;
  • Importante: o usuário deste webservice deve armazenar o protocolo gerado. Chamados de suporte referentes a esta integração irão necessitar deste protocolo.

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#downloadDocumentsHistory"

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  

 downloadDocumentsHistory

 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

 qtdDocumentos

 inteiro

 Quantidade máxima de documentos que serão retornadas nessa consulta.


Exemplo da requisição
 

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
    <x:Header/>
    <x:Body>
        <urn:downloadDocumentsHistory>
            <urn:qtdDocumentos>10</urn: qtdDocumentos>
        </urn:downloadDocumentsHistory>
    </x:Body>
</x:Envelope>

Parâmetros de saída

 Atributo

 Tipo

 Descrição

 status

 string

 Mensagem de sucesso ou de erro para a chamada do método.

 protocolo

 string

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


Exemplo 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:urn:downloadDocumentsHistoryResponse>
            <status xsi:type="xsd:string">Exportação adicionada a fila com sucesso. Acompanhe o processamento utilizado o protocolo fornecido!</status>
            <protocolo xsi:type="xsd:string">201701105874d00016685</protocolo>
        </ns1:urn:downloadDocumentsHistoryResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Comments