Objetivo
Esse método tem como objetivo, listar as rotas ativas.
Observações Importantes
- 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 | Não | Número da Página | N/A |
4 | QuantidadeItensPorPagina | int | Não | 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
Abaixo, segue exemplo do método - 'ListarRotas' (Buscando apenas uma Rota ativa).
Exemplo - 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>