WS115 - Receber Ocorrências Usando a Chave da Danfe

Objetivo

Receber todas as ocorrências que estão associadas a chave de uma Danfe.

Descrição do método


`Método`	getDanfeHistory
`WSDL`	https://soap.comprovei.com.br/exportQueue/index.php?wsdl

Importante

Nossas conexões são seguras utilizando o protocolo SSL. Por questão de segurança nossos certificados são alterados constantemente e sem aviso prévio. Portanto é recomendável que não desenvolvam as integrações baseadas em um certificado fixo.
Constantemente (e sem aviso prévio) adicionamos novos campos e estruturas tanto nas requisições quanto nas respostas dos nossos webservices. Quem for utilizar nossos webservices deve implementar de tal maneira que os programas que consomem estes webservices não deixem de funcionar quando houver as alterações de campos mencionadas.

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.

Exemplo cabeçalho HTTP com a autenticação

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#getDanfeHistory"
Authorization: Basic BASE64(user:password)
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Request

A requisição para o nosso Web Service é composta da seguinte forma:

TAG	Tipo	Descrição
`ChaveDanfe`	string	Chave associada a Danfe.

Exemplo de Request

<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:getDanfeHistory soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <ChaveDanfe xsi:type="xsd:string">351704619402920001375502200092</ChaveDanfe>
      </urn:getDanfeHistory>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG	Tipo	Descrição
`CodigoRetorno`	integer	Código da mensagem de retorno (ver tabela de Códigos de retorno).
`MensagemRetorno`	string	Mensagem de retorno (ver tabela de Códigos de retorno).
`Danfe`	element	Elemento Danfe.

Danfe

Contém todas as informações da danfe, caso seja encontrada alguma.

TAG	Tipo	Descrição
`Numero`	string	Número da Danfe.
`Serie`	string	Série da Danfe.
`Documento`	element	Contém informações do documento ao qual pertence esta Danfe. Ver Documento.
`Ocorrencias`	element	Lista de Ocorrencia.

Documento

Contém informação da documento associado a Danfe.

TAG	Tipo	Descrição
`Numero`	string	Número do documento.

Ocorrencia

Contém informação da ocorrência, caso alguma tenha sido apontada.

TAG	Tipo	Descrição
`Data`	string	Data e hora da ocorrência no formato: YYYY-MM-DD HH:MM:SS.
`Codigo`	string	Código da ocorrência.
`Descricao`	string	Descrição da ocorrência.
`Fotos`	element	Lista de Foto, caso existam.
`Rota`	element	Informações da rota associada a ocorrência, se existir. Ver mais em Rota.

Foto

Contém a URL para acessar a foto realizada na ocorrência.

TAG	Tipo	Descrição
`Foto`	string	URL de acesso a foto realizada na ocorrência.

Rota

Contém informação da rota associada a ocorrência, caso exista.

TAG	Tipo	Descrição
`Data`	string	Data da rota no formato: YYYY-MM-DD.
`Nome`	string	Nome da rota.
`Numero`	string	Número da rota.
`Placa`	string	Placa do veículo da rota.
`Regiao`	string	Região da rota.
`Transportadora`	element	Informações da transportadora responsável pela rota. Ver mais em Transportadora.
`Motorista`	element	Informações do motorista responsável pela rota. Ver mais em Motorista.

Transportadora

Contém informações da transportadora responsável pela rota

TAG	Tipo	Descrição
`CNPJ`	string	CNPJ da transportadora.
`Nome`	string	Nome da transportadora.

Motorista

Informações do motorista responsável pela rota

TAG	Tipo	Descrição
`Codigo`	string	Código do motorista.
`Nome`	string	Nome do motorista.

Códigos de retorno

Contém a lista de todos os possíveis códigos e mensagens de retono do método.

Código	Descrição
`0`	Chave não encontrada.
`1`	Chave encontrada.
`998`	Parâmetro de entrada não foi preenchido.
`999`	Usuário não autenticado.

Exemplos de Response

<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:getDanfeHistoryResponse>
         <CodigoRetorno xsi:type="xsd:integer">999</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">Usuário não autenticado!</MensagemRetorno>
         <Danfe xsi:nil="true" xsi:type="Danfe"/>
      </ns1:getDanfeHistoryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<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:getDanfeHistoryResponse>
         <CodigoRetorno xsi:type="xsd:integer">0</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">Chave não encontrada!</MensagemRetorno>
         <Danfe xsi:nil="true" xsi:type="Danfe"/>
      </ns1:getDanfeHistoryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<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:getDanfeHistoryResponse>
         <CodigoRetorno xsi:type="xsd:integer">1</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">Chave encontrada</MensagemRetorno>
         <Danfe xsi:type="Danfe">
            <Numero xsi:type="xsd:string">928460</Numero>
            <Serie xsi:type="xsd:string">22</Serie>
            <Documento xsi:type="Documento">
                <Numero xsi:type="xsd:string">31618</Numero>
            </Documento>
            <Ocorrencias xsi:type="Ocorrencias">
                <Ocorrencia xsi:type="Ocorrencia">
                    <Data xsi:type="xsd:string">2018-09-18 09:57:54</Data>
                    <Codigo xsi:type="xsd:string">0</Codigo>
                    <Descricao xsi:type="xsd:string">Entrega Normal</Descricao>
                    <Fotos xsi:type="Fotos">
                        <Foto xsi:type="xsd:string">http://images.comprovei.com.br/.....</Foto>
                    </Fotos>
                    <Rota xsi:type="Rota">
                        <Data xsi:type="xsd:string">2018-09-04</Data>
                        <Nome xsi:type="xsd:string">OSASCO</Nome>
                        <Numero xsi:type="xsd:string">159_400_2</Numero>
                        <Placa xsi:type="xsd:string">ELH1841</Placa>
                        <Regiao xsi:type="xsd:string">SPC</Regiao>
                        <Transportadora xsi:type="Transportadora">
                            <CNPJ xsi:type="xsd:string">17915300000101</CNPJ>
                            <Nome xsi:type="xsd:string">RONDOLOG TRANSPORTES LTDA</Nome>
                        </Transportadora>
                        <Motorista xsi:type="Motorista">
                            <Codigo xsi:type="xsd:string">00123104688</Codigo>
                            <Nome xsi:type="xsd:string">José Antonio Silva</Nome>
                        </Motorista>
                    </Rota>                    
                </Ocorrencia>
            </Ocorrencias>
         </Danfe>
      </ns1:getDanfeHistoryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>