Se você está nessa página, nós assumimos que:
Você já possui uma chave de acesso;

Tenha conhecimento sobre o funcionamento dos exemplos de código através do guia Primeiros passos;

Tenha conhecimento de XML e Web Services SOAP.

O serviço RouteProximity disponibiliza através de suas operações as funcionalidades de geração de rotas simples, possibilidade de obter dados de descrição dos trajetos e a renderização de mapa por rota, onde estes métodos possuem em seu retorno os pontos de interesse por proximidade existentes no trajeto sugerido para a rota em questão. Adicionalmente, é possível ter como resultado somente a lista com os pontos de interesse por proximidade para o percurso da rota, e por fim, estão disponíveis operações adicionais para cálculo de rotas, sendo elas, obter dados de custos com o trajeto da rota e dados sumarizados.

A estrutura abaixo contém as informações de versão, endereço de acesso e contrato de operação para o serviço RouteProximity.

Nome do serviço: Route
Endereço de acesso: http://services.maplink.com.br/webservices/v1.1/routeproximity/routeproximity.asmx
Versão atual: V1.1
Funcionalidade Nome da Operação
Geração de rotas com pontos de interesse por proximidade GetRouteProximity
Obter dados de descrição por rota e pontos de interesse por proximidade GetRouteProximityDescription
Renderização de mapa por rota com pontos de interesse por proximidade GetRouteProximityWithMap
Obter pontos de proximidade por rota GetRouteProximityList
Obter dados de resumo por rota GetRouteProximitySummary
Cálculo de valores totais por rota GetRouteProximityTotals
Cálculo de valores totais por conjunto de rotas GetRouteProximityTotalsBatch

A funcionalidade de geração de rotas com pontos de interesse por proximidade está disponível através da operação “GetRouteProximity” e tem como objetivo retornar dados detalhados de uma rota gerada a partir de um ponto de origem e destino, juntamente com os pontos de interesse existentes por proximidade para o trajeto retornado para a rota corrente. É possível definir os parâmetros de configuração para geração da rota, como por exemplo, tipo da rota a ser gerada, considerando o trajeto mais rápido ou curto, dados de um veículo, como velocidade média e consumo de combustível médio, tipos de ponto de interesse a ser localizado e valor para o raio.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhes a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “RouteStop” contém os dados de pontos de parada de origem e destino e/ou um ou mais pontos de parada existentes na rota a ser gerada.
Nome do Atributo Tipo Descrição
Description Conjunto de caracteres Indica a descrição do ponto de parada
Point Estrutura Point Indica as coordenadas geográficas correspondente aos pontos de origem e destino
Estrutura “Point” contém as coordenadas de latitude e longitude para um determinado endereço
Nome do Atributo Tipo Descrição
X Número com casas decimais Indica a longitude de uma coordenada geográfica
Y Número com casas decimais Indica a latitude de uma coordenada geográfica
Estrutura “RouteOptions” contém as opções usadas no processo de roteirização.
Nome do Atributo Tipo Descrição
Language Conjunto de caracteres Indica o idioma utilizado para gerar os dados de descrição da rota
RouteDetails Estrutura RouteDetails Indica as opções e filtros a serem utilizados para geração da rota
Vehicle Estrutura Vehicle Indica as propriedades do veículo usado no percurso e de categoria de pedágio
RouteLine Estrutura RouteLine Indica o padrão da linha a ser traçada no mapa para a rota gerada
Estrutura “RouteDetails” contém os detalhes da rota, contendo o tipo da rota e se as paradas sejam otimizadas
Atributo Tipo Descrição

BarrierPoint Estrutura Point Indica um conjunto de pontos de bloqueio na rota
BarriersList Conjunto de caracteres Indica uma lista de pontos pré-definidos para bloqueio
DescriptionType Estrutura DescriptionType Indica a descrição da rota (urbana/rodoviária)
OptimizeRoute * Booleano Indica a existência de otimização na rota a ser gerada
PoiRoute Conjunto de caracteres Indica o nome do POI (ponto de interesse) * verificar disponibilidade
RouteType Estrutura RouteType Indica o tipo da rota

