Route - Get Route Directions

Referência

Service:: Maps

API Version:: 1.0

Use para calcular uma rota entre uma origem e um destino especificados, passando por quaisquer pontos de passagem especificados.

A Get Route Directions API é uma solicitação HTTP GET que retorna uma rota entre uma origem e um destino, passando por pontos de passagem, se especificado. A rota leva em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia.

As informações retornadas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem otimizada do ponto de passagem ou instruções por turno, também estão disponíveis, dependendo das opções selecionadas.

O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada de um modelo de consumo específico do veículo. Para obter mais informações, consulte Modelo de consumo.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número de versão da API de Mapas Azure.
query	query	True	string	As Coordenadas por meio das quais a rota é calculada, delimitadas por dois-pontos. Um mínimo de duas coordenadas é necessário. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio atuam como WayPoints na rota. Você pode passar até 150 WayPoints.
accelerationEfficiency	query		number double	Especifica a eficiência da conversão de energia química armazenada em combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido pela conversão de combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com decelerationEfficiency. O intervalo de valores permitidos é de 0,0 a 1/decelerationEfficiency. Valores sensatos: para o modelo de combustão : 0,33, para o modelo elétrico : 0,66
alternativeType	query		AlternativeRouteType	Controla a idealidade, em relação aos critérios de planejamento fornecidos, das alternativas calculadas em comparação com a rota de referência.
arriveAt	query		string date-time	A data e a hora de chegada no ponto de destino. Ele deve ser especificado como dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de destino. O valor arriveAt deve estar no futuro. O parâmetro arriveAt não pode ser usado em conjunto com departAt, minDeviationDistance ou minDeviationTime.
auxiliaryPowerInkW	query		number double	Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em quilowatts (kW). Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas como sistemas AC, rádio, aquecimento etc. Valores sensatos: 1,7
auxiliaryPowerInLitersPerHour	query		number double	Especifica a quantidade de combustível consumida para sustentar sistemas auxiliares do veículo, em litros por hora. Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas como sistemas AC, rádio, aquecimento etc. Valores sensatos: 0,2
avoid	query		RouteAvoidType[]	Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações calculateReachableRange, o valor alreadyUsedRoads não deve ser usado.
computeBestOrder	query		boolean	Ordene novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Gera melhores resultados quando usado em conjunto com routeType mais curto. Observe que a origem e o destino são excluídos dos índices de ponto de passagem otimizados. Para incluir a origem e o destino na resposta, aumente todos os índices em 1 para considerar a origem e adicione o destino como o índice final. Os possíveis valores são true ou false. True calcula uma ordem melhor, se possível, mas não tem permissão para ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com pontos de passagem de círculo. False usará os locais na ordem determinada e não poderá ser usado em conjunto com routeRepresentation none.
computeTravelTimeFor	query		ComputeTravelTime	Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Especifica o componente dependente de velocidade do consumo. Fornecido como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira: por interpolação linear, se a velocidade fornecida estiver entre duas velocidades na lista por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional. O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas menores velocidades na lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor. O intervalo válido para os valores de consumo (expressos em kWh/100km) está entre 0,01 e 100000.0. Valores sensatos: 50,8,2:130,21,3 Esse parâmetro é necessário para o modelo de consumo elétrico.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Especifica o componente dependente de velocidade do consumo. Fornecida como uma lista não ordenada de velocidade delimitada por dois-pontos & pares de taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira: por interpolação linear, se a velocidade fornecida estiver entre duas velocidades na lista por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional. O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas menores velocidades na lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor. O intervalo válido para os valores de consumo (expressos em l/100km) está entre 0,01 e 1000000,0. Valores sensatos: 50,6.3:130,11,5 Observação : esse parâmetro é necessário para o Modelo de Consumo de Combustão.
currentChargeInkWh	query		number double	Especifica o fornecimento de energia elétrica atual em quilowatts-hora (kWh). Esse parâmetro coexiste com o parâmetro maxChargeInkWh . O intervalo de valores permitidos é de 0,0 a maxChargeInkWh. Valores sensatos: 43
currentFuelInLiters	query		number double	Especifica o fornecimento atual de combustível em litros. Valores sensatos: 55
decelerationEfficiency	query		number double	Especifica a eficiência da conversão de energia cinética em combustível salvo (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com accelerationEfficiency. O intervalo de valores permitidos é de 0,0 a 1/accelerationEfficiency. Valores sensatos: para o modelo de combustão : 0,83, para o modelo elétrico : 0,91
departAt	query		string date-time	A data e a hora da partida do ponto de origem. Horários de partida separados de agora devem ser especificados como um dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de origem. O valor departAt deve estar no futuro no formato de data e hora (1996-12-19T16:39:57-08:00).
downhillEfficiency	query		number double	Especifica a eficiência da conversão de energia potencial para combustível salvo (não consumido) quando o veículo perde elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com uphillEfficiency. O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency. Valores sensatos: para o modelo de combustão : 0,51, para o modelo elétrico : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Especifica a quantidade de energia química armazenada em um litro de combustível em megajoules (MJ). Ele é usado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível salvos ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para gasolina e 35,8 MJ/l para diesel. Esse parâmetro será necessário se qualquer parâmetro *Efficiency estiver definido. Valores sensatos: 34.2
hilliness	query		InclineLevel	Grau de colina para rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.
instructionsType	query		RouteInstructionsType	Se especificado, as instruções de diretriz serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none
language	query		string	O parâmetro de idioma determina o idioma das mensagens de orientação. Substantivos adequados (os nomes de ruas, praças etc.) são retornados no idioma especificado ou, se isso não estiver disponível, eles serão retornados em um idioma disponível próximo a ele. Os valores permitidos são (um subconjunto de) as marcas de idioma IETF. Os idiomas com suporte no momento estão listados na seção Idiomas com suporte. Valor padrão: en-GB
maxAlternatives	query		integer	Número de rotas alternativas desejadas a serem calculadas. Padrão: 0, mínimo: 0 e máximo: 5
maxChargeInkWh	query		number double	Especifica o fornecimento máximo de energia elétrica em kWh (quilowatts-hora) que podem ser armazenados na bateria do veículo. Esse parâmetro coexiste com o parâmetro currentChargeInkWh . O valor mínimo deve ser maior ou igual a currentChargeInkWh. Valores sensatos: 85
minDeviationDistance	query		integer	Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção Solicitações POST) do ponto de origem da solicitação calculateRoute para pelo menos esse número de medidores. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser usado em conjunto com arriveAt
minDeviationTime	query		integer	Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção Solicitações POST) do ponto de origem da solicitação calculateRoute para pelo menos esse número de segundos. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationTime não pode ser usado em conjunto com arriveAt. O valor padrão é 0. Definir )minDeviationTime_ como um valor maior que zero tem as seguintes consequências: O ponto de origem da solicitação calculateRoute deve estar na (ou muito próxima) da rota de referência de entrada. Se esse não for o caso, um erro será retornado. No entanto, o ponto de origem não precisa estar no início da rota de referência de entrada (ele pode ser considerado como a posição atual do veículo na rota de referência). A rota de referência, retornada como a primeira rota na resposta calculateRoute , começará no ponto de origem especificado na Solicitação calculateRoute . A parte inicial da rota de referência de entrada até que o ponto de origem seja excluído da Resposta. Os valores de minDeviationDistance e minDeviationTime determinam até que ponto as rotas alternativas serão garantidas para seguir a rota de referência do ponto de origem em diante. A rota deve usar departAt. O vehicleHeading é ignorado.
report	query		Report	Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros efetivos ou os dados usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.
routeRepresentation	query		RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecido como resposta. Esse valor de parâmetro só pode ser usado em conjunto com computeBestOrder=true.
routeType	query		RouteType	O tipo de rota solicitada.
sectionType	query		SectionType	Especifica qual dos tipos de seção é relatado na resposta da rota. Por exemplo, se sectionType = pedestre, as seções adequadas somente para pedestres serão retornadas. Vários tipos podem ser usados. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro
traffic	query		boolean	Valores possíveis: true – considere todas as informações de tráfego disponíveis durante o roteamento false – ignorar dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico nas velocidades efetivas das estradas ainda é incorporado.
travelMode	query		TravelMode	O modo de viagem para a rota solicitada. Se não estiver definido, o padrão será 'car'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem de ônibus, motocicleta, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas. Em solicitações calculateReachableRange , os valores bicicleta e pedestre não devem ser usados.
uphillEfficiency	query		number double	Especifica a eficiência da conversão de energia química armazenada em combustível para energia potencial quando o veículo ganha elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido pela conversão de combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com downhillEfficiency. O intervalo de valores permitidos é de 0,0 a 1/downhillEfficiency. Valores sensatos: para o modelo de combustão : 0,27, para o modelo elétrico : 0,74
vehicleAxleWeight	query		integer	Peso por eixo do veículo em kg. Um valor de 0 significa que as restrições de peso por eixo não são consideradas.
vehicleCommercial	query		boolean	Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir em algumas estradas.
vehicleEngineType	query		VehicleEngineType	Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.
vehicleHeading	query		integer	O título direcional do veículo em graus começando no verdadeiro Norte e continuando na direção no sentido horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus. Valores possíveis de 0 a 359
vehicleHeight	query		number double	Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.
vehicleLength	query		number double	Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
vehicleLoadType	query		VehicleLoadType	Tipos de carga que podem ser classificados como materiais perigosos e restritos de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro só é considerado para travelMode=truck.
vehicleMaxSpeed	query		integer	Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é usada para marcar se um veículo é permitido em auto-estradas. Um valor 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota. Um valor diferente de zero pode ser substituído durante o planejamento de rota. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo for definida como 50 km/hora, o motor de roteamento considerará 60 km/hora, pois essa é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o motor de roteamento usará novamente 60 km/hora.
vehicleWeight	query		integer	Peso do veículo em quilogramas. É obrigatório se qualquer um dos parâmetros Efficiency estiver definido. Ele deve ser estritamente positivo quando usado no contexto do Modelo de Consumo. Restrições de peso são consideradas. Se nenhum Modelo de Consumo* detalhado for especificado e o valor de vehicleWeight for diferente de zero, as restrições de peso serão consideradas. Em todos os outros casos, esse parâmetro é ignorado. Valores sensatos: para o modelo de combustão : 1600, para o modelo elétrico : 1900
vehicleWidth	query		number double	Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.
windingness	query		WindingnessLevel	Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	RouteDirections	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

