Route - Get Route Directions

Referência

Serviço:: Maps

Versão da API:: 1.0

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

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

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

O serviço de encaminhamento 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}

Com parâmetros opcionais:

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 do URI

Name	Em	Necessá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 da versão da API do Azure Maps.
query	query	True	string	As coordenadas através das quais a rota é calculada, delimitadas por dois pontos. É necessário um mínimo de duas coordenadas. O primeiro é a origem e o último é o destino da rota. Coordenadas opcionais intermediárias atuam como WayPoints na rota. Você pode passar até 150 WayPoints.
accelerationEfficiency	query		number double	Especifica a eficiência da conversão da energia química armazenada no combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com desaceleraçãoEficiência. O intervalo de valores permitidos são de 0,0 a 1/desaceleraçãoEficiência. Valores sensíveis: para modelo de combustão: 0,33, para modelo elétrico: 0,66
alternativeType	query		AlternativeRouteType	Controla a otimização, em relação aos critérios de planeamento 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 ao ponto de destino formatadas como um valor de `dateTime`, conforme definido no RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não é especificado, presumir-se-á que é o do ponto de destino. Exemplos: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 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 de CA, rádio, aquecimento, etc. Valores sensíveis : 1.7
auxiliaryPowerInLitersPerHour	query		number double	Especifica a quantidade de combustível consumida para sustentar os sistemas auxiliares do veículo, em litros por hora. Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc. Valores sensíveis : 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 um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.
computeBestOrder	query		boolean	Reordene os waypoints de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Produz melhores resultados quando usado em conjunto com routeType mais curto. Observe que origem e destino são excluídos dos índices de waypoint otimizados. Para incluir origem e destino na resposta, aumente todos os índices em 1 para levar em conta a origem e, em seguida, adicione o destino como o índice final. Os valores possíveis são true ou false. True calcula uma ordem melhor, se possível, mas não pode ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com waypoints circulares. False usará os locais na ordem dada e não poderá ser usado em conjunto com routeRepresentation nenhum.
computeTravelTimeFor	query		ComputeTravelTime	Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Especifica o componente dependente da 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 constam da lista são as seguintes: por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional. O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas. Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior. O intervalo válido para os valores de consumo (expresso em kWh/100km) situa-se entre 0,01 e 100000,0. Valores sensíveis : 50,8.2:130,21.3 Este parâmetro é necessário para modelo de consumo elétrico.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Especifica o componente dependente da velocidade do consumo. Fornecido como uma lista não ordenada de pares de velocidade & taxa de consumo delimitados por dois pontos. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes: por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional. O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas. Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior. O intervalo válido para os valores de consumo (expresso em l/100km) situa-se entre 0,01 e 100000,0. Valores sensíveis : 50,6.3:130,11.5 Nota : Este parâmetro é necessário para O Modelo de Consumo de Combustão.
currentChargeInkWh	query		number double	Especifica o fornecimento atual de energia elétrica em quilowatts-hora (kWh). Este parâmetro coexiste com 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 sensíveis : 55
decelerationEfficiency	query		number double	Especifica a eficiência da conversão de energia cinética em combustível economizado (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com aceleraçãoEficiência. O intervalo de valores permitidos é de 0,0 a 1/aceleraçãoEficiência. Valores sensíveis: para modelo de combustão: 0,83, para modelo elétrico: 0,91
departAt	query		string date-time	A data e hora de partida do ponto de origem formatado como um valor de `dateTime`, conforme definido no RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não é especificado, presumir-se-á que é o do ponto de origem. Valor padrão: agora Outro valor: `dateTime` Exemplos: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 O parâmetro `departAt` não pode ser usado em conjunto com `arriveAt`.
downhillEfficiency	query		number double	Especifica a eficiência da conversão de energia potencial em combustível economizado (não consumido) quando o veículo perde de elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com uphillEfficiency. O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency. Valores sensíveis: para modelo de combustão: 0,51, para 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). É utilizado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível poupados ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para a gasolina e 35,8 MJ/l para o gasóleo. Este parâmetro é necessário se qualquer parâmetro *Efficiency estiver definido. Valores sensíveis : 34,2
hilliness	query		InclineLevel	Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com `routeType`=thrilling.
instructionsType	query		RouteInstructionsType	Se especificado, as instruções de orientação serão devolvidas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.
language	query		string	O parâmetro language determina o idioma das mensagens de orientação. Os nomes próprios (os nomes das ruas, praças, etc.) são devolvidos na língua especificada ou, se esta não estiver disponível, são devolvidos numa língua disponível que esteja próxima da mesma. Os valores permitidos são (um subconjunto de) as tags de idioma IETF. Os idiomas suportados atualmente estão listados na seção Idiomas suportados . 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 quilowatts-hora (kWh) que pode ser armazenada na bateria do veículo. Este parâmetro coexiste com parâmetro currentChargeInkWh. O valor mínimo tem de ser maior ou igual a currentChargeInkWh. Valores sensíveis : 85
minDeviationDistance	query		integer	Todas as rotas alternativas devolvidas seguirão a rota de referência (ver secção Pedidos POST) a partir do ponto de origem do pedido calculateRoute para, pelo menos, este número de metros. 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) a partir do ponto de origem da solicitação calculateRoute por 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_ para um valor maior que zero tem as seguintes consequências: O ponto de origem do calculateRoute Request deve estar na rota de referência de entrada (ou muito próxima). Se este 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 (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 no calculateRoute Response, começará no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até o ponto de origem será excluída da Resposta. Os valores de minDeviationDistance e minDeviationTime determinar até que ponto rotas alternativas serão garantidas para seguir a rota de referência a partir do ponto de origem. A rota deve usar partirEm. 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 ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido onde o parâmetro não foi especificado pelo chamador.
routeRepresentation	query		RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecidas como resposta.
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 que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro
traffic	query		boolean	Valores possíveis: true - Considere todas as informações de tráfego disponíveis durante o roteamento false - Ignore os dados de tráfego atuais durante o roteamento. Note-se que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico nas velocidades efetivas da estrada ainda é incorporado.
travelMode	query		TravelMode	O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é '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 ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
uphillEfficiency	query		number double	Especifica a eficiência da conversão da energia química armazenada no combustível em energia potencial quando o veículo ganha de elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com downhillEfficiency. O intervalo de valores permitidos são de 0,0 a 1/downhillEfficiency. Valores sensíveis: para modelo de combustão: 0,27, para modelo elétrico: 0,74
vehicleAxleWeight	query		integer	Peso por eixo do veículo, em kg. Um valor 0 significa que as restrições de peso por eixo não são consideradas.
vehicleCommercial	query		boolean	Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular 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	A direção direcional do veículo em graus, começando no verdadeiro norte e continuando no sentido horário. Norte é de 0 graus, leste é de 90 graus, sul é de 180 graus, oeste é de 270 graus. Valores possíveis 0-359
vehicleHeight	query		number double	Altura do veículo em metros. Um valor 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 restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, 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 otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este 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 é utilizada para verificar se um veículo é permitido em autoestradas. Um valor 0 significa que será determinado e aplicado um valor adequado para o veículo durante o planeamento de rotas. Um valor diferente de zero pode ser substituído durante o planejamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida para 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é 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 algum dos parâmetros Eficiência for definido. Deve ser estritamente positivo quando utilizado no contexto do Modelo de Consumo. Restrições de peso são consideradas. Se não for especificado um detalhado do Modelo de Consumo de e o valor de de peso do veículo for diferente de zero, as restrições de peso serão consideradas. Em todos os outros casos, esse parâmetro é ignorado. Valores sensíveis: para modelo de combustão: 1600, para 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. Este parâmetro só pode ser usado em conjunto com `routeType`=thrilling.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

Name	Tipo	Description
200 OK	RouteDirections	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 APIs REST do Azure Maps.

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

Observações

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

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 ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve a route between an origin and a destination

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
AlternativeRouteType	Controla a otimização, em relação aos critérios de planeamento fornecidos, das alternativas calculadas em comparação com a rota de referência.
ComputeTravelTime	Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.
DelayMagnitude	A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta do Get Traffic Incident Detail API.
DrivingSide	Indica a condução à esquerda vs. à direita no ponto da manobra.
EffectiveSetting	Parâmetro ou dados efetivos usados ao chamar essa API de rota.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GuidanceInstructionType	Tipo de instrução, por exemplo, virar ou mudar de forma de estrada.
GuidanceManeuver	Um código que identifica a manobra.
InclineLevel	Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com `routeType`=thrilling.
JunctionType	O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.
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 onde 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 como `other` 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 um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.
RouteDirections	Este objeto é retornado de uma chamada bem-sucedida de Direções de Rota
RouteGuidance	Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.
RouteInstruction	Um conjunto de atributos que descrevem uma manobra, por exemplo, «Vire à direita», «Mantenha-se à esquerda», «Apanhe o ferry», «Apanhe a autoestrada», «Chegar».
RouteInstructionGroup	Agrupa uma sequência de elementos de instrução que estã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 devolvidas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.
RouteLeg	Descrição de uma parte de um percurso, composta por uma lista de pontos. Cada waypoint adicional fornecido na solicitação resultará em um trecho adicional na rota devolvida.
RouteLegSummary	Objeto de resumo para a seção de rota.
RouteOptimizedWaypoint	Objeto de ponto de caminho otimizado.
RouteReport	Relata as configurações efetivas usadas na chamada atual.
RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecidas como 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`, `endPointIndex`e `sectionType`.
RouteSectionTec	Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.
RouteSectionTecCause	A causa do evento de trânsito. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.
RouteSummary	Objeto de resumo
RouteType	O tipo de rota solicitada.
SectionType	Especifica qual dos tipos de seção é relatado na resposta da rota. Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro
SimpleCategory	Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.
TravelMode	O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é '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 ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
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 classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, 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 otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.
WindingnessLevel	Nível de voltas para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com `routeType`=thrilling.

AlternativeRouteType

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

Name	Tipo	Description
anyRoute	string	Permitir que qualquer rota alternativa seja devolvida, independentemente da forma como se compara com a rota de referência em termos de otimidade.
betterRoute	string	Devolver uma rota alternativa apenas se for melhor do que a rota de referência de acordo com os critérios de planeamento fornecidos.

ComputeTravelTime

Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.

Name	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 noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds e liveTrafficIncidentsTravelTimeInSeconds 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 do Get Traffic Incident Detail API.

Name	Tipo	Description
0	string	Desconhecido.
1	string	Menor.
2	string	Moderado.
3	string	Major.
4	string	Indefinido, usado para fechamentos de estradas e outros atrasos indefinidos.

DrivingSide

Indica a condução à esquerda vs. à direita no ponto da manobra.

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

EffectiveSetting

Parâmetro ou dados efetivos usados ao chamar essa API de rota.

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

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GuidanceInstructionType

Tipo de instrução, por exemplo, virar ou mudar de forma de estrada.

Name	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	Vira a página.

GuidanceManeuver

Um código que identifica a manobra.

Name	Tipo	Description
ARRIVE	string	Chegou.
ARRIVE_LEFT	string	Chegou. Seu destino está à esquerda.
ARRIVE_RIGHT	string	Chegou. Seu destino está à direita.
BEAR_LEFT	string	Urso à esquerda.
BEAR_RIGHT	string	Ter razão.
DEPART	string	Saia.
ENTER_FREEWAY	string	Pegue a rodovia.
ENTER_HIGHWAY	string	Pegue a rodovia.
ENTER_MOTORWAY	string	Pegue a estrada.
ENTRANCE_RAMP	string	Pegue a rampa.
FOLLOW	string	Acompanhe.
KEEP_LEFT	string	Mantenha-se à esquerda.
KEEP_RIGHT	string	Mantenha-se à direita.
MAKE_UTURN	string	Faça uma inversão de marcha.
MOTORWAY_EXIT_LEFT	string	Pegue a saída à esquerda.
MOTORWAY_EXIT_RIGHT	string	Pegue a saída à direita.
ROUNDABOUT_BACK	string	Contorne a rotunda.
ROUNDABOUT_CROSS	string	Atravesse 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 bem à esquerda.
SHARP_RIGHT	string	Vire bem à direita.
STRAIGHT	string	Mantenha-se em frente.
SWITCH_MAIN_ROAD	string	Mude para a estrada principal.
SWITCH_PARALLEL_ROAD	string	Mude para a estrada paralela.
TAKE_EXIT	string	Pegue a saída.
TAKE_FERRY	string	Pegue a balsa.
TRY_MAKE_UTURN	string	Tente fazer uma inversão de marcha.
TURN_LEFT	string	Vire à esquerda.
TURN_RIGHT	string	Vire à direita.
WAYPOINT_LEFT	string	Chegou ao ponto de passagem. Está à esquerda.
WAYPOINT_REACHED	string	Chegou ao ponto de passagem.
WAYPOINT_RIGHT	string	Chegou ao ponto de passagem. Está à direita.

InclineLevel

Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com routeType=thrilling.

Name	Tipo	Description
high	string	alto
low	string	baixo
normal	string	normal

JunctionType

O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.

Name	Tipo	Description
BIFURCATION	string	bifurcação
REGULAR	string	regular
ROUNDABOUT	string	rotunda

LatLongPair

Um local representado como latitude e longitude.

Name	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 onde o parâmetro não foi especificado pelo chamador.

Name	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.

Name	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

Name	Tipo	Description
CARPOOL	string	Troços do percurso que requerem a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
CAR_TRAIN	string	Troços do percurso que são carros ou comboios.
COUNTRY	string	Secções que indicam em que países/regiões se encontra a rota.
FERRY	string	Troços do percurso que são ferries.
MOTORWAY	string	Troços do percurso que são autoestradas.
PEDESTRIAN	string	Troços do percurso que só servem para peões.
TOLL_ROAD	string	Troços do percurso que exigem o pagamento de portagens.
TOLL_VIGNETTE	string	Troços do percurso que requerem vinheta de portagem para estarem presentes.
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 request `travelMode`.
TUNNEL	string	Troços do percurso que são túneis.
URBAN	string	Troços do percurso situados em zonas urbanas.

ResponseTravelMode

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

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

Route

Name	Tipo	Description
guidance	RouteGuidance	Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.
legs	RouteLeg[]	Arranjo de pernas
sections	RouteSection[]	Matriz de seções
summary	RouteSummary	Objeto de resumo

RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.

Name	Tipo	Description
alreadyUsedRoads	string	Evita usar a mesma estrada várias vezes. Mais útil em conjunto com `routeType`=emocionante.
borderCrossings	string	Evita passagens de fronteira no cálculo de rotas.
carpools	string	Evita percursos que exijam a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
ferries	string	Evita ferries
motorways	string	Evita autoestradas
tollRoads	string	Evita estradas com portagem.
unpavedRoads	string	Evita estradas não pavimentadas

RouteDirections

Este objeto é retornado de uma chamada bem-sucedida de Direções de Rota

Name	Tipo	Description
formatVersion	string	Propriedade Format Version
optimizedWaypoints	RouteOptimizedWaypoint[]	Sequência otimizada de waypoints. 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 por 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 com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.

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

RouteInstruction

Um conjunto de atributos que descrevem uma manobra, por exemplo, «Vire à direita», «Mantenha-se à esquerda», «Apanhe o ferry», «Apanhe a autoestrada», «Chegar».

Name	Tipo	Description
combinedMessage	string	Uma mensagem legível por humanos 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, tornando mais fácil de seguir. Quando este for o caso, o sinalizador possibleCombineWithNext será true. 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 da orientação codificada que ela pode ser combinada com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitem orientação legível 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	3 caracteres código de país ISO 3166-1 alpha-3. Por exemplo, EUA.
drivingSide	DrivingSide	Indica a condução à esquerda vs. à direita no ponto da manobra.
exitNumber	string	O(s) número(s) de uma saída de 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 de instrução, por exemplo, virar ou mudar de forma de estrada.
junctionType	JunctionType	O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.
maneuver	GuidanceManeuver	Um código que identifica a manobra.
message	string	Uma mensagem legível por humanos 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 "Vire à esquerda e depois vire à direita".
roadNumbers	string[]	Número(s) de estrada do(s) próximo(s) segmento(s) de estrada significativo(s) após a manobra, ou da(s) estrada(s) a seguir. Exemplo: ["E34", "N205"]
roundaboutExitNumber	integer	Isso indica qual saída tomar em uma rotatória.
routeOffsetInMeters	integer	Distância desde o início do percurso até ao ponto da instrução.
signpostText	string	O texto em uma placa de sinalização 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 significativo da estrada após a manobra, ou da rua que deve ser seguida.
travelTimeInSeconds	integer	Tempo de viagem estimado até o ponto correspondente a routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indica a direção de uma instrução. Se junctionType indicar uma instrução de volta: 180 = Retorno em U [-179, -1] = Virar à esquerda 0 = Em linha reta (uma volta de '0 grau') [1, 179] = Virar à direita Se junctionType indicar uma instrução de bifurcação: <0 - mantenha-se à esquerda >0 - mantenha-se à direita

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução que estã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.

Name	Tipo	Description
firstInstructionIndex	integer	Índice da primeira instrução nas instruções e pertencente a este 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 tagged).
lastInstructionIndex	integer	Índice da última instrução nas instruções e pertencente a este grupo.

RouteInstructionsType

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

Name Tipo Description

coded

Name	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 marcadas legíveis por humanos para permitir a formatação. Uma mensagem legível por humanos é construída a partir de 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 marcada 'Virar à esquerda': `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 marcadas legíveis por humanos para permitir a formatação. Uma mensagem legível por humanos é construída a partir de 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 marcada 'Virar à esquerda':

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

Descrição de uma parte de um percurso, composta por uma lista de pontos. Cada waypoint adicional fornecido na solicitação resultará em um trecho adicional na rota devolvida.

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

RouteLegSummary

Objeto de resumo para a seção de rota.

Name	Tipo	Description
arrivalTime	string	A hora prevista de chegada para o percurso ou trecho. A hora está em UTC.
batteryConsumptionInkWh	number	Consumo estimado de energia elétrica em quilowatts-hora (kWh) utilizando o Modelo de Consumo Elétrico. Incluído se vehicleEngineType estiver definido como elétrico e constantSpeedConsumptionInkWhPerHundredkm for especificado. O valor da bateriaConsumoInkWh 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 sem restrições é assumida no cálculo do consumo.
departureTime	string	A hora de partida estimada para a rota ou trecho. A hora está em UTC.
fuelConsumptionInLiters	number	Consumo de combustível estimado em litros utilizando o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido para de combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.
historicTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado utilizando dados históricos de tráfego dependentes do tempo. Incluído somente se computeTravelTimeFor = all for usado na consulta.
lengthInMeters	integer	Comprimento em metros propriedade
liveTrafficIncidentsTravelTimeInSeconds	integer	Tempo de viagem estimado calculado usando dados de velocidade em tempo real. Incluído somente se computeTravelTimeFor = all for usado na consulta.
noTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado como se não houvesse atrasos no percurso devido a condições de tráfego (por exemplo, congestionamento). Incluído somente se computeTravelTimeFor = all for usado na consulta.
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelo(s) incidente(s) em tempo real de acordo com as informações de tráfego. Para rotas planejadas com horário 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 computeTravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade de 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 for no futuro, o tempo de viagem é calculado usando dados históricos de tráfego dependentes do tempo.

RouteOptimizedWaypoint

Objeto de ponto de caminho otimizado.

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

RouteReport

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

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

RouteRepresentationForBestOrder

Especifica a representação do conjunto de rotas fornecidas como resposta.

Name	Tipo	Description
none	string	Inclui apenas os índices de waypoint otimizados, mas não inclui a geometria da rota na resposta. Esse valor de parâmetro só pode ser usado em conjunto com computeBestOrder=true.
polyline	string	Inclui geometria de rota na resposta.
summaryOnly	string	Resumo conforme 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.

Name	Tipo	Description
delayInSeconds	integer	Atraso em segundos causado pelo incidente.
effectiveSpeedInKmh	integer	Velocidade efetiva do incidente em km/h, calculada em 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 do Get Traffic Incident Detail API.
sectionType	ResponseSectionType	Tipos de seção da resposta de rota relatada
simpleCategory	SimpleCategory	Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.
startPointIndex	integer	Índice do primeiro ponto (deslocamento 0) na rota a que esta secção se aplica.
tec	RouteSectionTec	Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.
travelMode	ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido como `other` 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 TPEG2-TEC padrão. Pode conter elementos effectCode e causas.

Name	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 codificar eventos de tráfego por cores de acordo com a gravidade.

RouteSectionTecCause

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

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

RouteSummary

Objeto de resumo

Name	Tipo	Description
arrivalTime	string	A hora prevista de chegada para o percurso ou trecho. A hora está em UTC.
departureTime	string	A hora de partida estimada para a rota ou trecho. A hora está em UTC.
lengthInMeters	integer	Comprimento em metros propriedade
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelo(s) incidente(s) em tempo real de acordo com as informações de tráfego. Para rotas planejadas com horário 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 computeTravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade de 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 for no futuro, o tempo de viagem é calculado usando dados históricos de tráfego dependentes do tempo.

RouteType

O tipo de rota solicitada.

Name	Tipo	Description
eco	string	Uma rota equilibrada pela economia e velocidade.
fastest	string	A rota mais rápida.
shortest	string	O percurso mais curto por distância.
thrilling	string	Inclui estradas interessantes ou desafiantes e utiliza o menor número possível de autoestradas. Você pode escolher o nível de voltas incluídas e também o grau de inclinação. Veja os parâmetros de inclinação e enrolamento 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 da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro

Name	Tipo	Description
carTrain	string	Troços do percurso que são carros ou comboios.
carpool	string	Troços do percurso que requerem a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
country	string	Secções que indicam em que países/regiões se encontra a rota.
ferry	string	Troços do percurso que são ferries.
motorway	string	Troços do percurso que são autoestradas.
pedestrian	string	Troços do percurso que só servem para peões.
tollRoad	string	Troços do percurso que exigem o pagamento de portagens.
tollVignette	string	Troços do percurso que requerem vinheta de portagem para estarem presentes.
traffic	string	Seções da rota que contêm informações de tráfego.
travelMode	string	Seções em relação ao parâmetro request `travelMode`.
tunnel	string	Troços do percurso que são túneis.
urban	string	Troços do percurso situados em zonas urbanas.

SimpleCategory

Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.

Name	Tipo	Description
JAM	string	Engarrafamento.
OTHER	string	Outros.
ROAD_CLOSURE	string	Encerramento de estradas.
ROAD_WORK	string	Obras rodoviárias.

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é '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 ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.

Name	Tipo	Description
bicycle	string	As rotas devolvidas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus	string	As rotas de retorno são otimizadas para ônibus, incluindo o uso de faixas exclusivas para ônibus. Funcionalidade BETA.
car	string	As rotas devolvidas são otimizadas para carros.
motorcycle	string	As rotas devolvidas são otimizadas para motocicletas. Funcionalidade BETA.
pedestrian	string	As rotas de retorno são otimizadas para pedestres, incluindo o uso de calçadas.
taxi	string	As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas de retorno são otimizadas para veículos comerciais, como para caminhões.
van	string	As rotas devolvidas 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.

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

VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, 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 otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.

Name	Tipo	Description
USHazmatClass1	string	Explosivos
USHazmatClass2	string	Gás comprimido
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	Disposições diversas
otherHazmatExplosive	string	Explosivos
otherHazmatGeneral	string	Disposições diversas
otherHazmatHarmfulToWater	string	Nocivo para a água

WindingnessLevel

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

Name	Tipo	Description
high	string	alto
low	string	baixo
normal	string	normal

Partilhar via

Route - Get Route Directions

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Observações

Âmbitos

subscription-key

SAS Token

Exemplos

Successfully retrieve a route between an origin and a destination

Pedido de amostra

Resposta da amostra

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