Route - Get Route Range

Use para crear un mapa que muestre el área accesible desde un punto determinado dentro de un determinado umbral en función del tiempo, la distancia o la capacidad de combustible.

La Get Route Range API (Isochrone) es una solicitud HTTP GET que calculará un conjunto de ubicaciones a las que se puede acceder desde el punto de origen en función del combustible, energía, tiempo o presupuesto de distancia especificado. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que fue el resultado del punto de origen.

El polígono devuelto se puede usar para su posterior procesamiento, como Búsqueda Inside Geometry para buscar POIs dentro del isócrono proporcionado.

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
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 identificador URI

Nombre En Requerido Tipo Description
format
path True

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

api-version
query True

string

Número de versión de la API de Azure Maps.

query
query True

number[]

Coordenada desde la que se debe iniciar el cálculo del intervalo.

accelerationEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía cinética cuando el vehículo se acelera (es decir, CinéticaEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con deceleraciónEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/deceleraciónEfficiency.

Valores sensibles: para el modelo de combustión : 0,33, para el modelo eléctrico : 0,66

auxiliaryPowerInkW
query

number

double

Especifica la cantidad de energía consumida para mantener sistemas auxiliares, en kilowatts (kW).

Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas DE CA, radio, calefacción, etc.

Valores sensibles: 1,7

auxiliaryPowerInLitersPerHour
query

number

double

Especifica la cantidad de combustible consumido para mantener sistemas auxiliares del vehículo, en litros por hora.

Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas DE CA, radio, calefacción, etc.

Valores sensibles: 0,2

avoid
query

RouteAvoidType[]

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.

constantSpeedConsumptionInkWhPerHundredkm
query

string

Especifica el componente dependiente de la velocidad del consumo.

Se proporciona como una lista desordenada de pares de velocidad/velocidad de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera:

  • por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista

  • por extrapolación lineal de lo contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista

La lista debe contener entre 1 y 25 puntos (inclusive), y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional.

El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas.

De forma similar, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad menor.

El intervalo válido para los valores de consumo (expresados en kWh/100km) está comprendido entre 0,01 y 100000,0.

Valores sensibles: 50,8.2:130,21.3

Este parámetro es necesario para el modelo de consumo eléctrico.

constantSpeedConsumptionInLitersPerHundredkm
query

string

Especifica el componente dependiente de la velocidad del consumo.

Se proporciona como una lista desordenada de velocidad delimitada por dos puntos & pares de tasa de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera:

  • por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista

  • por extrapolación lineal de lo contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista

La lista debe contener entre 1 y 25 puntos (inclusive), y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional.

El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas.

De forma similar, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad menor.

El intervalo válido para los valores de consumo (expresados en l/100km) está comprendido entre 0,01 y 100000,0.

Valores sensibles: 50,6.3:130,11.5

Nota : Este parámetro es necesario para el modelo de consumo de combustión.

currentChargeInkWh
query

number

double

Especifica la fuente de energía eléctrica actual en horas de kilowatt (kWh).

Este parámetro coexiste con el parámetro maxChargeInkWh .

El intervalo de valores permitidos es de 0,0 a maxChargeInkWh.

Valores sensibles: 43

currentFuelInLiters
query

number

double

Especifica el suministro actual de combustible en litros.

Valores sensibles: 55

decelerationEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía cinética en combustible ahorrado (no consumido) cuando el vehículo se decelera (es decir, ChemicalEnergySaved/CinéticaEnergyLost). ChemicalEnergySaved se obtiene convirtiendo combustible guardado (no consumido) en energía utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con accelerationEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/accelerationEfficiency.

Valores sensibles : para el modelo de combustión : 0,83, para el modelo eléctrico : 0,91

departAt
query

string

date-time

Fecha y hora de salida del punto de origen con formato de valor definido en RFC 3339, sección 5.6, con un dateTime desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de origen.

  • Valor predeterminado: ahora
  • Otro valor: dateTime

Ejemplos:

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

El departAt parámetro no se puede usar junto con arriveAt.

distanceBudgetInMeters
query

number

double

Presupuesto de distancia en metros que determina el intervalo máximo que se puede viajar utilizando la distancia de conducción. El modelo de consumo solo afectará al intervalo cuando routeType sea eco.
Se debe usar exactamente un presupuesto (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec o distanceBudgetInMeters).

downhillEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía potencial a combustible ahorrado (no consumido) cuando el vehículo pierde la elevación (es decir, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved se obtiene convirtiendo combustible guardado (no consumido) en energía utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con uphillEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/uphillEfficiency.

Valores sensibles : para el modelo de combustión : 0,51, para el modelo eléctrico : 0,73

energyBudgetInkWh
query

number

double

Presupuesto de energía eléctrica en horas de kilowatt (kWh) que determina el rango máximo que se puede viajar utilizando el modelo de consumo eléctrico especificado.
Cuando se usa energyBudgetInkWh, es obligatorio especificar un modelo de consumo eléctrico detallado.
Se debe usar exactamente un presupuesto (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec o distanceBudgetInMeters).

fuelBudgetInLiters
query

number

double

Presupuesto de combustible en litros que determina el rango máximo que se puede viajar utilizando el modelo de consumo de combustión especificado.
Cuando se usa fuelBudgetInLiters, es obligatorio especificar un modelo de consumo de combustión detallado.
Se debe usar exactamente un presupuesto (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec o distanceBudgetInMeters).

fuelEnergyDensityInMJoulesPerLiter
query

number

double

Especifica la cantidad de energía química almacenada en un litro de combustible en megajoules (MJ). Se utiliza junto con los parámetros *Efficiency para conversiones entre energía guardada o consumida y combustible. Por ejemplo, la densidad energética es de 34,2 MJ/l para gasolina y 35,8 MJ/l para combustible diesel.

Este parámetro es necesario si se establece algún parámetro *Efficiency .

Valores sensibles: 34.2

hilliness
query

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=thrilling.

maxChargeInkWh
query

number

double

Especifica el suministro máximo de energía eléctrica en kilowatt horas (kWh) que se pueden almacenar en la batería del vehículo.

Este parámetro coexiste con el parámetro currentChargeInkWh .

El valor mínimo debe ser mayor o igual que currentChargeInkWh.

Valores sensibles: 85

routeType
query

RouteType

Tipo de ruta solicitada.

timeBudgetInSec
query

number

double

Presupuesto de tiempo en segundos que determina el intervalo máximo que se puede viajar usando el tiempo de conducción. El modelo de consumo solo afectará al intervalo cuando routeType sea eco.
Se debe usar exactamente un presupuesto (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec o distanceBudgetInMeters).

traffic
query

boolean

Valores posibles:

  • true: considere toda la información de tráfico disponible durante el enrutamiento.
  • false: omita los datos de tráfico actuales durante el enrutamiento. Tenga en cuenta que, aunque los datos de tráfico actuales se omiten durante el enrutamiento, el efecto del tráfico histórico en velocidades de carretera efectivas sigue incorporando.
travelMode
query

TravelMode

Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que es posible que el travelMode solicitado no esté disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y camioneta son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

uphillEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía potencial cuando el vehículo obtiene elevación (es decir, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con downhillEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/downhillEfficiency.

Valores sensibles: para el modelo de combustión : 0,27, para el modelo eléctrico : 0,74

vehicleAxleWeight
query

integer

Peso por eje del vehículo en kg. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso por eje.

vehicleCommercial
query

boolean

Si el vehículo se utiliza con fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.

vehicleEngineType
query

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

vehicleHeight
query

number

double

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.

vehicleLength
query

number

double

Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.

vehicleLoadType
query

VehicleLoadType

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países o regiones. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

vehicleMaxSpeed
query

integer

Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas.

  • Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante la planificación de rutas.

  • Un valor distinto de cero se puede invalidar durante el planeamiento de rutas. Por ejemplo, el flujo de tráfico actual es de 60 km/hora. Si la velocidad máxima del vehículo se establece en 50 km/hora, el motor de enrutamiento tendrá en cuenta 60 km/hora, ya que esta es la situación actual. Si la velocidad máxima del vehículo se proporciona como 80 km/hora, pero el flujo de tráfico actual es de 60 km/hora, el motor de enrutamiento volverá a usar 60 km/hora.

vehicleWeight
query

integer

Peso del vehículo en kilogramos.

  • Es obligatorio si se establece alguno de los parámetros *Efficiency.

  • Debe ser estrictamente positivo cuando se usa en el contexto del modelo de consumo. Se tienen en cuenta las restricciones de peso.

  • Si no se especifica ningún modelo de consumo detallado y el valor de vehicleWeight no es cero, se tienen en cuenta las restricciones de peso.

  • En todos los demás casos, este parámetro se omite.

Valores sensibles: para el modelo de combustión : 1600, para el modelo eléctrico : 1900

vehicleWidth
query

number

double

Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.

windingness
query

WindingnessLevel

Nivel de turnos para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=thrilling.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

RouteRangeResult

Aceptar

Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los Microsoft Entra flujos de OAuth 2.0. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

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

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Create una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

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

Sample Request

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

Sample Response

{
  "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
      }
    ]
  }
}

