WS101 - Receber rotas finalizadas

Objetivo

Receber as informações de uma rota FINALIZADA. Uma rota é considerada finalizada quando seu status é igual a BASE. Rotas com status diferente de BASE não são acessíveis por este método.

Características
  • As chamadas serão realizadas via "SOAP" sobre HTTP;
  • 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 http://soap.comprovei.com.br/WebServicePOD/server.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#getDocFromPOD"
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   getDocFromPOD
 Endereço de acesso http://soap.comprovei.com.br/WebServicePOD/server.php?wsdl
 Versão atual 2.2 (30/04/2016)

Histórico das versões
 Data Responsável Histórico
22/10/2015 rmiuraFormalização da versão 2.0
 30/04/2016 rmiura Alteração da url de conexão

Parâmetros de entrada
 Atributo Tipo Descrição
 numeroRota conjunto de caracteres Id da rota. Identificação da rota no sistema Comprovei. É necessário que a rota esteja com status BASE. Caso contrário não serão disponibilizadas as informações.
 dataRota conjunto de caracteres Data atribuída à rota. Uma mesma rota pode ter várias datas. É obrigatório informar a data no formato YYYYMMDD. Não confundir esta data como sendo a data da consulta ou qualquer outra data que não seja a data da rota.

Estrutura do arquivo .xml de retorno

 Atributo Tipo Obrigatório Descrição
+Rota                  


     Numero string sim Identificação da rota. Retorna o mesmo valor informado nos parâmetros de entrada.
     Data string sim Data da rota. Retorna o mesmo valor informado nos parâmetros de entrada.
   +Paradas   Indicador do início da estrutura das paradas. Cada Parada representa um documento de entrega ou coleta.
      +Parada   Indicador do início da estrutura da parada.
         Numerostring  sim Número do documento associado a esta parada.
         +Itens   Indicador do inicio da estrutura dos itens desta parada/documento.
            +Item   Indicador do início da estrutura do item.
               Numero string sim Sequencia do item no documento (sempre inicia do numero 1).
               Descricao string sim Descrição do item.
               Barcode string sim Barcode do item.
               Quantidade string sim Quantidade conferida do item no forma x / y, onde x = quantidade conferida e y = quantidade total do item.
               Foto string não Foto do item codificado no formato BASE64
               Motivo    string não Motivo da não entrega de um item caso o motorista faça a justificativa.
         +Ocorrências   Indicador do início da estrutura das ocorrências desta parada/documento. Uma parada/documento pode ter várias ocorrências na rota.
            +Ocorrencia   Indicador do início da estrutura da ocorrência.
               Numero string sim Id da ocorrência. Este número é único e não se repete pois representa a chave do registro em nossa base de dados.
               Motivo string sim Código da ocorrência + descrição da ocorrência.
               +Assinatura   Indicador do início da estrutura da assinatura.
                  Extensao string sim informa tipo do arquivo imagem da assinatura.
                  Nome string nao Informação adicionada na assinatura como nome, RG, etc de quem assinou.
                  Dado string sim Imagem da assinatura codificada no formato BASE64.
               Anotacao string sim Texto digitado no campo anotação.
               +Foto   Indicador do início da estrutura da foto.
                  Extensao string sim informa tipo do arquivo imagem da foto.
                  Tipo string nao *** desativado ****
                  Comentario  string nao Legenda da foto, informada pelo motorista.
                  Dado string sim Imagem da foto codificada no formato BASE64.
   +Pausas   Indicador do início da estrutura de pausas. Em uma rota pode ocorrer diversas pausas.
       +Pausa   Indicador do início da pausa.
          Numero string sim Sequencia da pausa. Sempre inicia a partir do número .
          DataHoraIni string sim Horário de início da pausa no formato yyyymmdd hh:mm:ss
          DataHoraFim string sim Horário de fim da pausa no formato yyyymmdd hh:mm:ss
          Motivo   Código da pausa + descrição da pausa.
          Anotacao string sim Texto digitado no campo anotação.
          +Foto   Indicador do início da estrutura da foto.
             Extensao string sim informa tipo do arquivo imagem da foto.
             Tipo string nao *** desativado ****
             Comentario string nao Legenda da foto, informada pelo motorista.
             Dado string sim Imagem da foto codificada no formato BASE64.