Successfully retrieve a route between an origin and a destination

Sample Request

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definições

Nome	Description
AlternativeRouteType	Controla a idealidade, em relação aos critérios de planejamento fornecidos, das alternativas calculadas em comparação com a rota de referência.
ComputeTravelTime	Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.
DelayMagnitude	A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API Obter Detalhes do Incidente de Tráfego.
DrivingSide	Indica direção à esquerda versus à direita no ponto da manobra.
EffectiveSetting	Parâmetro efetivo ou dados usados ao chamar essa API de Rota.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
GuidanceInstructionType	Tipo da instrução, por exemplo, girar ou alterar a forma da estrada.
GuidanceManeuver	Um código que identifica a manobra.
InclineLevel	Grau de colina para rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.
JunctionType	O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.
LatLongPair	Um local representado como latitude e longitude.
Report	Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
ResponseSectionType	Tipos de seção da resposta de rota relatada
ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido `other` como se o modo de transporte solicitado não for possível nesta seção
Route
RouteAvoidType	Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Em solicitações calculateReachableRange, o valor alreadyUsedRoads não deve ser usado.
RouteDirections	Este objeto é retornado de uma chamada de Trajeto de Rota bem-sucedida
RouteGuidance	Contém elementos relacionados a diretrizes. Esse campo está presente somente quando as diretrizes foram solicitadas e estão disponíveis.
RouteInstruction	Um conjunto de atributos que descrevem uma manobra, por exemplo, "Vire para a direita", "Mantenha a esquerda", "Pegue a balsa", "Pegue a auto-estrada", "Chegar".
RouteInstructionGroup	Agrupa uma sequência de elementos de instrução relacionados entre si. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo retornada quando disponível.
RouteInstructionsType	Se especificado, as instruções de orientação serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none
RouteLeg	Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido na solicitação resultará em uma etapa adicional na rota retornada.
RouteLegSummary	Objeto summary para a seção de rota.
RouteOptimizedWaypoint	Objeto de ponto de passagem otimizado.
RouteReport	Relata as configurações efetivas usadas na chamada atual.
RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecido como resposta. Esse valor de parâmetro só pode ser usado em conjunto com computeBestOrder=true.
RouteSection	As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos `startPointIndex`, `endPointIndex`e `sectionType`.
RouteSectionTec	Detalhes do evento de tráfego, usando definições no padrão TPEG2-TEC . Pode conter effectCode e causa elementos.
RouteSectionTecCause	A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.
RouteSummary	Objeto Summary
RouteType	O tipo de rota solicitada.
SectionType	Especifica qual dos tipos de seção é relatado na resposta de rota. Por exemplo, se sectionType = pedestre, as seções adequadas apenas para pedestres serão retornadas. Vários tipos podem ser usados. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro
SimpleCategory	Tipo do incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Confira "tec" para obter informações detalhadas.
TravelMode	O modo de viagem para a rota solicitada. Se não estiver definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem de ônibus, motocicleta, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas. Em solicitações calculateReachableRange , os valores bicicleta e pedestre não devem ser usados.
VehicleEngineType	Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.
VehicleLoadType	Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.
WindingnessLevel	Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.

