WS106 - 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.

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/exportQueue/index.php HTTP/1.1

Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#getCompletedRoutes"
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  

 getCompletedRoutes

 Endereço de acesso

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

 Versão atual

1.0 (03/07/2017)

 

Parâmetros de entrada

 Atributo

 Tipo

Obrigatório

 Descrição

 QtdRotas

 Inteiro

Sim

 Quantidade máxima de rotas a ser recebida por chamada.

Estrutura da requisição

Parâmetros de saída

 Atributo

 Tipo

 Descrição

 CodigoRetorno

 Inteiro

 Código da mensagem de retorno.

 MensagemRetorno

 Conjunto de caracteres

 Mensagem de retorno.

 Rotas

 Estrutura Rotas

 Contém o conjunto de rotas finalizadas. Formado por N estrutura Rota.

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

 Atributo

 Tipo

 Descrição

 Data

 Conjunto de caracteres

 Data da rota no formato: YYYY-MM-DD.

 Nome

 Conjunto de caracteres

 Nome da rota.

 Numero

 Conjunto de caracteres

 Número da rota.

 CodigoMotorista

 Conjunto de caracteres

 Motorista associado a rota.

 Placa

 Conjunto de caracteres

 Placa de veículo associada a rota.

 CodigoStatus

 Inteiro

 Inteiro que representa o status da rota.

 Status

 Conjunto de caracteres

 Nome do status da rota.

 Localizacao

 Estrutura Localizacao

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

 DataHoraInicio

 Conjunto de caracteres

 Data e Hora de início da rota. Formato: YYYY-MM-DD HH:MM:SS

 DataHoraFim

 Conjunto de caracteres

Data e Hora de finalização da rota. Formato: YYYY-MM-DD HH:MM:SS

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

 Atributo

 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.

 Código

 Descrição

 0

 Sem rotas para retornar.

 1

 X rota(s) finalizada(s).

 998

 Parâmetro de entrada não foi preenchido.

 999

 Usuário não autenticado.

Estrutura da saída

<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">0</CodigoRetorno>
         <MensagemRetorno xsi:type="xsd:string">Sem rotas para retornar.</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="xsd:Rotas">
             <Rota xsi:type="Rota">
                   <Data xsi:type="xsd:string">2017-06-12</Data>
                   <Nome xsi:type="xsd:string">OSASCO</Nome>
                   <Numero xsi:type="xsd:string">9577</Numero>
                   <CodigoMotorista xsi:type="xsd:string">159500</CodigoMotorista>
                   <Placa xsi:type="xsd:string">ELW2173</Placa>
                   <CodigoStatus xsi:type="xsd:int">6</CodigoStatus>
                   <Status xsi:type="xsd:string">Base</Status>
                   <Localizacao xsi:type="Localizacao">
                         <Latitude xsi:type="xsd:string">-23.5053339</Latitude>
                         <Longitude xsi:type="xsd:string">-46.8358987</Longitude>
                  </Localizacao>
                  <DataHoraInicio>2017-06-12 08:16:16</DataHoraInicio>
                  <DataHoraFim>2017-06-12 12:42:07</DataHoraFim>
            </Rota>
            <Rota xsi:type="Rota">
                   <Data xsi:type="xsd:string">2017-06-12</Data>
                   <Nome xsi:type="xsd:string">UMUARAMA </Nome>
                   <Numero xsi:type="xsd:string">542_090_2</Numero>
                   <CodigoMotorista xsi:type="xsd:string">542090</CodigoMotorista>
                   <Placa xsi:type="xsd:string">PUE0222</Placa>
                   <CodigoStatus xsi:type="xsd:int">6</CodigoStatus>
                   <Status xsi:type="xsd:string">Base</Status>
                   <Localizacao xsi:type="Localizacao">
                         <Latitude xsi:type="xsd:string">-22.42184306</Latitude>
                         <Longitude xsi:type="xsd:string">-45.45987337</Longitude>
                  </Localizacao>
                  <DataHoraInicio>2017-06-12 09:15:47</DataHoraInicio>
                  <DataHoraFim>2017-06-12 15:33:21</DataHoraFim>
            </Rota>
        </Rotas>
      </ns1:getCompletedRoutesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>