Route - Get Route Range

Referência

Serviço:: Maps

Versão da API:: 1.0

Utilizado para criar um mapa que ilustra a área acessível a partir de um determinado ponto dentro de um determinado limiar com base no tempo, distância ou capacidade de combustível.

A Get Route Range API (Isochrone) é um pedido HTTP GET que irá calcular um conjunto de localizações que podem ser alcançadas a partir do ponto de origem com base no orçamento de combustível, energia, tempo ou distância especificado. Um limite de polígono (ou Isochrone) é devolvido numa orientação no sentido contrário ao dos ponteiros do relógio, bem como no centro de polígonos preciso que foi o resultado do ponto de origem.

O polígono devolvido pode ser utilizado para processamento adicional, como a Geometria De Pesquisa Interna , para procurar POIs no isorono fornecido.

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

Com parâmetros opcionais:

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&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 do Azure Maps.
query	query	True	number[]	A Coordenada a partir da qual o cálculo do intervalo deve ser iniciado.
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
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.
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`.
distanceBudgetInMeters	query		number double	Orçamento de distância em medidores que determina o intervalo máximo que pode ser percorrido com a distância de condução. O Modelo de Consumo só afetará o intervalo quando routeType for eco. Tem de ser utilizado exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters).
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
energyBudgetInkWh	query		number double	Orçamento de energia elétrica em kilowatt horas (kWh) que determina o intervalo máximo que pode ser percorrido com o Modelo de Consumo Elétrico especificado. Quando o energyBudgetInkWh é utilizado, é obrigatório especificar um Modelo de Consumo Elétrico detalhado. Tem de ser utilizado exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters).
fuelBudgetInLiters	query		number double	Orçamento do combustível em litros que determina o intervalo máximo que pode ser percorrido com o Modelo de Consumo de Combustão especificado. Quando fuelBudgetInLiters é utilizado, é obrigatório especificar um Modelo de Consumo de Combustão detalhado. Tem de ser utilizado exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters).
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.
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
routeType	query		RouteType	O tipo de rota pedida.
timeBudgetInSec	query		number double	Orçamento de tempo em segundos que determina o intervalo máximo que pode ser percorrido com o tempo de condução. O Modelo de Consumo só afetará o intervalo quando routeType for eco. Tem de ser utilizado exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters).
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.
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. Este parâmetro é atualmente considerado apenas 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 do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	RouteRangeResult	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 do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. 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 as APIs REST do Azure Maps.

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 recurso do Azure Maps 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 do 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 do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do 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 a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades 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 partilhada que é aprovisionada quando cria uma conta do Azure Maps no portal do Azure ou utiliza 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 às APIs REST do Azure Maps para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Pedido de amostra

HTTP

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Resposta da amostra

Código de estado:: 200

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

Definições

Name	Description
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
InclineLevel	Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com `routeType`=emocionante.
LatLongPair	Uma localização representada como uma latitude e longitude.
ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
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.
RouteRange	Intervalo Acessível
RouteRangeResult	Este objeto é devolvido a partir de uma chamada de Intervalo Acessível de Rota com êxito
RouteReport	Comunica as definições efetivas utilizadas na chamada atual.
RouteType	O tipo de rota pedida.
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.

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.

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

LatLongPair

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

Name	Tipo	Description
latitude	number	Propriedade Latitude
longitude	number	Propriedade Longitude

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

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

RouteRange

Intervalo Acessível

Name	Tipo	Description
boundary	LatLongPair[]	Limite de polígono do intervalo acessível representado como uma lista de pontos.
center	LatLongPair	Ponto central do intervalo acessível

RouteRangeResult

Este objeto é devolvido a partir de uma chamada de Intervalo Acessível de Rota com êxito

Name	Tipo	Description
formatVersion	string	Propriedade Formatar Versão
reachableRange	RouteRange	Intervalo Acessível
report	RouteReport	Comunica as definições efetivas utilizadas na chamada atual.

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.

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

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

Partilhar via