AlternativeRouteType

Controla a idealidade, em relação aos critérios de planejamento fornecidos, das alternativas calculadas em comparação com a rota de referência.

Nome	Tipo	Description
anyRoute	string	Permita que qualquer rota alternativa seja retornada independentemente de como ela se compara à rota de referência em termos de idealidade.
betterRoute	string	Retorne uma rota alternativa somente se ela for melhor do que a rota de referência de acordo com os critérios de planejamento especificados.

ComputeTravelTime

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.

Nome	Tipo	Description
all	string	Calcula os tempos de viagem para todos os tipos de informações de tráfego e especifica todos os resultados nos campos noTraffic TravelTimeInSeconds, historicTraffic TravelTimeInSeconds e liveTrafficIncidents TravelTimeInSeconds incluídos nos resumos na resposta da rota.
none	string	Não calcula tempos de viagem adicionais.

DelayMagnitude

A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API Obter Detalhes do Incidente de Tráfego.

Nome	Tipo	Description
0	string	Desconhecida.
1	string	Secundário.
2	string	Moderado.
3	string	Principal.
4	string	Indefinido, usado para fechamentos de estradas e outros atrasos indefinidos.

DrivingSide

Indica direção à esquerda versus à direita no ponto da manobra.

Nome	Tipo	Description
LEFT	string	Lado esquerdo.
RIGHT	string	Lado direito.

