Route - Post Route Directions

Service:

Maps

API Version:

1.0

Utilize para calcular uma rota entre uma determinada origem e destino, passando por quaisquer pontos de caminho especificados.

A Post Route Directions API é um pedido HTTP POST que devolve uma rota entre uma origem e um destino, passando pelos pontos de passagem se forem especificados. O percurso terá em conta fatores como o tráfego atual e as velocidades típicas das estradas no dia solicitado da semana e hora do dia.

As informações devolvidas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Também estão disponíveis informações de encaminhamento adicionais, como a ordem otimizada do waypoint ou as instruções de turn by turn, consoante as 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. Verifique o Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.

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

With optional parameters:

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&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 pretendido da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número da versão da API 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. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio atuam como WayPoints na rota. Pode deixar 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 através da conversão de combustível consumido em energia química utilizando fuelEnergyDensityInMJoulesPerLiter. Tem de ser emparelhado com a desaceleraçãoEficiência. O intervalo de valores permitidos é de 0,0 a 1/deceleraçãoEficiência. Valores Sensatos: para o Modelo de Combustão : 0,33, para Modelo Elétrico : 0,66
alternativeType	query		AlternativeRouteType	Controla a otimização, relativamente aos critérios de planeamento especificados, das alternativas calculadas em comparação com a rota de referência.
arriveAt	query		string date-time	A data e hora de chegada no ponto de destino formatado como um dateTime valor conforme definido em RFC 3339, secção 5.6, com um desvio de fuso horário opcional. Quando um desvio de fuso horário não for especificado, assume-se que é o do ponto de destino. Exemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 O arriveAt parâmetro não pode ser utilizado em conjunto com departAt, minDeviationDistance ou minDeviationTime.
auxiliaryPowerInkW	query		number double	Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em kilowatts (kW). Pode ser utilizado para especificar o consumo devido a dispositivos e sistemas como sistemas CA, rádio, aquecimento, etc. Valores Sensatos: 1,7
auxiliaryPowerInLitersPerHour	query		number double	Especifica a quantidade de combustível consumido para sustentar sistemas auxiliares do veículo, em litros por hora. Pode ser utilizado para especificar o consumo devido a dispositivos e sistemas como sistemas CA, rádio, aquecimento, etc. Valores Sensatos: 0,2
avoid	query		RouteAvoidType[]	Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor jáUsedRoads não pode ser utilizado.
computeBestOrder	query		boolean	Reordene os pontos de caminho de rota com um algoritmo heurístico rápido para reduzir o comprimento da rota. Produz os melhores resultados quando utilizado em conjunto com routeType mais curto. Tenha em atenção que a origem e o destino estão excluídos dos índices de pontos de passagem otimizados. Para incluir a origem e o destino na resposta, aumente todos os índices em 1 para ter em conta a origem e, em seguida, adicione o destino como o índice final. Os valores possíveis são verdadeiros ou falsos. True calcula uma ordem melhor se possível, mas não é permitido ser utilizado em conjunto com o valor maxAlternatives superior a 0 ou em conjunto com pontos de passagem circulares. Falso utilizará as localizações pela ordem indicada e não poderá ser utilizado em conjunto com routeRepresentation none.
computeTravelTimeFor	query		ComputeTravelTime	Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de 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 numa curva de consumo. As taxas de consumo para velocidades que não se encontram na lista são encontradas da seguinte forma: por interpolação linear, se a velocidade especificada se situar entre duas velocidades na lista por extrapolação linear, caso contrário, assumindo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista tem de conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se apenas contiver um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional. O consumo especificado para a maior velocidade tem de ser maior ou igual ao da penúltima maior velocidade. Isto garante que a extrapolação não conduz a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas velocidades mais pequenas na lista não podem levar a uma taxa de consumo negativa para qualquer velocidade mais pequena. O intervalo válido para os valores de consumo (expresso em kWh/100km) está entre 0,01 e 100000,0. Valores Sensatos: 50,8.2:130,21.3 Este parâmetro é necessário para o modelo de consumo Elétrico.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Especifica o componente dependente da velocidade do consumo. Fornecido como uma lista não ordenada de velocidade delimitada por dois pontos & pares de taxa de consumo. A lista define pontos numa curva de consumo. As taxas de consumo para velocidades que não se encontram na lista são encontradas da seguinte forma: por interpolação linear, se a velocidade especificada se situar entre duas velocidades na lista por extrapolação linear, caso contrário, assumindo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista tem de conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se apenas contiver um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional. O consumo especificado para a maior velocidade tem de ser maior ou igual ao da penúltima maior velocidade. Isto garante que a extrapolação não conduz a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas velocidades mais pequenas na lista não podem levar a uma taxa de consumo negativa para qualquer velocidade mais pequena. O intervalo válido para os valores de consumo (expresso em l/100km) está entre 0,01 e 100000,0. Valores Sensatos: 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 de energia elétrica atual em kilowatt hours (kWh). Este 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 guardado (não consumido) quando o veículo decelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido através da conversão de combustível guardado (não consumido) em energia utilizando fuelEnergyDensityInMJoulesPerLiter. Tem de 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 Modelo Elétrico : 0.91
departAt	query		string date-time	A data e hora de partida do ponto de origem formatada como um dateTime valor conforme definido em RFC 3339, secção 5.6, com um desvio opcional do fuso horário. Quando um desvio de fuso horário não é especificado, assume-se que é o do ponto de origem. Valor predefinido: agora Outro valor: dateTime Exemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 O departAt parâmetro não pode ser utilizado em conjunto com arriveAt.
downhillEfficiency	query		number double	Especifica a eficiência da conversão de energia potencial em combustível guardado (não consumido) quando o veículo perde elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido através da conversão de combustível guardado (não consumido) em energia utilizando fuelEnergyDensityInMJoulesPerLiter. Tem de 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 Modelo Elétrico : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Especifica a quantidade de energia química armazenada num litro de combustível em megajoules (MJ). É utilizado em conjunto com os *Parâmetros de eficiência para conversões entre energia e combustível guardados ou consumidos. Por exemplo, a densidade energética é de 34,2 MJ/l para gasolina e 35,8 MJ/l para combustível diesel. Este parâmetro é necessário se algum *Parâmetro de eficiência estiver definido. Valores Sensatos: 34.2
hilliness	query		InclineLevel	Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante.
instructionsType	query		RouteInstructionsType	Se especificado, serão devolvidas instruções de orientação. Tenha em atenção que o parâmetro instructionsType não pode ser utilizado em conjunto com routeRepresentation=none
language	query		string	O parâmetro de idioma determina o idioma das mensagens de orientação. Não afeta os substantivos adequados (os nomes das ruas, praças, etc.) Não tem efeito quando instruçõesType=coded. Os valores permitidos são (um subconjunto de) as etiquetas de idioma IETF descritas
maxAlternatives	query		integer	Número de rotas alternativas pretendidas a serem calculadas. Predefinição: 0, mínimo: 0 e máximo: 5
maxChargeInkWh	query		number double	Especifica o fornecimento máximo de energia elétrica em kilowatt horas (kWh) que pode ser armazenado na bateria do veículo. Este parâmetro coexiste com o parâmetro currentChargeInkWh . O valor mínimo tem de ser maior ou igual a currentChargeInkWh. Valores Sensatos: 85
minDeviationDistance	query		integer	Todas as rotas alternativas devolvidas seguirão a rota de referência (veja a secção Pedidos POST) a partir do ponto de origem do pedido calculateRoute para, pelo menos, este número de medidores. Só pode ser utilizado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser utilizado em conjunto com o arriveAt
minDeviationTime	query		integer	Todas as rotas alternativas devolvidas seguirão a rota de referência (veja a secção Pedidos POST) a partir do ponto de origem do pedido calculateRoute durante, pelo menos, este número de segundos. Só pode ser utilizado ao reconstruir uma rota. O parâmetro minDeviationTime não pode ser utilizado em conjunto com arriveAt. O valor predefinido é 0. A definição de )minDeviationTime_ para um valor superior a zero tem as seguintes consequências: O ponto de origem do Pedido calculateRoute tem de estar (ou muito próximo) da rota de referência de entrada. Se não for este o caso, é devolvido um erro. No entanto, o ponto de origem não precisa de estar no início da rota de referência de entrada (pode ser considerada a posição atual do veículo na rota de referência). A rota de referência, devolvida como a primeira rota na Resposta calculateRoute , será iniciada no ponto de origem especificado no Pedido calculateRoute . A parte inicial da rota de referência de entrada até ao ponto de origem será excluída 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 a partir do ponto de origem. A rota tem de utilizar departAt. O veículoHeading é ignorado.
report	query		Report	Especifica os dados que devem ser comunicados para fins de diagnóstico. O único valor possível é effectiveSettings. Comunica os parâmetros ou dados eficazes utilizados ao chamar a API. No caso dos parâmetros predefinidos, a predefinição será refletida em que o parâmetro não foi especificado pelo autor da chamada.
routeRepresentation	query		RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecido como resposta. Este valor de parâmetro só pode ser utilizado em conjunto com computeBestOrder=true.
routeType	query		RouteType	O tipo de rota pedida.
sectionType	query		SectionType	Especifica qual dos tipos de secção é comunicado na resposta da rota. Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefiniçã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 encaminhamento false - Ignore os dados de tráfego atuais durante o encaminhamento. Tenha em atenção que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico em velocidades de estrada eficazes continua a ser incorporado.
travelMode	query		TravelMode	O modo de viagem para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas.
uphillEfficiency	query		number double	Especifica a eficiência da conversão de energia química armazenada em combustível em energia potencial quando o veículo ganha elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido através da conversão de combustível consumido em energia química utilizando fuelEnergyDensityInMJoulesPerLiter. Tem de ser emparelhado com a descidaEficiência. O intervalo de valores permitidos é de 0,0 a 1/descidaEficiência. Valores Sensatos: para o 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 de 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 conduzir em algumas estradas.
vehicleEngineType	query		VehicleEngineType	Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, tem de ser consistente com o valor de vehicleEngineType.
vehicleHeading	query		integer	O cabeçalho direcional do veículo em graus começando no verdadeiro Norte e continuando na direção dos ponteiros do relógio. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus. Valores possíveis 0-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 restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados 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 nas auto-estradas. Um valor de 0 significa que um valor adequado para o veículo será determinado e aplicado durante o planeamento da rota. Um valor não zero pode ser substituído durante o planeamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida como 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 encaminhamento voltará a utilizar 60 km/hora.
vehicleWeight	query		integer	Peso do veículo em quilogramas. É obrigatório se algum dos parâmetros *Eficiência estiver definido. Tem de ser estritamente positivo quando utilizado no contexto do Modelo de Consumo. As restrições de peso são consideradas. Se não for especificado nenhum Modelo de Consumo detalhado e o valor de vehicleWeight não for zero, as restrições de peso serão consideradas. Em todos os outros casos, este parâmetro é ignorado. Valores Sensatos: para o 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 utilizado em conjunto com routeType=emocionante.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Corpo do Pedido