* A otimização das rotas é feita sobre a malha viária quando o número de pontos da rota não exceda dez pontos (considerando origem, destino e parada), o que significa um resultado mais próximo da melhor rota possível. Entretanto, caso a rota possua dez ou mais pontos, um algoritmo secundário é adotado e o resultado obtido pode apresentar dados não ideais.

Estrutura “DescriptionType” contém os atributos para definir a descrição da rota. Possui as opções de rota urbana e rodoviária.
Atributo Descrição
0 Rota urbana
1 Rota rodoviária
Estrutura “RouteType” contém os atributos para definir o tipo da rota a ser gerada
Atributo Descrição
0 Rota padrão mais rápida
1 Rota padrão mais curta
2 Rota “a 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
21 * Rota com transporte público
23 Rota evitando o trânsito. (Somente utilizando base urbana, verificar disponibilidade)
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
26 ** Rota priorizando ciclovias, ciclofaixas e ciclorrotas

* Opção disponível somente para API Javascript. Não é possível obter os dados de transporte público através do serviço SOAP.

** É necessário definir o parâmetro DescriptionType com o valor 0, cujo valor representa uma rota urbana.

Estrutura “Vehicle” contém os atributos para definir as propriedades do veículo considerando na rota e a categoria de pedágio a ser calculada
Atributo Tipo Descrição
AverageConsumption Número com casas decimais Indica o consumo médio do veículo
AverageSpeed Número inteiro Indica a velocidade média do veículo (em quilômetros por hora)
FuelPrice Número com casas decimais Indica o preço do combustível
TankCapacity Número inteiro Indica a capacidade do tanque em litros
TollFeeCat Número inteiro Estrutura TollFeeCat
Estrutura “TollFeeCat” contém os atributos para definir a categoria do pedágio a ser calculado.
Atributo Descrição
0 Não será calculado o valor do pedágio
1 Motocicletas, motonetas e bicicletas a motor
2 Automóvel, caminhoneta e furgão (dois eixos simples)
3 Automóvel, caminhoneta com semi-reboque (três eixos simples)
4 Automóvel, caminhoneta com reboque (quatro eixos simples)
5 Ônibus (dois eixos duplos)
6 Ônibus com reboque (três eixos duplos)
7 Caminhão leve, furgão e cavalo mecânico (dois eixos duplos)
8 Caminhão, caminhão trator e cavalo mecânico com semi-reboque (três eixos duplos)
9 Caminhão com reboque e cavalo mecânico com semi-reboque (quatro eixos duplos)
10 Caminhão com reboque e cavalo mecânico com semi-reboque (cinco eixos duplos)
11 Caminhão com reboque e cavalo mecânico com semi-reboque (seis eixos duplos)
12 Caminhão com reboque e cavalo mecânico com semi-reboque (sete eixos duplos)
13 Caminhão com reboque e cavalo mecânico com semi-reboque (oito eixos duplos)
14 Caminhão com reboque e cavalo mecânico com semi-reboque (nove eixos duplos)
Estrutura “RouteLine” permite realizar a customização da cor da linha da rota gerada
Atributo Tipo Descrição
RGB Conjunto de Caracteres Indica a cor da linha a ser traçada em RGB (sistema de cores aditivas), por exemplo: “255,0,0,3″
Transparency Número com casas decimais Indica o nível de transparência da linha
width Número inteiro Indica a espessura da linha

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “routeID”, “mapInfo” (MapInfo), “segDescription” (SegmentDescription), “routeTotals” (RouteTotals), “routeSummary” (RouteSummary) e “roadType” (RoadType), sendo estes descritos em detalhes a seguir:

  • routeID