Definiciones

Nombre Description
EffectiveSetting

Parámetro o datos efectivos que se usan al llamar a esta ROUTE API.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=thrilling.

LatLongPair

Una ubicación representada como latitud y longitud.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

RouteAvoidType

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de ruta, no se debe usar el valor alreadyUsedRoads.

RouteRange

Intervalo accesible

RouteRangeResult

Este objeto se devuelve de una llamada de intervalo accesible de ruta correcta.

RouteReport

Informa de la configuración efectiva usada en la llamada actual.

RouteType

Tipo de ruta solicitada.

TravelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Si el objeto travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Ten en cuenta que los modos de viaje bus, motocicleta, taxi y camioneta son la funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

VehicleLoadType

Tipos de carga que pueden clasificarse como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países o regiones. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

WindingnessLevel

Nivel de turnos para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=thrilling.

EffectiveSetting

Parámetro o datos efectivos que se usan al llamar a esta ROUTE API.

Nombre Tipo Description
key

string

Nombre del parámetro usado.

value

string

Valor del parámetro utilizado.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=thrilling.

Nombre Tipo Description
high

string

high

low

string

low

normal

string

normal

LatLongPair

Una ubicación representada como latitud y longitud.

Nombre Tipo Description
latitude

number

Propiedad Latitude