Name	Tipo	Description
allowVignette	string[]	Esta é uma lista de códigos de país de 3 carateres, ISO 3166-1 e alfa-3 de países/regiões em que são permitidas estradas com vinhetas de portagens, por exemplo, "AUS,CHE". Especificar allowVignette com alguns países/regiões X é equivalente a especificar avoidVignette com todos os países/regiões, mas X. Especificar permitirVignette com uma lista vazia é o mesmo que evitar todas as estradas com vinhetas. Nota: é um erro especificar avoidVignette e allowVignette.
avoidAreas	GeoJsonMultiPolygon	Uma GeoJSON MultiPolygon que representa a lista de áreas a evitar. Só são suportados polígonos retângulos. O tamanho máximo de um retângulo é de cerca de 160x160 km. O número máximo de áreas evitadas é 10. Não pode atravessar o 180º meridiano. Tem de estar entre -80 e +80 graus de latitude.
avoidVignette	string[]	Esta é uma lista de códigos de país de 3 carateres, ISO 3166-1 e alfa-3 de países/regiões em que todas as estradas de portagem com vinhetas devem ser evitadas, por exemplo, "AUS,CHE". As estradas com vinhetas em países/regiões que não constam da lista não são afetadas. Nota: é um erro especificar avoidVignette e allowVignette.
supportingPoints	GeoJsonGeometryCollection	Uma coleção de Geometria GeoJSON que representa a sequência de coordenadas utilizadas como entrada para a reconstrução de rotas e para calcular zero ou mais rotas alternativas para esta rota de referência. A sequência fornecida de pontos de suporte é utilizada como entrada para a reconstrução de rotas. As rotas alternativas são calculadas entre os pontos de origem e de destino especificados nas localizações dos parâmetros do caminho base. Se minDeviationDistance e minDeviationTime estiverem definidos como zero, espera-se que estes pontos de origem e de destino estejam no início e no fim da rota de referência, respetivamente. As localizações intermédias (pontos de passagem) não são suportadas ao utilizar <pontos de> suporte. A rota de referência pode conter incidentes de tráfego do tipo ROAD_CLOSURE, que são ignorados para o cálculo do tempo de viagem da rota de referência e atraso de tráfego. Consulte Pontos de Suporte para obter detalhes.

