RouteGetRouteDirectionsQueryParamProperties interface

Paquete:

@azure-rest/maps-route

Propiedades

accelerationEfficiency	Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía cinética cuando el vehículo 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 razonables: para modelo de combustión : 0,33, para modelo eléctrico : 0,66
alternativeType	Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.
arriveAt	La fecha y hora de llegada al punto de destino con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino. Ejemplos: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.
auxiliaryPowerInkW	Especifica la cantidad de energía consumida para mantener sistemas auxiliares, en kilowatts (kW). Se puede usar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etcetera. Valores razonables: 1,7
auxiliaryPowerInLitersPerHour	Especifica la cantidad de combustible consumido para mantener sistemas auxiliares del vehículo, en litros por hora. Se puede usar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etcetera. Valores razonables: 0,2
avoid	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.
computeBestOrder	Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir la longitud de la ruta. Produce mejores resultados cuando se usa junto con routeType más corto. Observe que el origen y el destino se excluyen de los índices de punto de referencia optimizados. Para incluir el origen y el destino en la respuesta, aumente todos los índices en 1 para tener en cuenta el origen y agregue el destino como índice final. Los valores posibles son true o false. True calcula un orden mejor si es posible, pero no se permite usar junto con el valor maxAlternatives mayor que 0 o junto con los puntos de referencia de círculo. False usará las ubicaciones en el orden especificado y no podrá usarse junto con routeRepresentation ninguno.
computeTravelTimeFor	Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.
constantSpeedConsumptionInkWhPerHundredkm	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 en caso 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. Del mismo modo, 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 más pequeña. El intervalo válido para los valores de consumo (expresados en kWh/100km) está comprendido entre 0,01 y 100000,0. Valores razonables: 50,8.2:130,21.3 Este parámetro es necesario para modelo de consumo eléctrico.
constantSpeedConsumptionInLitersPerHundredkm	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 en caso 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. Del mismo modo, 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 más pequeña. El intervalo válido para los valores de consumo (expresados en l/100km) está comprendido entre 0,01 y 100000,0. Valores razonables: 50,6.3:130,11.5 Nota : este parámetro es necesario para el modelo de consumo de combustión.
currentChargeInkWh	Especifica el suministro de energía eléctrica actual en horas de kilowatt (kWh). Este parámetro coexiste con parámetro maxChargeInkWh. El intervalo de valores permitidos es de 0,0 a maxChargeInkWh. Valores razonables: 43
currentFuelInLiters	Especifica el suministro actual de combustible en litros. Valores razonables: 55
decelerationEfficiency	Especifica la eficiencia de la conversión de energía cinética a combustible ahorrado (no consumido) cuando el vehículo se decelera (es decir, ChemicalEnergySaved/CinéticaEnergyLost). El ChemicalEnergySaved se obtiene convirtiendo el combustible ahorrado (no consumido) a energía utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con aceleraciónEfficiency. El intervalo de valores permitidos es de 0,0 a 1/aceleraciónEfficiency. Valores razonables: para modelo de combustión : 0,83, para modelo eléctrico : 0,91
departAt	Fecha y hora de salida del punto de origen con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento opcional de zona horaria. 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-19T16:39:57-08:00 No se puede usar el parámetro departAt junto con arriveAt.
downhillEfficiency	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). El ChemicalEnergySaved se obtiene convirtiendo el combustible ahorrado (no consumido) a energía utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con uphillEfficiency. El intervalo de valores permitidos es de 0,0 a 1/uphillEfficiency. Valores razonables: para modelo de combustión : 0,51, para modelo eléctrico : 0,73
fuelEnergyDensityInMJoulesPerLiter	Especifica la cantidad de energía química almacenada en un litros de combustible en megajoules (MJ). Se utiliza junto con los parámetros *Eficiencia para conversiones entre energía guardada o consumida y combustible. Por ejemplo, la densidad de energía es 34,2 MJ/l para gasolina y 35,8 MJ/l para combustible Diesel. Este parámetro es necesario si se establece cualquier parámetro *Efficiency. Valores razonables: 34.2
hilliness	Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.
instructionsType	Si se especifica, se devolverán instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none.
language	El parámetro language determina el idioma de los mensajes de guía. Los nombres adecuados (los nombres de calles, plazas, etcetera.) se devuelven en el idioma especificado, o si no está disponible, se devuelven en un idioma disponible que está cerca de él. Los valores permitidos son (un subconjunto de) las etiquetas de lenguaje IETF. Los idiomas admitidos actualmente se enumeran en la sección idiomas admitidos . Valor predeterminado: en-GB
maxAlternatives	Número de rutas alternativas deseadas que se van a calcular. Valor predeterminado: 0, mínimo: 0 y máximo: 5
maxChargeInkWh	Especifica el suministro máximo de energía eléctrica en kilowatt hours (kWh) que se puede almacenar en la batería del vehículo. Este parámetro coexiste con parámetro currentChargeInkWh. El valor mínimo debe ser mayor o igual que currentChargeInkWh. Valores razonables: 85
minDeviationDistance	Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute para al menos este número de metros. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationDistance no se puede usar junto con arriveAt
minDeviationTime	Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute durante al menos este número de segundos. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationTime no se puede usar junto con arriveAt. El valor predeterminado es 0. Establecer )minDeviationTime_ en un valor mayor que cero tiene las siguientes consecuencias: El punto de origen del calculateRoute Request debe estar en la ruta de referencia de entrada (o muy cerca). Si no es así, se devuelve un error. Sin embargo, el punto de origen no necesita estar al principio de la ruta de referencia de entrada (se puede considerar como la posición actual del vehículo en la ruta de referencia). La ruta de referencia, que se devuelve como la primera ruta de la calculateRoute Response, se iniciará en el punto de origen especificado en el calculateRoute Request. Parte inicial de la ruta de referencia de entrada hasta que el punto de origen se excluirá de la respuesta. Los valores de minDeviationDistance y minDeviationTime determinar hasta dónde se garantizarán las rutas alternativas para seguir la ruta de referencia desde el punto de origen en adelante. La ruta debe usar departAt. Se omite el de vehicleHeading.
query	Coordenadas a través de las que se calcula la ruta, delimitada por dos puntos. Se requiere un mínimo de dos coordenadas. La primera es el origen y la última es el destino de la ruta. Las coordenadas opcionales entre actúan como WayPoints en la ruta. Puede pasar hasta 150 WayPoints.
report	Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.
routeRepresentation	Especifica la representación del conjunto de rutas proporcionadas como respuesta.
routeType	Tipo de ruta solicitada.
sectionType	Especifica cuál de los tipos de sección se notifica en la respuesta de ruta. Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche
traffic	Valores posibles: true: considere toda la información de tráfico disponible durante el enrutamiento. false: omite 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 todavía se incorpora.
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. 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 van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.
uphillEfficiency	Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía potencial cuando el vehículo obtiene la 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 razonables: para modelo de combustión : 0,27 para modelo eléctrico : 0,74
vehicleAxleWeight	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	Si el vehículo se utiliza para fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.
vehicleEngineType	Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.
vehicleHeading	El encabezado direccional del vehículo en grados comenzando en el verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados. Valores posibles entre 0 y 359
vehicleHeight	Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
vehicleLength	Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.
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	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 el planeamiento 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 considerará 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	Peso del vehículo en kilogramos. Es obligatorio si se establece cualquiera de los parámetros *Efficiency. Debe ser estrictamente positivo cuando se usa en el contexto del modelo de consumo. Se consideran restricciones de peso. Si no se especifica ningún modelo de consumo detallado y el valor de vehicleWeight es distinto de cero, se tienen en cuenta las restricciones de peso. En todos los demás casos, este parámetro se omite. Valores razonables: para modelo de combustión : 1600, para modelo eléctrico : 1900
vehicleWidth	Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.
windingness	Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