EffectiveSetting

Parâmetro efetivo ou dados usados ao chamar essa API de Rota.

Nome	Tipo	Description
key	string	Nome do parâmetro usado.
value	string	Valor do parâmetro usado.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GuidanceInstructionType

Tipo da instrução, por exemplo, girar ou alterar a forma da estrada.

Nome	Tipo	Description
DIRECTION_INFO	string	Informações de direção.
LOCATION_ARRIVAL	string	Local de chegada.
LOCATION_DEPARTURE	string	Local de partida.
LOCATION_WAYPOINT	string	Localização do ponto de passagem.
ROAD_CHANGE	string	Mudança de Estrada.
TURN	string	Transformar.

GuidanceManeuver

Um código que identifica a manobra.

Nome	Tipo	Description
ARRIVE	string	Você chegou.
ARRIVE_LEFT	string	Você chegou. Seu destino está à esquerda.
ARRIVE_RIGHT	string	Você chegou. Seu destino está à direita.
BEAR_LEFT	string	Urso à esquerda.
BEAR_RIGHT	string	Tenha razão.
DEPART	string	Deixar.
ENTER_FREEWAY	string	Pegue a rodovia.
ENTER_HIGHWAY	string	Pegue a estrada.
ENTER_MOTORWAY	string	Pegue a auto-estrada.
ENTRANCE_RAMP	string	Pegue a rampa.
FOLLOW	string	Seguir.
KEEP_LEFT	string	Mantenha-se à esquerda.
KEEP_RIGHT	string	Mantenha a direita.
MAKE_UTURN	string	Faça um retorno.
MOTORWAY_EXIT_LEFT	string	Pegue a saída para a esquerda.
MOTORWAY_EXIT_RIGHT	string	Pegue a saída à direita.
ROUNDABOUT_BACK	string	Desaiba a rotatória.
ROUNDABOUT_CROSS	string	Cruze a rotatória.
ROUNDABOUT_LEFT	string	Na rotatória, pegue a saída à esquerda.
ROUNDABOUT_RIGHT	string	Na rotatória, pegue a saída à direita.
SHARP_LEFT	string	Vire afiado para a esquerda.
SHARP_RIGHT	string	Vire afiado para a direita.
STRAIGHT	string	Continue em frente.
SWITCH_MAIN_ROAD	string	Alterne para a estrada main.
SWITCH_PARALLEL_ROAD	string	Alterne para a estrada paralela.
TAKE_EXIT	string	Pegue a saída.
TAKE_FERRY	string	Pegue a balsa.
TRY_MAKE_UTURN	string	Tente fazer uma reviravolta.
TURN_LEFT	string	Vire para a esquerda.
TURN_RIGHT	string	Vire para a direita.
WAYPOINT_LEFT	string	Você chegou ao ponto de passagem. Está à esquerda.
WAYPOINT_REACHED	string	Você chegou ao ponto de passagem.
WAYPOINT_RIGHT	string	Você chegou ao ponto de passagem. Está à direita.

InclineLevel

Grau de colina para rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Nome	Tipo	Description
high	string	high
low	string	low
normal	string	normal

JunctionType

O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.

Nome	Tipo	Description
BIFURCATION	string	Bifurcação
REGULAR	string	regular
ROUNDABOUT	string	Rotunda

LatLongPair

Um local representado como latitude e longitude.

