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

Estrutura “MAddress” contém os dados de nome e número da rua, código postal, bairro, cidade e estado
Nome do atributo Tipo Descrição
street Conjunto de caracteres Indica o nome da rua
houseNumber Número inteiro Indica o número da rua
zip Conjunto de caracteres Indica o código postal
district Conjunto de caracteres Indica o nome da bairro
city Estrutura MCity Indica a cidade e estado
Estrutura “MAddressOptions” contém opções de filtro para a busca por endereço
Nome do atributo Tipo Descrição
matchType Número inteiro Não aplicável
usePhonetic Booleano Define se o endereço será pesquisado utilizando busca com termos fonéticos
searchType Estrutura MSearchType Define o padrão de busca
resultRange Estrutura MResultRange Define opções de paginação para a busca
Estrutura “MCity” contém os dados do nome da cidade e de seu estado
Nome do atributo Tipo Descrição
name Conjunto de caracteres Indica o nome da cidade
state Número inteiro Indica o nome do estado
Estrutura “MResultRange” contém os atributos para definir a paginação para a busca realizada
Atributo Tipo Descrição
pageIndex Número inteiro Indica o índice da página de retorno
recordsPerPage Número inteiro Indica o número de registros por página
Estrutura “MWsAddressFinder” é tilizada para consumir o serviço SOAP “AddressFinder”
Nome da operação Parâmetros Retorno Descrição
findAddress
  • address (estrutura MAddress) – Indica os dados de nome e número da rua, código postal, bairro, cidade e estado
  • addressOptions (estrutura MAddressOptions) – Indica as opções de filtro para a busca por endereço.
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de endereços
findCity
  • city (estrutura MCity) – Indica os dados do nome da cidade e de seu estado
  • addressOptions (estrutura MAddressOptions) – Indica as opções de filtro para a busca por endereço.
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de cidades
findPOI
  • poi_name – Indica o nome do ponto de interesse a ser localizado
  • city (estrutura MCity) – Indica os dados do nome da cidade e de seu estado
  • resultRange (estrutura MResultRange) – Indica os atributos para definir a paginação para a busca realizada
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter pontos de interesse
getAddress
  • point (estrutura MPoint) – ponto geografico a ser transformado em endereço
  • função de callBack de retorno