Detalles de las propiedades

accelerationEfficiency

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía cinética cuando el vehículo 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 razonables: para modelo de combustión : 0,33, para modelo eléctrico : 0,66

accelerationEfficiency?: number

Valor de propiedad

number

alternativeType

Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.

alternativeType?: "anyRoute" | "betterRoute"

Valor de propiedad

"anyRoute" | "betterRoute"

arriveAt

La fecha y hora de llegada al punto de destino con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino.

Ejemplos:

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

El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.

arriveAt?: string | Date

Valor de propiedad

string | Date

auxiliaryPowerInkW

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

Se puede usar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etcetera.

Valores razonables: 1,7

auxiliaryPowerInkW?: number

Valor de propiedad

number

auxiliaryPowerInLitersPerHour

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

Se puede usar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etcetera.

Valores razonables: 0,2

auxiliaryPowerInLitersPerHour?: number

Valor de propiedad

number

avoid

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.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Valor de propiedad

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeBestOrder

Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir la longitud de la ruta. Produce mejores resultados cuando se usa junto con routeType más corto. Observe que el origen y el destino se excluyen de los índices de punto de referencia optimizados. Para incluir el origen y el destino en la respuesta, aumente todos los índices en 1 para tener en cuenta el origen y agregue el destino como índice final. Los valores posibles son true o false. True calcula un orden mejor si es posible, pero no se permite usar junto con el valor maxAlternatives mayor que 0 o junto con los puntos de referencia de círculo. False usará las ubicaciones en el orden especificado y no podrá usarse junto con routeRepresentation ninguno.