Nome	Tipo	Description
latitude	number	Propriedade Latitude
longitude	number	Propriedade Longitude

Report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.

Nome	Tipo	Description
effectiveSettings	string	Relata os parâmetros ou dados efetivos usados ao chamar a API.

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript
xml	string	A linguagem de marcação extensível

ResponseSectionType

Tipos de seção da resposta de rota relatada

Nome	Tipo	Description
CARPOOL	string	Seções da rota que exigem o uso de pistas de carona (HOV/Veículo de Alta Ocupação).
CAR_TRAIN	string	Seções da rota que são carros ou trens.
COUNTRY	string	Seções que indicam em quais países/regiões a rota está.
FERRY	string	Seções da rota que são balsas.
MOTORWAY	string	Seções da rota que são auto-estradas.
PEDESTRIAN	string	Seções da rota que são adequadas apenas para pedestres.
TOLL_ROAD	string	Seções da rota que exigem um pedágio a ser pago.
TOLL_VIGNETTE	string	Seções da rota que exigem uma vinheta de pedágio para estar presente.
TRAFFIC	string	Seções da rota que contêm informações de tráfego.
TRAVEL_MODE	string	Seções em relação ao parâmetro de solicitação `travelMode`.
TUNNEL	string	Seções da rota que são túneis.
URBAN	string	Seções da rota que estão localizadas em áreas urbanas.

ResponseTravelMode

Modo de viagem para a rota calculada. O valor será definido other como se o modo de transporte solicitado não for possível nesta seção

Nome	Tipo	Description
bicycle	string	As rotas retornadas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus	string	As rotas retornadas são otimizadas para ônibus, incluindo o uso de faixas somente de ônibus. Funcionalidade BETA.
car	string	As rotas retornadas são otimizadas para carros.
motorcycle	string	As rotas retornadas são otimizadas para motocicletas. Funcionalidade BETA.
other	string	O modo de transporte especificado não é possível nesta seção
pedestrian	string	As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.
taxi	string	As rotas retornadas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas retornadas são otimizadas para veículos comerciais, como para caminhões.
van	string	As rotas retornadas são otimizadas para vans. Funcionalidade BETA.

Route

Nome	Tipo	Description
guidance	RouteGuidance	Contém elementos relacionados a diretrizes. Esse campo está presente somente quando as diretrizes foram solicitadas e estão disponíveis.
legs	RouteLeg[]	Matriz de pernas
sections	RouteSection[]	Matriz de seções
summary	RouteSummary	Objeto Summary

RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Em solicitações calculateReachableRange, o valor alreadyUsedRoads não deve ser usado.

Nome	Tipo	Description
alreadyUsedRoads	string	Evita usar a mesma estrada várias vezes. Mais útil em conjunto com `routeType`=emocionante.
borderCrossings	string	Evita cruzamentos de borda no cálculo de rota.
carpools	string	Evita rotas que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).
ferries	string	Evita balsas
motorways	string	Evita auto-estradas
tollRoads	string	Evita estradas pedagiadas.
unpavedRoads	string	Evita estradas não pavimentadas

RouteDirections

Este objeto é retornado de uma chamada de Trajeto de Rota bem-sucedida

