Partilhar via

Route - Get Route Range

Serviço:
Maps
Versão da API:
1.0

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

Observação

de desativação do serviço Azure Maps Route v1

O serviço de do Azure Maps Route v1 foi preterido e será desativado em 31/03/28. Para evitar interrupções no serviço, todas as chamadas para o serviço Route v1 precisarão ser atualizadas para usar serviço de do Route v2025-01-01 até 31/03/28. Para obter mais informações, consulte migrar APIs do Azure Maps Route 1.0.

A API Get Route Range (Isochrone) é uma solicitação de GET HTTP que calculará um conjunto de locais que podem ser alcançados 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) é retornado em uma orientação anti-horário, bem como o centro de polígono preciso que foi o resultado do ponto de origem.

O polígono retornado pode ser usado para processamento adicional, como Search Inside Geometry para procurar POIs dentro da isocrona fornecida.

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 desejado da resposta. O valor pode ser json ou xml.
api-version
 query True

string

Número da versão da API do Azure Maps.
query
 query True

number[]

A coordenada a partir da qual o cálculo do intervalo deve começar.
accelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

Especifica a eficiência da conversão da energia química armazenada no combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com desaceleraçãoEficiência.

O intervalo de valores permitidos são de 0,0 a 1/desaceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,33, para modelo elétrico: 0,66
auxiliaryPowerInkW
 query

number (double)

Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em quilowatts (kW).

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 1.7
auxiliaryPowerInLitersPerHour
 query

number (double)

Especifica a quantidade de combustível consumida para sustentar os sistemas auxiliares do veículo, em litros por hora.

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 0.2
avoid
 query

RouteAvoidType[]

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

string

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em kWh/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,8.2:130,21.3

Este parâmetro é necessário para modelo de consumo elétrico.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade & taxa de consumo delimitados por dois pontos. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em l/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,6.3:130,11.5

Nota : Este parâmetro é necessário para O Modelo de Consumo de Combustão.
currentChargeInkWh
 query

number (double)

Especifica o fornecimento atual de energia elétrica em quilowatts-hora (kWh).

Este parâmetro coexiste com parâmetro maxChargeInkWh.

O intervalo de valores permitidos é de 0,0 a maxChargeInkWh.

Valores sensatos : 43
currentFuelInLiters
 query

number (double)

Especifica o fornecimento atual de combustível em litros.

Valores sensíveis : 55
decelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

Especifica a eficiência da conversão de energia cinética em combustível economizado (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com aceleraçãoEficiência.

O intervalo de valores permitidos é de 0,0 a 1/aceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,83, para modelo elétrico: 0,91
departAt
 query

string (date-time)

A data e hora de partida do ponto de origem formatado como um valor de dateTime, conforme definido no RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não é especificado, presumir-se-á que é o do ponto de origem.

  • Valor padrão: agora
  • Outro valor: dateTime

Exemplos:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

O parâmetro departAt não pode ser usado em conjunto com arriveAt.
distanceBudgetInMeters
 query

number (double)

Orçamento de distância em metros que determina o alcance máximo que pode ser percorrido usando a distância de condução. O Modelo de Consumo só afetará o alcance quando routeType for ecológico.
Exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) deve ser usado.
downhillEfficiency
 query

number (double)

minimum: 0
maximum: 1

Especifica a eficiência da conversão de energia potencial em combustível economizado (não consumido) quando o veículo perde de elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com uphillEfficiency.

O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency.

Valores sensíveis: para modelo de combustão: 0,51, para modelo elétrico: 0,73
energyBudgetInkWh
 query

number (double)

Orçamento de energia elétrica em quilowatts-hora (kWh) que determina o alcance máximo que pode ser percorrido usando o Modelo de Consumo Elétrico especificado.
Quando energyBudgetInkWh é utilizado, é obrigatório especificar um Modelo de Consumo Elétrico detalhado.
Exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) deve ser usado.
fuelBudgetInLiters
 query

