RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties interface

Paquet:

@azure-rest/maps-route

Propriétés

accelerationEfficiency	Spécifie l’efficacité de la conversion de l’énergie chimique stockée dans le carburant en énergie cinétique lorsque le véhicule accélère (c’est-à-dire, c’est-à-dire, l’énergie cinétique Gagnée/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuelEnergyDensityInMJoulesPerLiter. Doit être associé à decelerationEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/décélérationEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,33, pour le modèle électrique : 0,66
alternativeType	Contrôle l’optimalité, par rapport aux critères de planification donnés, des alternatives calculées par rapport à l’itinéraire de référence.
arriveAt	Date et heure d’arrivée au point de destination. Il doit être spécifié en tant que dateTime. Quand aucun décalage de fuseau horaire n’est spécifié, il est supposé être celui du point de destination. La valeur arriveAt doit être dans le futur. Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt, minDeviationDistance ou minDeviationTime.
auxiliaryPowerInkW	Spécifie la quantité d’énergie consommée pour le maintien des systèmes auxiliaires, en kilowatts (kW). Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc. Valeurs sensibles : 1.7
auxiliaryPowerInLitersPerHour	Spécifie la quantité de carburant consommée pour le maintien des systèmes auxiliaires du véhicule, en litres par heure. Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc. Valeurs sensibles : 0,2
avoid	Spécifie quelque chose que le calcul de l’itinéraire doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une même demande, par exemple , '&avoid=highways&avoid=tollRoads&avoid=ferries'. Dans les requêtes calculateReachableRange, la valeur alreadyUsedRoads ne doit pas être utilisée.
computeBestOrder	Récommandez les points de routage à l’aide d’un algorithme heuristique rapide pour réduire la longueur de l’itinéraire. Obtient de meilleurs résultats lorsqu’il est utilisé conjointement avec routeType le plus court. Notez que l’origine et la destination sont exclues des index de point de route optimisés. Pour inclure l’origine et la destination dans la réponse, augmentez tous les index de 1 pour tenir compte de l’origine, puis ajoutez la destination comme index final. Les valeurs possibles sont true ou false. True calcule un meilleur ordre si possible, mais n’est pas autorisé à être utilisé conjointement avec la valeur maxAlternatives supérieure à 0 ou conjointement avec des points de chemin de cercle. False utilise les emplacements dans l’ordre donné et n’est pas autorisé à être utilisé conjointement avec routeRepresentation none.
computeTravelTimeFor	Spécifie s’il faut retourner des temps de trajet supplémentaires à l’aide de différents types d’informations sur la circulation (aucun, historique, temps réel) ainsi que de la meilleure estimation par défaut du temps de trajet.
constantSpeedConsumptionInkWhPerHundredkm	Spécifie le composant dépendant de la vitesse de consommation. Fourni sous la forme d’une liste non triée de paires vitesse/débit de consommation. La liste définit des points sur une courbe de consommation. Les taux de consommation pour les vitesses qui ne figurent pas dans la liste sont les suivants : par interpolation linéaire, si la vitesse donnée se situe entre deux vitesses dans la liste par extrapolation linéaire dans le cas contraire, en supposant une constante (ΔConsumption/ΔSpeed) déterminée par les deux points les plus proches de la liste La liste doit contenir entre 1 et 25 points (inclus) et ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire. La consommation spécifiée pour la vitesse la plus élevée doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs. De même, les valeurs de consommation spécifiées pour les deux vitesses les plus petites de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse plus petite. La plage valide pour les valeurs de consommation (exprimées en kWh/100km) est comprise entre 0,01 et 100000,0. Valeurs sensibles : 50,8.2 :130,21.3 Ce paramètre est requis pour le modèle de consommation électrique.
constantSpeedConsumptionInLitersPerHundredkm	Spécifie le composant dépendant de la vitesse de consommation. Fourni sous la forme d’une liste non triée de vitesses délimitées par des deux-points & paires de taux de consommation. La liste définit des points sur une courbe de consommation. Les taux de consommation pour les vitesses qui ne figurent pas dans la liste sont les suivants : par interpolation linéaire, si la vitesse donnée se situe entre deux vitesses dans la liste par extrapolation linéaire dans le cas contraire, en supposant une constante (ΔConsumption/ΔSpeed) déterminée par les deux points les plus proches de la liste La liste doit contenir entre 1 et 25 points (inclus) et ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire. La consommation spécifiée pour la vitesse la plus élevée doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs. De même, les valeurs de consommation spécifiées pour les deux vitesses les plus petites de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse plus petite. La plage valide pour les valeurs de consommation (exprimées en l/100km) est comprise entre 0,01 et 100000,0. Valeurs sensibles : 50,6.3 :130,11.5 Remarque : Ce paramètre est requis pour le modèle de consommation de combustion.
currentChargeInkWh	Spécifie l’alimentation électrique actuelle en kilowattheures (kWh). Ce paramètre coexiste avec le paramètre maxChargeInkWh . La plage de valeurs autorisées est comprise entre 0,0 et maxChargeInkWh. Valeurs sensibles : 43
currentFuelInLiters	Spécifie l’approvisionnement actuel en carburant en litres. Valeurs sensibles : 55
decelerationEfficiency	Spécifie l’efficacité de la conversion de l’énergie cinétique en carburant économisé (non consommé) lorsque le véhicule décélère (c.-à-d. ChemicalEnergySaved/Cinétique EnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuelEnergyDensityInMJoulesPerLiter. Doit être associé à accelerationEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/accelerationEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,83, pour le modèle électrique : 0,91
departAt	Date et heure de départ du point d’origine. Les heures de départ en dehors de maintenant doivent être spécifiées en tant que dateTime. Lorsqu’aucun décalage de fuseau horaire n’est spécifié, il est supposé être celui du point d’origine. La valeur departAt doit être ultérieurement au format date-heure (1996-12-19T16 :39 :57-08 :00).
downhillEfficiency	Spécifie l’efficacité de la conversion de l’énergie potentielle en carburant économisé (non consommé) lorsque le véhicule perd de l’altitude (par exemple, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuelEnergyDensityInMJoulesPerLiter. Doit être associé à uphillEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/uphillEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,51, pour le modèle électrique : 0,73
fuelEnergyDensityInMJoulesPerLiter	Spécifie la quantité d’énergie chimique stockée dans un litre de carburant en mégajoules (MJ). Il est utilisé conjointement avec les paramètres *Efficacité pour les conversions entre l’énergie économisée ou consommée et le carburant. Par exemple, la densité énergétique est de 34,2 MJ/l pour l’essence et de 35,8 MJ/l pour le carburant diesel. Ce paramètre est obligatoire si un paramètre *Efficiency est défini. Valeurs sensibles : 34.2
hilliness	Degré de colline pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec routeType=thrilling.
instructionsType	Si elle est spécifiée, des instructions d’aide sont retournées. Notez que le paramètre instructionsType ne peut pas être utilisé conjointement avec routeRepresentation=none
language	Le paramètre language détermine la langue des messages d’aide. Elle n’affecte pas les noms propres (noms de rues, places, etc.) Elle n’a aucun effet lorsque instructionsType=coded. Les valeurs autorisées sont (un sous-ensemble de) les balises de langage IETF décrites
maxAlternatives	Nombre d’itinéraires alternatifs souhaités à calculer. Valeur par défaut : 0, minimum : 0 et maximum : 5
maxChargeInkWh	Spécifie l’alimentation électrique maximale en kilowattheures (kWh) qui peut être stockée dans la batterie du véhicule. Ce paramètre coexiste avec le paramètre currentChargeInkWh . La valeur minimale doit être supérieure ou égale à currentChargeInkWh. Valeurs sensibles : 85
minDeviationDistance	Toutes les autres routes retournées suivent l’itinéraire de référence (voir la section Requêtes POST) à partir du point d’origine de la requête calculateRoute pour au moins ce nombre de mètres. Ne peut être utilisé que lors de la reconstruction d’un itinéraire. Le paramètre minDeviationDistance ne peut pas être utilisé conjointement avec arriveAt
minDeviationTime	Toutes les autres routes retournées suivent l’itinéraire de référence (voir la section Requêtes POST) à partir du point d’origine de la requête calculateRoute pendant au moins ce nombre de secondes. Ne peut être utilisé que lors de la reconstruction d’un itinéraire. Le paramètre minDeviationTime ne peut pas être utilisé conjointement avec arriveAt. La valeur par défaut est 0. La définition de )minDeviationTime_ sur une valeur supérieure à zéro a les conséquences suivantes : Le point d’origine de la requête calculateRoute doit se trouver sur (ou très près) de l’itinéraire de référence d’entrée. Si ce n’est pas le cas, une erreur est retournée. Toutefois, le point d’origine n’a pas besoin d’être au début de l’itinéraire de référence d’entrée (il peut être considéré comme la position actuelle du véhicule sur l’itinéraire de référence). L’itinéraire de référence, retourné en tant que premier itinéraire dans la réponse calculateRoute , démarre au point d’origine spécifié dans la requête calculateRoute . La partie initiale de l’itinéraire de référence d’entrée jusqu’à ce que le point d’origine soit exclu de la réponse. Les valeurs de minDeviationDistance et minDeviationTime déterminent dans quelle mesure d’autres itinéraires seront garantis pour suivre l’itinéraire de référence à partir du point d’origine. L’itinéraire doit utiliser departAt. La propriété vehicleHeading est ignorée.
query	Coordonnées par lesquelles l’itinéraire est calculé, délimités par un signe deux-points. Au moins deux coordonnées sont requises. Le premier est l’origine et le dernier est la destination de l’itinéraire. Les coordonnées facultatives entre les deux agissent en tant que WayPoints dans l’itinéraire. Vous pouvez passer jusqu’à 150 WayPoints.
report	Spécifie les données à signaler à des fins de diagnostic. La seule valeur possible est effectiveSettings. Signale les paramètres ou données effectifs utilisés lors de l’appel de l’API. Dans le cas des paramètres par défaut, la valeur par défaut est reflétée lorsque le paramètre n’a pas été spécifié par l’appelant.
routeRepresentation	Spécifie la représentation de l’ensemble d’itinéraires fourni en tant que réponse. Cette valeur de paramètre ne peut être utilisée qu’avec computeBestOrder=true.
routeType	Type d’itinéraire demandé.
sectionType	Spécifie les types de section signalés dans la réponse d’itinéraire. Par exemple, si sectionType = piéton, les sections qui conviennent uniquement aux piétons sont retournées. Plusieurs types peuvent être utilisés. Le sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur car
traffic	Valeurs possibles : true : tenez compte de toutes les informations de trafic disponibles pendant le routage false : ignorer les données de trafic actuelles pendant le routage. Notez que bien que les données de trafic actuelles soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de circulation effectives est toujours incorporé.
travelMode	Mode de déplacement pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’ensemble de l’itinéraire. Si le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse pour cette section sera « other ». Notez que les modes de voyage bus, moto, taxi et fourgonnette sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones. Dans les requêtes calculateReachableRange , les valeurs vélo et piéton ne doivent pas être utilisées.
uphillEfficiency	Spécifie l’efficacité de la conversion de l’énergie chimique stockée dans le carburant en énergie potentielle lorsque le véhicule gagne en altitude (c.-à-d. PotentialEnergy Gagné/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuelEnergyDensityInMJoulesPerLiter. Doit être associé à downhillEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/downhillEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,27, pour le modèle électrique : 0,74
vehicleAxleWeight	Poids par essieu du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.
vehicleCommercial	Si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à circuler sur certaines routes.
vehicleEngineType	Type de moteur du véhicule. Lorsqu’un modèle de consommation détaillé est spécifié, il doit être cohérent avec la valeur de vehicleEngineType.
vehicleHeading	Direction du véhicule en degrés commençant au vrai nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degré, l’est à 90 degrés, le sud à 180 degrés, l’ouest à 270 degrés. Valeurs possibles 0-359
vehicleHeight	Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte.
vehicleLength	Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte.
vehicleLoadType	Types de marchandises qui peuvent être classées comme des matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes US Hazmat 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.
vehicleMaxSpeed	Vitesse maximale du véhicule en km/heure. La vitesse maximale dans le profil du véhicule est utilisée pour case activée si un véhicule est autorisé sur les autoroutes. La valeur 0 signifie qu’une valeur appropriée pour le véhicule sera déterminée et appliquée lors de la planification de l’itinéraire. Une valeur autre que zéro peut être remplacée pendant la planification de l’itinéraire. Par exemple, le flux de trafic actuel est de 60 km/heure. Si la vitesse maximale du véhicule est définie sur 50 km/heure, le moteur de routage considérera 60 km/heure, car c’est la situation actuelle. Si la vitesse maximale du véhicule est de 80 km/heure, mais que la circulation actuelle est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.
vehicleWeight	Poids du véhicule en kilogrammes. Il est obligatoire si l’un des paramètres *Efficacité est défini. Il doit être strictement positif lorsqu’il est utilisé dans le contexte du modèle de consommation. Les restrictions de poids sont prises en compte. Si aucun modèle de consommation détaillé n’est spécifié et que la valeur de vehicleWeight est différente de zéro, les restrictions de poids sont prises en compte. Dans tous les autres cas, ce paramètre est ignoré. Valeurs sensibles : pour le modèle de combustion : 1600, pour le modèle électrique : 1900
vehicleWidth	Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte.
windingness	Niveau de virages pour un itinéraire palpitant. Ce paramètre peut uniquement être utilisé conjointement avec routeType=thrilling.

Détails de la propriété

accelerationEfficiency

Spécifie l’efficacité de la conversion de l’énergie chimique stockée dans le carburant en énergie cinétique lorsque le véhicule accélère (c’est-à-dire, c’est-à-dire, l’énergie cinétique Gagnée/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuelEnergyDensityInMJoulesPerLiter.

Doit être associé à decelerationEfficiency.

La plage de valeurs autorisées est comprise entre 0,0 et 1/décélérationEfficiency.

Valeurs sensibles : pour le modèle de combustion : 0,33, pour le modèle électrique : 0,66

accelerationEfficiency?: number

Valeur de propriété

number

alternativeType

Contrôle l’optimalité, par rapport aux critères de planification donnés, des alternatives calculées par rapport à l’itinéraire de référence.

alternativeType?: "anyRoute" | "betterRoute"

Valeur de propriété

"anyRoute" | "betterRoute"

arriveAt

Date et heure d’arrivée au point de destination. Il doit être spécifié en tant que dateTime. Quand aucun décalage de fuseau horaire n’est spécifié, il est supposé être celui du point de destination. La valeur arriveAt doit être dans le futur. Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt, minDeviationDistance ou minDeviationTime.

arriveAt?: string | Date

Valeur de propriété

string | Date

auxiliaryPowerInkW

Spécifie la quantité d’énergie consommée pour le maintien des systèmes auxiliaires, en kilowatts (kW).

Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc.

Valeurs sensibles : 1.7

auxiliaryPowerInkW?: number

Valeur de propriété

number

auxiliaryPowerInLitersPerHour

Spécifie la quantité de carburant consommée pour le maintien des systèmes auxiliaires du véhicule, en litres par heure.

Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc.

Valeurs sensibles : 0,2

auxiliaryPowerInLitersPerHour?: number

Valeur de propriété

number

avoid

Spécifie quelque chose que le calcul de l’itinéraire doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une même demande, par exemple , '&avoid=highways&avoid=tollRoads&avoid=ferries'. Dans les requêtes calculateReachableRange, la valeur alreadyUsedRoads ne doit pas être utilisée.

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

Valeur de propriété

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

computeBestOrder

Récommandez les points de routage à l’aide d’un algorithme heuristique rapide pour réduire la longueur de l’itinéraire. Obtient de meilleurs résultats lorsqu’il est utilisé conjointement avec routeType le plus court. Notez que l’origine et la destination sont exclues des index de point de route optimisés. Pour inclure l’origine et la destination dans la réponse, augmentez tous les index de 1 pour tenir compte de l’origine, puis ajoutez la destination comme index final. Les valeurs possibles sont true ou false. True calcule un meilleur ordre si possible, mais n’est pas autorisé à être utilisé conjointement avec la valeur maxAlternatives supérieure à 0 ou conjointement avec des points de chemin de cercle. False utilise les emplacements dans l’ordre donné et n’est pas autorisé à être utilisé conjointement avec routeRepresentation none.

computeBestOrder?: boolean

Valeur de propriété

boolean

computeTravelTimeFor

Spécifie s’il faut retourner des temps de trajet supplémentaires à l’aide de différents types d’informations sur la circulation (aucun, historique, temps réel) ainsi que de la meilleure estimation par défaut du temps de trajet.

computeTravelTimeFor?: "none" | "all"

Valeur de propriété

"none" | "all"

constantSpeedConsumptionInkWhPerHundredkm

Spécifie le composant dépendant de la vitesse de consommation.

Fourni sous la forme d’une liste non triée de paires vitesse/débit de consommation. La liste définit des points sur une courbe de consommation. Les taux de consommation pour les vitesses qui ne figurent pas dans la liste sont les suivants :

• par interpolation linéaire, si la vitesse donnée se situe entre deux vitesses dans la liste

• par extrapolation linéaire dans le cas contraire, en supposant une constante (ΔConsumption/ΔSpeed) déterminée par les deux points les plus proches de la liste

La liste doit contenir entre 1 et 25 points (inclus) et ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire.

La consommation spécifiée pour la vitesse la plus élevée doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs.

De même, les valeurs de consommation spécifiées pour les deux vitesses les plus petites de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse plus petite.

La plage valide pour les valeurs de consommation (exprimées en kWh/100km) est comprise entre 0,01 et 100000,0.

Valeurs sensibles : 50,8.2 :130,21.3

Ce paramètre est requis pour le modèle de consommation électrique.

constantSpeedConsumptionInkWhPerHundredkm?: string

Valeur de propriété

string

constantSpeedConsumptionInLitersPerHundredkm

Spécifie le composant dépendant de la vitesse de consommation.

Fourni sous la forme d’une liste non triée de vitesses délimitées par des deux-points & paires de taux de consommation. La liste définit des points sur une courbe de consommation. Les taux de consommation pour les vitesses qui ne figurent pas dans la liste sont les suivants :

• par interpolation linéaire, si la vitesse donnée se situe entre deux vitesses dans la liste

• par extrapolation linéaire dans le cas contraire, en supposant une constante (ΔConsumption/ΔSpeed) déterminée par les deux points les plus proches de la liste

La liste doit contenir entre 1 et 25 points (inclus) et ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire.

La consommation spécifiée pour la vitesse la plus élevée doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs.

De même, les valeurs de consommation spécifiées pour les deux vitesses les plus petites de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse plus petite.

La plage valide pour les valeurs de consommation (exprimées en l/100km) est comprise entre 0,01 et 100000,0.

Valeurs sensibles : 50,6.3 :130,11.5

Remarque : Ce paramètre est requis pour le modèle de consommation de combustion.

constantSpeedConsumptionInLitersPerHundredkm?: string

Valeur de propriété

string

currentChargeInkWh

Spécifie l’alimentation électrique actuelle en kilowattheures (kWh).

Ce paramètre coexiste avec le paramètre maxChargeInkWh .

La plage de valeurs autorisées est comprise entre 0,0 et maxChargeInkWh.

Valeurs sensibles : 43

currentChargeInkWh?: number

Valeur de propriété

number

currentFuelInLiters

Spécifie l’approvisionnement actuel en carburant en litres.

Valeurs sensibles : 55

currentFuelInLiters?: number

Valeur de propriété

number

decelerationEfficiency

Spécifie l’efficacité de la conversion de l’énergie cinétique en carburant économisé (non consommé) lorsque le véhicule décélère (c.-à-d. ChemicalEnergySaved/Cinétique EnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuelEnergyDensityInMJoulesPerLiter.

Doit être associé à accelerationEfficiency.

La plage de valeurs autorisées est comprise entre 0,0 et 1/accelerationEfficiency.

Valeurs sensibles : pour le modèle de combustion : 0,83, pour le modèle électrique : 0,91

decelerationEfficiency?: number

Valeur de propriété

number

departAt

Date et heure de départ du point d’origine. Les heures de départ en dehors de maintenant doivent être spécifiées en tant que dateTime. Lorsqu’aucun décalage de fuseau horaire n’est spécifié, il est supposé être celui du point d’origine. La valeur departAt doit être ultérieurement au format date-heure (1996-12-19T16 :39 :57-08 :00).

departAt?: string | Date

Valeur de propriété

string | Date

downhillEfficiency

Spécifie l’efficacité de la conversion de l’énergie potentielle en carburant économisé (non consommé) lorsque le véhicule perd de l’altitude (par exemple, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuelEnergyDensityInMJoulesPerLiter.

Doit être associé à uphillEfficiency.

La plage de valeurs autorisées est comprise entre 0,0 et 1/uphillEfficiency.

Valeurs sensibles : pour le modèle de combustion : 0,51, pour le modèle électrique : 0,73

downhillEfficiency?: number

Valeur de propriété

number

fuelEnergyDensityInMJoulesPerLiter

Spécifie la quantité d’énergie chimique stockée dans un litre de carburant en mégajoules (MJ). Il est utilisé conjointement avec les paramètres *Efficacité pour les conversions entre l’énergie économisée ou consommée et le carburant. Par exemple, la densité énergétique est de 34,2 MJ/l pour l’essence et de 35,8 MJ/l pour le carburant diesel.

Ce paramètre est obligatoire si un paramètre *Efficiency est défini.

Valeurs sensibles : 34.2

fuelEnergyDensityInMJoulesPerLiter?: number

Valeur de propriété

number

hilliness

Degré de colline pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec routeType=thrilling.

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

Valeur de propriété

"low" | "normal" | "high"

instructionsType

Si elle est spécifiée, des instructions d’aide sont retournées. Notez que le paramètre instructionsType ne peut pas être utilisé conjointement avec routeRepresentation=none

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

Valeur de propriété

"coded" | "text" | "tagged"

language

Le paramètre language détermine la langue des messages d’aide. Elle n’affecte pas les noms propres (noms de rues, places, etc.) Elle n’a aucun effet lorsque instructionsType=coded. Les valeurs autorisées sont (un sous-ensemble de) les balises de langage IETF décrites

language?: string

Valeur de propriété

string

maxAlternatives

Nombre d’itinéraires alternatifs souhaités à calculer. Valeur par défaut : 0, minimum : 0 et maximum : 5

maxAlternatives?: number

Valeur de propriété

number

maxChargeInkWh

Spécifie l’alimentation électrique maximale en kilowattheures (kWh) qui peut être stockée dans la batterie du véhicule.

Ce paramètre coexiste avec le paramètre currentChargeInkWh .

La valeur minimale doit être supérieure ou égale à currentChargeInkWh.

Valeurs sensibles : 85

maxChargeInkWh?: number

Valeur de propriété

number

minDeviationDistance

Toutes les autres routes retournées suivent l’itinéraire de référence (voir la section Requêtes POST) à partir du point d’origine de la requête calculateRoute pour au moins ce nombre de mètres. Ne peut être utilisé que lors de la reconstruction d’un itinéraire. Le paramètre minDeviationDistance ne peut pas être utilisé conjointement avec arriveAt

minDeviationDistance?: number

Valeur de propriété

number

minDeviationTime

Toutes les autres routes retournées suivent l’itinéraire de référence (voir la section Requêtes POST) à partir du point d’origine de la requête calculateRoute pendant au moins ce nombre de secondes. Ne peut être utilisé que lors de la reconstruction d’un itinéraire. Le paramètre minDeviationTime ne peut pas être utilisé conjointement avec arriveAt. La valeur par défaut est 0. La définition de )minDeviationTime_ sur une valeur supérieure à zéro a les conséquences suivantes :

• Le point d’origine de la requête calculateRoute doit se trouver sur (ou très près) de l’itinéraire de référence d’entrée.
  • Si ce n’est pas le cas, une erreur est retournée.
  • Toutefois, le point d’origine n’a pas besoin d’être au début de l’itinéraire de référence d’entrée (il peut être considéré comme la position actuelle du véhicule sur l’itinéraire de référence).
• L’itinéraire de référence, retourné en tant que premier itinéraire dans la réponse calculateRoute , démarre au point d’origine spécifié dans la requête calculateRoute . La partie initiale de l’itinéraire de référence d’entrée jusqu’à ce que le point d’origine soit exclu de la réponse.
• Les valeurs de minDeviationDistance et minDeviationTime déterminent dans quelle mesure d’autres itinéraires seront garantis pour suivre l’itinéraire de référence à partir du point d’origine.
• L’itinéraire doit utiliser departAt.
• La propriété vehicleHeading est ignorée.

minDeviationTime?: number

Valeur de propriété

number

query

Coordonnées par lesquelles l’itinéraire est calculé, délimités par un signe deux-points. Au moins deux coordonnées sont requises. Le premier est l’origine et le dernier est la destination de l’itinéraire. Les coordonnées facultatives entre les deux agissent en tant que WayPoints dans l’itinéraire. Vous pouvez passer jusqu’à 150 WayPoints.

query: string

Valeur de propriété

string

report

Spécifie les données à signaler à des fins de diagnostic. La seule valeur possible est effectiveSettings. Signale les paramètres ou données effectifs utilisés lors de l’appel de l’API. Dans le cas des paramètres par défaut, la valeur par défaut est reflétée lorsque le paramètre n’a pas été spécifié par l’appelant.

report?: "effectiveSettings"

Valeur de propriété

"effectiveSettings"

routeRepresentation

Spécifie la représentation de l’ensemble d’itinéraires fourni en tant que réponse. Cette valeur de paramètre ne peut être utilisée qu’avec computeBestOrder=true.

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

Valeur de propriété

"polyline" | "summaryOnly" | "none"

routeType

Type d’itinéraire demandé.

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

Valeur de propriété

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

sectionType

Spécifie les types de section signalés dans la réponse d’itinéraire.

Par exemple, si sectionType = piéton, les sections qui conviennent uniquement aux piétons sont retournées. Plusieurs types peuvent être utilisés. Le sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur car

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

Valeur de propriété

"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"

traffic

Valeurs possibles :

• true : tenez compte de toutes les informations de trafic disponibles pendant le routage
• false : ignorer les données de trafic actuelles pendant le routage. Notez que bien que les données de trafic actuelles soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de circulation effectives est toujours incorporé.

traffic?: boolean

Valeur de propriété

boolean

travelMode

Mode de déplacement pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’ensemble de l’itinéraire. Si le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse pour cette section sera « other ». Notez que les modes de voyage bus, moto, taxi et fourgonnette sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones. Dans les requêtes calculateReachableRange , les valeurs vélo et piéton ne doivent pas être utilisées.

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

Valeur de propriété

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

uphillEfficiency

Spécifie l’efficacité de la conversion de l’énergie chimique stockée dans le carburant en énergie potentielle lorsque le véhicule gagne en altitude (c.-à-d. PotentialEnergy Gagné/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuelEnergyDensityInMJoulesPerLiter.

Doit être associé à downhillEfficiency.

La plage de valeurs autorisées est comprise entre 0,0 et 1/downhillEfficiency.

Valeurs sensibles : pour le modèle de combustion : 0,27, pour le modèle électrique : 0,74

uphillEfficiency?: number

Valeur de propriété

number

vehicleAxleWeight

Poids par essieu du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.

vehicleAxleWeight?: number

Valeur de propriété

number

vehicleCommercial

Si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à circuler sur certaines routes.

vehicleCommercial?: boolean

Valeur de propriété

boolean

vehicleEngineType

Type de moteur du véhicule. Lorsqu’un modèle de consommation détaillé est spécifié, il doit être cohérent avec la valeur de vehicleEngineType.

vehicleEngineType?: "combustion" | "electric"

Valeur de propriété

"combustion" | "electric"

vehicleHeading

Direction du véhicule en degrés commençant au vrai nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degré, l’est à 90 degrés, le sud à 180 degrés, l’ouest à 270 degrés. Valeurs possibles 0-359

vehicleHeading?: number

Valeur de propriété

number

vehicleHeight

Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte.

vehicleHeight?: number

Valeur de propriété

number

vehicleLength

Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte.

vehicleLength?: number

Valeur de propriété

number

vehicleLoadType

Types de marchandises qui peuvent être classées comme des matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes US Hazmat 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.

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

Valeur de propriété

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

vehicleMaxSpeed

Vitesse maximale du véhicule en km/heure. La vitesse maximale dans le profil du véhicule est utilisée pour case activée si un véhicule est autorisé sur les autoroutes.

• La valeur 0 signifie qu’une valeur appropriée pour le véhicule sera déterminée et appliquée lors de la planification de l’itinéraire.

• Une valeur autre que zéro peut être remplacée pendant la planification de l’itinéraire. Par exemple, le flux de trafic actuel est de 60 km/heure. Si la vitesse maximale du véhicule est définie sur 50 km/heure, le moteur de routage considérera 60 km/heure, car c’est la situation actuelle. Si la vitesse maximale du véhicule est de 80 km/heure, mais que la circulation actuelle est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.

vehicleMaxSpeed?: number

Valeur de propriété

number

vehicleWeight

Poids du véhicule en kilogrammes.

• Il est obligatoire si l’un des paramètres *Efficacité est défini.

• Il doit être strictement positif lorsqu’il est utilisé dans le contexte du modèle de consommation. Les restrictions de poids sont prises en compte.

• Si aucun modèle de consommation détaillé n’est spécifié et que la valeur de vehicleWeight est différente de zéro, les restrictions de poids sont prises en compte.

• Dans tous les autres cas, ce paramètre est ignoré.

Valeurs sensibles : pour le modèle de combustion : 1600, pour le modèle électrique : 1900

vehicleWeight?: number

Valeur de propriété

number

vehicleWidth

Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte.

vehicleWidth?: number

Valeur de propriété

number

windingness

Niveau de virages pour un itinéraire palpitant. Ce paramètre peut uniquement être utilisé conjointement avec routeType=thrilling.

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

Valeur de propriété

"low" | "normal" | "high"