Objetivo
Esse método tem como objetivo, listar as rotas ativas.
Observações Importantes
- Não é possível realizar rajadas para esse método, a TARGET limita 50 requisições por minuto, aconselhamos requisições por demanda, caso o limite de 50 requisições seja ultrapassado, iremos bloquear as requisições apenas para o método que ultrapassou o limite durante 5 minutos.
- As rotas devem ser previamente cadastradas através da Plataforma Web ou através do método - CadastrarRoteiro.
Request
| ListarRotaClienteRequest | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | CodigoIBGEOrigem | int | Não | Código IBGE de Origem | N/A |
| 2 | CodigoIBGEDestino | int | Não | Código IBGE de Destino | N/A |
| 3 | NumeroPagina | int | Sim | Número da Página | N/A |
| 4 | QuantidadeItensPorPagina | int | Sim | Quantidade de Itens por página | Só realizamos a busca |
Response
| ListarRotaClienteResponse | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
| 2 | Itens | Sim | Itens de uma Página. | N/A | |
| 3 | NumeroPagina | int | Sim | Numero da pagina atual que está sendo exibida (1 - N). | N/A |
| 4 | QuantidadeItensPorPagina | int | Sim | Quantidade de itens por página nesta busca. | N/A |
| 5 | QuantidadeTotalItens | int | Sim | Quantidade total de itens que existe para a busca (em todas as páginas). | N/A |
| 6 | QuantidadeTotalPaginas | int | Sim | Quantidade total de páginas. | N/A |
| ListarRotasClienteResponse | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
| 2 | Mensagem | string | Sim | Mensagem de Retorno | N/A |
| 3 | Rotas | List<RotaResponse> | Não | Rotas do Cliente | N/A |
| RotaResponse | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
| 2 | IdRotaCliente | int | Sim | Id da Rota Cliente | Informamos apenas caso exista ao menos uma rota ativa. |
| 3 | NomeRota | string | Sim | Nome da Rota | Informamos apenas caso exista ao menos uma rota ativa. |
| 4 | DataHoraCadastro | Datetime(YYYY-MM-DD) | Data e Hora do Cadastro da Rota | Informamos apenas caso exista ao menos uma rota ativa. | |
| 5 | ValorCombustivel | decimal | Não | Valor Combustível | Informamos apenas caso exista ao menos uma rota ativa. |
| 6 | DistanciaPercorrida | decimal | Sim | Distância Percorrida | Informamos apenas caso exista ao menos uma rota ativa. |
| 7 | TempoViagem | double | Sim | Tempo da Viagem | Informamos apenas caso exista ao menos uma rota ativa. |
| 8 | Origem | string | Não | Origem | Informamos apenas caso exista ao menos uma rota ativa. |
| 9 | Destino | string | Não | Destino | Informamos apenas caso exista ao menos uma rota ativa. |
| 10 | DataHoraAtualizacao | Datetime(YYYY-MM-DD) | Não | Data e Hora da Atualização | Informamos apenas caso exista ao menos uma rota ativa. |
| 11 | Ativo | bool(true || false) | Sim | Ativo | Informamos apenas caso exista ao menos uma rota ativa. |
Método
Abaixo, segue método - 'ListarRotaClienteRequest.
ListarRotaClienteRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
<soapenv:Header/>
<soapenv:Body>
<tms:ListarRotas>
<tms:auth>
<tms:Usuario>?</tms:Usuario>
<tms:Senha>?</tms:Senha>
<tms:Token>?</tms:Token>
</tms:auth>
<tms:listarRotasRequest>
<tms:CodigoIBGEOrigem>?</tms:CodigoIBGEOrigem>
<tms:CodigoIBGEDestino>?</tms:CodigoIBGEDestino>
<tms:NumeroPagina>?</tms:NumeroPagina>
<tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina>
</tms:listarRotasRequest>
</tms:ListarRotas>
</soapenv:Body>
</soapenv:Envelope>
Listar Rotas - Exemplo 1
Abaixo, segue exemplo do método - 'ListarRotas' (Buscando apenas uma Rota ativa).
Exemplo 1 - ListarRotaClienteRequest
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<tms:ListarRotas>
<tms:auth>
<tms:Usuario>tms.exemplo</tms:Usuario>
<tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
<tms:Token i:nil="true" />
</tms:auth>
<tms:listarRotasRequest>
<tms:CodigoIBGEOrigem>4213203</tms:CodigoIBGEOrigem>
<tms:CodigoIBGEDestino>4211900</tms:CodigoIBGEDestino>
<tms:NumeroPagina>1</tms:NumeroPagina>
<tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina>
</tms:listarRotasRequest>
</tms:ListarRotas>
</soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tmsfrete.v2.targetmp.com.br/FreteTMSService/ListarRotasResponse</Action>
</s:Header>
<s:Body>
<ListarRotasResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
<ListarRotasResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Erro i:nil="true" />
<Itens>
<ListarRotasClienteResponse>
<Erro i:nil="true" />
<Mensagem>Rotas ativas obtidas com sucesso!</Mensagem>
<Rotas>
<RotaResponse>
<Erro i:nil="true" />
<IdRotaCliente>47672</IdRotaCliente>
<NomeRota>POM_SC0183 </NomeRota>
<DataHoraCadastro>2018-04-02T10:00:52.367</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>168.03</DistanciaPercorrida>
<TempoViagem>8160</TempoViagem>
<Origem>Pomerode, SC</Origem>
<Destino>Palhoça, SC</Destino>
<DataHoraAtualizacao>2018-04-02T10:00:52.383</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
</Rotas>
</ListarRotasClienteResponse>
</Itens>
<NumeroPagina>1</NumeroPagina>
<QuantidadeItensPorPagina>20</QuantidadeItensPorPagina>
<QuantidadeTotalItens>1</QuantidadeTotalItens>
<QuantidadeTotalPaginas>1</QuantidadeTotalPaginas>
</ListarRotasResult>
</ListarRotasResponse>
</s:Body>
</s:Envelope>
Listar Rotas - Exemplo 2
Abaixo, segue exemplo do método - 'ListarRotas' (Buscando N Rotas ativas).
Exemplo 2 - ListarRotaClienteRequest
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<tms:ListarRotas>
<tms:auth>
<tms:Usuario>tms.exemplo</tms:Usuario>
<tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
<tms:Token i:nil="true" />
</tms:auth>
<tms:listarRotasRequest>
<tms:CodigoIBGEOrigem i:nil="true" />
<tms:CodigoIBGEDestino i:nil="true" />
<tms:NumeroPagina>1</tms:NumeroPagina>
<tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina>
</tms:listarRotasRequest>
</tms:ListarRotas>
</soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ListarRotasResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
<ListarRotasResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Erro i:nil="true"/>
<Itens>
<ListarRotasClienteResponse>
<Erro i:nil="true"/>
<Mensagem>Rotas ativas obtidas com sucesso!</Mensagem>
<Rotas>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10</IdRotaCliente>
<NomeRota>RIO X SAO PAULO 2</NomeRota>
<DataHoraCadastro>2018-01-08T16:33:43.407</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>461.76</DistanciaPercorrida>
<TempoViagem>20400</TempoViagem>
<Origem>Itapevi, SP</Origem>
<Destino>Rio de Janeiro, RJ</Destino>
<DataHoraAtualizacao>2018-01-08T16:33:43.417</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>570</IdRotaCliente>
<NomeRota>CABACEIRAS</NomeRota>
<DataHoraCadastro>2015-07-15T18:30:59.157</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>3216.49</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Curuá, PA</Origem>
<Destino>Cabaceiras, PB</Destino>
<DataHoraAtualizacao>2015-07-15T18:30:59.263</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>571</IdRotaCliente>
<NomeRota>CABA</NomeRota>
<DataHoraCadastro>2015-07-15T18:34:00.843</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>201.87</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Cabanas, PE</Origem>
<Destino>Cabaceiras, PB</Destino>
<DataHoraAtualizacao>2015-07-15T18:34:00.843</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>572</IdRotaCliente>
<NomeRota>Rio X Barra X Vassouras</NomeRota>
<DataHoraCadastro>2016-03-29T20:07:08.547</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>161.80</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Rio de Janeiro, RJ</Origem>
<Destino>Vassouras, RJ</Destino>
<DataHoraAtualizacao>2016-03-29T20:07:08.55</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>573</IdRotaCliente>
<NomeRota>VASSOURAS X BARRA X RIO</NomeRota>
<DataHoraCadastro>2016-03-29T20:13:10.987</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>162.11</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Vassouras, RJ</Origem>
<Destino>Rio de Janeiro, RJ</Destino>
<DataHoraAtualizacao>2016-03-29T20:13:10.993</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>575</IdRotaCliente>
<NomeRota>SEROPÉDICA X BARRA</NomeRota>
<DataHoraCadastro>2016-03-31T21:27:36.667</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>80.00</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Seropédica, RJ</Origem>
<Destino>Barra da Tijuca, RJ</Destino>
<DataHoraAtualizacao>2016-03-31T21:27:36.84</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>576</IdRotaCliente>
<NomeRota>ROTA VITOR COSTA</NomeRota>
<DataHoraCadastro>2016-07-21T16:58:29.893</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>73.13</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Queimados, RJ</Origem>
<Destino>Barra da Tijuca, RJ</Destino>
<DataHoraAtualizacao>2016-07-21T16:58:30.047</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>587</IdRotaCliente>
<NomeRota>PASSARINHO</NomeRota>
<DataHoraCadastro>2016-12-16T10:56:25.74</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>1390.32</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Curatis, CE</Origem>
<Destino>Soure, PA</Destino>
<DataHoraAtualizacao>2016-12-16T10:56:25.76</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>593</IdRotaCliente>
<NomeRota>HOJJJJJEEEEE</NomeRota>
<DataHoraCadastro>2016-12-16T16:50:35.187</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>5765.30</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Rio da Dona, BA</Origem>
<Destino>Juruá, AM</Destino>
<DataHoraAtualizacao>2016-12-16T16:50:38.687</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>594</IdRotaCliente>
<NomeRota>8778878787</NomeRota>
<DataHoraCadastro>2016-12-16T17:08:25.55</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>2576.49</DistanciaPercorrida>
<TempoViagem>0</TempoViagem>
<Origem>Canas, SP</Origem>
<Destino>Cariús, CE</Destino>
<DataHoraAtualizacao>2016-12-16T17:08:25.577</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>2660</IdRotaCliente>
<NomeRota>ROTEIROTESTEVIRADA3</NomeRota>
<DataHoraCadastro>2018-01-08T16:30:07.643</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>266.18</DistanciaPercorrida>
<TempoViagem>12540</TempoViagem>
<Origem>Itapevi, SP</Origem>
<Destino>Piracicaba, SP</Destino>
<DataHoraAtualizacao>2018-01-08T16:30:07.787</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>2661</IdRotaCliente>
<NomeRota>ROTEIROTESTEVIRADA34</NomeRota>
<DataHoraCadastro>2018-01-08T16:37:57.173</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>70.53</DistanciaPercorrida>
<TempoViagem>3360</TempoViagem>
<Origem>Itapevi, SP</Origem>
<Destino>Itu, SP</Destino>
<DataHoraAtualizacao>2018-01-08T16:37:57.187</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>2752</IdRotaCliente>
<NomeRota>TESTE</NomeRota>
<DataHoraCadastro>2018-05-03T15:27:55.673</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>2072.23</DistanciaPercorrida>
<TempoViagem>95520</TempoViagem>
<Origem>Rio de Janeiro, RJ</Origem>
<Destino>Acauã, PI</Destino>
<DataHoraAtualizacao>2018-05-03T15:27:56.003</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>2753</IdRotaCliente>
<NomeRota>TESTESTERSTE</NomeRota>
<DataHoraCadastro>2018-05-03T15:33:48.13</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>707.63</DistanciaPercorrida>
<TempoViagem>31560</TempoViagem>
<Origem>Embu das Artes, SP</Origem>
<Destino>Videira, SC</Destino>
<DataHoraAtualizacao>2018-05-03T15:33:48.14</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10169</IdRotaCliente>
<NomeRota>X STS</NomeRota>
<DataHoraCadastro>2018-08-27T15:45:37.14</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>701.36</DistanciaPercorrida>
<TempoViagem>33682</TempoViagem>
<Origem>Narandiba, SP</Origem>
<Destino>Santos, SP</Destino>
<DataHoraAtualizacao>2018-08-27T15:45:37.493</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10170</IdRotaCliente>
<NomeRota>PEIS X SP</NomeRota>
<DataHoraCadastro>2018-08-27T15:49:20.853</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>1318.64</DistanciaPercorrida>
<TempoViagem>57483</TempoViagem>
<Origem>Pedrinópolis, MG</Origem>
<Destino>Querência, MT</Destino>
<DataHoraAtualizacao>2018-08-27T15:49:20.857</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10171</IdRotaCliente>
<NomeRota>ROTA12345</NomeRota>
<DataHoraCadastro>2018-08-27T16:51:31.257</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>1665.87</DistanciaPercorrida>
<TempoViagem>79981</TempoViagem>
<Origem>Porto Seguro, BA</Origem>
<Destino>Rio Grande da Serra, SP</Destino>
<DataHoraAtualizacao>2018-08-27T16:51:31.257</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10172</IdRotaCliente>
<NomeRota>ROTA123456</NomeRota>
<DataHoraCadastro>2018-08-27T16:31:00.85</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>1665.87</DistanciaPercorrida>
<TempoViagem>79981</TempoViagem>
<Origem>Porto Seguro, BA</Origem>
<Destino>Rio Grande da Serra, SP</Destino>
<DataHoraAtualizacao>2018-08-27T16:31:00.857</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
<RotaResponse>
<Erro i:nil="true"/>
<IdRotaCliente>10173</IdRotaCliente>
<NomeRota>ROTA_TESTE123</NomeRota>
<DataHoraCadastro>2018-08-27T16:51:08.737</DataHoraCadastro>
<ValorCombustivel>0.00</ValorCombustivel>
<DistanciaPercorrida>1090.64</DistanciaPercorrida>
<TempoViagem>46882</TempoViagem>
<Origem>Rio de Janeiro, RJ</Origem>
<Destino>Belo Horizonte, MG</Destino>
<DataHoraAtualizacao>2018-08-27T16:51:09.083</DataHoraAtualizacao>
<Ativo>true</Ativo>
</RotaResponse>
</Rotas>
</ListarRotasClienteResponse>
</Itens>
<NumeroPagina>1</NumeroPagina>
<QuantidadeItensPorPagina>20</QuantidadeItensPorPagina>
<QuantidadeTotalItens>1</QuantidadeTotalItens>
<QuantidadeTotalPaginas>1</QuantidadeTotalPaginas>
</ListarRotasResult>
</ListarRotasResponse>
</s:Body>
</s:Envelope>