number (double)

Orçamento de combustível em litros que determina a autonomia máxima que pode ser percorrida usando o Modelo de Consumo de Combustão especificado.
Quando fuelBudgetInLiters é usado, é obrigatório especificar um modelo detalhado de consumo de combustão.
Exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) deve ser usado.
fuelEnergyDensityInMJoulesPerLiter
 query

number (double)

Especifica a quantidade de energia química armazenada em um litro de combustível em megajoules (MJ). É utilizado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível poupados ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para a gasolina e 35,8 MJ/l para o gasóleo.

Este parâmetro é necessário se qualquer parâmetro *Efficiency estiver definido.

Valores sensíveis : 34,2
hilliness
 query

InclineLevel

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

number (double)

Especifica o fornecimento máximo de energia elétrica em quilowatts-hora (kWh) que pode ser armazenada na bateria do veículo.

Este parâmetro coexiste com parâmetro currentChargeInkWh.

O valor mínimo tem de ser maior ou igual a currentChargeInkWh.

Valores sensíveis : 85
routeType
 query

RouteType

O tipo de rota solicitada.
timeBudgetInSec
 query

number (double)

Orçamento de tempo em segundos que determina o alcance máximo que pode ser percorrido usando o tempo de condução. O Modelo de Consumo só afetará o alcance quando routeType for ecológico.
Exatamente um orçamento (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) deve ser usado.
traffic
 query

boolean

Valores possíveis:

  • true - Considere todas as informações de tráfego disponíveis durante o roteamento
  • false - Ignore os dados de tráfego atuais durante o roteamento. Note-se que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico nas velocidades efetivas da estrada ainda é incorporado.
travelMode
 query

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
uphillEfficiency
 query

number (double)

minimum: 0
maximum: 1

Especifica a eficiência da conversão da energia química armazenada no combustível em energia potencial quando o veículo ganha de elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com downhillEfficiency.

O intervalo de valores permitidos são de 0,0 a 1/downhillEfficiency.

Valores sensíveis: para modelo de combustão: 0,27, para modelo elétrico: 0,74
vehicleAxleWeight
 query

integer

Peso por eixo do veículo, em kg. Um valor 0 significa que as restrições de peso por eixo não são consideradas.
vehicleCommercial
 query

boolean

Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular em algumas estradas.
vehicleEngineType
 query

VehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.
vehicleHeight
 query

number (double)

Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas.
vehicleLength
 query

number (double)

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
vehicleLoadType
 query

VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.
vehicleMaxSpeed
 query

integer

Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é utilizada para verificar se um veículo é permitido em autoestradas.

  • Um valor 0 significa que será determinado e aplicado um valor adequado para o veículo durante o planeamento de rotas.

  • Um valor diferente de zero pode ser substituído durante o planejamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida para 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o motor de roteamento usará novamente 60 km/hora.
vehicleWeight
 query

integer

Peso do veículo em quilogramas.

  • É obrigatório se algum dos parâmetros *Eficiência for definido.

  • Deve ser estritamente positivo quando utilizado no contexto do Modelo de Consumo. Restrições de peso são consideradas.

  • Se não for especificado um detalhado do Modelo de Consumo de e o valor de de peso do veículo for diferente de zero, as restrições de peso serão consideradas.

  • Em todos os outros casos, esse parâmetro é ignorado.

Valores sensíveis: para modelo de combustão: 1600, para modelo elétrico: 1900
vehicleWidth
 query

number (double)

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.
windingness
 query

WindingnessLevel

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

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.

Respostas

Name Tipo Description
200 OK

RouteRangeResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

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

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

Observações

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

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

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

Âmbitos

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

subscription-key

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

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

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

Tipo: apiKey
Em: query

SAS Token

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

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

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

Tipo: apiKey
Em: header

Exemplos

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

Pedido de amostra

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 efetivos usados ao chamar essa API de rota.
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
InclineLevel

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

