Route - Get Route Directions
Utilisez pour calculer un itinéraire entre une origine et une destination spécifiée, en passant par n’importe quel point de passage spécifié.
L’API Get Route Directions
est une requête HTTP GET
qui retourne un itinéraire entre une origine et une destination, en passant par des points de passage si spécifié. L’itinéraire prend en compte des facteurs tels que le trafic actuel et les vitesses typiques de la route sur le jour de la semaine et l’heure de la journée demandés.
Les informations retournées incluent la distance, le temps de trajet estimé et une représentation de la géométrie de l’itinéraire. Des informations de routage supplémentaires, telles que l’ordre de point de routage optimisé ou les instructions de tour par étape, sont également disponibles, en fonction des options sélectionnées.
Le service de routage fournit un ensemble de paramètres pour une description détaillée d’un modèle de consommation spécifique au véhicule. Pour plus d’informations, consultez Modèle de consommation.
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings§ionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
Format souhaité de la réponse. La valeur peut être json ou xml. |
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
query
|
query | True |
string |
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. |
acceleration
|
query |
number double |
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, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide du carburantEnergyDensityInMJoulesPerLiter. 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 |
|
alternative
|
query |
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. |
||
arrive
|
query |
string date-time |
Date et heure d’arrivée au point de destination mis en forme en tant que Exemples :
Le |
|
auxiliary
|
query |
number double |
Spécifie la quantité d’énergie consommée pour le maintien en puissance 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 |
|
auxiliary
|
query |
number double |
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
|
query |
Spécifie un élément que le calcul de la route doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une seule demande, par exemple, « &avoid=autoroutes&avoid=tollRoads&avoid=ferries ». Dans les demandes de plage de routage, la valeur alreadyUsedRoads ne doit pas être utilisée. |
||
compute
|
query |
boolean |
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. |
|
compute
|
query |
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. |
||
constant
|
query |
string |
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 :
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 plus grande vitesse 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 plus petites vitesses de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse inférieure. La plage valide pour les valeurs de consommation (exprimées en kWh/100 km) 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. |
|
constant
|
query |
string |
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 sont les suivants :
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 plus grande vitesse 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 plus petites vitesses de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse inférieure. La plage valide pour les valeurs de consommation (exprimées en l/100 km) 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. |
|
current
|
query |
number double |
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 |
|
current
|
query |
number double |
Spécifie l’approvisionnement actuel en carburant en litres. Valeurs sensibles : 55 |
|
deceleration
|
query |
number double |
Spécifie l’efficacité de la conversion de l’énergie cinétique en carburant économisé (non consommé) lorsque le véhicule ralentit (c’est-à-dire, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide du carburantEnergyDensityInMJoulesPerLiter. 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 |
|
depart
|
query |
string date-time |
Date et heure de départ du point d’origine mis en forme en tant que
Exemples :
Le |
|
downhill
|
query |
number double |
Spécifie l’efficacité de la conversion de l’énergie potentielle en carburant économisé (non consommé) lorsque le véhicule perd de l’élévation (c’est-à-dire, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide du carburantEnergyDensityInMJoulesPerLiter. 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 |
|
fuel
|
query |
number double |
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 diesel. Ce paramètre est obligatoire si un paramètre *Efficiency est défini. Valeurs sensibles : 34.2 |
|
hilliness
|
query |
Degré de colline pour un itinéraire palpitant. Ce paramètre peut uniquement être utilisé conjointement avec |
||
instructions
|
query |
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
|
query |
string |
Le paramètre language détermine la langue des messages d’aide. Les noms propres (noms des rues, des places, 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 (un sous-ensemble de) 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 |
|
max
|
query |
integer |
Nombre d’itinéraires alternatifs souhaités à calculer. Valeur par défaut : 0, minimum : 0 et maximum : 5 |
|
max
|
query |
number double |
Spécifie la quantité maximale d’énergie électrique en 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 |
|
min
|
query |
integer |
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 |
|
min
|
query |
integer |
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 :
|
|
report
|
query |
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. |
||
route
|
query |
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. |
||
route
|
query |
Type d’itinéraire demandé. |
||
section
|
query |
Spécifie les types de section signalés dans la réponse d’itinéraire. |
||
traffic
|
query |
boolean |
Valeurs possibles :
|
|
travel
|
query |
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 « autre ». Notez que les modes de voyage bus, moto, taxi et fourgon sont des fonctionnalités BETA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones. |
||
uphill
|
query |
number double |
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 élévation (par exemple, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide du carburantEnergyDensityInMJoulesPerLiter. 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 |
|
vehicle
|
query |
integer |
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. |
|
vehicle
|
query |
boolean |
Si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à circuler sur certaines routes. |
|
vehicle
|
query |
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. |
||
vehicle
|
query |
integer |
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 |
|
vehicle
|
query |
number double |
Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte. |
|
vehicle
|
query |
number double |
Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte. |
|
vehicle
|
query |
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/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. |
||
vehicle
|
query |
integer |
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.
|
|
vehicle
|
query |
integer |
Poids du véhicule en kilogrammes.
Valeurs sensibles : pour le modèle de combustion : 1600, pour le modèle électrique : 1900 |
|
vehicle
|
query |
number double |
Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte. |
|
windingness
|
query |
Niveau de virages pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.
Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Notes
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps.
est Authorization URL
spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
* L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée qui est provisionnée lorsque vous Create un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, sdk Azure ou API REST.
Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.
Type:
apiKey
In:
query
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et à la ou les régions d’utilisation du jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.
Type:
apiKey
In:
header
Exemples
Successfully retrieve a route between an origin and a destination
Sample Request
GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
Sample Response
{
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"points": [
{
"latitude": 52.50931,
"longitude": 13.42937
},
{
"latitude": 52.50904,
"longitude": 13.42912
},
{
"latitude": 52.50894,
"longitude": 13.42904
},
{
"latitude": 52.50867,
"longitude": 13.42879
},
{
"latitude": 52.5084,
"longitude": 13.42857
},
{
"latitude": 52.50791,
"longitude": 13.42824
},
{
"latitude": 52.50757,
"longitude": 13.42772
},
{
"latitude": 52.50735,
"longitude": 13.42823
},
{
"latitude": 52.5073,
"longitude": 13.42836
},
{
"latitude": 52.50573,
"longitude": 13.43194
},
{
"latitude": 52.50512,
"longitude": 13.43336
},
{
"latitude": 52.50464,
"longitude": 13.43451
},
{
"latitude": 52.5045,
"longitude": 13.43481
},
{
"latitude": 52.50443,
"longitude": 13.43498
},
{
"latitude": 52.50343,
"longitude": 13.43737
},
{
"latitude": 52.50274,
"longitude": 13.43872
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 15,
"sectionType": "TRAVEL_MODE",
"travelMode": "car"
}
]
}
]
}
Définitions
Nom | Description |
---|---|
Alternative |
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. |
Compute |
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. |
Delay |
Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir le détail des incidents de trafic. |
Driving |
Indique la conduite à gauche et à droite au point de la manœuvre. |
Effective |
Paramètre ou données effectifs utilisés lors de l’appel de cette API de route. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Guidance |
Type de l’instruction, par exemple, virage ou changement de formulaire de route. |
Guidance |
Code identifiant la manœuvre. |
Incline |
Degré de colline pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec |
Junction |
Type de jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et quitter le rond-point. |
Lat |
Emplacement représenté sous la forme d’une latitude et d’une longitude. |
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. |
Response |
Format souhaité de la réponse. La valeur peut être json ou xml. |
Response |
Types de section de la réponse de routage signalée |
Response |
Mode voyage pour l’itinéraire calculé. La valeur est définie |
Route | |
Route |
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 demandes de plage de routes, la valeur alreadyUsedRoads ne doit pas être utilisée. |
Route |
Cet objet est retourné à partir d’un appel d’itinéraire réussi |
Route |
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles. |
Route |
Ensemble d’attributs décrivant une manœuvre, par exemple« Tourner à droite », « Rester à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ». |
Route |
Groupes une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée par firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés à des fins d’aide (instructionType=text ou étiqueté), un message de synthèse est retourné dans le groupe d’instructions lorsqu’il est disponible. |
Route |
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 |
Route |
Description d’une partie d’un itinéraire, composée d’une liste de points. Chaque point de chemin supplémentaire fourni dans la demande entraîne une étape supplémentaire dans l’itinéraire retourné. |
Route |
Objet summary pour la section route. |
Route |
Objet point de chemin optimisé. |
Route |
Indique les paramètres effectifs utilisés dans l’appel actuel. |
Route |
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. |
Route |
Les sections de routage contiennent des informations supplémentaires sur les parties d’un itinéraire. Chaque section contient au moins les éléments |
Route |
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes. |
Route |
Cause de l’événement de trafic. Peut contenir des éléments mainCauseCode et subCauseCode. Peut être utilisé pour définir l’iconographie et les descriptions. |
Route |
Objet Summary |
Route |
Type d’itinéraire demandé. |
Section |
Spécifie les types de section signalés dans la réponse d’itinéraire. |
Simple |
Type de l’incident. Actuellement, il peut s’agir de JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ». |
Travel |
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. |
Vehicle |
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. |
Vehicle |
Types de cargaisons qui peuvent être classées comme des matières dangereuses et interdites à 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/régions. Les valeurs commençant par USHazmat sont destinées au routage des États-Unis, tandis que otherHazmat doit être utilisé 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. |
Windingness |
Niveau de virages pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec |
AlternativeRouteType
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.
Nom | Type | Description |
---|---|---|
anyRoute |
string |
Autorisez le retour d’une autre route, quelle que soit la façon dont elle se compare à l’itinéraire de référence en termes d’optimalité. |
betterRoute |
string |
Retourne une autre route uniquement si elle est meilleure que l’itinéraire de référence selon les critères de planification donnés. |
ComputeTravelTime
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.
Nom | Type | Description |
---|---|---|
all |
string |
Calcule les temps de trajet pour tous les types d’informations sur le trafic et spécifie tous les résultats dans les champs noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds et liveTrafficIncidentsTravelTimeInSeconds inclus dans les résumés dans la réponse d’itinéraire. |
none |
string |
Ne calcule pas les temps de trajet supplémentaires. |
DelayMagnitude
Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir le détail des incidents de trafic.
Nom | Type | Description |
---|---|---|
0 |
string |
Inconnu. |
1 |
string |
Mineur. |
2 |
string |
Modéré. |
3 |
string |
Majeur. |
4 |
string |
Non défini, utilisé pour les fermetures de routes et autres retards indéfinis. |
DrivingSide
Indique la conduite à gauche et à droite au point de la manœuvre.
Nom | Type | Description |
---|---|---|
LEFT |
string |
Gauche. |
RIGHT |
string |
Côté droit. |
EffectiveSetting
Paramètre ou données effectifs utilisés lors de l’appel de cette API de route.
Nom | Type | Description |
---|---|---|
key |
string |
Nom du paramètre utilisé. |
value |
string |
Valeur du paramètre utilisé. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet error. |
GuidanceInstructionType
Type de l’instruction, par exemple, virage ou changement de formulaire de route.
Nom | Type | Description |
---|---|---|
DIRECTION_INFO |
string |
Informations de direction. |
LOCATION_ARRIVAL |
string |
Lieu d’arrivée. |
LOCATION_DEPARTURE |
string |
Lieu de départ. |
LOCATION_WAYPOINT |
string |
Emplacement du point de passage. |
ROAD_CHANGE |
string |
Changement de route. |
TURN |
string |
Tourner. |
GuidanceManeuver
Code identifiant la manœuvre.
Nom | Type | Description |
---|---|---|
ARRIVE |
string |
Tu es arrivé. |
ARRIVE_LEFT |
string |
Tu es arrivé. Votre destination se trouve sur la gauche. |
ARRIVE_RIGHT |
string |
Tu es arrivé. Votre destination est à droite. |
BEAR_LEFT |
string |
Ours à gauche. |
BEAR_RIGHT |
string |
Portez à droite. |
DEPART |
string |
Laisser. |
ENTER_FREEWAY |
string |
Prenez l’autoroute. |
ENTER_HIGHWAY |
string |
Prenez l’autoroute. |
ENTER_MOTORWAY |
string |
Prenez l’autoroute. |
ENTRANCE_RAMP |
string |
Prenez la rampe. |
FOLLOW |
string |
Suivre. |
KEEP_LEFT |
string |
Restez à gauche. |
KEEP_RIGHT |
string |
Gardez la droite. |
MAKE_UTURN |
string |
Faites un demi-tour. |
MOTORWAY_EXIT_LEFT |
string |
Prendre la sortie de gauche. |
MOTORWAY_EXIT_RIGHT |
string |
Prenez la sortie de droite. |
ROUNDABOUT_BACK |
string |
Faire le tour du rond-point. |
ROUNDABOUT_CROSS |
string |
Traverser le rond-point. |
ROUNDABOUT_LEFT |
string |
Au rond-point, prendre la sortie à gauche. |
ROUNDABOUT_RIGHT |
string |
Au rond-point, prendre la sortie à droite. |
SHARP_LEFT |
string |
Tourner vers la gauche. |
SHARP_RIGHT |
string |
Tourner vers la droite. |
STRAIGHT |
string |
Continuez tout droit. |
SWITCH_MAIN_ROAD |
string |
Passez à la route main. |
SWITCH_PARALLEL_ROAD |
string |
Basculez vers la route parallèle. |
TAKE_EXIT |
string |
Prenez la sortie. |
TAKE_FERRY |
string |
Prenez le ferry. |
TRY_MAKE_UTURN |
string |
Essayez de faire un demi-tour. |
TURN_LEFT |
string |
Tourner à gauche. |
TURN_RIGHT |
string |
Tourner à droite. |
WAYPOINT_LEFT |
string |
Vous avez atteint le point de passage. C’est à gauche. |
WAYPOINT_REACHED |
string |
Vous avez atteint le point de passage. |
WAYPOINT_RIGHT |
string |
Vous avez atteint le point de passage. C’est à droite. |
InclineLevel
Degré de colline pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec routeType
=thrilling.
Nom | Type | Description |
---|---|---|
high |
string |
high |
low |
string |
low |
normal |
string |
normal |
JunctionType
Type de jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et quitter le rond-point.
Nom | Type | Description |
---|---|---|
BIFURCATION |
string |
bifurcation |
REGULAR |
string |
regular |
ROUNDABOUT |
string |
Rond-point |
LatLongPair
Emplacement représenté sous la forme d’une latitude et d’une longitude.
Nom | Type | Description |
---|---|---|
latitude |
number |
Propriété Latitude |
longitude |
number |
Longitude, propriété |
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.
Nom | Type | Description |
---|---|---|
effectiveSettings |
string |
Signale les paramètres ou données effectifs utilisés lors de l’appel de l’API. |
ResponseFormat
Format souhaité de la réponse. La valeur peut être json ou xml.
Nom | Type | Description |
---|---|---|
json |
string |
|
xml |
string |
ResponseSectionType
Types de section de la réponse de routage signalée
Nom | Type | Description |
---|---|---|
CARPOOL |
string |
Sections de l’itinéraire qui nécessitent l’utilisation de voies de covoiturage (HOV/High Occupationy Vehicle). |
CAR_TRAIN |
string |
Sections de l’itinéraire qui sont des voitures ou des trains. |
COUNTRY |
string |
Sections indiquant les pays/régions dans lesquels se trouve l’itinéraire. |
FERRY |
string |
Sections de la route qui sont des traversiers. |
MOTORWAY |
string |
Sections de la route qui sont des autoroutes. |
PEDESTRIAN |
string |
Sections de l’itinéraire qui ne sont adaptées qu’aux piétons. |
TOLL_ROAD |
string |
Sections de l’itinéraire qui nécessitent un péage à payer. |
TOLL_VIGNETTE |
string |
Sections de l’itinéraire qui nécessitent la présence d’une vignette de péage. |
TRAFFIC |
string |
Sections de l’itinéraire qui contiennent des informations sur le trafic. |
TRAVEL_MODE |
string |
Sections relatives au paramètre |
TUNNEL |
string |
Sections de l’itinéraire qui sont des tunnels. |
URBAN |
string |
Sections de l’itinéraire situées dans des zones urbaines. |
ResponseTravelMode
Mode voyage pour l’itinéraire calculé. La valeur est définie other
sur si le mode de transport demandé n’est pas possible dans cette section
Nom | Type | Description |
---|---|---|
bicycle |
string |
Les itinéraires retournés sont optimisés pour les bicyclettes, y compris l’utilisation de voies cyclables. |
bus |
string |
Les itinéraires retournés sont optimisés pour les autobus, y compris l’utilisation de voies réservées aux autobus. Fonctionnalité BÊTA. |
car |
string |
Les itinéraires retournés sont optimisés pour les voitures. |
motorcycle |
string |
Les itinéraires retournés sont optimisés pour les motos. Fonctionnalité BÊTA. |
other |
string |
Le mode de transport donné n’est pas possible dans cette section |
pedestrian |
string |
Les itinéraires retournés sont optimisés pour les piétons, y compris l’utilisation des trottoirs. |
taxi |
string |
Les itinéraires retournés sont optimisés pour les taxis. Fonctionnalité BÊTA. |
truck |
string |
Les itinéraires retournés sont optimisés pour les véhicules commerciaux, comme pour les camions. |
van |
string |
Les itinéraires retournés sont optimisés pour les fourgonnettes. Fonctionnalité BÊTA. |
Route
Nom | Type | Description |
---|---|---|
guidance |
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles. |
|
legs |
Route |
Tableau d’jambes |
sections |
Tableau sections |
|
summary |
Objet Summary |
RouteAvoidType
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 demandes de plage de routes, la valeur alreadyUsedRoads ne doit pas être utilisée.
Nom | Type | Description |
---|---|---|
alreadyUsedRoads |
string |
Évite d’utiliser la même route plusieurs fois. Plus utile en conjonction avec |
borderCrossings |
string |
Évite les passages aux frontières dans le calcul de l’itinéraire. |
carpools |
string |
Évite les itinéraires qui nécessitent l’utilisation de voies de covoiturage (HOV/High Occupationy Vehicle). |
ferries |
string |
Évite les traversiers |
motorways |
string |
Évite les autoroutes |
tollRoads |
string |
Évite les routes à péage. |
unpavedRoads |
string |
Évite les routes non pavées |
RouteDirections
Cet objet est retourné à partir d’un appel d’itinéraire réussi
Nom | Type | Description |
---|---|---|
formatVersion |
string |
Propriété Format Version |
optimizedWaypoints |
Séquence optimisée de points de cheminement. Il affiche l’index de la séquence de point de chemin fournie par l’utilisateur pour la liste d’origine et optimisée. Pour instance, une réponse :
signifie que la séquence d’origine est [0, 1, 2] et la séquence optimisée est [1, 2, 0]. Étant donné que l’index commence par 0, l’original est « first, second, third » tandis que l’optimisé est « second, third, first ». |
|
report |
Indique les paramètres effectifs utilisés dans l’appel actuel. |
|
routes |
Route[] |
Tableau d’itinéraires |
RouteGuidance
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles.
Nom | Type | Description |
---|---|---|
instructionGroups |
Groupes une séquence d’éléments d’instruction qui sont liés les uns aux autres. |
|
instructions |
Liste d’instructions décrivant les manœuvres. |
RouteInstruction
Ensemble d’attributs décrivant une manœuvre, par exemple« Tourner à droite », « Rester à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ».
Nom | Type | Description |
---|---|---|
combinedMessage |
string |
Message lisible par l’homme pour la manœuvre combiné au message de l’instruction suivante. Il est parfois possible de combiner deux instructions successives en une seule instruction, ce qui facilite le suivi. Dans ce cas, l’indicateur possibleCombineWithNext est true. Par exemple :
L’indicateur possibleCombineWithNext de l’instruction 10 est true. Cela indique aux clients des instructions codées qu’elles peuvent être combinées à l’instruction 11. Les instructions seront combinées automatiquement pour les clients qui demandent des conseils lisibles par l’utilisateur. Le champ combinedMessage contient le message combiné :
|
countryCode |
string |
Code pays iso 3166-1 alpha-3 à 3 caractères. Par exemple, les États-Unis. |
drivingSide |
Indique la conduite côté gauche par rapport à droite au point de la manœuvre. |
|
exitNumber |
string |
Nombre(s) d’une sortie d’autoroute prise par la manœuvre actuelle. Si une sortie a plusieurs numéros de sortie, ils sont séparés par « », et éventuellement agrégés par « - », par exemple, « 10, 13-15 ». |
instructionType |
Type de l’instruction, par exemple, virage ou changement de formulaire de route. |
|
junctionType |
Type de la jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et sortir du rond-point. |
|
maneuver |
Code identifiant la manœuvre. |
|
message |
string |
Un message lisible par l’homme pour la manœuvre. |
point |
Emplacement représenté sous la forme d’une latitude et d’une longitude. |
|
pointIndex |
integer |
Index du point dans la liste des « points » polylignes correspondant au point de l’instruction. |
possibleCombineWithNext |
boolean |
Il est possible de combiner éventuellement l’instruction avec la suivante. Cela peut être utilisé pour générer des messages tels que « Tourner à gauche, puis tourner à droite ». |
roadNumbers |
string[] |
Numéro(s) de route du ou des segments de route significatifs suivants après la manœuvre, ou des routes à suivre. Exemple : ["E34 », « N205"] |
roundaboutExitNumber |
string |
Cela indique la sortie à prendre à un rond-point. |
routeOffsetInMeters |
integer |
Distance entre le début de l’itinéraire et le point de l’instruction. |
signpostText |
string |
Texte sur un panneau qui est le plus pertinent pour la manœuvre, ou pour la direction à suivre. |
stateCode |
string |
Subdivision (par exemple, état) du pays, représentée par la deuxième partie d’un code ISO 3166-2 . Cette option n’est disponible que pour certains pays/régions comme les États-Unis, le Canada et le Mexique. |
street |
string |
Nom de la rue du prochain segment de route significatif après la manœuvre, ou de la rue à suivre. |
travelTimeInSeconds |
integer |
Temps de trajet estimé jusqu’au point correspondant à routeOffsetInMeters. |
turnAngleInDecimalDegrees |
integer |
Indique la direction d’une instruction. Si junctionType indique une instruction de tour :
Si junctionType indique une instruction de bifurcation :
|
RouteInstructionGroup
Groupes une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée par firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés à des fins d’aide (instructionType=text ou étiqueté), un message de synthèse est retourné dans le groupe d’instructions lorsqu’il est disponible.
Nom | Type | Description |
---|---|---|
firstInstructionIndex |
integer |
Index de la première instruction des instructions et appartenant à ce groupe. |
groupLengthInMeters |
integer |
Longueur du groupe. |
groupMessage |
string |
Message de synthèse lorsque des messages texte lisibles par l’homme sont demandés à des fins d’aide (instructionType=texte ou étiqueté). |
lastInstructionIndex |
integer |
Index de la dernière instruction dans les instructions et appartenant à ce groupe. |
RouteInstructionsType
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
Nom | Type | Description |
---|---|---|
coded |
string |
Retourne des données d’instructions brutes sans messages lisibles par l’homme. |
tagged |
string |
Retourne des données d’instruction brutes avec des messages étiquetés lisibles par l’homme pour permettre la mise en forme. Un message lisible par l’homme est créé à partir d’éléments identifiés reproductibles. Celles-ci sont étiquetées pour permettre aux applications clientes de les mettre en forme correctement. Les composants de message suivants sont marqués quand instructionsType=tagged : street, roadNumber, signpostText, exitNumber, rond-pointExitNumber. Exemple de message étiqueté « Tourner à gauche » :
|
text |
string |
Retourne des données d’instructions brutes avec des messages lisibles par l’homme en texte brut. |
RouteLeg
Description d’une partie d’un itinéraire, composée d’une liste de points. Chaque point de chemin supplémentaire fourni dans la demande entraîne une étape supplémentaire dans l’itinéraire retourné.
Nom | Type | Description |
---|---|---|
points |
Tableau de points |
|
summary |
Objet summary pour la section route. |
RouteLegSummary
Objet summary pour la section route.
Nom | Type | Description |
---|---|---|
arrivalTime |
string |
Heure d’arrivée estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC. |
batteryConsumptionInkWh |
number |
Estimation de la consommation d’énergie électrique en kilowattheures (kWh) à l’aide du modèle de consommation électrique. Inclus si vehicleEngineType est défini sur électrique et constantSpeedConsumptionInkWhPerHundredkm est spécifié. La valeur de batteryConsumptionInkWh inclut l’énergie électrique récupérée et peut donc être négative (ce qui indique la prise d’énergie). Si maxChargeInkWh et currentChargeInkWh sont spécifiés, la récupération sera limitée pour garantir que le niveau de charge de la batterie ne dépasse jamais maxChargeInkWh. Si ni maxChargeInkWh ni currentChargeInkWh ne sont spécifiés, la récupération sans contrainte est supposée dans le calcul de la consommation. |
departureTime |
string |
Heure de départ estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC. |
fuelConsumptionInLiters |
number |
Estimation de la consommation de carburant en litres à l’aide du modèle de consommation de combustion. Inclus si vehicleEngineType est défini sur combustion et constantSpeedConsumptionInLitersPerHundredkm est spécifié. La valeur n’est pas négative. |
historicTrafficTravelTimeInSeconds |
integer |
Durée estimée du trajet calculée à l’aide de données de trafic historiques dépendantes du temps. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête. |
lengthInMeters |
integer |
Propriété Length In Meters |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Temps de trajet estimé calculé à l’aide de données de vitesse en temps réel. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête. |
noTrafficTravelTimeInSeconds |
integer |
Estimation du temps de trajet calculé comme s’il n’y avait aucun retard sur l’itinéraire en raison des conditions de circulation (par exemple, congestion). Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête. |
trafficDelayInSeconds |
integer |
Délai estimé en secondes provoqué par le ou les incidents en temps réel en fonction des informations sur le trafic. Pour les itinéraires prévus avec l’heure de départ à l’avenir, les retards sont toujours de 0. Pour retourner des temps de trajet supplémentaires à l’aide de différents types d’informations de trafic, le paramètre computeTravelTimeFor=all doit être ajouté. |
travelTimeInSeconds |
integer |
Durée estimée du trajet en secondes qui inclut le retard dû au trafic en temps réel. Notez que même lorsque traffic=false travelTimeInSeconds inclut toujours le retard dû au trafic. Si DepartAt est à l’avenir, le temps de trajet est calculé à l’aide de données de trafic historique dépendantes du temps. |
RouteOptimizedWaypoint
Objet point de chemin optimisé.
Nom | Type | Description |
---|---|---|
optimizedIndex |
integer |
Index de point de voie optimisé à partir du système. |
providedIndex |
integer |
Index de point de chemin fourni par l’utilisateur. |
RouteReport
Indique les paramètres effectifs utilisés dans l’appel actuel.
Nom | Type | Description |
---|---|---|
effectiveSettings |
Paramètres ou données effectifs utilisés lors de l’appel de cette API de route. |
RouteRepresentationForBestOrder
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.
Nom | Type | Description |
---|---|---|
none |
string |
Inclut uniquement les index de point de route optimisés, mais n’inclut pas la géométrie d’itinéraire dans la réponse. |
polyline |
string |
Inclut la géométrie de routage dans la réponse. |
summaryOnly |
string |
Résumé conformément à la polyligne, mais à l’exclusion des éléments géométriques de point pour les itinéraires dans la réponse. |
RouteSection
Les sections de routage contiennent des informations supplémentaires sur les parties d’un itinéraire. Chaque section contient au moins les éléments startPointIndex
, endPointIndex
et sectionType
.
Nom | Type | Description |
---|---|---|
delayInSeconds |
integer |
Retard en secondes provoqué par l’incident. |
effectiveSpeedInKmh |
integer |
Vitesse effective de l’incident en km/h, moyenne sur toute sa longueur. |
endPointIndex |
integer |
Index du dernier point (décalage 0) dans l’itinéraire auquel cette section s’applique. |
magnitudeOfDelay |
L’ampleur du retard causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir les détails des incidents de trafic. |
|
sectionType |
Types de section de la réponse d’itinéraire signalée |
|
simpleCategory |
Type de l’incident. Peut actuellement être JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ». |
|
startPointIndex |
integer |
Index du premier point (décalage 0) dans l’itinéraire auquel cette section s’applique. |
tec |
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes. |
|
travelMode |
Mode de déplacement pour l’itinéraire calculé. La valeur est définie sur |
RouteSectionTec
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes.
Nom | Type | Description |
---|---|---|
causes |
Tableau de causes |
|
effectCode |
integer |
Effet sur le flux de trafic. Contient une valeur dans la table tec001 :EffectCode, telle que définie dans la norme TPEG2-TEC . Peut être utilisé pour colorer les événements de trafic en fonction de la gravité. |
RouteSectionTecCause
Cause de l’événement de trafic. Peut contenir des éléments mainCauseCode et subCauseCode. Peut être utilisé pour définir l’iconographie et les descriptions.
Nom | Type | Description |
---|---|---|
mainCauseCode |
integer |
Cause main de l’événement de trafic. Contient une valeur dans la table tec002 :CauseCode, comme défini dans la norme TPEG2-TEC . |
subCauseCode |
integer |
Sous-utilisation de l’événement de trafic. Contient une valeur dans la table de sous-cause définie par mainCauseCode, comme défini dans la norme TPEG2-TEC . |
RouteSummary
Objet Summary
Nom | Type | Description |
---|---|---|
arrivalTime |
string |
Heure d’arrivée estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC. |
departureTime |
string |
Heure de départ estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC. |
lengthInMeters |
integer |
Propriété Length In Meters |
trafficDelayInSeconds |
integer |
Délai estimé en secondes provoqué par le ou les incidents en temps réel en fonction des informations sur le trafic. Pour les itinéraires prévus avec l’heure de départ à l’avenir, les retards sont toujours de 0. Pour retourner des temps de trajet supplémentaires à l’aide de différents types d’informations de trafic, le paramètre computeTravelTimeFor=all doit être ajouté. |
travelTimeInSeconds |
integer |
Durée estimée du trajet en secondes qui inclut le retard dû au trafic en temps réel. Notez que même lorsque traffic=false travelTimeInSeconds inclut toujours le retard dû au trafic. Si DepartAt est à l’avenir, le temps de trajet est calculé à l’aide de données de trafic historique dépendantes du temps. |
RouteType
Type d’itinéraire demandé.
Nom | Type | Description |
---|---|---|
eco |
string |
Un itinéraire équilibré par l’économie et la vitesse. |
fastest |
string |
L’itinéraire le plus rapide. |
shortest |
string |
Itinéraire le plus court par distance. |
thrilling |
string |
Comprend des routes intéressantes ou difficiles et utilise aussi peu d’autoroutes que possible. Vous pouvez choisir le niveau de virages inclus et aussi le degré de colline. Consultez les paramètres de colline et d’enroulement pour savoir comment le définir. Il y a une limite de 900 km sur les itinéraires planifiés avec |
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
Nom | Type | Description |
---|---|---|
carTrain |
string |
Sections de l’itinéraire qui sont des voitures ou des trains. |
carpool |
string |
Sections de l’itinéraire qui nécessitent l’utilisation de voies de covoiturage (HOV/Véhicule à occupation élevée). |
country |
string |
Sections indiquant les pays/régions dans lesquels se trouve l’itinéraire. |
ferry |
string |
Sections de l’itinéraire qui sont des traversiers. |
motorway |
string |
Sections de l’itinéraire qui sont des autoroutes. |
pedestrian |
string |
Sections de l’itinéraire qui ne conviennent qu’aux piétons. |
tollRoad |
string |
Sections de l’itinéraire qui nécessitent le paiement d’un péage. |
tollVignette |
string |
Sections de l’itinéraire qui nécessitent la présence d’une vignette de péage. |
traffic |
string |
Sections de l’itinéraire qui contiennent des informations sur le trafic. |
travelMode |
string |
Sections par rapport au paramètre |
tunnel |
string |
Sections de l’itinéraire qui sont des tunnels. |
urban |
string |
Sections de l’itinéraire situées dans des zones urbaines. |
SimpleCategory
Type de l’incident. Actuellement, il peut s’agir de JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ».
Nom | Type | Description |
---|---|---|
JAM |
string |
Embouteillage. |
OTHER |
string |
Autre. |
ROAD_CLOSURE |
string |
Fermeture de la route. |
ROAD_WORK |
string |
Travaux routiers. |
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.
Nom | Type | Description |
---|---|---|
bicycle |
string |
Les itinéraires retournés sont optimisés pour les vélos, y compris l’utilisation de pistes cyclables. |
bus |
string |
Les itinéraires retournés sont optimisés pour les autobus, y compris l’utilisation de voies réservées aux autobus. Fonctionnalité BÊTA. |
car |
string |
Les itinéraires retournés sont optimisés pour les voitures. |
motorcycle |
string |
Les itinéraires retournés sont optimisés pour les motocyclettes. Fonctionnalité BÊTA. |
pedestrian |
string |
Les itinéraires retournés sont optimisés pour les piétons, y compris l’utilisation des trottoirs. |
taxi |
string |
Les itinéraires retournés sont optimisés pour les taxis. Fonctionnalité BÊTA. |
truck |
string |
Les itinéraires retournés sont optimisés pour les véhicules commerciaux, comme pour les camions. |
van |
string |
Les itinéraires retournés sont optimisés pour les fourgonnettes. Fonctionnalité BÊTA. |
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.
Nom | Type | Description |
---|---|---|
combustion |
string |
Moteur à combustion interne. |
electric |
string |
Moteur électrique. |
VehicleLoadType
Types de cargaisons qui peuvent être classées comme des matières dangereuses et interdites à 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/régions. Les valeurs commençant par USHazmat sont destinées au routage des États-Unis, tandis que otherHazmat doit être utilisé 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.
Nom | Type | Description |
---|---|---|
USHazmatClass1 |
string |
Explosifs |
USHazmatClass2 |
string |
Gaz compressé |
USHazmatClass3 |
string |
Liquides inflammables |
USHazmatClass4 |
string |
Matières solides inflammables |
USHazmatClass5 |
string |
Oxydants |
USHazmatClass6 |
string |
Poisons |
USHazmatClass7 |
string |
Matières radioactives |
USHazmatClass8 |
string |
Substances corrosives |
USHazmatClass9 |
string |
Divers |
otherHazmatExplosive |
string |
Explosifs |
otherHazmatGeneral |
string |
Divers |
otherHazmatHarmfulToWater |
string |
Nocif pour l’eau |
WindingnessLevel
Niveau de virages pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec routeType
=thrilling.
Nom | Type | Description |
---|---|---|
high |
string |
high |
low |
string |
low |
normal |
string |
normal |