computeBestOrder?: boolean

Valor de propiedad

boolean

computeTravelTimeFor

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.

computeTravelTimeFor?: "none" | "all"

Valor de propiedad

"none" | "all"

constantSpeedConsumptionInkWhPerHundredkm

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

Del mismo modo, 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 más pequeña.

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

Valores razonables: 50,8.2:130,21.3

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

constantSpeedConsumptionInkWhPerHundredkm?: string

Valor de propiedad

string

constantSpeedConsumptionInLitersPerHundredkm

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

Del mismo modo, 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 más pequeña.

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

Valores razonables: 50,6.3:130,11.5

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

constantSpeedConsumptionInLitersPerHundredkm?: string

Valor de propiedad

string

currentChargeInkWh

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

Este parámetro coexiste con parámetro maxChargeInkWh.

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

Valores razonables: 43

currentChargeInkWh?: number

Valor de propiedad

number

currentFuelInLiters

Especifica el suministro actual de combustible en litros.

Valores razonables: 55

currentFuelInLiters?: number

Valor de propiedad

number

decelerationEfficiency

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

Debe emparejarse con aceleraciónEfficiency.

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

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

decelerationEfficiency?: number

Valor de propiedad

number

departAt

Fecha y hora de salida del punto de origen con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento opcional de zona horaria. 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-19T16:39:57-08:00

No se puede usar el parámetro departAt junto con arriveAt.

departAt?: string | Date

Valor de propiedad

string | Date

downhillEfficiency

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). El ChemicalEnergySaved se obtiene convirtiendo el combustible ahorrado (no consumido) a energía utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con uphillEfficiency.

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

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

downhillEfficiency?: number

Valor de propiedad

number

fuelEnergyDensityInMJoulesPerLiter

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

Este parámetro es necesario si se establece cualquier parámetro *Efficiency.

Valores razonables: 34.2

fuelEnergyDensityInMJoulesPerLiter?: number

Valor de propiedad

number

hilliness

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

hilliness?: "low" | "normal" | "high"

Valor de propiedad

"low" | "normal" | "high"

instructionsType

Si se especifica, se devolverán instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none.

instructionsType?: "coded" | "text" | "tagged"

Valor de propiedad

"coded" | "text" | "tagged"

language

El parámetro language determina el idioma de los mensajes de guía. Los nombres adecuados (los nombres de calles, plazas, etcetera.) se devuelven en el idioma especificado, o si no está disponible, se devuelven en un idioma disponible que está cerca de él. Los valores permitidos son (un subconjunto de) las etiquetas de lenguaje IETF. Los idiomas admitidos actualmente se enumeran en la sección idiomas admitidos .

Valor predeterminado: en-GB

language?: string