Através de callback de retorno Consome serviço de geocodificação inversa para o ponto especificado
findCitiesByState
  • city – (estrutura MCity) – Cidade com o estado a ser buscado preenchido.
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter todas as cidades de um estado
findAddressContext (uso interno)
  • address – (estrutura MAddress) – Endereço a ser geocodificado.
  • ao – (estrutura MAddressOption – Opções de filtros para a geocodificação
  • função de callBack de retorno
  • identificador interno de contexto
Através de função de callBack de retorno geocodifica o endereço utilizando contexto – função de uso interno
findCityContext (Uso interno)
  • city – (estrutura MCity) – Indica os dados do nome da cidade e de seu estado
  • ao – (estrutura MAddressOption – Opções de filtros para a geocodificação
  • função de callBack de retorno
  • identificador interno de contexto
Através de função de callBack de retorno Consome serviço de busca de cidades – função de uso interno
getXY
  • address – (estrutura MAddress) – Indica os dados de nome e número da rua, código postal, bairro, cidade e estado.
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geocodificação
Estrutura “MCityLocation” contém informações sobre a localização da cidade
Nome do atributo Tipo Descrição
city Estrutura MCity Nome e estado da cidade
point Estrutura MPoint Latitude e longitude da cidade
carAccess Valor booleano informa se a cidade possui acesso de carro ou não
zipRangeStart Conjunto de caracteres Informa o inicio do intervalo de CEP para a cidade
zipRangeEnd Conjunto de caracteres Informa o fim do intervalo de CEP para a cidade
capital Valor booleano informa se a cidade é a capital do estado ou não
addressesAvailable Valor booleano Informa se os endereços da cidade estão disponíveis
Estrutura “MPOILocation” contém informações sobre a localização de pontos de interesse
Nome do atributo Tipo Descrição
name Conjunto de caracteres Nome do ponto de interesse
district Conjunto de caracteres nome do bairro
carAccess Valor booleano informa se o local possui acesso de carro ou não
dataSource Conjunto de caracteres Informa a fonte dos dados
city Estrutura MCity Informa cidade do ponto de interesse
point Estrutura MPoint Localização geográfica do ponto de interesse
Estrutura “MAddressLocation” contém informações sobre a localização de um endereço e informações adicionais acerca do mesmo
Nome do atributo Tipo Descrição
key Conjunto de caracteres Código de identificação do endereço
zipL Conjunto de caracteres CEP do lado esquerdo
zipR Conjunto de caracteres CEP postal do lado direito
carAccess Valor booleano indica se o endereço permite o trânsito de carros
dataSource Conjunto de caracteres Fonte de dados utilizados para obter informações do endereço
point Estrutura MPoint Localização geográfica do endereço correspondente
Estrutura “MAddressInfo” contém um agrupamento de informações sobre o endereço assim como informações sobre a paginação da resposta do webservice
Nome do atributo Tipo Descrição
recordCount Número inteiro Número de registros encontrado pela busca realizada
pageCount Número inteiro Número de páginas referente a paginação da busca realizada
AddressLocation Array de estrutura MAddressLocation Agrupamento de informações sobre os endereços encontrados
Estrutura “MCityLocationInfo” contém um agrupamento de informações sobre a cidade e a paginação da resposta do webservice
Nome do atributo Tipo Descrição
recordCount Número inteiro Número de registros encontrado pela busca realizada
pageCount Número inteiro Número de páginas referente a paginação da busca realizada
cityLocation Array de estrutura MCityLocation Agrupamento de informações sobre as cidades encontradas
Estrutura “MPOIInfo” contém um agrupamento de informações sobre a pontos de interesse e a paginação da resposta do webservice
Nome do atributo Tipo Descrição
recordCount Número inteiro Número de registros encontrado pela busca realizada
pageCount Número inteiro Número de páginas referente a paginação da busca realizada
poiLocation Array de estrutura MPOILocation Agrupamento de informações os pontos de interesse e suas localizações

Operações para criação de layers
Nome da operação Parâmetros Retorno Descrição
createLabelsLayer Não aplicável Instância do layer de rótulos Realiza a criação do layer de rótulos e retorna instância do objeto
createTrafficLayer Não aplicável Instância do layer de trânsito Realiza a criação do layer de trânsito e retorna instância do objeto

Estruturas de controle
Nome da estrutura Descrição
GControl Estrutura básica de controles. A partir dela é possível criar controles customizados.
GLargeMapControl Controle com recursos de deslocamento de posição e manipulação de zoom com botões e barra de rolagem
GSmallMapControl Controle com recursos de deslocamento de posição e manipulação de zoom com botões
Estrutura “MIcon” contém os atributos e operações para manipulação de ícone
Nome do atributo Tipo Descrição
iconAnchor MSize Armazena estrutura com pixels de coordenadas em relação ao canto superior esquerdo da imagem do ícone em que este ícone é ancorado ao mapa.
iconSize MSize Armazena o tamanho do ícone em pixels
image Conjunto de caracteres Armazena o endereço de acesso da imagem a ser representada no ícone
Nome da operação Parâmetros Retorno Descrição
addLayer Referência do layer a ser associado no mapa Não aplicável Adiciona layer para o mapa
Estrutura “MMap2″ contém os atributos e operações para manipulação de mapa geográfica e suas características
Nome do atributo Tipo Descrição
infoWindow LBS.InfoWindow Armazena objeto do tipo InfoWindow
layers LBS.Layer.BaseTile Armazena coleção de layers presentes no mapa
Nome da operação Parâmetros Retorno Descrição
addControls Referência controle a ser associado no mapa Não aplicável Adiciona controle para o mapa
addLayer Referência do layer a ser associado no mapa Não aplicável Adiciona layer para o mapa
addOverlay Referência de marcador ou polyline Não aplicável Adiciona estrutura overlay (marker ou polyline) para o mapa
addMarker Referência do marcador MMaker a ser inserido no mapa Não aplicável Adiciona marcador para o mapa
addLayers Conjunto de referências dos layers a serem associados no mapa Não aplicável Adiciona conjunto de layers para o mapa
getInfoWindow Não aplicável Instância de objeto LBS.InfoWindow Obtém instância do objeto LBS.InfoWindow através do atributo “infoWindow”. Caso não exista conteúdo definido para o atributo “infoWindow”, uma janela de informação em branco é exibida no centro do mapa.
getLayersByName Nome de identificação do layer Instância do objeto do layer Obtém instância do objeto do layer a partir do seu nome
getLayerPxFromLatLng Estrutura MPoint com dados de coordenadas geográficas Layer com dados em pixels Obtém layer com dados em pixels a partir de ponto de localização com dados de latitude e longitude
getZoom Não aplicável Número inteiro Obtém número inteiro que representa o nível de zoom definido no mapa
removeAllMarkers Não aplicável Não aplicável Remove todos os marcadores presentes no mapa
removeControl Referência do control a ser removido no mapa Não aplicável Remove control do mapa
removeLayers Referência do layer a ser removido no mapa Não aplicável Remove layer do mapa
removeMarker Referência do marcador a ser removido no mapa Não aplicável Remove marcador do mapa
setCenter
  • latlng (estrutura MPoint) – Indica coordenadas geográficas com a localização do ponto a ser definido
  • zoom (número inteiro) – Nível de zoom para o mapa
Não aplicável Define o ponto central do mapa
setZoom level (número inteiro entre 1 e 19) – Indica o nível de zoom no mapa Não aplicável Define o ponto central do mapa
zoomIn Não aplicável Não aplicável Adiciona o valor 1 (um) para o nível atual de zoom do mapa
zoomOut Não aplicável Não aplicável Diminui o valor 1 (um) para o nível atual de zoom do mapa
Estrutura “MPoint” contém as coordenadas de latitude e longitude para um determinado endereço
Nome da operação Parâmetros Retorno Descrição
construtor – MPoint()
  • latitude (número com casas decimais) – Indica o valor de latitude para a coordenada geográfica
  • longitude (número com casas decimais) – Indica o valor de longitude para a coordenada geográfica
Não aplicável Constrói o objeto com valores de coordenadas geográficas (latitude e longitude)
Estrutura “MExtent” configura o mapa a partir de valores minimos e maximos para coordenadas X e Y.
Nome do atributo Tipo Descrição
xMin Número com casas decimais Indica valor mínimo da coordenada X
xMax Número com casas decimais Indica o valor máximo da coordenada X
yMin Número com casas decimais Indica o valor mínimo da coordenada Y
yMax Número com casas decimais Indica o valor máximo da coordenada Y
Estrutura “MMapSize” contém o tamanho do mapa
Nome do atributo Tipo Descrição
width Número inteiro Indica a largura do mapa
height Número inteiro Indica a altura do mapa
Estrutura “MMapOption” contém propriedades e filtros para geração de um mapa
Nome do atributo Tipo Descrição
mapSize Estrutura MMapSize 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 “MWsMapRender” é utilizada para consumir o serviço SOAP “MapRender”
Nome da operação Parâmetros Retorno Descrição
getMap
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • extent (estrutura MExtent) – Indica dimensão do mapa
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa
getZoom
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • extent (estrutura MExtent) – Indica dimensão do mapa
  • percZoom – Número inteiro que indica porcentagem de ampliação de um mapa
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com zoom
getPan
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • direction – número inteiro que indica a direção e o nivel de deslocamento
  • percNavigation – número inteiro que indica a direção para a realização de deslocamento em uma mapa
  • extent (estrutura MExtent) – Indica dimensão do mapa
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com deslocamento
getZoomRadius
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • pX (estrutura MPoint) – coordenadas geográficas desejadas
  • radius – Número inteiro representando
  • extent (estrutura MExtent) – Indica dimensão do mapa
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com deslocamento
getZoomWindow
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • old extent (estrutura MExtent) – Indica dimensão do mapa atual
  • newExtendInPixels(estrutura MExtent) – Indica os pontos utilizados para realizar a ampliação no mapa, obtendo um ponto central de visualização desejado
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com ampliação por pontos
getZoomState
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • uf – nome do estado a ser destacado no mapa
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com ampliação em um estado
getZoomCity
  • routeID – identificador de rota gerado por metódos do serviço MWsRoute
  • mo (estrutura MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • city (estrutura MCity) – Indica cidade a ser destacada
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de renderização de mapa com ampliação em uma cidade

Estrutura “MMarker” contém os atributos e operações para manipulação de marcadores
Nome do atributo Tipo Descrição
description Conjunto de caracteres Armazena a descrição do marcador.
icon MIcon Armazena ícone a ser representado no marcador.
latlng LBS.LatLng Armazena estrutura com dados de coordenadas geográficas (latitude e longitude).
Nome da operação Parâmetros Retorno Descrição
addLayer Referência do layer a ser associado no mapa Não aplicável Adiciona layer para o mapa
bindInfoWindowHtml Não aplicável Não aplicável Registra um evento para ativar a função “openInfoWindow” ao clicar sobre o marcador, exibindo o conteúdo informado como parâmetro na janela de informações.
closeInfoWindow Não aplicável Não aplicável Fecha a janela de informações do marcador.
hide Não aplicável Não aplicável Desabilita a exibição do marcador no mapa.
openInfoWindow Não aplicável Não aplicável Exibe uma janela com o conteúdo contido no atributo “description” para o marcador. Atribui o conteúdo com tipo “LBS.InfoWindow” para o atributo do “infoWindow” do mapa corrente.
openInfoWindow (content) Conteúdo a ser exibido Não aplicável Atualiza o atributo “description” com o valor fornecido como parâmetro e exibe uma janela com o conteúdo recém atribuido. Atribui o conteúdo com tipo “LBS.InfoWindow” para o atributo do “infoWindow” do mapa corrente.
openInfoWindowHtml Conteúdo a ser exibido Não aplicável Atualiza o atributo “description” com o valor fornecido (permite tags e estrutura HTML) como parâmetro e exibe uma janela com o conteúdo recém atribuido. Atribui o conteúdo com tipo “LBS.InfoWindow” para o atributo do “infoWindow” do mapa corrente.
show Não aplicável Não aplicável Habilita a exibição do marcador no mapa.
Estrutura “MSize” contém as dimensões de altura e largura, sendo estes representados em pixels
Nome do atributo Tipo Descrição
height Número inteiro Indica o tamanho em altura
width Número inteiro Indica o tamanho em largura
Nome da operação Parâmetros Retorno Descrição
construtor – MSize()
  • width (número inteiro) – largura
  • height (número inteiro) – altura
Não aplicável Adiciona layer para o mapa

Estrutura “MPolyline” contém operações para criação de formas e polígonos
Nome da operação Parâmetros Retorno Descrição
construtor – MPolyLine()
  • polyPoints (conjunto de implementações da estrutura MMarker) – conjunto de pontos
  • lineColor (conjunto de caracteres no padrão “#ABCDEF”) – cor da linha
  • lineWeight (número inteiro) – tamanho (espessura) da linha
  • lineOpacity (número com casas decimais) – opacidade da linha
Instância da estrutura MPolyLine Cria instância da estrutura MPolyLine
Estrutura “MPolylineProperties” contém as propriedades da linha a ser utilizada para desenho de linhas para um polígono.
Nome da operação Parâmetros Retorno Descrição
construtor – MPolylineProperties()
  • color (conjunto de caracteres no padrão “#ABCDEF”) – cor da linha
  • weight (número inteiro) – tamanho (espessura) da linha
  • opacity (número com casas decimais) – opacidade da linha
Instância da estrutura MPolylineProperties Cria instância da estrutura MPolylineProperties
Estrutura “MCircle” contém operações para criação de círculos.
Nome da operação Parâmetros Retorno Descrição
construtor – MCircle()
  • originPoint (MPoint) – ponto de origem (central) para desenho do círculo
  • radius (número inteiro) – raio a ser considerado (em metros) para desenho do círculo
  • lineProperties (MPolylineProperties) – contém as propriedades da linha a ser usada para traçamento do círculo
Instância da estrutura MCircle Cria instância da estrutura MCircle
Estrutura “MDescriptionType” 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 “MRouteDescriptionOptions” contém as opções para geração do conteúdo de descrição por rota
Nome da operação Parâmetros Retorno Descrição
construtor – MRouteDescriptionOptions()
  • divName (conjunto de caracteres) – indica o nome do elemento “div” onde o conteúdo será exibido
  • routeOptions (estrutura MTable

) – indica referência de estrutura MTable Instância da estrutura MRouteDescriptionOptions Cria instância da estrutura MRouteDescriptionOptions

Estrutura “RouteDetails” contém os detalhes da rota, contendo o tipo da rota e se as paradas sejam otimizadas
Nome do atributo Tipo Descrição
BarrierPoint Estrutura MPoint Indica um conjunto de pontos de bloqueio na rota
BarriersList Conjunto de caracteres Indica uma lista de pontos pré-definidos para bloqueio
DescriptionType Estrutura MDescriptionType 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 MRouteType Indica o tipo da rota
Estrutura “MRouteOptions” 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 MRouteDetails Indica as opções e filtros a serem utilizados para geração da rota
Vehicle Estrutura MVehicle Indica as propriedades do veículo usado no percurso e de categoria de pedágio
Estrutura “MRouteStop” 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 MPoint Indica as coordenadas geográficas correspondente aos pontos de origem e destino
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
Estrutura “SearchType” contém os filtros disponíveis para a busca por endereço a ser realizada
Atributo Descrição
0 Busca exata pelo texto digitado
1 Busca começando com o texto digitado
2 Busca o texto digitado em qualquer lugar do endereço
3 Busca endereços que terminem com o texto digitado
Estrutura “MTable” armazena forma para criação de tabela e exibição de dados de descrição por rota.
Nome da operação Parâmetros Retorno Descrição
construtor – MTable() width (número inteiro) – indica o tamanho em largura da tabela ser criada Instância da estrutura “MTable” Cria instância da estrutura “MTable”
setLineStyle html (conjunto de caracteres) – indica o html com formatação para o estilo da linha Não aplicável Define o estilo a ser aplicado na linha da tabela
setLineAlterStyle html (conjunto de caracteres) – indica o html com formatação para o estilo da linha alternativa Não aplicável Define o estilo a ser aplicado na linha alternativa da tabela
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 “MVehicle” 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
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 MTollFeeCat
Estrutura “MWsRoute” é utilizada para consumir o serviço SOAP “Route”
Nome da operação Parâmetros Retorno Descrição
getRoute
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geração de rotas
getRouteSummary
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter dados de resumo por rota
getRouteTotals
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de cálculo de valores totais por rota
getRouteDescription
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter dados de descrição por rota
getRouteAvoidingTraffic (uso interno)
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • idInternal – identificador de contexto
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geração de rotas evitando o tránsito (uso interno)
getRouteWithMap
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • mapOptions (MMapOption) – Indica opções de exibição do mapa como tamanho e barra de escala
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geração de rota com renderização de mapa
getCoordsFull
  • routeID – identificador de rota gerado pelo serviço
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter coordenadas de uma rota
getRouteByID (uso interno)
  • routeID – identificador de rota gerada pelo serviço
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de obter rota pelo identificador (uso interno)
getDistancePointFromRoute
  • routeID – identificador de rota gerado pelo serviço
  • point – (estrutura MPoint) – Ponto utilizado como referência para o calculo da distância
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de calcular distância de um ponto a uma rota
Estrutura “MWsSpecialRoute” é utilizada para consumir o serviço SOAP “SpecialRoute”
Nome da operação Parâmetros Retorno Descrição
getRouteAvoidingTraffic
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geração de rotas com recursos de desvio de áreas com trafégo intenso
getRouteAvoidingRestrictedArea
  • routes (conjunto de implementações da estrutura MRouteStop) – Indica os pontos de parada da roda
  • routeOptions (estrutura MRouteOptions) – Indica as opções usadas no processo de roteirização
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de geração de rotas com recursos de desvio de áreas com rodizio
Estrutura “MTollFeeDetails” Contém as informações das praças de pedágio
Atributo Tipo Descrição
name Conjunto de caracteres Indica o nome da praça de pedágio
direction Conjunto de caracteres indica o sentido da 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
price Conjunto de caracteres Indica o preço a ser cobrado
pricePerAxle Conjunto de caracteres Indica o o preço por eixo
Estrutura “MPOIDetails” Contém dados do ponto de interesse
Atributo Tipo Descrição
clientID Conjunto de caracteres Indica o código de identificação
name Conjunto de caracteres Indica o nome do ponto de interesse
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 na obtenção dos dados
point Estrutura MPoint Indica as coordenadas geográficas correspondente ao ponto de interesse
Estrutura “MRouteSummary” Contém dados resumidos das paradas da rota
Atributo Tipo Descrição
description Conjunto de caracteres Indica a descrição da parada
distance Número com casas decimais Indica a distância do percurso da parada
point Estrutura MPoint Indica as coordenadas geográficas correspondente da parada
Estrutura “MRoadType” Contém os tipos de asfalto/piso para as rodovias percorridas na rota
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 construção
roadwayInPoorConditions Número inteiro Quantidade de quilômetros de pista em duplicação
secondLaneUnderConstruction Número inteiro Quantidade de quilômetros de pista em duplicação
TwoLaneHighway Número inteiro Quantidade de quilômetros em pista dupla
Estrutura “MRouteTotals” Contém os valores totais gastos por rota
Atributo Tipo Descrição
taxiFare1 Número com casas decimais Indica custo de taxi com bandeira 1
taxiFare2 Número com casas decimais Indica custo de taxi com bandeira 2
totalCost Número com casas decimais Indica o custo total da rota (inclui o custo de combustivel e de eventuais pedágios)
totalDistance Número 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 a quantidade de combustível gasta
totalTime Conjunto de caracteres Indica o tempo total para a rota no padrão ISO8601. Exemplo: P18Y9M4DT11H9M8S (18 anos, 9 meses, 4 dias, 11 horas e 8 segundo. Calculo realizado pela velocidade média da via
totalTollFeeCost Número com casas decimais Indica o custo total de pedágios
Estrutura “MSegmentDescription” Contém dados de descrição do percurso por rota
Atributo Tipo Descrição
command Conjunto de caracteres Indica os possiveis comando sendo eles:

  • Inicio da rota
  • Fim da rota
  • Siga
  • Continue
  • Siga na unificação
  • Vire à esquerda
  • Vire à direita
  • Faça curva acentuada à esquerda
  • Permaneça à esquerda
  • Permaneça à direita
  • Pegue o retorno
  • Pegue o retorno à direita
  • Para X (onde X é ponto de parada requisitado na rota, por exemplo, “Parada 1″)
description Conjunto de caracteres Indica o nome do logradouro ou rodovia
city Estrutura MCity Indica o nome do logradouro ou rodovia
tollFeeDetails Estrutura MTollFeeDetails Indica as informações das praças de pedágio
roadType Conjunto de caracteres Indica 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 percurso
cumulativeDistance Número com casas decimais Indica a distância acumuluda
point Estrutura MPoint Indica as coordenadas geográficas corresponde ao ponto
poiRoute Conjunto de caracteres Indica o tipo do ponto de interesse
poiRouteDetails Estrutura MPOIDetails Indica os dados do ponto de interesse
Estrutura “MRouteInfo” Contém informações detalhadas sobre a rota pesquisada
Atributo Tipo Descrição
routeID Número inteiro Indica código de identificação da rota gerada
mapInfo Estrutura MMapInfo Indica Informaçãoes sobre o mapa renderizado
segDescription Estrutura MRouteTotals Descrição sobre o percurso da rota gerada
routeSummary Estrutura MRouteSummary Indica as informações resumidas sobre as paradas da rota
roadType Estrutura MRoadType Indica informações sobre o asfalto e piso da rota gerada
distance Número com casas decimais Indica a distância do percurso
cumulativeDistance Número com casas decimais Indica a distância acumuluda
point Estrutura MPoint Indica as coordenadas geográficas corresponde ao ponto
poiRoute Conjunto de caracteres Indica o tipo do ponto de interesse
poiRouteDetails Estrutura MPOIDetails Indica os dados do ponto de interesse

Estrutura “MWsTraffic” é utilizada para consumir o serviço SOAP “Traffic”
Nome da operação Parâmetros Retorno Descrição
getInfo
  • city (estrutura MCity) – Indica cidade a ser analisada
  • resultRange (estrutura MResultRange) – Indica opções de paginação
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de trânsito
getCorridors
  • city (estrutura MCity) – Indica cidade a ser analisada
  • resultRange (estrutura MResultRange) – Indica opções de paginação
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de corredores
getCorridorById
  • city (estrutura MCity) – Indica cidade a ser analisada
  • corridorId – identificador do corredor a ser buscado
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de um corredor específico
getExcerpts
  • city (estrutura MCity) – Indica cidade a ser analisada
  • corridorId – identificador de corredor
  • resultRange (estrutura MResultRange) – Indica opções de paginação
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de trechos por corredor
getCongestedCorridors
  • city (estrutura MCity) – Indica cidade a ser analisada
  • resultRange (estrutura MResultRange) – Indica opções de paginação
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de corredores congestionados
getAllCongested
  • city (estrutura MCity) – Indica cidade a ser analisada
  • função de callBack de retorno
Através de função de callBack de retorno Consome serviço de busca de informações de corredores e trechos congestionados
Estrutura “MInfo” Contém informações atuais do trânsito
Atributo Tipo Descrição
date Conjunto de caracteres data da informação
time Conjunto de caracteres Indica Hora da informação
situation Conjunto de caracteres descrição da informação
km Conjunto de caracteres Indica quilometro onde ocorreu a situação
city Estrutura MCity Indica informações do local (cidade e estado)
Estrutura “MLevelCongested” contém o nível de congestionamento.
Atributo Descrição
0 Livre
1 Lento
2 Fluido
4 Bloqueado
8 *Sem Informação
16 Intenso

* O processo de atualização das informações de trânsito ocorre a cada 15 minutos. Quando não há registro de dados de trânsito para um determinado corredor, considerando a última atualização realizada, o status “Sem informação” é retornado.

Estrutura “MExcerpt” Contém dados de trecho por corredor
Atributo Tipo Descrição
codCorridor Número inteiro indica o código do corredor
codExcept Número inteiro Indica código do techo
nameExcept Conjunto de caracteres Indica o nome do trecho
levelCongested Estrutura MLevelCongested Indica o nível de congestionamento da via
codDirection Número inteiro Código de direção ou sentido
direction Conjunto de caracteres Indica a direção ou sentido
city Estrutura MCity Indica informações do local (cidade e estado)
point Estrutura MPoint Indica as coordenadas geográficas correspondente a localização
distance Número inteiro Distância do trecho em metros
order Número inteiro Código da ordem que ocupa no corredor
description Conjunto de caracteres Descrição do estado do tránsition atual
Estrutura “MExcerptInfo” Contém dados de paginação e de trechos de um corredor
Atributo Tipo Descrição
pageCount Número inteiro Indica um número inteiro com a página corrente para o sistema de paginação
totalRecord Número inteiro Indica um número inteiro com a quantidade total de registros obtidos para a requisição solicitada
excerpt Número inteiro Armazena um conjunto de implementações para a estrutura “Excerpt” com os dados de trechos de um corredor
Estrutura “MCorridor” Contém dados de corredores
Atributo Tipo Descrição
codCorridor Número inteiro Indica o código do corredor
nameCorridor Conjunto de caracteres Indica o nome do corredor
levelCongested Estrutura MLevelCongested Indica o nível de congestionamento da via
city Estrutura MCity Indica a cidade e estado
point Estrutura MPoint Indica as coordenadas geográficas correspondente a localização
excerptInfo Estrutura MExcerptInfo Indica os trechos existentes para o corredor corrente
Estrutura “MCorridorInfo” Contem informações de corredores
Atributo Tipo Descrição
pageCount Número inteiro número de paginas retornadas
recordCount Número inteiro numero de registros retornados
totalRecord Número inteiro total de registros existentes
info Conjunto de Estrutura MCorridor Informações de transito sobre os corredores.
Estrutura “MTrafficInfo” Contém informações de trânsito e dados de paginação
Atributo Tipo Descrição
pageCount Número inteiro número de paginas retornadas
recordCount Número inteiro numero de registros retornados
totalRecord Número inteiro total de registros existentes
time Número inteiro Parâmetro descontinuado
info Conjunto de Estrutura MInfo Informações sobre o transito