Respostas

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

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

• Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

• Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Sample Request

HTTP

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

{
  "supportingPoints": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Point",
        "coordinates": [
          13.42936,
          52.5093
        ]
      },
      {
        "type": "Point",
        "coordinates": [
          13.42859,
          52.50844
        ]
      }
    ]
  },
  "avoidVignette": [
    "AUS",
    "CHE"
  ],
  "avoidAreas": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [
            -122.39456176757811,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.489368981370724
          ]
        ]
      ],
      [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    ]
  }
}

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

Name	Description
AlternativeRouteType	Controla a otimização, relativamente aos critérios de planeamento especificados, das alternativas calculadas em comparação com a rota de referência.
ComputeTravelTime	Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido com a melhor estimativa.
DelayMagnitude	A magnitude do atraso causado pelo incidente. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.
DrivingSide	Indica a condução do lado esquerdo vs. direito no ponto da manobra.
EffectiveSetting	Parâmetro ou dados eficazes utilizados ao chamar esta API de Rota.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GeoJsonGeometry	Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection	Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString	Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString	Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint	Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon	Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
GeoJsonPoint	Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon	Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
GuidanceInstructionType	Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.
GuidanceManeuver	Um código que identifica a manobra.
InclineLevel	Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante.
JunctionType	O tipo de junção onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.
LatLongPair	Uma localização representada como uma latitude e longitude.
Report	Especifica os dados que devem ser comunicados para fins de diagnóstico. O único valor possível é effectiveSettings. Comunica os parâmetros ou dados eficazes utilizados ao chamar a API. No caso dos parâmetros predefinidos, a predefinição será refletida em que o parâmetro não foi especificado pelo autor da chamada.
ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
ResponseSectionType	Tipos de secção da resposta de rota reportada
ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte pedido não for possível nesta secção
Route
RouteAvoidType	Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor alreadyUsedRoads não pode ser utilizado.
RouteDirectionParameters	Pós-parâmetros do corpo para direções da rota.
RouteDirections	Este objeto é devolvido de uma chamada Route Directions bem-sucedida
RouteGuidance	Contém elementos relacionados com a documentação de orientação. Este campo só está presente quando a documentação de orientação foi pedida e está disponível.
RouteInstruction	Um conjunto de atributos que descreve uma manobra, por exemplo, "Virar à direita", "Manter à esquerda", "Apanhar o ferry", "Tomar a auto-estrada", "Chegar".
RouteInstructionGroup	Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência está restrito a firstInstructionIndex e lastInstructionIndex. Quando são pedidas mensagens de texto legíveis por humanos para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo devolvida quando disponível.
RouteInstructionsType	Se for especificado, serão devolvidas instruções de orientação. Tenha em atenção que o parâmetro instructionsType não pode ser utilizado 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 no pedido resultará numa etapa adicional na rota devolvida.
RouteLegSummary	Objeto de resumo para a secção de rota.
RouteOptimizedWaypoint	Objeto de ponto de passagem otimizado.
RouteReport	Comunica as definições efetivas utilizadas na chamada atual.
RouteRepresentationForBestOrder	Especifica a representação do conjunto de rotas fornecido como resposta. Este valor de parâmetro só pode ser utilizado em conjunto com computeBestOrder=true.
RouteSection	As secções de rota contêm informações adicionais sobre partes de uma rota. Cada secção contém, pelo menos, os elementos startPointIndex, endPointIndexe sectionType.
RouteSectionTec	Detalhes do evento de tráfego, com definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.
RouteSectionTecCause	A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser utilizado para definir iconografia e descrições.
RouteSummary	Objeto de resumo
RouteType	O tipo de rota pedida.
SectionType	Especifica qual dos tipos de secção é comunicado na resposta da rota. Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro
SimpleCategory	Tipo de incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Consulte "tec" para obter informações detalhadas.
TravelMode	O modo de deslocação para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Se o travelMode solicitado não estiver disponível para uma determinada secção, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motocicleta, táxi e carrinha são a funcionalidade BETA. Os dados de restrição total não estão disponíveis em todas as áreas.
VehicleEngineType	Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, tem de ser consistente com o valor de vehicleEngineType.
VehicleLoadType	Tipos de carga que podem ser classificados como materiais perigosos e restringidos de algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos E.U.A. 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados 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 utilizado em conjunto com routeType=emocionante.

