DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Objetivo

O objetivo desse método é realizar o cadastro de novas rotas.


Observações Importantes

  1. Não é possível realizar rajadas para esse método, a TARGET limita uma quantidade X de requisições por minuto, aconselhamos requisições por demanda.


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

RoteiroRequest
CampoTipoObrigatórioDescriçãoObservação
1NomeRoteirostringSimNome do Roteiro a ser criado.N/A
2CategoriaVeiculointSimCategoria de um veículo base, para definição do preço.
3CodigoIBGEMunicipioOrigemintSimCódigo IBGE do município de Origem do Roteiro.N/A
4CodigosIBGEMunicipioParadasintSimCódigo IBGE dos municípios de paradas intermediárias, sendo no máximo 35 paradas.N/A
5CodigoIBGEMunicipioDestinointSimCódigo IBGE do município de Destino do Roteiro.N/A

Response

RoteiroResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoMensagem de ErroNULO em caso de sucesso.
2IdRoteirointSimID gerado pelo método para o roteiro criado.N/A
3NomeRoteirostringSimNome informado na geração do Roteiro.N/A
4OrigemstringSimNome do local de origem do Roteiro.N/A
5DestinostringSimNome do local de destino do roteiro.N/A
6DistanciadecimalSimDistancia em km do roteiro.N/A
7CustoPedagioTotaldecimalSimCusto de pedágio do Roteiro.N/A
8CustoTotalRotadecimalSimCusto total gasto no Roteiro.N/A

Método

Abaixo, segue método - CadastrarRoteiro.

RoteiroRequest
<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:roteiroRequest>
      </tms:CadastrarRoteiro>
   </soapenv:Body>
</soapenv:Envelope>

Cadastrar

Abaixo, segue o primeiro exemplo para cadastrar um Roteiro.

Cadastrar - RoteiroRequest
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: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.

Cadastrar - RoteiroRequest
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: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>
  • No labels