Nome	Tipo	Description
formatVersion	string	Propriedade Format Version
optimizedWaypoints	RouteOptimizedWaypoint[]	Sequência otimizada de pontos de passagem. Ele mostra o índice da sequência de waypoint fornecida pelo usuário para a lista original e otimizada. Por exemplo, uma resposta: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` significa que a sequência original é [0, 1, 2] e a sequência otimizada é [1, 2, 0]. Como o índice começa em 0, o original é "primeiro, segundo, terceiro" enquanto o otimizado é "segundo, terceiro, primeiro".
report	RouteReport	Relata as configurações efetivas usadas na chamada atual.
routes	Route[]	Matriz de rotas

RouteGuidance

Contém elementos relacionados a diretrizes. Esse campo está presente somente quando as diretrizes foram solicitadas e estão disponíveis.

Nome	Tipo	Description
instructionGroups	RouteInstructionGroup[]	Agrupa uma sequência de elementos de instrução relacionados entre si.
instructions	RouteInstruction[]	Uma lista de instruções que descrevem manobras.

RouteInstruction

Um conjunto de atributos que descrevem uma manobra, por exemplo, "Vire para a direita", "Mantenha a esquerda", "Pegue a balsa", "Pegue a auto-estrada", "Chegar".

Nome	Tipo	Description
combinedMessage	string	Uma mensagem legível para a manobra combinada com a mensagem da próxima instrução. Às vezes, é possível combinar duas instruções sucessivas em uma única instrução, facilitando o acompanhamento. Quando esse for o caso, o sinalizador possibleCombineWithNext será verdadeiro. Por exemplo: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` O sinalizador possibleCombineWithNext na instrução 10 é true. Isso indica aos clientes de diretrizes codificadas que ele pode ser combinado com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitam diretrizes legíveis por humanos. O campo combinedMessage contém a mensagem combinada: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	Código de país ISO 3166-1 alfa-3 de 3 caracteres. Por exemplo, EUA.
drivingSide	DrivingSide	Indica direção à esquerda versus à direita no ponto da manobra.
exitNumber	string	O número de uma saída da rodovia tomada pela manobra atual. Se uma saída tiver vários números de saída, eles serão separados por "," e possivelmente agregados por "-", por exemplo, "10, 13-15".
instructionType	GuidanceInstructionType	Tipo da instrução, por exemplo, girar ou alterar a forma da estrada.
junctionType	JunctionType	O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.
maneuver	GuidanceManeuver	Um código que identifica a manobra.
message	string	Uma mensagem legível para a manobra.
point	LatLongPair	Um local representado como latitude e longitude.
pointIndex	integer	O índice do ponto na lista de "pontos" de polilinha correspondente ao ponto da instrução.
possibleCombineWithNext	boolean	Opcionalmente, é possível combinar a instrução com a próxima. Isso pode ser usado para criar mensagens como "Virar para a esquerda e depois virar para a direita".
roadNumbers	string[]	O(s) número(s) de estrada(s) dos próximos segmentos de estrada significativos após a manobra, ou das estradas a serem seguidas. Exemplo: ["E34", "N205"]
roundaboutExitNumber	string	Isso indica qual saída tomar em uma rotatória.
routeOffsetInMeters	integer	Distância do início da rota até o ponto da instrução.
signpostText	string	O texto em uma placa que é mais relevante para a manobra ou para a direção que deve ser seguida.
stateCode	string	Uma subdivisão (por exemplo, estado) do país, representada pela segunda parte de um código ISO 3166-2 . Isso só está disponível para alguns países/regiões, como EUA, Canadá e México.
street	string	Nome da rua do próximo segmento de estrada significativo após a manobra, ou da rua que deve ser seguida.
travelTimeInSeconds	integer	Tempo estimado de viagem até o ponto correspondente a routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indica a direção de uma instrução. Se junctionType indicar uma instrução de turno: 180 = U-turn [-179, -1] = Curva à esquerda 0 = Em linha reta (uma curva de '0 grau') [1, 179] = Curva à direita Se junctionType indicar uma instrução de bifurcação: <0 - mantenha a esquerda >0 - mantenha a direita

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução relacionados entre si. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo retornada quando disponível.

Nome	Tipo	Description
firstInstructionIndex	integer	Índice da primeira instrução nas instruções e pertencente a esse grupo.
groupLengthInMeters	integer	Comprimento do grupo.
groupMessage	string	Mensagem de resumo quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou marcadas).
lastInstructionIndex	integer	Índice da última instrução nas instruções e pertencente a esse grupo.

RouteInstructionsType

Se especificado, as instruções de orientação serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none

Nome Tipo Description

coded

