Consulta Rotas

Consulta Rotas (Get_ConsultaRotas)

O método Get_ConsultaRotas consulta rotas

Campos obrigatórios : iCodigoInicial

*Esse método traz 100 registro por vez. Na primeira solitação sempre enviar iCodigoInicial=0, quando o receber o retorno do WS se o campo iQtdRota conter a quantidade de 100 registros, possivélmente terá mais informações, então o campo iCodigoInicial deve conter as informações que retornarem no campo iUltCodigo, dessa forma na próxima consulta o WS vai retornar os próximos 100 Registros.

Tabela de campos de envio para consulta de rotas

Grupo/Campo	Tipo	Descrição	Observação	Obrigatório
iCodigoInicial	int	Código inicial para retorno de dados		Sim

Tabela de campos de retorno para consulta de rotas

Grupo/Campo	Tipo	Descrição	Observação
iQtdRota	int	Quantidade total de rotas retornadas
iUltCodigo	int	Último código retornado
DadosRota		Grupo de rotas cadastradas
iCodigo	int	Código identificador da rota
sNomeRota	string	Nome completo da rota
sApelido	string	Apelido ou nome alternativo da rota
sAtivo	string	Indica se a rota está ativa (S/N)	Valores esperados: "SIM" ou "NAO"
sIBGE_Origem	string	Código IBGE da cidade de origem
sLat_Origem	string	Latitude do ponto de origem
sLng_Origem	string	Longitude do ponto de origem
sIBGE_Destino	string	Código IBGE da cidade de destino
sLat_Destino	string	Latitude do ponto de destino
sLng_Destino	string	Longitude do ponto de destino
PontosPassagem		Grupo de pontos intermediários da rota
iSequencia	int	Ordem do ponto de passagem na rota
sLatitude	string	Latitude do ponto de passagem
sLongitude	string	Longitude do ponto de passagem
sNmReferencia	string	Nome de referência do ponto de passagem

Exemplo do Envio/Retorno para solicitação de posição do veículo

XML de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Get_ConsultaCNPJ xmlns="http://tempuri.org/">
      <Login>
        <sUserName>string</sUserName>
        <sPassWord>string</sPassWord>
        <sToken>string</sToken>
      </Login>
      <Controle>
        <iCodigoInicial>int</iCodigoInicial>
      </Controle>
    </Get_ConsultaCNPJ>
  </soap:Body>
</soap:Envelope>

XML de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Get_ConsultaRotasResponse xmlns="http://tempuri.org/">
      <Get_ConsultaRotasResult>
        <iQtdRota>int</iQtdRota>
        <iUltCodigo>int</iUltCodigo>
        <DadosRota>
          <stDadosRota>
            <iCodigo>int</iCodigo>
            <sNomeRota>string</sNomeRota>
            <sApelido>string</sApelido>
            <sAtivo>string</sAtivo>
            <sIBGE_Origem>string</sIBGE_Origem>
            <sLat_Origem>string</sLat_Origem>
            <sLng_Origem>string</sLng_Origem>
            <sIBGE_Destino>string</sIBGE_Destino>
            <sLat_Destino>string</sLat_Destino>
            <sLng_Destino>string</sLng_Destino>
            <PontosPassagem>
              <stPontosPassagem>
                <iSequencia>int</iSequencia>
                <sLatitude>string</sLatitude>
                <sLongitude>string</sLongitude>
                <sNmReferencia>string</sNmReferencia>
              </stPontosPassagem>
              <stPontosPassagem>
                <iSequencia>int</iSequencia>
                <sLatitude>string</sLatitude>
                <sLongitude>string</sLongitude>
                <sNmReferencia>string</sNmReferencia>
              </stPontosPassagem>
            </PontosPassagem>
          </stDadosRota>
          <stDadosRota>
            <iCodigo>int</iCodigo>
            <sNomeRota>string</sNomeRota>
            <sApelido>string</sApelido>
            <sAtivo>string</sAtivo>
            <sIBGE_Origem>string</sIBGE_Origem>
            <sLat_Origem>string</sLat_Origem>
            <sLng_Origem>string</sLng_Origem>
            <sIBGE_Destino>string</sIBGE_Destino>
            <sLat_Destino>string</sLat_Destino>
            <sLng_Destino>string</sLng_Destino>
            <PontosPassagem>
              <stPontosPassagem>
                <iSequencia>int</iSequencia>
                <sLatitude>string</sLatitude>
                <sLongitude>string</sLongitude>
                <sNmReferencia>string</sNmReferencia>
              </stPontosPassagem>
              <stPontosPassagem>
                <iSequencia>int</iSequencia>
                <sLatitude>string</sLatitude>
                <sLongitude>string</sLongitude>
                <sNmReferencia>string</sNmReferencia>
              </stPontosPassagem>
            </PontosPassagem>
          </stDadosRota>
        </DadosRota>
        <Retorno>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
        </Retorno>
      </Get_ConsultaRotasResult>
    </Get_ConsultaRotasResponse>
  </soap:Body>
</soap:Envelope>