WS076 - Consultar o status da rota

Objetivo

Receber as informações de uma rota. Exibe o status, a ultima ocorrência e

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#sendDocsToPOD"
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   getRouteStatus
 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
09/01/2015 rmiuraFormalização da versão 1.0
 30/04/2016 rmiura Alteração da url de conexão

Parâmetros de entrada
 Atributo Tipo Descrição
 numeroRota conjunto de caracteres Identificação da rota
 dataRota conjunto de caracteres Data da rota. obrigatório estar no formato YYYYMMDD
 codigoMotorista conjunto de caracteres Código do motorista atribuído a esta rota
 placa conjunto de caracteres Placa do veículo associado a rota. Obrigatório estar no formato AAAA9999 (sem hifen)

Estrutura do arquivo .xml de retorno

 Atributo Tipo Obrigatório Descrição
    StatusRota   Indicador do início da estrutura dos documentos
    +UltimaOcorrencia   Indicador do início da estrutura do documento
        NumeroParada string sim Número ou sequencia da parada
        StatusParada string sim  Status do documento nesta parada
        TipoDocumento string  sim Tipo do documento
        NumeroDocumento string sim Número do documento
        +Cliente   Indicador do início da estrutura do cliente
           Nome string sim Razão social ou nome do cliente
           Rua string sim Endereço - Logradouro, número
           Cidade string sim Endereço - Cidade
           Estado string sim Endereço - Estado 
           CEP string sim Código postal
           Telefone string sim Telefone (somente números, sem espaços ou hífen)
           Email string sim email
           Regiao string sim Região logística informada no documento
           Contato string sim Nome do contato no cliente
    +UltimoHistorico   Indicador do início da estrutura do último histórico
       Datahora data sim Data + hora do último histórico
       Evento string sim Descrição do evento
       Complemento string sim Complemento do evento

Exemplo de arquivo xml de retorno da consulta
<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:getRouteStatusResponse xmlns:ns1="urn:WebServiceComprovei">
         <Retorno xsi:type="tns:StatusRota">
            <StatusRota xsi:type="xsd:string">Em transito</StatusRota>
            <UltimaOcorrencia xsi:type="tns:Evento">
               <NumeroParada xsi:type="xsd:string">2</NumeroParada>
               <StatusParada xsi:type="xsd:string">Entregue</StatusParada>
               <TipoDocumento xsi:type="xsd:string">NFS</TipoDocumento>
               <NumeroDocumento xsi:type="xsd:string">4193055</NumeroDocumento>
               <Cliente xsi:type="tns:Cliente">
                  <Nome xsi:nil="true" xsi:type="xsd:string"/>
                  <Rua xsi:type="xsd:string">AV DA SAUDADE, 2</Rua>
                  <Cidade xsi:type="xsd:string">ITATIBA</Cidade>
                  <Estado xsi:type="xsd:string">SP</Estado>
                  <CEP xsi:type="xsd:string">13253000</CEP>
                  <Telefone xsi:type="xsd:string">1145382336</Telefone>
                  <Email xsi:type="xsd:string">COMERCIAL@COMPROVEI.COM.BR</Email>
                  <Regiao xsi:type="xsd:string">6 - GARULHOS</Regiao>
                  <Contato xsi:type="xsd:string">LUIS ANTONIO</Contato>
               </Cliente>
            </UltimaOcorrencia>
            <UltimoHistorico xsi:type="tns:Historico">
               <DataHora xsi:type="xsd:string">2016-01-15 10:14:09</DataHora>
               <Evento xsi:type="xsd:string">Fim do descarregamento</Evento>
               <Complemento xsi:type="xsd:string">4193055</Complemento>
            </UltimoHistorico>
         </Retorno>
      </ns1:getRouteStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>