Armazena o código de identificação da rota gerada. Este identificador pode ser utilizado para apresentar o percurso da rota gerado nos mapas renderizados pelas operações do serviço MapRender.

  • mapInfo

Armazena uma implementação da estrutura MapInfo com o endereço de acesso do mapa renderizado e suas propriedades.

  • segDescription

Armazena uma implementação da estrutura SegmentDescription com os dados de descrição do percurso por rota.

  • routeTotals

Armazena uma implementação da estrutura RouteTotals com os valores totais gastos por rota.

  • routeSummary

Armazena uma implementação da estrutura RouteSummary com dados sumarizados por rota.

  • roadType

Armazena uma implementação da estrutura RoadType com dados de pisos das rodovias percorridas na rota.

Estrutura “RouteInfo” contém todas as informações da rota gerada.
Nome do Atributo Tipo Descrição
RouteId Conjunto de caracteres Contém o código de identificação da rota gerada
MapInfo Estrutura MapInfo Contém a informações do mapa
RoadType Estrutura RoadType Contém o informações do tipo da rota
RouteSummary Estrutura RouteSummary Contém o resumo dos pontos da rota
RouteTotals Estrutura RouteTotals Contém os totais da rota gerada
SegmentDescription Estrutura SegmentDescription Contém as informações da descriçao da rota gerada
Estrutura “MapInfo” contém o endereço de acesso do mapa renderizado e suas dimensões.
Nome do Atributo Tipo Descrição
Extent Estrutura Extent Indica o par de coordenadas mínimas e máximas do mapa a ser gerado
URL Conjunto de Caracteres Indica o endereço (internet) de onde está a imagem do mapa
Estrutura “Extent” representa a área do mapa através dos valores mínimos e máximos para as coordenadas X e Y
Nome do Atributo Tipo Descrição
XMin Número com casas decimais Indica o valor mínimo da coordenada X
XMax Número com casas decimais Indica o valor máximo da coordenada Y
YMin Número com casas decimais Indica o valor mínimo da coordenada X
YMax Número com casas decimais Indica o valor máximo da coordenada Y
Estrutura “SegmentDescription” contém os dados de descrição do percurso por rota.
Nome do Atributo Tipo Descrição
Command Conjunto de caracteres Indica os comandos: Em frente ; Permaneça a esquerda ; Permaneça a direita ; Curva acentuada a esquerda ; Curva acentuada a direita ; Curva a esquerda ; Curva a direita ; Retorno
Description Conjunto de caracteres Indica o nome do logradouro ou rodovia
City Estrutura City Indica a cidade
TollFeeDetails Estrutura TollFeeDetails Indica as iformações das praças de pedágio
RoadType Conjunto de caracteres Contém o tipo do caminho: CP – Condições Precárias ; ED – Em Duplicação ; EP – Em Pavimentação ; PD – Pista Dupla ; T – Terra ; BA – Balsa ; P – Pavimentada
Distance Número com casas decimais Indica a distância do trecho
CumulativeDistance Número com casas decimais Indica a distância acumulada
Point Estrutura Point Indica as coordenadas geográficas correspondente ao ponto
PoiRoute Conjunto de caracteres Indica o tipo do ponto de interesse
PoiRouteDetails Estrutura PoiDetails Indica os dados do ponto de interesse
Estrutura “City” contém as informações do nome da cidade e de seu estado.
Nome do Atributo Tipo Descrição
Name Conjunto de caracteres Indica o nome da cidade
State Conjunto de Caracteres Indica o nome do estado
Estrutura “TollFeeDetails” contém as informações das praças de pedágio.
Nome do Atributo Tipo Descrição
Name Conjunto de caracteres Indica o nome da praça de pedágio
Direction Conjunto de Caracteres Indica o sentido de cobrança do pedágio
Address Conjunto de Caracteres Indica o endereço da praça de pedágio
Concession Conjunto de Caracteres Indica o nome da concessionária
Phone Conjunto de Caracteres Indica o telefone da concessionária
State Conjunto de Caracteres Indica o nome do estado
Price Conjunto de Caracteres Indica o preço à ser cobrado
PricePerAxle Conjunto de Caracteres Indica o preço por eixo
Estrutura “PoiDetails” contém os dados do ponto de interesse.
Nome do Atributo Tipo Descrição
ClientID Conjunto de caracteres Indica o código de identificação
Name Conjunto de Caracteres Indica o nome
AddressInfo Conjunto de Caracteres Indica o endereço (nome e número da rua/avenida/estrada/rodovia)
source Conjunto de Caracteres Indica a fonte de dados utilizada para obter o dado
Point Estrutura Point Indica as coordenadas geográficas correspondente ao ponto
Estrutura “RouteTotals” contém os valores totais gastos por rota.
Nome do Atributo Tipo Descrição
TaxiFare1 Número com casas decimais Indica o custo de taxi com bandeira 1
TaxiFare2 Número com casas decimais Indica o custo de taxi com bandeira 2
TotalCost Número com casas decimais Indica o custo total da rota
TotalDistance Número com casas decimais Indica a distância total da rota em quilômetros
TotalfuelCost Número com casas decimais Indica o custo total de combustível
TotalFuelUsed Número com casas decimais Indica o custo total de combustível usado na rota
TotalTime Conjunto de caracteres Indica o tempo total para a rota no padrão ISO8601. Exemplo: P18Y9M4DT11H9M8S (18 years, 9 months, 4 days, 11 hours, 9 minutes and 8 seconds.)
TotalTollFeeCost Número com casas decimais Indica o custo total de pedágios
Estrutura “RouteSummary” contém um array com o resumo das paradas da rota.
Nome do Atributo Tipo Descrição
Description Conjunto de caracteres Indica a descrição do ponto
Distance Número com casas decimais Distância do persurso
Point Estrutura Point Indica as coordenadas geográficas correspondente ao ponto
Estrutura “RoadType” contém os tipos de asfalto/psio para as rodovias percorridas na rota.
Nome do Atributo Tipo Descrição
dirtRoad Número inteiro Quantidade de quilômetros em pista de terra
ferry Número inteiro Quantidade de quilômetros em balsa
oneLaneRoadway Número inteiro Quantidade de quilômetros em pista simples
pavingWorkInProgress Número inteiro Quantidade de quilômetros de pista em contrução
roadwayInPoorConditions Número inteiro Quantidade de quilômetros de pista em más condições
secondLaneUnderConstruction Número inteiro Quantidade de quilômetros de segunda pista em duplicação
twoLaneHighway Número inteiro Quantidade de quilômetros em pista dupla

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximity”, com o objetivo de obter os dados para uma rota gerada e seus pontos de interesse por proximidade, a partir de um ponto de origem, de destino e parâmetros de customizações.