Valor de propiedad

string

maxAlternatives

Número de rutas alternativas deseadas que se van a calcular. Valor predeterminado: 0, mínimo: 0 y máximo: 5

maxAlternatives?: number

Valor de propiedad

number

maxChargeInkWh

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

Este parámetro coexiste con parámetro currentChargeInkWh.

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

Valores razonables: 85

maxChargeInkWh?: number

Valor de propiedad

number

minDeviationDistance

Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute para al menos este número de metros. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationDistance no se puede usar junto con arriveAt

minDeviationDistance?: number

Valor de propiedad

number

minDeviationTime

Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute durante al menos este número de segundos. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationTime no se puede usar junto con arriveAt. El valor predeterminado es 0. Establecer )minDeviationTime_ en un valor mayor que cero tiene las siguientes consecuencias:

• El punto de origen del calculateRoute Request debe estar en la ruta de referencia de entrada (o muy cerca).
  • Si no es así, se devuelve un error.
  • Sin embargo, el punto de origen no necesita estar al principio de la ruta de referencia de entrada (se puede considerar como la posición actual del vehículo en la ruta de referencia).
• La ruta de referencia, que se devuelve como la primera ruta de la calculateRoute Response, se iniciará en el punto de origen especificado en el calculateRoute Request. Parte inicial de la ruta de referencia de entrada hasta que el punto de origen se excluirá de la respuesta.
• Los valores de minDeviationDistance y minDeviationTime determinar hasta dónde se garantizarán las rutas alternativas para seguir la ruta de referencia desde el punto de origen en adelante.
• La ruta debe usar departAt.
• Se omite el de vehicleHeading.

minDeviationTime?: number

Valor de propiedad

number

query

Coordenadas a través de las que se calcula la ruta, delimitada por dos puntos. Se requiere un mínimo de dos coordenadas. La primera es el origen y la última es el destino de la ruta. Las coordenadas opcionales entre actúan como WayPoints en la ruta. Puede pasar hasta 150 WayPoints.

query: string

Valor de propiedad

string

report

Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.

report?: "effectiveSettings"

Valor de propiedad

"effectiveSettings"

routeRepresentation

Especifica la representación del conjunto de rutas proporcionadas como respuesta.

routeRepresentation?: "polyline" | "summaryOnly" | "none"

Valor de propiedad

"polyline" | "summaryOnly" | "none"

routeType

Tipo de ruta solicitada.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Valor de propiedad

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Valor de propiedad

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

Valores posibles:

• true: considere toda la información de tráfico disponible durante el enrutamiento.
• false: omite 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 todavía se incorpora.

traffic?: boolean

Valor de propiedad

boolean

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. 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 van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Valor de propiedad

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

uphillEfficiency

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía potencial cuando el vehículo obtiene la 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 razonables: para modelo de combustión : 0,27 para modelo eléctrico : 0,74

uphillEfficiency?: number

Valor de propiedad

number

vehicleAxleWeight

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.

vehicleAxleWeight?: number

Valor de propiedad

number

vehicleCommercial

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

vehicleCommercial?: boolean

Valor de propiedad

boolean

vehicleEngineType

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

vehicleEngineType?: "combustion" | "electric"

Valor de propiedad

"combustion" | "electric"

vehicleHeading

El encabezado direccional del vehículo en grados comenzando en el verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados. Valores posibles entre 0 y 359

vehicleHeading?: number

Valor de propiedad

number

vehicleHeight

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

vehicleHeight?: number

Valor de propiedad

number

vehicleLength

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

vehicleLength?: number

Valor de propiedad

number

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.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Valor de propiedad

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

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 el planeamiento 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 considerará 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.

vehicleMaxSpeed?: number

Valor de propiedad

number

vehicleWeight

Peso del vehículo en kilogramos.

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

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

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

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

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

vehicleWeight?: number

Valor de propiedad

number

vehicleWidth

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

vehicleWidth?: number

Valor de propiedad

number

windingness

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

windingness?: "low" | "normal" | "high"

Valor de propiedad

"low" | "normal" | "high"