RouteGetRouteDirectionsQueryParamProperties 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 la (c’est-à-dire l’activation de l’énergie chimique/Chemical EnergyConsumed). Chemical EnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuel EnergyDensityInMSourcesPerLiter. Doit être associé à décélérationEfficiency. La plage de valeurs autorisées est de 0,0 à 1/décélérationEfficiency. Valeurs sensibles : pour modèle de combustion : 0,33, pour modèle électrique : 0,66
alternativeType	Contrôle l’optimalité, en ce qui concerne les 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 mis en forme sous la forme d’une valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point de destination. Exemples : 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt, minDeviationDistance ou minDeviationTime.
auxiliaryPowerInkW	Spécifie la quantité de puissance consommée pour le maintien des systèmes auxiliaires, en kw (kW). Il peut être utilisé pour spécifier la consommation en raison d’appareils et de systèmes tels que les systèmes AC, la radio, le chauffage, etc. Valeurs sensibles : 1,7
auxiliaryPowerInLitersPerHour	Spécifie la quantité de carburant consommée pour soutenir les systèmes auxiliaires du véhicule, en litres par heure. Il peut être utilisé pour spécifier la consommation en raison d’appareils et de systèmes tels que les systèmes AC, la radio, le chauffage, etc. Valeurs sensibles : 0.2
avoid	Spécifie un élément 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 requête, par exemple , '&avoid=autoroutes&avoid=tollRoads&avoid=ferries'. Dans les requêtes de plage d’itinéraires, la valeur déjàUsedRoads ne doit pas être utilisée.
computeBestOrder	Récommandez les points de route à l’aide d’un algorithme heuristique rapide pour réduire la longueur de l’itinéraire. Génère les meilleurs résultats lorsqu’ils sont utilisés conjointement avec routeType plus court. Notez que l’origine et la destination sont exclues des index waypoint 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 en tant qu’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 aucun.
computeTravelTimeFor	Spécifie s’il faut retourner des temps de voyage supplémentaires à l’aide de différents types d’informations sur le trafic (aucun, historique, live) ainsi que le temps de voyage par défaut le mieux estimé.
constantSpeedConsumptionInkWhPerHundredkm	Spécifie le composant dépendant de la vitesse de consommation. Fourni sous la forme d’une liste non ordonnée de paires vitesse/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 se trouvent comme suit : par interpolation linéaire, si la vitesse donnée se trouve entre deux vitesses dans la liste par extrapolation linéaire sinon, 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 peut ne pas contenir de points dupliqués 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 plus grande vitesse doit être supérieure ou égale à celle de la dernière vitesse la plus élevée. 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 entraîner 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 1 0000,0. Valeurs sensibles : 50,8.2:130,21.3 Ce paramètre est requis pour 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 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 se trouvent comme suit : par interpolation linéaire, si la vitesse donnée se trouve entre deux vitesses dans la liste par extrapolation linéaire sinon, 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 peut ne pas contenir de points dupliqués 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 plus grande vitesse doit être supérieure ou égale à celle de la dernière vitesse la plus élevée. 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 entraîner 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 kw heures (kWh). Ce paramètre existe conjointement avec paramètre maxChargeInkWh. La plage de valeurs autorisée est de 0,0 à 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é (c’est-à-dire Chemical EnergySaved/Vector EnergyLost). Chemical EnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuel ConsumeDensityInMThermsPerLiter. Doit être associé à accélérationEfficiency. La plage de valeurs autorisées est de 0,0 à 1/accelerationEfficiency. Valeurs sensibles : pour modèle de combustion : 0,83, pour modèle électrique : 0,91
departAt	Date et heure de départ du point d’origine mis en forme comme valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point d’origine. Valeur par défaut : maintenant Autre valeur : dateTime Exemples : 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Le paramètre departAt ne peut pas être utilisé conjointement avec arriveAt.
downhillEfficiency	Spécifie l’efficacité de la conversion de l’énergie potentielle en carburant économisé (non consommé) lorsque le véhicule perd l’élévation (c’est-à-dire Chemical EnergySaved/Potential EnergyLost). Chemical EnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuel ConsumeDensityInMThermsPerLiter. Doit être associé à uphillEfficiency. La plage de valeurs autorisées est de 0,0 à 1/uphillEfficiency. Valeurs sensibles : pour modèle de combustion : 0,51, pour modèle électrique : 0,73
fuelEnergyDensityInMJoulesPerLiter	Spécifie la quantité d’énergie chimique stockée dans un litre de carburant en méga millisecondes (MJ). Il est utilisé conjointement avec les paramètres *Efficiency pour les conversions entre l’énergie et le carburant économisés ou consommés. 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 la route excitante. Ce paramètre ne peut être utilisé que conjointement 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 de langue détermine la langue des messages d’aide. Les noms appropriés (les noms des rues, des plazas, etc.) sont retournés dans la langue spécifiée, ou s’ils ne sont pas disponibles, ils sont retournés dans une langue disponible proche de celle-ci. Les valeurs autorisées sont (sous-ensemble) les balises de langue IETF. Les langues actuellement prises en charge sont répertoriées dans la section Langues prises en charge. Valeur par défaut : en-GB
maxAlternatives	Nombre d’itinéraires alternatifs souhaités à calculer. Valeur par défaut : 0, minimum : 0 et maximum : 5
maxChargeInkWh	Spécifie la quantité maximale d’énergie électrique en kWh (kWh) qui peut être stockée dans la batterie du véhicule. Ce paramètre existe conjointement avec 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 Demandes POST) à partir du point d’origine de la requête calculateRoute pour au moins ce nombre de compteurs. Peut être utilisé uniquement 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 Demandes POST) à partir du point d’origine de la requête calculateRoute pendant au moins ce nombre de secondes. Peut être utilisé uniquement 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 l'calculateRoute Request 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 la route 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é comme premier itinéraire dans la calculateRoute Response, 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éterminer la distance entre les itinéraires alternatifs et les itinéraires de référence à partir du point d’origine. L’itinéraire doit utiliser départAt. Le vehicleHeading est ignoré.
query	Coordonnées par lesquelles l’itinéraire est calculé, délimité par un signe deux-points. Un minimum de deux coordonnées est requis. La première est l’origine et la dernière est la destination de l’itinéraire. Les coordonnées facultatives entre-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 effectifs ou les données utilisées 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 dans laquelle le paramètre n’a pas été spécifié par l’appelant.
routeRepresentation	Spécifie la représentation de l’ensemble d’itinéraires fournis en tant que réponse.
routeType	Type d’itinéraire demandé.
sectionType	Spécifie quels types de sections sont signalés dans la réponse de routage. Par exemple, si sectionType = piéton les sections qui conviennent uniquement aux piétons sont retournées. Peut être spécifié plusieurs fois dans une requête, par exemple , '§ionType=carTrain§ionType=piéton§ionType=autoroute'. La sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur voiture
traffic	Valeurs possibles : true : tenez compte de toutes les informations de trafic disponibles pendant le routage false : ignorez les données de trafic actuelles pendant le routage. Notez que bien que les données actuelles sur le trafic soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de route effectives est toujours incorporé.
travelMode	Mode de voyage pour l’itinéraire demandé. S’il n’est pas défini, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ». Notez que les modes de voyage bus, moto, taxi et van sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.
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 d’élévation (c.-à-d. Potential EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuel EnergyDensityInMSourcesPerLiter. Doit être associé à downhillEfficiency. La plage de valeurs autorisées est de 0,0 à 1/downhillEfficiency. Valeurs sensibles : pour modèle de combustion : 0,27, pour modèle électrique : 0,74
vehicleAxleWeight	Poids par axe du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.
vehicleCommercial	Indique si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à conduire 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	Le titre directionnel du véhicule en degrés commençant à vrai Nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degrés, est de 90 degrés, le sud est de 180 degrés, l’ouest est de 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 cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. 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/régions. 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 vérifier 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 pendant la planification de l’itinéraire. Une valeur non nulle 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 prend en compte 60 km/heure, car il s’agit de la situation actuelle. Si la vitesse maximale du véhicule est fournie comme étant de 80 km/heure, mais que le trafic actuel est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.
vehicleWeight	Poids du véhicule en kilos. 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 véhiculeWeight n’est pas égale à zéro, les restrictions de poids sont prises en compte. Dans tous les autres cas, ce paramètre est ignoré. Valeurs sensibles : pour modèle de combustion : 1600, pour 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 la route excitante. Ce paramètre ne peut être utilisé que 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 la (c’est-à-dire l’activation de l’énergie chimique/Chemical EnergyConsumed). Chemical EnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuel EnergyDensityInMSourcesPerLiter.

Doit être associé à décélérationEfficiency.

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

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

accelerationEfficiency?: number

Valeur de propriété

number

alternativeType

Contrôle l’optimalité, en ce qui concerne les 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 mis en forme sous la forme d’une valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point de destination.

Exemples :

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

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é de puissance consommée pour le maintien des systèmes auxiliaires, en kw (kW).

Il peut être utilisé pour spécifier la consommation en raison d’appareils et de systèmes tels que les systèmes AC, 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 soutenir les systèmes auxiliaires du véhicule, en litres par heure.

Il peut être utilisé pour spécifier la consommation en raison d’appareils et de systèmes tels que les systèmes AC, la radio, le chauffage, etc.

Valeurs sensibles : 0.2

auxiliaryPowerInLitersPerHour?: number

Valeur de propriété

number

avoid

Spécifie un élément 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 requête, par exemple , '&avoid=autoroutes&avoid=tollRoads&avoid=ferries'. Dans les requêtes de plage d’itinéraires, la valeur déjàUsedRoads 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 route à l’aide d’un algorithme heuristique rapide pour réduire la longueur de l’itinéraire. Génère les meilleurs résultats lorsqu’ils sont utilisés conjointement avec routeType plus court. Notez que l’origine et la destination sont exclues des index waypoint 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 en tant qu’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 aucun.

computeBestOrder?: boolean

Valeur de propriété

boolean

computeTravelTimeFor

Spécifie s’il faut retourner des temps de voyage supplémentaires à l’aide de différents types d’informations sur le trafic (aucun, historique, live) ainsi que le temps de voyage par défaut le mieux estimé.

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 ordonnée de paires vitesse/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 se trouvent comme suit :

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

• par extrapolation linéaire sinon, 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 peut ne pas contenir de points dupliqués 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 plus grande vitesse doit être supérieure ou égale à celle de la dernière vitesse la plus élevée. 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 entraîner 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 1 0000,0.

Valeurs sensibles : 50,8.2:130,21.3

Ce paramètre est requis pour 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 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 se trouvent comme suit :

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

• par extrapolation linéaire sinon, 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 peut ne pas contenir de points dupliqués 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 plus grande vitesse doit être supérieure ou égale à celle de la dernière vitesse la plus élevée. 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 entraîner 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 kw heures (kWh).

Ce paramètre existe conjointement avec paramètre maxChargeInkWh.

La plage de valeurs autorisée est de 0,0 à 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é (c’est-à-dire Chemical EnergySaved/Vector EnergyLost). Chemical EnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuel ConsumeDensityInMThermsPerLiter.

Doit être associé à accélérationEfficiency.

La plage de valeurs autorisées est de 0,0 à 1/accelerationEfficiency.

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

decelerationEfficiency?: number

Valeur de propriété

number

departAt

Date et heure de départ du point d’origine mis en forme comme valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point d’origine.

• Valeur par défaut : maintenant
• Autre valeur : dateTime

Exemples :

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

Le paramètre departAt ne peut pas être utilisé conjointement avec arriveAt.

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 l’élévation (c’est-à-dire Chemical EnergySaved/Potential EnergyLost). Chemical EnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide de fuel ConsumeDensityInMThermsPerLiter.

Doit être associé à uphillEfficiency.

La plage de valeurs autorisées est de 0,0 à 1/uphillEfficiency.

Valeurs sensibles : pour modèle de combustion : 0,51, pour 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éga millisecondes (MJ). Il est utilisé conjointement avec les paramètres *Efficiency pour les conversions entre l’énergie et le carburant économisés ou consommés. 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 la route excitante. Ce paramètre ne peut être utilisé que conjointement 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 de langue détermine la langue des messages d’aide. Les noms appropriés (les noms des rues, des plazas, etc.) sont retournés dans la langue spécifiée, ou s’ils ne sont pas disponibles, ils sont retournés dans une langue disponible proche de celle-ci. Les valeurs autorisées sont (sous-ensemble) les balises de langue IETF. Les langues actuellement prises en charge sont répertoriées dans la section Langues prises en charge.

Valeur par défaut : en-GB

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 la quantité maximale d’énergie électrique en kWh (kWh) qui peut être stockée dans la batterie du véhicule.

Ce paramètre existe conjointement avec 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 Demandes POST) à partir du point d’origine de la requête calculateRoute pour au moins ce nombre de compteurs. Peut être utilisé uniquement 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 Demandes POST) à partir du point d’origine de la requête calculateRoute pendant au moins ce nombre de secondes. Peut être utilisé uniquement 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 l'calculateRoute Request 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 la route 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é comme premier itinéraire dans la calculateRoute Response, 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éterminer la distance entre les itinéraires alternatifs et les itinéraires de référence à partir du point d’origine.
• L’itinéraire doit utiliser départAt.
• Le vehicleHeading est ignoré.