AlternativeRouteType

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

Name	Tipo	Description
anyRoute	string	Permitir a devolução de qualquer rota alternativa, independentemente da forma como se compara à rota de referência em termos de otimização.
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 indicados.

ComputeTravelTime

Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido com a 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. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.

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

DrivingSide

Indica a condução do lado esquerdo vs. direito no ponto da manobra.

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

EffectiveSetting

Parâmetro ou dados eficazes utilizados ao chamar esta API de Rota.

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
type	GeoJsonObjectType	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contém uma lista de objetos de geometria válidos GeoJSON . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: GeometryCollection	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a GeoJson LineString geometria.
type	string: LineString	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a GeoJson MultiLineString geometria.
type	string: MultiLineString	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a GeoJson MultiPoint geometria.
type	string: MultiPoint	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Contém uma lista de objetos válidos GeoJSON Polygon . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: MultiPolygon	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	A Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type	string: Point	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para o GeoJson Polygon tipo de geometria.
type	string: Polygon	Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GuidanceInstructionType

Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.

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

GuidanceManeuver

Um código que identifica a manobra.

Name	Tipo	Description
ARRIVE	string	Chegou.
ARRIVE_LEFT	string	Chegou. O seu destino é à esquerda.
ARRIVE_RIGHT	string	Chegou. O seu destino está à direita.
BEAR_LEFT	string	Urso à esquerda.
BEAR_RIGHT	string	Urso à direita.
DEPART	string	Vai embora.
ENTER_FREEWAY	string	Pegue a auto-estrada.
ENTER_HIGHWAY	string	Pegue a auto-estrada.
ENTER_MOTORWAY	string	Pegue a auto-estrada.
ENTRANCE_RAMP	string	Pegue a rampa.
FOLLOW	string	Siga- o.
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	Faça a saída à direita.
ROUNDABOUT_BACK	string	Dar a volta à rotunda.
ROUNDABOUT_CROSS	string	Atravessem a rotunda.
ROUNDABOUT_LEFT	string	Na rotunda, pegue a saída à esquerda.
ROUNDABOUT_RIGHT	string	Na rotunda, pegue a saída à direita.
SHARP_LEFT	string	Vire para a esquerda.
SHARP_RIGHT	string	Vire para a direita.
STRAIGHT	string	Mantenha-se direto.
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 o ferry.
TRY_MAKE_UTURN	string	Tente fazer uma inversão de marcha.
TURN_LEFT	string	Vire para a esquerda.
TURN_RIGHT	string	Vire à direita.
WAYPOINT_LEFT	string	Chegou ao ponto de passagem. É à esquerda.
WAYPOINT_REACHED	string	Chegou ao ponto de passagem.
WAYPOINT_RIGHT	string	Chegou ao ponto de passagem. É à direita.