Como parâmetros de entrada são definidos os pontos de parada através da estrutura RouteStop, sendo origem com os valores de longitude “-46.442782″, latitude “-23.579934″ e descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, e de destino com longitude “-49.272567″, latitude “-25.431531″ e descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”. Na estrutura RouteDetails é definido o ponto de interesse a ser considerado como “PETROBRAS” através do parâmetro “poiRoute”. Com isso, são buscados no trajeto da rota pontos de interesse, considerando a proximidade através do valor informado no parâmetro “radius”, sendo este preenchido com o valor “100″.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

Trecho do XML SOAP de resposta com os dados do ponto de interesse por proximidade:

XML SOAP de resposta (exemplo de retorno reduzido):

Visualizar XML SOAP de retorno completo


A funcionalidade de obter dados de descrição por rota e pontos de interesse por proximidade está disponível através da operação “GetRouteProximityDescription” e tem como objetivo retornar a descrição da rota, incluindo os passos necessários para chegar ao local desejado, considerando um ponto de origem, juntamente com os pontos de interesse próximos a localização dos pontos que contemplam o percurso da rota gerada. Os dados de descrição da rota incluem indicações de percurso, como por exemplo: “siga em frente, vire a direta ou esquerda”, juntamente com a distância a ser percorrida neste trajeto.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhes a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui o parâmetro “segmentDescription” (SegmentDescription), sendo este descrito em detalhes a seguir:

  • segDescription