Exemplo de arquivo xml
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 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/" xmlns:tns="urn:WebServiceComprovei">
   <SOAP-ENV:Body>
      <ns1:getDocFromPODResponse xmlns:ns1="urn:WebServiceComprovei">
         <Rota xsi:type="tns:Rota">
            <Numero xsi:type="xsd:string">EXEMPLO</Numero>
            <Data xsi:type="xsd:string">20150210</Data>
            <Paradas xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Parada[5]">
               <Parada xsi:type="tns:Parada">
                  <Numero xsi:type="xsd:string">247834</Numero>
                  <Itens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Item[3]">
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Descricao xsi:type="xsd:string">PERFORMANCE H A 15KG</Descricao>
                        <Barcode xsi:type="xsd:string">7896181211754</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">2</Numero>
                        <Descricao xsi:type="xsd:string">OBESITY CANINE 10,1kg</Descricao>
                        <Barcode xsi:type="xsd:string">7896181213598</Barcode>
                        <Quantidade xsi:type="xsd:string">2 / 2</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">3</Numero>
                        <Descricao xsi:type="xsd:string">FRANGO 10,1KG</Descricao>
                        <Barcode xsi:type="xsd:string">7896181212607</Barcode>
                        <Quantidade xsi:type="xsd:string">2 / 2</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                  </Itens>
                  <Ocorrencias xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ocorrencia[1]">
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Motivo xsi:type="xsd:string">0 - Entrega Normal</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao"/>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Ocorrencia>
                  </Ocorrencias>
               </Parada>
               <Parada xsi:type="tns:Parada">
                  <Numero xsi:type="xsd:string">215203</Numero>
                  <Itens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Item[4]">
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Descricao xsi:type="xsd:string">VOLUME 5003 294755 ML E 0001 5003 ZL</Descricao>
                        <Barcode xsi:type="xsd:string">0078912450001</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">2</Numero>
                        <Descricao xsi:type="xsd:string">VOLUME 5003 294755 ES E 0001 5003 ZL</Descricao>
                        <Barcode xsi:type="xsd:string">0078912450002</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">3</Numero>
                        <Descricao xsi:type="xsd:string">VOLUME 5003 294755 ES E 0003 5003 ZL</Descricao>
                        <Barcode xsi:type="xsd:string">0078912450003</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">4</Numero>
                        <Descricao xsi:type="xsd:string">VOLUME 5003 294755 ES E 0002 5003 ZL</Descricao>
                        <Barcode xsi:type="xsd:string">0078912450004</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                  </Itens>
                  <Ocorrencias xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ocorrencia[1]">
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Motivo xsi:type="xsd:string">0 - Entrega Normal</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao"/>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Ocorrencia>
                  </Ocorrencias>
               </Parada>
               <Parada xsi:type="tns:Parada">
                  <Numero xsi:type="xsd:string">193055</Numero>
                  <Itens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Item[2]">
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Descricao xsi:type="xsd:string">PALETE 189004161920001</Descricao>
                        <Barcode xsi:type="xsd:string">189004161920001</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">2</Numero>
                        <Descricao xsi:type="xsd:string">PALETE 189004161920002</Descricao>
                        <Barcode xsi:type="xsd:string">189004161920002</Barcode>
                        <Quantidade xsi:type="xsd:string">0 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                  </Itens>
                  <Ocorrencias xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ocorrencia[3]">
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Motivo xsi:type="xsd:string">001 - Entrega com Restrição</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao"/>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Ocorrencia>
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">2</Numero>
                        <Motivo xsi:type="xsd:string">001 - Entrega com Restrição</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao">
                           <Anotacao xsi:type="xsd:string">Faltou um palete</Anotacao>
                        </Anotacao>
                        <Foto xsi:type="tns:Foto"/>
                     </Ocorrencia>
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">3</Numero>
                        <Motivo xsi:type="xsd:string">054 - Fora do horario</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao"/>
                        <Foto xsi:type="tns:Foto"/>
                     </Ocorrencia>
                  </Ocorrencias>
               </Parada>
               <Parada xsi:type="tns:Parada">
                  <Numero xsi:type="xsd:string">193057</Numero>
                  <Itens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Item[1]">
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Descricao xsi:type="xsd:string">CONTAINER FSCU 420622</Descricao>
                        <Barcode xsi:type="xsd:string">FSCU420622042G1</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto"/>
                     </Item>
                  </Itens>
                  <Ocorrencias xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ocorrencia[1]">
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Motivo xsi:type="xsd:string">001 - Entrega com Restrição</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao">
                           <Anotacao xsi:type="xsd:string">Avaria</Anotacao>
                        </Anotacao>
                        <Foto xsi:type="tns:Foto"/>
                     </Ocorrencia>
                  </Ocorrencias>
               </Parada>
               <Parada xsi:type="tns:Parada">
                  <Numero xsi:type="xsd:string">140231</Numero>
                  <Itens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Item[2]">
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Descricao xsi:type="xsd:string">DANFE 561606</Descricao>
                        <Barcode xsi:type="xsd:string">35140861079117010402550110005616061314395516</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Item>
                     <Item xsi:type="tns:Item">
                        <Numero xsi:type="xsd:string">2</Numero>
                        <Descricao xsi:type="xsd:string">DANFE 561607</Descricao>
                        <Barcode xsi:type="xsd:string">35140861079117010402550110005616071965483330</Barcode>
                        <Quantidade xsi:type="xsd:string">1 / 1</Quantidade>
                        <Foto xsi:type="tns:Foto">
                           <Extensao xsi:type="xsd:string">jpg</Extensao>
                           <Tipo xsi:type="xsd:string"/>
                           <Comentario xsi:type="xsd:string"/>
                           <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                        </Foto>
                     </Item>
                  </Itens>
                  <Ocorrencias xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ocorrencia[1]">
                     <Ocorrencia xsi:type="tns:Ocorrencia">
                        <Numero xsi:type="xsd:string">1</Numero>
                        <Motivo xsi:type="xsd:string">0 - Entrega Normal</Motivo>
                        <Assinatura xsi:type="tns:Assinatura"/>
                        <Anotacao xsi:type="tns:Anotacao"/>
                        <Foto xsi:type="tns:Foto"/>
                     </Ocorrencia>
                  </Ocorrencias>
               </Parada>
            </Paradas>
            <Pausas xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Pausa[1]">
               <Pausa xsi:type="tns:Pausa">
                  <Numero xsi:type="xsd:string">1</Numero>
                  <DataHoraIni xsi:type="xsd:string">20151022 11:00:59</DataHoraIni>
                  <DataHoraFim xsi:type="xsd:string">20151022 11:01:14</DataHoraFim>
                  <Motivo xsi:type="xsd:string">202 - Problema no veiculo</Motivo>
                  <Foto xsi:type="tns:Foto">
                     <Extensao xsi:type="xsd:string">jpg</Extensao>
                     <Tipo xsi:type="xsd:string"/>
                     <Comentario xsi:type="xsd:string"/>
                     <Dado xsi:type="xsd:string">{foto codificada no formato BASE64}</Dado>
                  </Foto>
               </Pausa>
            </Pausas>
         </Rota>
      </ns1:getDocFromPODResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>