minDeviationTime?: number

Valeur de propriété

number

query

Coordonnées par lesquelles l’itinéraire est calculé, délimité par un signe deux-points. Un minimum de deux coordonnées est requis. La première est l’origine et la dernière est la destination de l’itinéraire. Les coordonnées facultatives entre-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 effectifs ou les données utilisées 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 dans laquelle 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 fournis en tant que réponse.

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 quels types de sections sont signalés dans la réponse de routage.

Par exemple, si sectionType = piéton les sections qui conviennent uniquement aux piétons sont retournées. Peut être spécifié plusieurs fois dans une requête, par exemple , '§ionType=carTrain§ionType=piéton§ionType=autoroute'. La sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur voiture

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 : ignorez les données de trafic actuelles pendant le routage. Notez que bien que les données actuelles sur le trafic soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de route effectives est toujours incorporé.

traffic?: boolean

Valeur de propriété

boolean

travelMode

Mode de voyage pour l’itinéraire demandé. S’il n’est pas défini, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ». Notez que les modes de voyage bus, moto, taxi et van sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.

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 d’élévation (c.-à-d. Potential EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide de fuel EnergyDensityInMSourcesPerLiter.

Doit être associé à downhillEfficiency.

La plage de valeurs autorisées est de 0,0 à 1/downhillEfficiency.

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

uphillEfficiency?: number

Valeur de propriété

number

vehicleAxleWeight

Poids par axe 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

Indique si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à conduire 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

Le titre directionnel du véhicule en degrés commençant à vrai Nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degrés, est de 90 degrés, le sud est de 180 degrés, l’ouest est de 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 cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. 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/régions. 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 vérifier 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 pendant la planification de l’itinéraire.

• Une valeur non nulle 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 prend en compte 60 km/heure, car il s’agit de la situation actuelle. Si la vitesse maximale du véhicule est fournie comme étant de 80 km/heure, mais que le trafic actuel 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 kilos.

• 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 véhiculeWeight n’est pas égale à zéro, les restrictions de poids sont prises en compte.

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

Valeurs sensibles : pour modèle de combustion : 1600, pour 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 la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

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

Valeur de propriété

"low" | "normal" | "high"