DOCUMENTAÇÃO CORPORATIVA
ObterCustoRota
Objetivo
Esse método tem como objetivo obter os valores de uma rota.
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.
- Quando a TAG - 'ModoPagamentoRota' for igual a 1 (Cartão Transportes Bradesco TARGET), olhar para a TAG - 'ValorPedagioViaFacil' no response do método - 'ObterCustoRota'.
- Quando a TAG - 'ModoPagamentoRota' for igual a 2 (Via Fácil (Sem Parar)), olhar para a TAG - 'ValorPedagioTARGET' no response do método - 'ObterCustoRota'.
Request
ObtencaoCustoRotaRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | CategoriaVeiculo | int | Sim | Categoria do Veículo | |
2 | IdRotaModelo | int | Sim | Código identificador da rota no Sistema TARGET Frete. | N/A |
3 | ModoPagamentoRota | int | Sim | Informar em qual modo o pagamento será realizado. Podendo sofrer alteração de valores. | 1= Cartão Transportes Bradesco TARGET 2= Via Fácil (Sem Parar) 3= Veloe 6= ConectCar 7= Move Mais 8= Débito 9= Taggy |
Response
ObtencaoCustoRotaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em casa de sucesso. |
2 | Paradas | Lista | Sim | List<ConsultaRotaMapLinkParadaResponse> | 0= Rota padrão, mais, rápida 1= Rota padrão, mais curta 2= Rota “à pé”, (pedestre) 6= Rota evitando balsas 7= Rota evitando estradas de terra 8= Rota evitando balsas e estradas de terra 9= Rota evitando estradas em condições precárias 10= Rota evitando pedágios 24= Rota padrão mais rápida, com o tempo considerando trânsito 25= Rota padrão mais curta com o tempo considerando trânsito |
3 | Pedagios | Lista | Sim | List<ConsultaRotaMapLinkPedagiosResponse> | N/A |
4 | Otimizada | bool(true || false) | Sim | Otimizada | N/A |
5 | Tipo | int | Sim | Tipo | N/A |
6 | CategoriaVeiculo | int | Sim | Retorna a Categoria do Veículo. | |
7 | ValorPedagioTotal | decimal | Sim | Valor Pedágio Total | N/A |
8 | ValorPedagioTARGET | decimal | Sim | N/A | |
9 | ValorPedagioViaFacil | decimal | Sim | Valor Variavel conforme modo de compra de pedágio | |
10 | IdRotaCliente | int | Sim | N/A | |
11 | NomeRotaCliente | string | Sim | N/A | |
12 | DescricaoCategoriaVeiculo | string | Sim | Descrição da categoria do veículo mediante valor informado no request. | N/A |
13 | IdOrigemRota | int | Sim | ID Origem da Rota. | N/A |
14 | NomeOrigemRota | string | Sim | Nome Origem da Rota. | N/A |
15 | CodigoIBGEOrigemRota | int | Sim | Código IBGE de Origem da Rota. | N/A |
16 | IdDestinoRota | int | Sim | Id do Destino da Rota. | N/A |
17 | NomeDestinoRota | string | Sim | Nome do Destino da Rota. | N/A |
18 | CodigoIBGEDestinoRota | int | Sim | Código IBGE Destino da Rota. | N/A |
ConsultaRotaMapLinkParadaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em casa de sucesso. |
2 | Descricao | string | Não | Descrição | N/A |
3 | PontoX | double | Sim | Ponto X | N/A |
4 | PontoY | double | Sim | Ponto Y | N/A |
ConsultaRotaMapLinkPedagiosResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em caso de sucesso. |
2 | IdPedagio | int | Sim | Retorna o ID Pedágio. | N/A |
3 | FormaPagamento | string | Sim | Retorna a forma de pagamento. | N/A |
4 | Valor | decimal | Sim | Retorna o valor do pedágio. | N/A |
5 | Nome | string | Sim | Retorna o nome. | N/A |
Método
Abaixo, segue o método - 'ObterCustoRota'.
ObtencaoCustoRotaRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br"> <soapenv:Header/> <soapenv:Body> <tms:ObterCustoRota> <tms:auth> <tms:Usuario>?</tms:Usuario> <tms:Senha>?</tms:Senha> <tms:Token>?</tms:Token> </tms:auth> <tms:custoRotaRequest> <tms:CategoriaVeiculo>?</tms:CategoriaVeiculo> <tms:IdRotaModelo>?</tms:IdRotaModelo> <tms:ModoPagamentoRota>?</tms:ModoPagamentoRota> </tms:custoRotaRequest> </tms:ObterCustoRota> </soapenv:Body> </soapenv:Envelope>
Obter Custo Rota
Abaixo, segue exemplo do método - 'ObterCustoRota'.
Exemplo - ObtencaoCustoRotaRequest
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:ObterCustoRota> <tms:auth> <tms:Usuario>tms.exemplo</tms:Usuario> <tms:Senha>v0hXPrwerKblaBs=</tms:Senha> <tms:Token i:nil="true" /> </tms:auth> <tms:custoRotaRequest> <tms:CategoriaVeiculo>11</tms:CategoriaVeiculo> <tms:IdRotaModelo>54418</tms:IdRotaModelo> <tms:ModoPagamentoRota>2</tms:ModoPagamentoRota> </tms:custoRotaRequest> </tms:ObterCustoRota> </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/ObterCustoRotaResponse</Action> </s:Header> <s:Body> <ObterCustoRotaResponse xmlns="http://tmsfrete.v2.targetmp.com.br"> <ObterCustoRotaResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Erro i:nil="true" /> <Paradas> <ConsultaRotaMapLinkParadaResponse> <Erro i:nil="true" /> <Descricao>Ribeirão Preto, SP</Descricao> <PontoX>-47.8208378</PontoX> <PontoY>-21.1766308</PontoY> </ConsultaRotaMapLinkParadaResponse> <ConsultaRotaMapLinkParadaResponse> <Erro i:nil="true" /> <Descricao>Fazenda Rio Grande, PR</Descricao> <PontoX>-49.309412</PontoX> <PontoY>-25.649686</PontoY> </ConsultaRotaMapLinkParadaResponse> <ConsultaRotaMapLinkParadaResponse> <Erro i:nil="true" /> <Descricao>São Sebastião do Caí, RS</Descricao> <PontoX>-51.373399</PontoX> <PontoY>-29.5881939</PontoY> </ConsultaRotaMapLinkParadaResponse> </Paradas> <Pedagios> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>10</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>85.8</Valor> <Nome>PEDÁGIO - GUATAPARÁ</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>68</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>42.6</Valor> <Nome>PEDÁGIO - AVARÉ</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>114</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36.6</Valor> <Nome>PEDÁGIO - JAGUARIAÍVA</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>113</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>49.8</Valor> <Nome>PEDÁGIO - CARAMBEÍ</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>109</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>54.6</Valor> <Nome>PEDÁGIO - WITMARSUN</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>108</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>46.8</Valor> <Nome>PEDÁGIO - SÃO LUÍS DO PURUNÃ</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>253</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36</Valor> <Nome>PEDÁGIO - FAZENDA RIO GRANDE</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>254</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36</Valor> <Nome>PEDÁGIO - RIO NEGRO</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>255</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36</Valor> <Nome>PEDÁGIO - MONTE CASTELO</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>256</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36</Valor> <Nome>PEDÁGIO - SANTA CECÍLIA</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>257</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>36</Valor> <Nome>PEDÁGIO - CORREIA PINTO</Nome> </ConsultaRotaMapLinkPedagiosResponse> <ConsultaRotaMapLinkPedagiosResponse> <Erro i:nil="true" /> <IdPedagio>159</IdPedagio> <FormaPagamento>Via Fácil - SEM PARAR</FormaPagamento> <Valor>24.9</Valor> <Nome>PEDÁGIO - FLORES DA CUNHA</Nome> </ConsultaRotaMapLinkPedagiosResponse> </Pedagios> <Otimizada>false</Otimizada> <Tipo>0</Tipo> <CategoriaVeiculo>11</CategoriaVeiculo> <ValorPedagioTotal>521.1</ValorPedagioTotal> <ValorPedagioTARGET>0</ValorPedagioTARGET> <ValorPedagioViaFacil>521.1</ValorPedagioViaFacil> <IdRotaCliente>54418</IdRotaCliente> <NomeRotaCliente>O00402 - RIBEIRAO PRETO X SAO SEBASTIAO DO CAI</NomeRotaCliente> <DescricaoCategoriaVeiculo>Caminhão com reboque e cavalo mecânico com semi-reboque (seis eixos duplos)</DescricaoCategoriaVeiculo> <IdOrigemRota>5269</IdOrigemRota> <NomeOrigemRota>Ribeirão Preto, SP (3543402)</NomeOrigemRota> <CodigoIBGEOrigemRota>3543402</CodigoIBGEOrigemRota> <IdDestinoRota>4328</IdDestinoRota> <NomeDestinoRota>São Sebastião do Caí, RS (4319505)</NomeDestinoRota> <CodigoIBGEDestinoRota>4319505</CodigoIBGEDestinoRota> </ObterCustoRotaResult> </ObterCustoRotaResponse> </s:Body> </s:Envelope>