InclineLevel

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

Name	Tipo	Description
high	string	alta
low	string	baixa
normal	string	normal

JunctionType

O tipo de junção 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

Uma localização representada como uma latitude e longitude.

Name	Tipo	Description
latitude	number	Propriedade Latitude
longitude	number	Propriedade Longitude

Report

Especifica os dados que devem ser comunicados para fins de diagnóstico. O único valor possível é effectiveSettings. Comunica os parâmetros ou dados eficazes utilizados ao chamar a API. No caso dos parâmetros predefinidos, a predefinição será refletida em que o parâmetro não foi especificado pelo autor da chamada.

Name	Tipo	Description
effectiveSettings	string	Comunica os parâmetros ou dados eficazes utilizados ao chamar a API.

ResponseFormat

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

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange
xml	string	O Idioma de Marcação Extensível

ResponseSectionType

Tipos de secção da resposta de rota reportada

Name	Tipo	Description
CARPOOL	string	Secções da rota que requerem a utilização de pistas de caráter de boleia (HOV/Veículo de Alta Ocupação).
CAR_TRAIN	string	Secções da rota que são carros ou comboios.
COUNTRY	string	Secções que indicam em que países/regiões se encontra a rota.
FERRY	string	Secções da rota que são ferries.
MOTORWAY	string	Secções da rota que são auto-estradas.
PEDESTRIAN	string	Secções do percurso que são apenas adequadas para peões.
TOLL_ROAD	string	Secções da rota que exigem o pagamento de uma portagem.
TOLL_VIGNETTE	string	Secções da rota que requerem uma vinheta de portagem para estar presente.
TRAFFIC	string	Secções da rota que contêm informações de tráfego.
TRAVEL_MODE	string	Secções em relação ao parâmetro travelModede pedido .
TUNNEL	string	Secções da rota que são túneis.
URBAN	string	Secções da rota localizadas em áreas urbanas.

ResponseTravelMode

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

Name	Tipo	Description
bicycle	string	As rotas devolvidas são otimizadas para bicicletas, incluindo a utilização de ciclovias.
bus	string	As rotas devolvidas são otimizadas para autocarros, incluindo a utilização de faixas apenas de autocarro. Funcionalidade BETA.
car	string	As rotas devolvidas estão otimizadas para automóveis.
motorcycle	string	As rotas devolvidas são otimizadas para motociclos. Funcionalidade BETA.
other	string	O modo de transporte especificado não é possível nesta secção
pedestrian	string	As rotas devolvidas são otimizadas para peões, incluindo a utilização de calçadas.
taxi	string	As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas devolvidas são otimizadas para veículos comerciais, como para camiões.
van	string	As rotas devolvidas estão otimizadas para carrinhas. Funcionalidade BETA.

Route

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

RouteAvoidType

Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor alreadyUsedRoads não pode ser utilizado.

Name	Tipo	Description
alreadyUsedRoads	string	Evita utilizar a mesma estrada várias vezes. Mais útil em conjunto com routeType=emocionante.
borderCrossings	string	Evita passagens de limites no cálculo de rotas.
carpools	string	Evita rotas que exijam a utilização de faixas de rodagem (HOV/Veículo de Alta Ocupação).
ferries	string	Evita ferries
motorways	string	Evita auto-estradas
tollRoads	string	Evita estradas com portagens.
unpavedRoads	string	Evita estradas não remissadas