Um local representado como latitude e longitude.
ResponseFormat

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

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

Alcance acessível
RouteRangeResult

Este objeto é retornado de uma chamada de Intervalo Acessível de Rota bem-sucedida
RouteReport

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

O tipo de rota solicitada.
TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
VehicleEngineType

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

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.
WindingnessLevel

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

EffectiveSetting

Object

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

Name Tipo Description
key

string

Nome do parâmetro utilizado.
value

string

Valor do parâmetro utilizado.

ErrorAdditionalInfo

Object

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

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

InclineLevel

Enumeração

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

Valor Description
low

baixo
normal

normal
high

alto

LatLongPair

Object

Um local representado como latitude e longitude.

Name Tipo Description
latitude

number (double)

Propriedade Latitude
longitude

number (double)

Propriedade Longitude

ResponseFormat

Enumeração

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

Valor Description
json

O formato de intercâmbio de dados de notação de objeto JavaScript
xml

A linguagem de marcação extensível

RouteAvoidType

Enumeração

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

Valor Description
tollRoads

Evita estradas com portagem.
motorways

Evita autoestradas
ferries

Evita ferries
unpavedRoads

Evita estradas não pavimentadas
carpools

Evita percursos que exijam a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
alreadyUsedRoads

Evita usar a mesma estrada várias vezes. Mais útil em conjunto com routeType=emocionante.
borderCrossings

Evita passagens de fronteira no cálculo de rotas.

RouteRange

Object

Alcance acessível

Name Tipo Description
boundary

LatLongPair[]

Limite do polígono do intervalo alcançável representado como uma lista de pontos.
center

LatLongPair

Ponto central do alcance acessível

RouteRangeResult

Object

Este objeto é retornado de uma chamada de Intervalo Acessível de Rota bem-sucedida

Name Tipo Description
formatVersion

string

Propriedade Format Version
reachableRange

RouteRange

Alcance acessível
report

RouteReport

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

RouteReport

Object

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

Name Tipo Description
effectiveSettings

EffectiveSetting[]

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

RouteType

Enumeração

O tipo de rota solicitada.

Valor Description
fastest

A rota mais rápida.
shortest

O percurso mais curto por distância.
eco

Uma rota equilibrada pela economia e velocidade.
thrilling

Inclui estradas interessantes ou desafiantes e utiliza o menor número possível de autoestradas. Você pode escolher o nível de voltas incluídas e também o grau de inclinação. Veja os parâmetros de inclinação e enrolamento para saber como definir isso. Há um limite de 900 km em rotas planejadas com routeType=emocionante

TravelMode

Enumeração

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.

Valor Description
car

As rotas devolvidas são otimizadas para carros.
truck

As rotas de retorno são otimizadas para veículos comerciais, como para caminhões.
taxi

As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
bus

As rotas de retorno são otimizadas para ônibus, incluindo o uso de faixas exclusivas para ônibus. Funcionalidade BETA.
van

As rotas devolvidas são otimizadas para vans. Funcionalidade BETA.
motorcycle

As rotas devolvidas são otimizadas para motocicletas. Funcionalidade BETA.

VehicleEngineType

Enumeração

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

Valor Description
combustion

Motor de combustão interna.
electric

Motor elétrico.

VehicleLoadType

Enumeração

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.

Valor Description
USHazmatClass1

Explosivos
USHazmatClass2

Gás comprimido
USHazmatClass3

Líquidos inflamáveis
USHazmatClass4

Sólidos inflamáveis
USHazmatClass5

Oxidantes
USHazmatClass6

Venenos
USHazmatClass7

Radioativo
USHazmatClass8

Corrosivos
USHazmatClass9

Diversos
otherHazmatExplosive

Explosivos
otherHazmatGeneral

Diversos
otherHazmatHarmfulToWater

Nocivo para a água

WindingnessLevel

Enumeração

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

Valor Description
low

baixo
normal

normal
high

alto