longitude

number

Longitud (propiedad)

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre Tipo Description
json

string

Formato de intercambio de datos de notación de objetos JavaScript

xml

string

Lenguaje de marcado extensible

RouteAvoidType

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de ruta, no se debe usar el valor alreadyUsedRoads.

Nombre Tipo Description
alreadyUsedRoads

string

Evita el uso de la misma carretera varias veces. Lo más útil junto con routeType=emocionante.

borderCrossings

string

Evita los cruces de fronteras en el cálculo de rutas.

carpools

string

Evita las rutas que requieren el uso de calles de carpool (vehículo de alta ocupación) de HOV.

ferries

string

Evita los ferris

motorways

string

Evita las autopistas

tollRoads

string

Evita las carreteras de peaje.

unpavedRoads

string

Evita carreteras sin revisión

RouteRange

Intervalo accesible

Nombre Tipo Description
boundary

LatLongPair[]

Límite de polígono del intervalo accesible representado como una lista de puntos.

center

LatLongPair

Punto central del intervalo accesible

RouteRangeResult

Este objeto se devuelve de una llamada de intervalo accesible de ruta correcta.

Nombre Tipo Description
formatVersion

string

Format Version (propiedad)

reachableRange

RouteRange

Intervalo accesible

report

RouteReport

Informa de la configuración efectiva usada en la llamada actual.

RouteReport

Informa de la configuración efectiva usada en la llamada actual.

Nombre Tipo Description
effectiveSettings

EffectiveSetting[]

Parámetros o datos efectivos que se usan al llamar a esta ROUTE API.

RouteType

Tipo de ruta solicitada.

Nombre Tipo Description
eco

string

Una ruta equilibrada por economía y velocidad.

fastest

string

La ruta más rápida.

shortest

string

La ruta más corta por distancia.

thrilling

string

Incluye carreteras interesantes o desafiantes y utiliza tan pocas autopistas como sea posible. Puede elegir el nivel de giro incluido y también el grado de colina. Consulte los parámetros de pendiente y desvanecencia para saber cómo establecer esto. Hay un límite de 900 km en las rutas planeadas con routeType=emocionante

TravelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Si el objeto travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Ten en cuenta que los modos de viaje bus, motocicleta, taxi y camioneta son la funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

Nombre Tipo Description
bus

string

Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo carriles de autobús. Funcionalidad BETA.

car

string

Las rutas devueltas están optimizadas para automóviles.

motorcycle

string

Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.

taxi

string

Las rutas devueltas están optimizadas para taxis. Funcionalidad BETA.

truck

string

Las rutas devueltas están optimizadas para vehículos comerciales, como para camiones.

van

string

Las rutas devueltas están optimizadas para camionetas. Funcionalidad BETA.

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

Nombre Tipo Description
combustion

string

Motor de combustión interna.

electric

string

Motor eléctrico.

VehicleLoadType

Tipos de carga que pueden clasificarse como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países o regiones. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

Nombre Tipo Description
USHazmatClass1

string

Explosivos

USHazmatClass2

string

Gas comprimido

USHazmatClass3

string

Líquidos inflamables

USHazmatClass4

string

Sólidos inflamables

USHazmatClass5

string

Oxidantes

USHazmatClass6

string

Venenos

USHazmatClass7

string

Material radiactivo

USHazmatClass8

string

Corrosivos

USHazmatClass9

string

Disposiciones adicionales

otherHazmatExplosive

string

Explosivos

otherHazmatGeneral

string

Disposiciones adicionales

otherHazmatHarmfulToWater

string

Perjudicial para el agua

WindingnessLevel

Nivel de turnos para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=thrilling.

Nombre Tipo Description
high

string

high

low

string

low

normal

string

normal