DOCUMENTAÇÃO CORPORATIVA

CadastrarRoteiroDetalhado

Objetivo


Esse método tem como objetivo cadastrar um Roteiro através de um array de Latitude e Longitude, CEP ou CodigoMunicipioIBGE.
Pode-se usar para realmente cadastrar um Roteiro, deixando o mesmo salvo na base de dados da TARGET ou apenas obter os dados do response.

Observações Importantes

Observações Importantes

  1. 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:

  1. Cadastrando apenas a Origem e Destino: Por default a rota será criada pelo caminho mais rápido.
  2. 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


    
CadastrarRoteiroDetalhadoRequest
CampoTipoObrigatórioDescriçãoObservação
1NomeRotaStringSimNome da Rota que será cadastradaN/A
2CategoriaVeiculosIntSimCategoria da quantidade de eixos que o veículo possui. 
3LATDoubleNãoLatitude do LocalDeve ser informado caso deseje criar o roteiro através de LAT/LONG.
4LNGDoubleNãoLongitude do LocalDeve ser informado caso deseje criar o roteiro através de LAT/LONG.
5CEPStringNãoCEP do LocalDeve ser informado caso deseje criar o roteiro através do CEP do local.
6CodigoIBGEMunicipioIntNãoCodigo IBGE do Município Deve ser informado caso deseje criar o roteiro através do Código IBGE.
7RotaTemporariabool(true || false)SimCaso a Rota seja temporária (true) ou não (false)N/A
8SomenteCalculobool(true || false)SimCaso só deseje saber o valor que irá custar o pedágio.N/A

Response

CadastrarRoteiroDetalhadoResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoMensagem de Erro.NULO em caso de sucesso.
2IdRotaClieteintSimId do roteiro que foi cadastrado.N/A
3NomeRotaStringSimNome do roteiro que foi cadastrado.N/A
4OrigemList<CadastrarRoteiro
DetalhadoOrigem
Response
>
SimOrigem da Rota Cadastrada.

N/A


5DestinoList<CadastrarRoteiro
DetalhadoDestino
Response
>
SimDestino da Rota Cadastrada.

N/A

6RotaDetalhadaInfoPedagioList<Rota
Detalhada
InfoPedagio
Response
>
SimInformações do pedágio da Rota Cadastrada.N/A
7ValorTotalPedagiostringSimValor total do pedágio referente ao roteiro criado.
CadastrarRoteiroDetalhadoOrigemResponse
CampoTipoObrigatórioDescriçãoObservação
1CidadestringSimCidade de origem do roteiro cadastrado.N/A
2EndereçostringSimEndereço de Origem do roteiro cadastrado.N/A
3

Latitude


doubleSimLatitude de Origem do roteiro cadastrado.N/A
4LongitudedoubleSimLongitude de Origem do Roteiro Cadastrado.

N/A


5CEPstringSimCEP de Origem do Roteiro Cadastrado.

N/A

6OrdemintSimOrdem sequencial das paradas do Roteiro.N/A
CadastrarRoteiroDetalhadoDestinoResponse
CampoTipoObrigatórioDescriçãoObservação
1CidadestringSimCidade de Destino do roteiro cadastrado.N/A
2EndereçostringSimEndereço de Destino do roteiro cadastrado.N/A
3

Latitude


doubleSimLatitude de Destino do roteiro cadastrado.N/A
4LongitudedoubleSimLongitude de Destino do Roteiro Cadastrado.

N/A


5CEPstringSimCEP de Destino do Roteiro Cadastrado.

N/A

6OrdemintSimOrdem sequencial das paradas do Roteiro.N/A
RotaDetalhadaInfoPedagioResponse
CampoTipoObrigatórioDescriçãoObservação
1NomePedagiostringSimNome da Praça de Pedágio.N/A
2IdDmCategoriaVeiculointSimId da Categoria do Veículo utilizado para criar o Roteiro.N/A
3

Valor


stringSimValor da Praça de PedágioN/A
4OrdemintSimOrdem sequencial das paradas do Roteiro.

N/A


Método