RouteDirectionParameters

Pós-parâmetros do corpo para direções da rota.

Name	Tipo	Description
allowVignette	string[]	Esta é uma lista de 3 carateres, ISO 3166-1, alfa-3 códigos de país de países/regiões em que as estradas com vinhetas de portagem são permitidas, por exemplo, "AUS,CHE". Especificar allowVignette com alguns países/regiões X é equivalente a especificar avoidVignette com todos os países/regiões, mas X. Especificar allowVignette com uma lista vazia é o mesmo que evitar todas as estradas com vinhetas. Nota: é um erro especificar avoidVignette e allowVignette.
avoidAreas	GeoJsonMultiPolygon	Um GeoJSON MultiPolygon que representa uma lista de áreas a evitar. Só são suportados polígonos retângulos. O tamanho máximo de um retângulo é de cerca de 160x160 km. O número máximo de áreas evitadas é 10. Não pode atravessar o 180º meridiano. Tem de estar entre -80 e +80 graus de latitude.
avoidVignette	string[]	Esta é uma lista de 3 carateres, ISO 3166-1, alfa-3 códigos de país de países/regiões em que todas as estradas com vinhetas de portagem devem ser evitadas, por exemplo, "AUS,CHE". As estradas com portagens com vinhetas em países/regiões que não estão na lista não são afectadas. Nota: é um erro especificar avoidVignette e allowVignette.
supportingPoints	GeoJsonGeometryCollection	Uma coleção de Geometria GeoJSON que representa a sequência de coordenadas utilizadas como entrada para a reconstrução de rotas e para calcular zero ou mais rotas alternativas para esta rota de referência. A sequência fornecida de pontos de suporte é utilizada como entrada para a reconstrução de rotas. As rotas alternativas são calculadas entre os pontos de origem e de destino especificados nas localizações dos parâmetros do caminho de base. Se minDeviationDistance e minDeviationTime estiverem definidos como zero, espera-se que estes pontos de origem e de destino estejam no início e no fim da rota de referência, respetivamente. As localizações intermédias (waypoints) não são suportadas ao utilizar <pontos de> suporte. A rota de referência pode conter incidentes de tráfego do tipo ROAD_CLOSURE, que são ignorados para o cálculo do tempo de viagem e atraso de tráfego da rota de referência. Veja Pontos de Suporte para obter detalhes.

RouteDirections

Este objeto é devolvido de uma chamada Route Directions bem-sucedida

Name	Tipo	Description
formatVersion	string	Propriedade Formatar Versão
optimizedWaypoints	RouteOptimizedWaypoint[]	Sequência otimizada de pontos de passagem. Mostra o índice da sequência de waypoint fornecida pelo utilizador 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]. Uma vez que o índice começa por 0, o original é "primeiro, segundo, terceiro" enquanto o otimizado é "segundo, terceiro, primeiro".
report	RouteReport	Comunica as definições efetivas utilizadas na chamada atual.
routes	Route[]	Matriz de rotas

RouteGuidance

Contém elementos relacionados com a documentação de orientação. Este campo só está presente quando a documentação de orientação foi pedida 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 que descrevem manobras.

RouteInstruction

Um conjunto de atributos que descreve uma manobra, por exemplo, "Virar à direita", "Manter à esquerda", "Apanhar o ferry", "Tomar a auto-estrada", "Chegar".

Name	Tipo	Description
combinedMessage	string	Uma mensagem legível por humanos para a manobra combinada com a mensagem da instrução seguinte. Por vezes, é possível combinar duas instruções sucessivas numa única instrução, facilitando o seu seguimento. Quando for este 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 é verdadeiro. Isto indica aos clientes de orientação codificada que pode ser combinado com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitem orientações 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 carateres. Por exemplo, EUA.
drivingSide	DrivingSide	Indica a condução do lado esquerdo vs. direito no ponto da manobra.
exitNumber	string	O número de uma saída rodoviária tomada pela manobra atual. Se uma saída tiver vários números de saída, estes serão separados por "" e possivelmente agregados por "-", por exemplo, "10, 13-15".
instructionType	GuidanceInstructionType	Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.
junctionType	JunctionType	O tipo de junção 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	Uma localização representada como uma latitude e longitude.
pointIndex	integer	O índice do ponto na lista de "pontos" poliline correspondente ao ponto da instrução.
possibleCombineWithNext	boolean	Opcionalmente, é possível combinar a instrução com a seguinte. Isto pode ser utilizado para criar mensagens como "Virar para a esquerda e, em seguida, virar para a direita".
roadNumbers	string[]	O(s) número(s) de estrada(s) do(s) próximo(s) segmento(s) de estrada(s) significativo(s) após a manobra, ou das estradas a seguir. Exemplo: ["E34", "N205"]
roundaboutExitNumber	string	Isto indica que saída deve ser tomada numa rotunda.
routeOffsetInMeters	integer	Distância desde o início da rota até ao ponto da instrução.
signpostText	string	O texto numa 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 . Esta opção só está disponível para alguns países/regiões, como os EUA, o Canadá e o 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 deslocação até ao ponto correspondente a routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indica a direção de uma instrução. Se junctionType indicar uma instrução de viragem: 180 = U-turn [-179, -1] = Curva para a esquerda 0 = Ativado diretamente (uma curva de 0 graus) [1, 179] = Curva à direita Se junctionType indicar uma instrução de bifurcação: <0 - manter à esquerda >0 - manter à direita

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência está restrito a firstInstructionIndex e lastInstructionIndex. Quando são pedidas mensagens de texto legíveis por humanos para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo devolvida 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 são pedidas mensagens de texto legíveis por humanos para orientação (instructionType=text ou tagged).
lastInstructionIndex	integer	Índice da última instrução nas instruções e pertencente a este grupo.

