Objetivo
O objetivo desse método é realizar o cadastro de novas rotas.
...
| Info |
|---|
| title | 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.
Obs. Há duas maneiras de cadastrar um Roteiro através da integração: - Cadastrando apenas a Origem e Destino: Por default a rota será criada pelo caminho mais rápido.
- Cadastrando Origem e Destino com Pontos de parada (Pode até 35 pontos de parada): Iremos criar uma rota de acordo com os pontos de parada, novamente a rota é feita pelo caminho mais rápido, porém obedecendo a ordem das paradas informadas pelo usuário.
|
Request
| RoteiroRequest |
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|
| 1 | NomeRoteiro | string | Sim | Nome do Roteiro a ser criado. | N/A |
| 2 | CategoriaVeiculo | int | Sim | Categoria de um veículo base, para definição do preço. | | View file |
|---|
| name | CategoriaDeVeículos.xlsx |
|---|
| height | 150 |
|---|
|
|
| 3 | CodigoIBGEMunicipioOrigem | int | Sim | Código IBGE do município de Origem do Roteiro. | N/A |
| 4 | CodigosIBGEMunicipioParadas | int | Sim | Código IBGE dos municípios de paradas intermediárias, sendo no máximo 35 paradas. | N/A |
| 5 | CodigoIBGEMunicipioDestino | int | Sim | Código IBGE do município de Destino do Roteiro. | N/A |
| 6 | RotaOtimizada | bool (true || false) | Não | Rota Otimizada | Será considerada a Rota mais rápida ou não, de acordo com a flag. |
Response
| RoteiroResponse |
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|
| 1 | Erro | ErroResponse - string | Não | Mensagem de Erro | NULO em caso de sucesso. |
| 2 | IdRoteiro | int | Sim | ID gerado pelo método para o roteiro criado. | N/A |
| 3 | NomeRoteiro | string | Sim | Nome informado na geração do Roteiro. | N/A |
| 4 | Origem | string | Sim | Nome do local de origem do Roteiro. | N/A |
| 5 | Destino | string | Sim | Nome do local de destino do roteiro. | N/A |
| 6 | Distancia | decimal | Sim | Distancia em km do roteiro. | N/A |
| 7 | CustoPedagioTotal | decimal | Sim | Custo de pedágio do Roteiro. | N/A |
| 8 | CustoTotalRota | decimal | Sim | Custo total gasto no Roteiro. | N/A |
Método
Abaixo, segue método - CadastrarRoteiro.
| Code Block |
|---|
| language | xml |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | RoteiroRequest |
|---|
| linenumbers | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body>
<tms:CadastrarRoteiro>
<tms:auth>
<tms:Usuario>?</tms:Usuario>
<tms:Senha>?</tms:Senha>
<tms:Token>?</tms:Token>
</tms:auth>
<tms:roteiroRequest>
<tms:NomeRoteiro>?</tms:NomeRoteiro>
<tms:CategoriaVeiculo>?</tms:CategoriaVeiculo>
<tms:CodigoIBGEMunicipioOrigem>?</tms:CodigoIBGEMunicipioOrigem>
<tms:CodigosIBGEMunicipioParadas>
<arr:int>?</arr:int>
</tms:CodigosIBGEMunicipioParadas>
<tms:CodigoIBGEMunicipioDestino>?</tms:CodigoIBGEMunicipioDestino>
<tms:RotaOtimizada>?</tms:RotaOtimizada>
</tms:roteiroRequest>
</tms:CadastrarRoteiro>
</soapenv:Body>
</soapenv:Envelope> |
Cadastrar
Abaixo, segue o primeiro exemplo para cadastrar um Roteiro.
| Code Block |
|---|
| language | xml |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Cadastrar - RoteiroRequest |
|---|
| linenumbers | true |
|---|
|
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<tms:CadastrarRoteiro>
<tms:auth>
<tms:Usuario>eadiante</tms:Usuario>
<tms:Senha>v0hXPKblaBs=</tms:Senha>
<tms:Token i:nil="true" />
</tms:auth>
<tms:roteiroRequest>
<tms:NomeRoteiro>Nar X San</tms:NomeRoteiro>
<tms:CategoriaVeiculo>7</tms:CategoriaVeiculo>
<tms:CodigoIBGEMunicipioOrigem>3532207</tms:CodigoIBGEMunicipioOrigem>
<tms:CodigosIBGEMunicipioParadas>
<arr:int>3504008</arr:int>
<arr:int>3534708</arr:int>
<arr:int>3522307</arr:int>
<arr:int>3552205</arr:int>
<arr:int>3548708</arr:int>
</tms:CodigosIBGEMunicipioParadas>
<tms:CodigoIBGEMunicipioDestino>3548500</tms:CodigoIBGEMunicipioDestino>
<tms:RotaOtimizada>false</tms:RotaOtimizada>
</tms:roteiroRequest>
</tms:CadastrarRoteiro>
</soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CadastrarRoteiroResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
<CadastrarRoteiroResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Erro i:nil="true"/>
<IdRoteiro>10169</IdRoteiro>
<NomeRoteiro>Nar X San</NomeRoteiro>
<Origem>Narandiba, SP</Origem>
<Destino>Santos, SP</Destino>
<Distancia>701.36</Distancia>
<CustoPedagioTotal>176.4</CustoPedagioTotal>
<CustoTotalRota>176.4</CustoTotalRota>
</CadastrarRoteiroResult>
</CadastrarRoteiroResponse>
</s:Body>
</s:Envelope> |
Cadastrar
Abaixo, segue o segundo exemplo para cadastrar um Roteiro.
| Code Block |
|---|
| language | xml |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Cadastrar - RoteiroRequest |
|---|
| linenumbers | true |
|---|
|
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<tms:CadastrarRoteiro>
<tms:auth>
<tms:Usuario>eadiante</tms:Usuario>
<tms:Senha>v0hXPKblaBs=</tms:Senha>
<tms:Token i:nil="true" />
</tms:auth>
<tms:roteiroRequest>
<tms:NomeRoteiro>MG x MT</tms:NomeRoteiro>
<tms:CategoriaVeiculo>7</tms:CategoriaVeiculo>
<tms:CodigoIBGEMunicipioOrigem>3149200</tms:CodigoIBGEMunicipioOrigem>
<tms:CodigosIBGEMunicipioParadas i:nil="true" />
<tms:CodigoIBGEMunicipioDestino>5107065</tms:CodigoIBGEMunicipioDestino>
<tms:RotaOtimizada>false</tms:RotaOtimizada>
</tms:roteiroRequest>
</tms:CadastrarRoteiro>
</soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CadastrarRoteiroResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
<CadastrarRoteiroResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Erro i:nil="true"/>
<IdRoteiro>10170</IdRoteiro>
<NomeRoteiro>MG x MT</NomeRoteiro>
<Origem>Pedrinópolis, MG</Origem>
<Destino>Querência, MT</Destino>
<Distancia>1318.64</Distancia>
<CustoPedagioTotal>12.6</CustoPedagioTotal>
<CustoTotalRota>12.6</CustoTotalRota>
</CadastrarRoteiroResult>
</CadastrarRoteiroResponse>
</s:Body>
</s:Envelope> |