CadastrarRoteiroDetalhada
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
123
124
125
126
REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
    <soapenv:Header/>
     <soapenv:Body>
        <tms:CadastrarRoteiroDetalhado>
             <tms:auth>
                 <tms:Usuario>target.tms</tms:Usuario>
                 <tms:Senha>******</tms:Senha>
                 <tms:Token i:nil="true" />
            </tms:auth>
            <tms:rotaDetalhada>
                   <tms:NomeRota>Teste</tms:NomeRota>
                   <tms:CategoriaVeiculo>7</tms:CategoriaVeiculo>
                    <tms:Paradas>
                   <tms:RotaDetalhadaParada>
                         <tms:LAT>-22.3710357</tms:LAT>
                         <tms:LNG>-47.3810465</tms:LNG>
                         <tms:CEP i:nil="true" />
                         <tms:CodigoIBGEMunicipio>0</tms:CodigoIBGEMunicipio>
                  </tms:RotaDetalhadaParada>
                  <tms:RotaDetalhadaParada>
                         <tms:LAT>-22.8283659</tms:LAT>
                         <tms:LNG>-43.2737664</tms:LNG>
                         <tms:CEP i:nil="true" />
                        <tms:CodigoIBGEMunicipio>0</tms:CodigoIBGEMunicipio>
                  </tms:RotaDetalhadaParada>
                  <tms:RotaTemporaria>false</tms:RotaTemporaria>
                  <tms:SomenteCalculo>false</tms:SomenteCalculo>
              </tms:rotaDetalhada>
          </tms:CadastrarRoteiroDetalhado>
       </soapenv:Body>
</soapenv:Envelope>
RESPONSE
<s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
  <CadastrarRoteiroDetalhadoResponse
      xmlns="http://tmsfrete.v2.targetmp.com.br">
     <CadastrarRoteiroDetalhadoResult
         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Erro i:nil="true"/>
            <IdRotaCliente>139137</IdRotaCliente>
            <NomeRota>TESTE</NomeRota>
            <Origem>
                 <Cidade>Araras, SP</Cidade>
                 <Endereco>Avenida Limeira</Endereco>
                 <Latitude>-22.371021182009</Latitude>
                 <Longitude>-47.3810848484768</Longitude>
                 <Cep i:nil="true"/>
                 <Ordem>0</Ordem>
           </Origem>
           <Destino>
                <Cidade>Rio de Janeiro, RJ</Cidade>
                <Endereco>Rua Conde De Agrolongo,26</Endereco>
                <Latitude>-22.82831</Latitude>
                <Longitude>-43.273751</Longitude>
                <Cep i:nil="true"/>
               <Ordem>0</Ordem>
        </Destino>
        <Paradas/>
        <Pedagios>
           <RotaDetalhadaInfoPedagio>
              <NomePedagio>Pedágio - Limeira A Sul</NomePedagio>
              <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
             <Valor>12.8</Valor>
             <Ordem>1</Ordem>
         </RotaDetalhadaInfoPedagio>
         <RotaDetalhadaInfoPedagio>
            <NomePedagio>Pedágio - Nova Odessa Sul</NomePedagio>
            <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
            <Valor>16.8</Valor>
            <Ordem>2</Ordem>
         </RotaDetalhadaInfoPedagio>
         <RotaDetalhadaInfoPedagio>
           <NomePedagio>Pedágio - Itatiba</NomePedagio>
           <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
           <Valor>20.4</Valor>
           <Ordem>3</Ordem>
      </RotaDetalhadaInfoPedagio>
      <RotaDetalhadaInfoPedagio>
         <NomePedagio>Pedágio - Atibaia</NomePedagio>
         <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
         <Valor>15.2</Valor>
         <Ordem>4</Ordem>
     </RotaDetalhadaInfoPedagio>
     <RotaDetalhadaInfoPedagio>
       <NomePedagio>Pedágio - Igaratá</NomePedagio>
       <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
       <Valor>19</Valor>
       <Ordem>5</Ordem>
   </RotaDetalhadaInfoPedagio>
   <RotaDetalhadaInfoPedagio>
       <NomePedagio>Pedágio - Jacareí</NomePedagio>
       <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
       <Valor>13.4</Valor>
       <Ordem>6</Ordem>
    </RotaDetalhadaInfoPedagio>
   <RotaDetalhadaInfoPedagio>
       <NomePedagio>Pedágio - Moreira César</NomePedagio>
       <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
       <Valor>30.4</Valor>
       <Ordem>7</Ordem>
    </RotaDetalhadaInfoPedagio>
    <RotaDetalhadaInfoPedagio>
       <NomePedagio>Pedágio - Itatiaia</NomePedagio>
      <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
     <Valor>30.4</Valor>
     <Ordem>8</Ordem>
   </RotaDetalhadaInfoPedagio>
   <RotaDetalhadaInfoPedagio>
       <NomePedagio>Pedágio - Viúva Graça</NomePedagio>
       <IdDmCategoriaVeiculo>7</IdDmCategoriaVeiculo>
       <Valor>30.4</Valor> 
      <Ordem>9</Ordem>
   </RotaDetalhadaInfoPedagio>
  </Pedagios>
<ValorTotalPedagio>188.8</ValorTotalPedagio>
</CadastrarRoteiroDetalhadoResult>
</CadastrarRoteiroDetalhadoResponse>
</s:Body>
</s:Envelope>