RouteInstructionsType

Se for especificado, serão devolvidas instruções de orientação. Tenha em atenção que o parâmetro instructionsType não pode ser utilizado em conjunto com routeRepresentation=none

Name	Tipo	Description
coded	string	Devolve dados de instruções não processados sem mensagens legíveis por humanos.
tagged	string	Devolve dados de instruções não processados com mensagens legíveis por humanos etiquetadas para permitir formatação. Uma mensagem legível por humanos é criada a partir de elementos identificados repetíveis. Estes estão etiquetados para permitir que as aplicações cliente as formatem corretamente. Os seguintes componentes da mensagem são etiquetados quando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, rotundaExitNumber. Exemplo de mensagem etiquetada "Virar para a esquerda": Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>
text	string	Devolve dados de instruções não processadas com mensagens legíveis por humanos em texto simples.

RouteLeg

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido no pedido resultará numa etapa adicional na rota devolvida.

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

RouteLegSummary

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

Name	Tipo	Description
arrivalTime	string	A hora de chegada estimada para a rota ou perna. A hora é em UTC.
batteryConsumptionInkWh	number	Estimativa do consumo de energia elétrica em kilowatt horas (kWh) com 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 a obtenção de energia). Se estiverem especificados maxChargeInkWh e currentChargeInkWh, a recuperação será limitada para garantir que o nível de carga da bateria nunca excede maxChargeInkWh. Se não forem especificados maxChargeInkWh nem currentChargeInkWh, é assumida uma recuperação sem restrições no cálculo do consumo.
departureTime	string	A hora de partida estimada para a rota ou perna. A hora é em UTC.
fuelConsumptionInLiters	number	Consumo estimado de combustível em litros com o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido como combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.
historicTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado com dados de tráfego histórico dependentes do tempo. Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
lengthInMeters	integer	Propriedade Length In Meter
liveTrafficIncidentsTravelTimeInSeconds	integer	Tempo de viagem estimado calculado com dados de velocidade em tempo real. Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
noTrafficTravelTimeInSeconds	integer	O tempo estimado de deslocação foi calculado como se não existissem atrasos na rota devido às condições de tráfego (por exemplo, congestionamento). Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com as informações de tráfego. Para as rotas planeadas com a hora de partida no futuro, os atrasos são sempre 0. Para devolver tempos de viagem adicionais através de diferentes tipos de informações de tráfego, a computação de parâmetrosTravelTimeFor=all tem de ser adicionada.
travelTimeInSeconds	integer	Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Tenha em atenção que mesmo quando o tráfego=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem é calculado com dados de tráfego histórico dependentes do tempo.

RouteOptimizedWaypoint

Objeto de ponto de passagem otimizado.

Name	Tipo	Description
optimizedIndex	integer	Índice de pontos de passagem otimizado do sistema.
providedIndex	integer	Índice de ponto de caminho fornecido pelo utilizador.

RouteReport

Comunica as definições efetivas utilizadas na chamada atual.

Name	Tipo	Description
effectiveSettings	EffectiveSetting[]	Parâmetros ou dados eficazes utilizados ao chamar esta API de Rota.

RouteRepresentationForBestOrder

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

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

RouteSection

As secções de rota contêm informações adicionais sobre partes de uma rota. Cada secçã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, média acima de todo o seu comprimento.
endPointIndex	integer	O índice do último ponto (desvio 0) na rota a que esta secção se aplica.
magnitudeOfDelay	DelayMagnitude	A magnitude do atraso causado pelo incidente. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.
sectionType	ResponseSectionType	Tipos de secção da resposta de rota reportada
simpleCategory	SimpleCategory	Tipo de incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Consulte "tec" para obter informações detalhadas.
startPointIndex	integer	O índice do primeiro ponto (desvio 0) na rota a que esta secção se aplica.
tec	RouteSectionTec	Detalhes do evento de tráfego, com definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.
travelMode	ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte pedido não for possível nesta secção

