Compartilhar via

Route - Get Route Range

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

Use para criar um mapa que ilustra a área acessível 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 V1 da Rota do Azure Mapas

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

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

O polígono retornado pode ser usado para processamento adicional, como pesquisar dentro da geometria para pesquisar pois dentro do isócrono 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 de URI

Nome Em Obrigatório Tipo Description
format
 path True

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.
api-version
 query True

string

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

number[]

A coordenada da qual o cálculo do intervalo deve ser iniciado.
accelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

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). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com decelerationEfficiency.

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

Valores sensatos: para 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 AC, rádio, aquecimento etc.

Valores sensatos: 1,7
auxiliaryPowerInLitersPerHour
 query

number (double)

Especifica a quantidade de combustível consumida para manutenção de sistemas auxiliares do veículo, em litros por hora.

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

Valores sensatos: 0.2
avoid
 query

RouteAvoidType[]

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

string

Especifica o componente dependente de velocidade do consumo.

Fornecida como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira:

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

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

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

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em kWh/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,8,2:130,21,3

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

string

Especifica o componente dependente de velocidade do consumo.

Fornecida como uma lista não ordenada de velocidade delimitada por dois-pontos & pares de taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira:

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

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

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

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em l/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,6,3:130,11,5

Observação: esse parâmetro é necessário para o modelo de consumo de combustão.
currentChargeInkWh
 query

number (double)

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

Esse 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 sensatos: 55
decelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

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

Deve ser emparelhado com de aceleração.

O intervalo de valores permitidos é de 0,0 a 1/de aceleração.

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

string (date-time)

A data e hora da partida do ponto de origem formatado como um valor dateTime conforme definido em RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não for especificado, ele será considerado 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 medidores que determina o intervalo máximo que pode ser percorrido usando a distância de condução. O Modelo de Consumo só afetará o intervalo quando routeType for eco.
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 para o combustível salvo (não consumido) quando o veículo perde a elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com uphillEfficiency.

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

Valores sensatos: para 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 intervalo máximo que pode ser percorrido usando o modelo de consumo elétrico especificado.
Quando energyBudgetInkWh é usado, é 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 o intervalo máximo que pode ser percorrido usando o Modelo de Consumo de Combustão especificado.
Quando fuelBudgetInLiters é usado, é obrigatório especificar um modelo de consumo de combustão detalhado.
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). Ele é usado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível salvos ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para gasolina e 35,8 MJ/l para diesel.

Esse parâmetro será necessário se algum parâmetro *Efficiency estiver definido.

Valores sensatos: 34.2
hilliness
 query

InclineLevel

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

number (double)

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

Esse parâmetro coexiste com parâmetro CurrentChargeInkWh.

O valor mínimo deve ser maior ou igual a CurrentChargeInkWh .

Valores sensatos: 85
routeType
 query

RouteType

O tipo de rota solicitada.
timeBudgetInSec
 query

number (double)

Orçamento de tempo em segundos que determina o intervalo máximo que pode ser percorrido usando o tempo de condução. O Modelo de Consumo só afetará o intervalo quando routeType for eco.
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 – ignorar os dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico em velocidades de estrada efetivas ainda é incorporado.
travelMode
 query

TravelMode

O modo de viagem para a rota solicitada. Se não for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa 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 de energia química armazenada em combustível em energia potencial quando o veículo ganha elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com dede .

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

Valores sensatos: 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 de 0 significa que as restrições de peso por eixo não são consideradas.
vehicleCommercial
 query

boolean

Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir em algumas estradas.
vehicleEngineType
 query

VehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.
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 classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é 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 é usada para verificar se um veículo é permitido em auto-estradas.

  • Um valor de 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota.

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

integer

Peso do veículo em quilogramas.

  • É obrigatório se qualquer um dos parâmetros *Efficiency estiver definido.

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

  • Se nenhum modelo de consumo detalhado for especificado e o valor de vehicleWeight não for zero, as restrições de peso serão consideradas.

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

Valores sensatos: 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. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

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

Respostas

Nome Tipo Description
200 OK

RouteRangeResult

OKEY
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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

Anotações

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

O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

Escopos

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

subscription-key

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

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

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

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de 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

Solicitação de exemplo

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

Resposta de exemplo

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

Nome Description
EffectiveSetting

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

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

O detalhe do erro.
ErrorResponse

Resposta de erro
InclineLevel

Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.
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 uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.
RouteRange

Intervalo acessível
RouteRangeResult

Esse 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 for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa 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 classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.
WindingnessLevel

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

EffectiveSetting

Objeto

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

Nome Tipo Description
key

string

Nome do parâmetro usado.
value

string

Valor do parâmetro usado.

ErrorAdditionalInfo

Objeto

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

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

InclineLevel

Enumeração

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

Valor Description
low

baixo
normal

normal
high

high

LatLongPair

Objeto

Um local representado como latitude e longitude.

Nome 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 uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.

Valor Description
tollRoads

Evita estradas pedagiadas.
motorways

Evita auto-estradas
ferries

Evita balsas
unpavedRoads

Evita estradas não pavimentadas
carpools

Evita rotas que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).
alreadyUsedRoads

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

Evita cruzamentos de borda no cálculo de rota.

RouteRange

Objeto

Intervalo acessível

Nome 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

Objeto

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

Nome Tipo Description
formatVersion

string

Propriedade Format Version
reachableRange

RouteRange

Intervalo acessível
report

RouteReport

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

RouteReport

Objeto

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

Nome 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

A rota mais curta por distância.
eco

Uma rota equilibrada por economia e velocidade.
thrilling

Inclui estradas interessantes ou desafiadoras e usa o menor número possível de auto-estradas. Você pode escolher o nível de turnos incluído e também o grau de hilliness. Consulte os parâmetros de hilliness e windingness 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 for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.

Valor Description
car

As rotas retornadas são otimizadas para carros.
truck

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

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

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

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

As rotas retornadas 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

Mecanismo de combustão interna.
electric

Motor elétrico.

VehicleLoadType

Enumeração

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

Valor Description
USHazmatClass1

Explosivos
USHazmatClass2

Gás compactado
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

Prejudicial à água

WindingnessLevel

Enumeração

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

Valor Description
low

baixo
normal

normal
high

high