Nome	Tipo	Description
coded	string	Retorna dados de instrução brutos sem mensagens legíveis por humanos.
tagged	string	Retorna dados de instrução brutos com mensagens legívels por humanos marcadas para permitir a formatação. Uma mensagem legível por humanos é criada com base em elementos identificados repetíveis. Eles são marcados para permitir que os aplicativos cliente os formatem corretamente. Os seguintes componentes de mensagem são marcados quando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Exemplo de mensagem "Virar à esquerda" marcada: `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Retorna dados de instruções brutos com mensagens legíveis por humanos em texto sem formatação.

string

Retorna dados de instrução brutos sem mensagens legíveis por humanos.

tagged

string

Retorna dados de instrução brutos com mensagens legívels por humanos marcadas para permitir a formatação. Uma mensagem legível por humanos é criada com base em elementos identificados repetíveis. Eles são marcados para permitir que os aplicativos cliente os formatem corretamente. Os seguintes componentes de mensagem são marcados quando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Exemplo de mensagem "Virar à esquerda" marcada:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

text

string

Retorna dados de instruções brutos com mensagens legíveis por humanos em texto sem formatação.

RouteLeg

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido na solicitação resultará em uma etapa adicional na rota retornada.

Nome	Tipo	Description
points	LatLongPair[]	Matriz de pontos
summary	RouteLegSummary	Objeto summary para a seção de rota.

RouteLegSummary

Objeto summary para a seção de rota.

Nome	Tipo	Description
arrivalTime	string	A hora de chegada estimada para a rota ou a perna. A hora está em UTC.
batteryConsumptionInkWh	number	Consumo estimado de energia elétrica em kWh (quilowatts-hora) usando o Modelo de Consumo Elétrico. Incluído se vehicleEngineType estiver definido como elétrico e constantSpeedConsumptionInkWhPerHundredkm for especificado. O valor de batteryConsumptionInkWh inclui a energia elétrica recuperada e, portanto, pode ser negativo (o que indica ganho de energia). Se maxChargeInkWh e currentChargeInkWh forem especificados, a recuperação será limitada para garantir que o nível de carga da bateria nunca exceda maxChargeInkWh. Se nem maxChargeInkWh nem currentChargeInkWh forem especificados, a recuperação irrestrita será assumida no cálculo de consumo.
departureTime	string	A hora de partida estimada para a rota ou a perna. A hora está em UTC.
fuelConsumptionInLiters	number	Consumo estimado de combustível em litros usando o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido como combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor será não negativo.
historicTrafficTravelTimeInSeconds	integer	Tempo estimado de viagem calculado usando dados de tráfego histórico dependentes do tempo. Incluído somente se computeTravelTimeFor = todos forem usados na consulta.
lengthInMeters	integer	Propriedade Length In Meters
liveTrafficIncidentsTravelTimeInSeconds	integer	Tempo estimado de viagem calculado usando dados de velocidade em tempo real. Incluído somente se computeTravelTimeFor = todos forem usados na consulta.
noTrafficTravelTimeInSeconds	integer	Tempo estimado de viagem calculado como se não houvesse atrasos na rota devido a condições de tráfego (por exemplo, congestionamento). Incluído somente se computeTravelTimeFor = todos forem usados na consulta.
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelos incidentes em tempo real de acordo com as informações de tráfego. Para rotas planejadas com hora de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro compute TravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem será calculado usando dados de tráfego histórico dependentes do tempo.

RouteOptimizedWaypoint

Objeto de ponto de passagem otimizado.

Nome	Tipo	Description
optimizedIndex	integer	Índice de ponto de passagem otimizado do sistema.
providedIndex	integer	Índice de ponto de passagem fornecido pelo usuário.

RouteReport

Relata as configurações efetivas usadas na chamada atual.

Nome	Tipo	Description
effectiveSettings	EffectiveSetting[]	Parâmetros efetivos ou dados usados ao chamar essa API de Rota.

RouteRepresentationForBestOrder

Especifica a representação do conjunto de rotas fornecido como resposta. Esse valor de parâmetro só pode ser usado em conjunto com computeBestOrder=true.

Nome	Tipo	Description
none	string	Inclui apenas os índices de waypoint otimizados, mas não inclui a geometria de rota na resposta.
polyline	string	Inclui geometria de rota na resposta.
summaryOnly	string	Resumo de acordo com a polilinha, mas excluindo os elementos de geometria de ponto para as rotas na resposta.

RouteSection

As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos startPointIndex, endPointIndexe sectionType.

Nome	Tipo	Description
delayInSeconds	integer	Atraso em segundos causado pelo incidente.
effectiveSpeedInKmh	integer	Velocidade efetiva do incidente em km/h, média em todo o seu comprimento.
endPointIndex	integer	Índice do último ponto (deslocamento 0) na rota à qual esta seção se aplica.
magnitudeOfDelay	DelayMagnitude	A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API Obter Detalhes do Incidente de Tráfego.
sectionType	ResponseSectionType	Tipos de seção da resposta de rota relatada
simpleCategory	SimpleCategory	Tipo do incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Confira "tec" para obter informações detalhadas.
startPointIndex	integer	Índice do primeiro ponto (deslocamento 0) na rota à qual esta seção se aplica.
tec	RouteSectionTec	Detalhes do evento de tráfego, usando definições no padrão TPEG2-TEC . Pode conter effectCode e causa elementos.
travelMode	ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido `other` como se o modo de transporte solicitado não for possível nesta seção

RouteSectionTec

Detalhes do evento de tráfego, usando definições no padrão TPEG2-TEC . Pode conter effectCode e causa elementos.

Nome	Tipo	Description
causes	RouteSectionTecCause[]	Matriz de causas
effectCode	integer	O efeito no fluxo de tráfego. Contém um valor na tabela tec001:EffectCode, conforme definido no padrão TPEG2-TEC . Pode ser usado para eventos de tráfego de código de cor de acordo com a gravidade.

RouteSectionTecCause

A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.

Nome	Tipo	Description
mainCauseCode	integer	A main causa do evento de tráfego. Contém um valor na tabela tec002:CauseCode, conforme definido no padrão TPEG2-TEC .
subCauseCode	integer	A subcauso do evento de tráfego. Contém um valor na tabela de sub-causa definida pelo mainCauseCode, conforme definido no padrão TPEG2-TEC .

RouteSummary

Objeto Summary

Nome	Tipo	Description
arrivalTime	string	A hora de chegada estimada para a rota ou a perna. A hora está em UTC.
departureTime	string	A hora de partida estimada para a rota ou a perna. A hora está em UTC.
lengthInMeters	integer	Propriedade Length In Meters
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelos incidentes em tempo real de acordo com as informações de tráfego. Para rotas planejadas com hora de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro compute TravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem será calculado usando dados de tráfego histórico dependentes do tempo.

RouteType

O tipo de rota solicitada.

Nome	Tipo	Description
eco	string	Uma rota equilibrada por economia e velocidade.
fastest	string	A rota mais rápida.
shortest	string	A rota mais curta por distância.
thrilling	string	Inclui estradas interessantes ou desafiadoras e usa o menor número possível de auto-estradas. Você pode escolher o nível de voltas incluído e também o grau de montanhidade. Consulte os parâmetros hilliness e windingness para saber como definir isso. Há um limite de 900 km em rotas planejadas com `routeType`=emocionante

SectionType

Especifica qual dos tipos de seção é relatado na resposta de rota.

Por exemplo, se sectionType = pedestre, as seções adequadas apenas para pedestres serão retornadas. Vários tipos podem ser usados. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro

Nome	Tipo	Description
carTrain	string	Seções da rota que são carros ou trens.
carpool	string	Seções da rota que exigem o uso de pistas de carona (HOV/Veículo de Alta Ocupação).
country	string	Seções que indicam em quais países/regiões a rota está.
ferry	string	Seções da rota que são balsas.
motorway	string	Seções da rota que são auto-estradas.
pedestrian	string	Seções da rota que são adequadas apenas para pedestres.
tollRoad	string	Seções da rota que exigem um pedágio a ser pago.
tollVignette	string	Seções da rota que exigem uma vinheta de pedágio para estar presente.
traffic	string	Seções da rota que contêm informações de tráfego.
travelMode	string	Seções em relação ao parâmetro `travelMode`de solicitação .
tunnel	string	Seções da rota que são túneis.
urban	string	Seções da rota que estão localizadas em áreas urbanas.

SimpleCategory

Tipo do incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Confira "tec" para obter informações detalhadas.

Nome	Tipo	Description
JAM	string	Engarrafamento.
OTHER	string	Outros.
ROAD_CLOSURE	string	Fechamento da estrada.
ROAD_WORK	string	Trabalho rodoviário.

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem de ônibus, motocicleta, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas. Em solicitações calculateReachableRange , os valores bicicleta e pedestre não devem ser usados.

Nome	Tipo	Description
bicycle	string	As rotas retornadas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus	string	As rotas retornadas são otimizadas para ônibus, incluindo o uso de faixas somente de ônibus. Funcionalidade BETA.
car	string	As rotas retornadas são otimizadas para carros.
motorcycle	string	As rotas retornadas são otimizadas para motocicletas. Funcionalidade BETA.
pedestrian	string	As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.
taxi	string	As rotas retornadas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas retornadas são otimizadas para veículos comerciais, como para caminhões.
van	string	As rotas retornadas são otimizadas para vans. Funcionalidade BETA.

VehicleEngineType

Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.

Nome	Tipo	Description
combustion	string	Motor de combustão interna.
electric	string	Motor elétrico.

VehicleLoadType

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.

Nome	Tipo	Description
USHazmatClass1	string	Explosivos
USHazmatClass2	string	Gás compactado
USHazmatClass3	string	Líquidos inflamáveis
USHazmatClass4	string	Sólidos inflamáveis
USHazmatClass5	string	Oxidantes
USHazmatClass6	string	Venenos
USHazmatClass7	string	Radioativo
USHazmatClass8	string	Corrosivos
USHazmatClass9	string	Diversos
otherHazmatExplosive	string	Explosivos
otherHazmatGeneral	string	Diversos
otherHazmatHarmfulToWater	string	Prejudicial à água

WindingnessLevel

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Nome	Tipo	Description
high	string	high
low	string	low
normal	string	normal

Route - Get Route Directions

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Observações

Scopes

subscription-key

SAS Token

Exemplos

Successfully retrieve a route between an origin and a destination

Sample Request

Sample Response

Definições

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Recursos adicionais