RouteSectionTec

Detalhes do evento de tráfego, com definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.

Name	Tipo	Description
causes	RouteSectionTecCause[]	Causa matriz
effectCode	integer	O efeito no fluxo de tráfego. Contém um valor na tabela tec001:EffectCode, conforme definido na norma TPEG2-TEC . Pode ser utilizado para colorir eventos de tráfego de acordo com a gravidade.

RouteSectionTecCause

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

Name	Tipo	Description
mainCauseCode	integer	A principal causa do evento de tráfego. Contém um valor na tabela tec002:CauseCode, conforme definido na norma TPEG2-TEC .
subCauseCode	integer	A subcautilidade do evento de tráfego. Contém um valor na tabela de sub-causa definida pelo mainCauseCode, conforme definido na norma TPEG2-TEC .

RouteSummary

Objeto de resumo

Name	Tipo	Description
arrivalTime	string	A hora de chegada estimada para a rota ou perna. A hora é em UTC.
departureTime	string	A hora de partida estimada para a rota ou perna. A hora é em UTC.
lengthInMeters	integer	Propriedade Length In Meter
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com as informações de tráfego. Para as rotas planeadas com a hora de partida no futuro, os atrasos são sempre 0. Para devolver tempos de viagem adicionais através de diferentes tipos de informações de tráfego, a computação de parâmetrosTravelTimeFor=all tem de ser adicionada.
travelTimeInSeconds	integer	Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Tenha em atenção que mesmo quando o tráfego=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem é calculado com dados de tráfego histórico dependentes do tempo.

RouteType

O tipo de rota pedida.

Name	Tipo	Description
eco	string	Uma rota equilibrada pela 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 desafiantes e utiliza o menor número possível de auto-estradas. Pode escolher o nível de curvas incluído e também o grau de colina. Veja os parâmetros hilliness e windingness para saber como definir isto. Existe um limite de 900 km nas rotas planeadas com routeType=emocionante

SectionType

Especifica qual dos tipos de secção é comunicado na resposta da rota.

Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro

Name	Tipo	Description
carTrain	string	Secções da rota que são carros ou comboios.
carpool	string	Secções da rota que requerem a utilização de pistas de caráter de boleia (HOV/Veículo de Alta Ocupação).
country	string	Secções que indicam em que países/regiões se encontra a rota.
ferry	string	Secções da rota que são ferries.
motorway	string	Secções da rota que são auto-estradas.
pedestrian	string	Secções do percurso que são apenas adequadas para peões.
tollRoad	string	Secções da rota que exigem o pagamento de uma portagem.
tollVignette	string	Secções da rota que requerem uma vinheta de portagem para estar presente.
traffic	string	Secções da rota que contêm informações de tráfego.
travelMode	string	Secções em relação ao parâmetro travelModede pedido .
tunnel	string	Secções da rota que são túneis.
urban	string	Secções da rota localizadas em áreas urbanas.

SimpleCategory

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

Name	Tipo	Description
JAM	string	Engarrafamento.
OTHER	string	Outro.
ROAD_CLOSURE	string	Encerramento da estrada.
ROAD_WORK	string	Trabalho de estrada.

TravelMode

O modo de deslocação para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Se o travelMode solicitado não estiver disponível para uma determinada secção, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motocicleta, táxi e carrinha são a funcionalidade BETA. Os dados de restrição total não estão disponíveis em todas as áreas.

Name	Tipo	Description
bicycle	string	As rotas devolvidas são otimizadas para bicicletas, incluindo a utilização de ciclovias.
bus	string	As rotas devolvidas são otimizadas para autocarros, incluindo a utilização de faixas apenas de autocarro. Funcionalidade BETA.
car	string	As rotas devolvidas estão otimizadas para automóveis.
motorcycle	string	As rotas devolvidas são otimizadas para motociclos. Funcionalidade BETA.
pedestrian	string	As rotas devolvidas são otimizadas para peões, incluindo a utilização de calçadas.
taxi	string	As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas devolvidas são otimizadas para veículos comerciais, como para camiões.
van	string	As rotas devolvidas estão otimizadas para carrinhas. Funcionalidade BETA.

VehicleEngineType

Tipo de motor do veículo. Quando um Modelo de Consumo detalhado é especificado, tem de 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 de algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos E.U.A. 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados 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	Oxidizers
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. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante.

Name	Tipo	Description
high	string	alta
low	string	baixa
normal	string	normal