Armazena um conjunto de implementações da estrutura SegmentDescription com os dados de descrição do percurso por rota.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximityDescription”, com o objetivo de obter os dados de descrição do percurso a ser seguido para a rota gerada, considerando os pontos de origem e destino informados na solicitação da operação.

Como parâmetros de entrada são definidos os pontos de parada através da estrutura RouteStop, sendo origem com os valores de longitude “-46.442782″, latitude “-23.579934″ e descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, e de destino com longitude “-49.272567″, latitude “-25.431531″ e descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”. Na estrutura RouteDetails é definido o ponto de interesse a ser considerado como “PETROBRAS” através do parâmetro “poiRoute”. Com isso, são buscados no trajeto da rota pontos de interesse, considerando a proximidade através do valor informado no parâmetro “radius”, sendo este preenchido com o valor “100″.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta (exemplo de retorno reduzido):

Visualizar XML SOAP de retorno completo


A funcionalidade de renderização de mapas por rota está disponível através da operação “GetRouteProximityWithMap” e tem como objetivo retornar os dados da rota gerada, seguindo o mesmo escopo de saída da operação GetRouteProximity, com a diferença de incluir o endereço de acesso para o mapa renderizado e as dimensões do mapa cobrindo a área da rota obtida.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions), “mo” (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “MapOptions” contém as propriedades e filtros para geração de um mapa
Nome do Atributo Tipo Descrição
mapSize Estrutura MapSize Indica as propriedades de dimensão para um mapa
scaleBar Booleano Disponibiliza opção para exibição de barra de escala em um mapa
Estrutura “MapSize” contém as propriedades de dimensão de um mapa
Nome do Atributo Tipo Descrição
height Número inteiro Indica a altura do mapa
width Número inteiro Indica a largura do mapa

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “routeID”, “mapInfo” (MapInfo), “segDescription” (SegmentDescription), “routeTotals” (RouteTotals), “routeSummary” (RouteSummary) e “roadType” (RoadType), sendo estes descritos em detalhes a seguir:

  • routeID

Armazena o código de identificação da rota gerada. Este identificador pode ser utilizado para apresentar o percurso da rota gerado nos mapas renderizados pelas operações do serviço MapRender.

  • mapInfo

Armazena uma implementação da estrutura MapInfo com o endereço de acesso do mapa renderizado e suas propriedades.

  • segDescription

Armazena uma implementação da estrutura SegmentDescription com os dados de descrição do percurso por rota.

  • routeTotals

Armazena uma implementação da estrutura RouteTotals com os valores totais gastos por rota.

  • routeSummary

Armazena uma implementação da estrutura RouteSummary com dados sumarizados por rota.

  • roadType

Armazena uma implementação da estrutura RoadType com dados de pisos das rodovias percorridas na rota.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximityWithMap”, com o objetivo de obter todos os dados para a rota gerada e o endereço de acesso para o mapa renderizado, demonstrando a região onde há trechos do trajeto para a rota obtida.

Como parâmetros de entrada são definidos os pontos de parada através da estrutura RouteStop, sendo origem com os valores de longitude “-46.442782″, latitude “-23.579934″ e descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, e de destino com longitude “-49.272567″, latitude “-25.431531″ e descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”. Na estrutura RouteDetails é definido o ponto de interesse a ser considerado como “PETROBRAS” através do parâmetro “poiRoute”. Com isso, são buscados pontos de interesse no trajeto da rota, considerando a proximidade através do valor informado no parâmetro “radius”, sendo este preenchido com o valor “100″. O parâmetro MapOptions define as características do mapa a ser gerado, onde são informados os valores “600″ para largura e “800″ para altura.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta (exemplo de retorno reduzido):

Visualizar XML SOAP de retorno completo

A seguir são apresentadas duas imagens. A primeira foi obtida com o mapa renderizado obtido como resultado a partir do exemplo descrito anteriormente, enquanto a segunda teve origem a partir de uma customização, com o objetivo de demonstrar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

  • Imagem com mapa renderizado para rota gerada com pontos Av Jacu-Pessego/Nova Trabalhadores - São Paulo/SP e Rua Quinze de Novembro, 200 - Curitiba/PR

    Considerando ponto de origem “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP” e de destino “Rua Quinze de Novembro, 200 – Curitiba/PR”

    Visualizar em tamanho original

  • Imagem com mapa renderizado para rota gerada com pontos Avenida Paulista, 1000 e Av Pres Juscelino Kubitschek de Oliveira, 3000

    Considerando ponto de origem “Avenida Paulista, 1000 – São Paulo / SP” e de destino “Av Pres Juscelino Kubitschek de Oliveira, 3000 – São Paulo / SP”

    Visualizar em tamanho original


A funcionalidade de obter pontos de proximidade por rota está disponível através da operação “GetRouteProximityList” e tem como objetivo retornar uma lista com os pontos de interesse por proximidade encontrados no trajeto calculado para a rota solicitada.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhes a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui o parâmetro “ProximityList” (ProximityList), sendo este descrito em detalhes a seguir:

  • ProximityList

Armazena um conjunto de implementações da estrutura ProximityList com os pontos de interesse encontrados no percurso existente para a rota solicitada.

Estrutura “ProximityList” contém os dados do ponto de interesse
Nome do Atributo Tipo Descrição
clientID Número inteiro Indica o código de identificação
clientDetails Conjunto de caracteres Indica o nome detalhado para o ponto de interesse
point Estrutura Point Indica as coordenadas geográficas correspondente aos pontos de origem e destino

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximityList”, com o objetivo de obter os pontos de interesse por proximidade encontrados para a roteirização gerada.

Como parâmetros de entrada são definidos os pontos de parada através da estrutura RouteStop, sendo origem com os valores de longitude “-46.442782″, latitude “-23.579934″ e descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, e de destino com longitude “-49.272567″, latitude “-25.431531″ e descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”. Na estrutura RouteDetails é definido o ponto de interesse a ser considerado como “PETROBRAS” através do parâmetro “poiRoute”. Com isso, são buscados pontos de interesse no trajeto da rota, considerando a proximidade através do valor informado no parâmetro “radius”, sendo este preenchido com o valor “100″.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de Resposta:


A funcionalidade de obter dados de resumo por rota está disponível através da operação “GetRouteProximitySummary” e tem como objetivo retornar, de forma resumida, o cálculo de rota entre dois ou mais pontos de parada.

Esta operação possui a mesma estrutura de entrada, processamento e saída em relação ao método GetRouteSummary presente no serviço Route

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhes a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui o parâmetro “routeSummary” (RouteSummary), sendo este descrito em detalhes a seguir:

  • routeSummary

Armazena um conjunto de implementações da estrutura RouteSummary com dados sumarizados por rota.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximitySummary”, com o objetivo de obter os dados sumarizados para o cálculo de rotas gerado a partir dos pontos de origem e destino informados.

Como parâmetros de entrada são informados dois pontos de parada através da estrutura RouteStop, conforme relação abaixo:

  • Descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, latitude “-23.579934″ e longitude “-46.442782″
  • Descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”, latitude “-25.431531″ e longitude “-49.272567″

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de Resposta:


A funcionalidade de cálculo de valores totais por rota está disponível através da operação “GetRouteProximityTotals” e tem como objetivo retornar os dados detalhados dos valores totais obtidos para a rota gerada a partir dos pontos de origem e destino informados. O retorno da operação possui as informações de distância total percorrida, tempo total gasto, entre outros dados a serem detalhados na estrutura de resposta “RouteTotals“.

Esta operação possui a mesma estrutura de entrada, processamento e saída em relação ao método GetRouteTotals presente no serviço Route

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “rs” (RouteStop), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • rs

Armazena uma implementação da estrutura RouteStop com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui o parâmetro “routeTotals” (RouteTotals), sendo este descrito em detalhes a seguir:

  • routeTotals

Armazena uma implementação da estrutura RouteTotals com os valores totais gastos por rota.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “RouteProximity” utilizando a operação “GetRouteProximityTotals”, com o objetivo de retornar os dados totais gastos para realizar a rota gerada, considerando atributos como custo de combustível, táxi, distância em kilometros, entre outros indicadores.

Como parâmetros de entrada são definidos os seguintes pontos de parada através da estrutura RouteStop:

  • Origem com longitude “-46.442782″, latitude “-23.579934″ e descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”.
  • Destino com longitude “-49.272567″, latitude “-25.431531″ e descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de Resposta:


A funcionalidade de cálculo de valores totais para um conjunto de rotas está está disponível através da operação “GetRouteProximityTotalsBatch” e tem como objetivo retornar os dados detalhados dos valores totais obtidos para as rotas geradas, sendo estas geradas a partir do conjunto de pontos de origem e destino informados na solicitação da operação. O retorno da operação possui as informações de distância total percorrida, tempo total gasto, entre outros dados a serem detalhados na estrutura de resposta “RouteTotals”.

Esta operação possui a mesma estrutura de entrada, processamento e saída em relação ao método GetRouteProximityTotals presente no serviço Route.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “ra” (RouteArray), “ro” (RouteOptions) e “token”, sendo estes descritos em detalhes a seguir:

  • ra

Armazena uma implementação da estrutura RouteArray com os pontos de parada de origem e destino a serem utilizados para geração da rota.

  • ro

Armazena uma implementação da estrutura RouteOptions com as opções e filtros a serem considerados para realizar a roteirização.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “RouteArray” contém um conjunto de elementos da estrutura RouteStop
Nome do Atributo Tipo Descrição
RouteArray Estrutura RouteStop Contém os pontos de origem, destino e a descrição para o ponto de parada

Contrato de saída – Resposta

O contrato de resposta possui o parâmetro “routeTotals” (RouteTotals), sendo este descrito em detalhes a seguir:

  • routeTotals

Armazena uma implementação da estrutura RouteTotals com os valores totais gastos por rota.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “Route” utilizando a operação “GetRouteTotalsBatch” e tem como objetivo retornar os dados totais gastos para realizar as rotas geradas, considerando atributos como custo de combustível, táxi, distância em kilometros, entre outros indicadores, baseado em um conjunto de pontos de origem e destino.

Como parâmetros de entrada são informados dois conjuntos de pontos de parada (origem e destino) através da estrutura RouteArray, conforme relação abaixo.

Primeira rota:

  • Origem com descrição “Av Jacu-Pessego/Nova Trabalhadores – São Paulo/SP”, latitude “-23.579934″ e longitude “-46.442782″.
  • Destino com descrição “Rua Quinze de Novembro, 200 – Curitiba/PR”, latitude “-25.431531″ e longitude “-49.272567″.

Segunda rota:

  • Origem com descrição “Avenida Paulista, 1000 – São Paulo/SP”, latitude “-23.5650127″ e longitude “-46.6520066″.
  • Destino com descrição “Av Pres Juscelino Kubitschek de Oliveira, 3000 – São Paulo/SP”, latitude “-23.5230448″ e longitude “-46.6140738″.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de Resposta: