WS106 - Receber Rotas Finalizadas

Objetivo

Receber todas as rotas que foram finalizadas. Uma vez consultado, essas rotas não serão disponibilizadas novamente em uma futura consulta.

Descrição do método


`Método`	getCompletedRoutes
`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#getCompletedRoutes"
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
`QtdRotas`	integer	Quantidade máxima de rotas que serão retornadas pela consulta.

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:getCompletedRoutes soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <QtdRotas xsi:type="xsd:integer">2</QtdRotas>
      </urn:getCompletedRoutes>
   </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).
`Rotas`	element	Contém o conjunto de rotas finalizadas e é composto por elementos Rota.

Rota

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

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.
`CodigoMotorista`	string	Código do motorista associado a rota.
`Placa`	string	Placa de veículo associada a rota.
`CodigoStatus`	integer	Código iInteiro que representa o status da rota.
`Status`	string	Nome do status da rota.
`DistanciaPercorrida`	string	Distância percorrida pelo motorista em metros.
`DistanciaPrevista`	string	Distância prevista para a rota em metros.
`SomaPesosDocumentos`	decimal	Peso total dos documentos da rota.
`Localizacao`	element	Contém a última latitude e longitude capturada do motorista. Ver Localização.
`DataHoraInicio`	string	Data e Hora de início da rota. Formato: YYYY-MM-DD HH:MM:SS.
`DataHoraFim`	string	Data e Hora de finalização da rota. Formato: YYYY-MM-DD HH:MM:SS.

Localização

Contém a última latitude e longitude capturada do motorista.

TAG	Tipo	Descrição
`Latitude`	Decimal	Posição de latitude no formato decimal.
`Longitude`	Decimal	Posição de longitude no formato decimal.

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`	Sem rotas para retornar.
`1`	N rota(s) finalizada(s).
`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:getCompletedRoutesResponse>
         <CodigoRetorno xsi:type="xsd:integer">999</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">Usuário não autenticado!</MensagemRetorno>
         <Rotas xsi:nil="true" xsi:type="Rotas"/>
      </ns1:getCompletedRoutesResponse>
   </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:getCompletedRoutesResponse>
         <CodigoRetorno xsi:type="xsd:integer">1</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">2 rota(s) finalizadas(s).</MensagemRetorno>
         <Rotas xsi:type="Rotas">
            <Rota xsi:type="Rota">
               <Data xsi:type="xsd:string">2017-08-04</Data>
               <Nome xsi:type="xsd:string">LI:SP-Limeira-Campinas</Nome>
               <Numero xsi:type="xsd:string">0002399459</Numero>
               <CodigoMotorista xsi:type="xsd:string">12622266782</CodigoMotorista>
               <Placa xsi:type="xsd:string">NKX4738</Placa>
               <CodigoStatus xsi:type="xsd:int">6</CodigoStatus>
               <Status xsi:type="xsd:string">Base</Status>
               <DistanciaPercorrida xsi:type="xsd:string">5023</DistanciaPercorrida>
               <DistanciaPrevista></DistanciaPrevista>
               <SomaPesosDocumentos></SomaPesosDocumentos>
               <Localizacao xsi:type="Localizacao">
                  <Latitude xsi:type="xsd:string">-22.4219137</Latitude>
                  <Longitude xsi:type="xsd:string">-45.4597297</Longitude>
               </Localizacao>
               <DataHoraInicio xsi:type="xsd:string">2017-08-24 15:22:40</DataHoraInicio>
               <DataHoraFim xsi:type="xsd:string">2017-08-24 15:24:08</DataHoraFim>
            </Rota>
            <Rota xsi:type="Rota">
               <Data xsi:type="xsd:string">2017-08-04</Data>
               <Nome xsi:nil="true"/>
               <Numero xsi:type="xsd:string">12/1/9999</Numero>
               <CodigoMotorista xsi:type="xsd:string">0017</CodigoMotorista>
               <Placa xsi:type="xsd:string">EIJ9079</Placa>
               <CodigoStatus xsi:type="xsd:int">6</CodigoStatus>
               <Status xsi:type="xsd:string">Base</Status>
               <DistanciaPercorrida xsi:type="xsd:string">2301</DistanciaPercorrida>
               <Localizacao xsi:type="Localizacao">
                  <Latitude xsi:type="xsd:string">-22.4219504</Latitude>
                  <Longitude xsi:type="xsd:string">-45.4597297</Longitude>
               </Localizacao>
               <DataHoraInicio xsi:type="xsd:string">2017-08-07 15:27:03</DataHoraInicio>
               <DataHoraFim xsi:type="xsd:string">2017-08-07 15:32:40</DataHoraFim>
            </Rota>
         </Rotas>
      </ns1:getCompletedRoutesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>