Route - Get Route Directions

Référence

Service:: Maps

Version d'API:: 1.0

Permet de calculer un itinéraire entre une origine et une destination spécifiées, en passant par les points de route spécifiés.

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 route si spécifiés. L’itinéraire prend en compte des facteurs tels que le trafic actuel et les vitesses de route typiques du jour demandé de la semaine et de l’heure de la journée.

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 route optimisé ou le tour par tour 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}

Avec des paramètres facultatifs:

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&sectionType={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}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	ResponseFormat	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é 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.
accelerationEfficiency	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 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	query		AlternativeRouteType	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	query		string date-time	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	query		number double	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	query		number double	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	query		RouteAvoidType[]	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	query		boolean	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	query		ComputeTravelTime	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	query		string	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	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 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	query		number double	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	query		number double	Spécifie l’approvisionnement actuel en carburant en litres. Valeurs sensibles : 55
decelerationEfficiency	query		number double	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	query		string date-time	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	query		number double	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	query		number double	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	query		InclineLevel	Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec `routeType`=thrilling.
instructionsType	query		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.
language	query		string	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	query		integer	Nombre d’itinéraires alternatifs souhaités à calculer. Valeur par défaut : 0, minimum : 0 et maximum : 5
maxChargeInkWh	query		number double	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	query		integer	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	query		integer	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é.
report	query		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	query		RouteRepresentationForBestOrder	Spécifie la représentation de l’ensemble d’itinéraires fournis en tant que réponse.
routeType	query		RouteType	Type d’itinéraire demandé.
sectionType	query		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	query		boolean	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	query		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	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 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	query		integer	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	query		boolean	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	query		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	query		integer	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	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.
vehicleLength	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.
vehicleLoadType	query		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	query		integer	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	query		integer	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	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		WindingnessLevel	Niveau de virages pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec `routeType`=thrilling.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à l’utilisation 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 de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	RouteDirections	D’ACCORD
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation 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 la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.

La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST. * L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES 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 aux régions d’utilisation pour le 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 mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Successfully retrieve a route between an origin and a destination

Exemple de requête

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Exemple de réponse

Code d’état:: 200

{
  "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
AlternativeRouteType	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.
ComputeTravelTime	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é.
DelayMagnitude	Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse de la 'API Get Traffic Incident Detail.
DrivingSide	Indique la main gauche et le côté droit à la conduite au point de la manœuvre.
EffectiveSetting	Paramètre ou données effectifs utilisés lors de l’appel de cette API route.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GuidanceInstructionType	Type de l’instruction, par exemple, tourner ou changer de forme routière.
GuidanceManeuver	Code identifiant la manœuvre.
InclineLevel	Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec `routeType`=thrilling.
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 quitter le rond-point.
LatLongPair	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 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.
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
ResponseSectionType	Types de section de la réponse de routage signalée
ResponseTravelMode	Mode de déplacement pour l’itinéraire calculé. La valeur est définie sur `other` si le mode de transport demandé n’est pas possible dans cette section
Route
RouteAvoidType	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.
RouteDirections	Cet objet est retourné à partir d’un appel Route Directions réussi
RouteGuidance	Contient des éléments associés à des conseils. Ce champ n’est présent que lorsque des conseils ont été demandés et sont disponibles.
RouteInstruction	Ensemble d’attributs décrivant une manœuvre, par exemple « Tourner à droite », « Garder à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ».
RouteInstructionGroup	Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée avec firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés pour obtenir des conseils (instructionType=text ou étiqueté), le groupe d’instructions a un message de synthèse retourné lorsqu’il est disponible.
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.
RouteLeg	Description d’une partie d’une route, composée d’une liste de points. Chaque point de route supplémentaire fourni dans la requête entraîne une étape supplémentaire dans l’itinéraire retourné.
RouteLegSummary	Objet de synthèse pour la section route.
RouteOptimizedWaypoint	Objet point de chemin optimisé.
RouteReport	Signale les paramètres effectifs utilisés dans l’appel actuel.
RouteRepresentationForBestOrder	Spécifie la représentation de l’ensemble d’itinéraires fournis en tant que 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`.
RouteSectionTec	Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC. Peut contenir effectCode et provoquer des éléments.
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.
RouteSummary	Objet Summary
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
SimpleCategory	Type de l’incident. Peut actuellement être JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Pour plus d’informations, consultez « tec ».
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.
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.
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.
WindingnessLevel	Niveau de virages pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec `routeType`=thrilling.

AlternativeRouteType

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.

Nom	Type	Description
anyRoute	string	Autorisez tout autre itinéraire à retourner, quelle que soit la façon dont il se compare à l’itinéraire de référence en termes d’optimalité.
betterRoute	string	Retournez un itinéraire alternatif uniquement s’il est préférable à l’itinéraire de référence en fonction des critères de planification donnés.

ComputeTravelTime

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é.

Nom	Type	Description
all	string	Calcule les temps de déplacement pour tous les types d’informations de trafic et spécifie tous les résultats dans les champs noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds et liveTrafficIncidentsTravelTimeInSeconds inclus dans les résumés de la réponse de l’itinéraire.
none	string	Ne calcule pas de temps de trajet supplémentaires.

DelayMagnitude

Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse de la 'API Get Traffic Incident Detail.

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 d’autres retards indéfinis.

DrivingSide

Indique la main gauche et le côté droit à la conduite 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 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émentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GuidanceInstructionType

Type de l’instruction, par exemple, tourner ou changer de forme routière.

Nom	Type	Description
DIRECTION_INFO	string	Informations de direction.
LOCATION_ARRIVAL	string	Emplacement d’arrivée.
LOCATION_DEPARTURE	string	Emplacement de départ.
LOCATION_WAYPOINT	string	Emplacement du point de chemin.
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 est à gauche.
ARRIVE_RIGHT	string	Tu es arrivé. Votre destination est à droite.
BEAR_LEFT	string	Ours à gauche.
BEAR_RIGHT	string	Portez à droite.
DEPART	string	Partir.
ENTER_FREEWAY	string	Prenez la voie libre.
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 U-turn.
MOTORWAY_EXIT_LEFT	string	Prenez la sortie gauche.
MOTORWAY_EXIT_RIGHT	string	Prenez la sortie droite.
ROUNDABOUT_BACK	string	Tournez autour du rond-point.
ROUNDABOUT_CROSS	string	Traverser le rond-point.
ROUNDABOUT_LEFT	string	Au rond-point, prenez la sortie sur la gauche.
ROUNDABOUT_RIGHT	string	Au rond-point, prenez la sortie à droite.
SHARP_LEFT	string	Tournez vers la gauche forte.
SHARP_RIGHT	string	Tournez vers la droite.
STRAIGHT	string	Continuez tout droit.
SWITCH_MAIN_ROAD	string	Basculez vers la route principale.
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 U-turn.
TURN_LEFT	string	Tournez vers la gauche.
TURN_RIGHT	string	Tournez vers la droite.
WAYPOINT_LEFT	string	Vous avez atteint le point de route. C’est à gauche.
WAYPOINT_REACHED	string	Vous avez atteint le point de route.
WAYPOINT_RIGHT	string	Vous avez atteint le point de route. C’est sur la droite.

InclineLevel

Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

Nom	Type	Description
high	string	haut
low	string	bas
normal	string	normal

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 quitter le rond-point.

Nom	Type	Description
BIFURCATION	string	bifurcation
REGULAR	string	régulier
ROUNDABOUT	string	rond-point

LatLongPair

Emplacement représenté sous la forme d’une latitude et d’une longitude.

Nom	Type	Description
latitude	number	Latitude, propriété
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 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.

Nom	Type	Description
effectiveSettings	string	Signale les paramètres effectifs ou les données utilisées 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	le format d’échange de données JavaScript Object Notation
xml	string	le langage de balisage extensible

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 des voies de stationnement (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 l’itinéraire qui sont des ferries.
MOTORWAY	string	Sections de l’itinéraire qui sont des autoroutes.
PEDESTRIAN	string	Sections de la route qui ne conviennent 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 de trafic.
TRAVEL_MODE	string	Sections par rapport au paramètre de requête `travelMode`.
TUNNEL	string	Sections de l’itinéraire qui sont des tunnels.
URBAN	string	Sections de la route situées dans les zones urbaines.

ResponseTravelMode

Mode de déplacement pour l’itinéraire calculé. La valeur est définie sur other 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 vélos, y compris l’utilisation de voies cyclables.
bus	string	Les itinéraires retournés sont optimisés pour les bus, y compris l’utilisation des voies de bus uniquement. 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.
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 vans. Fonctionnalité BÊTA.

Route

Nom	Type	Description
guidance	RouteGuidance	Contient des éléments associés à des conseils. Ce champ n’est présent que lorsque des conseils ont été demandés et sont disponibles.
legs	RouteLeg[]	Tableau de jambes
sections	RouteSection[]	Tableau de sections
summary	RouteSummary	Objet Summary

RouteAvoidType

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.

Nom	Type	Description
alreadyUsedRoads	string	Évite d’utiliser la même route plusieurs fois. Plus utile conjointement avec `routeType`=thrilling.
borderCrossings	string	Évite les passages à la frontière dans le calcul de l’itinéraire.
carpools	string	Évite les itinéraires qui nécessitent l’utilisation des voies de stationnement (HOV/High Occupationy Vehicle).
ferries	string	Évite les ferrys
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 Route Directions réussi

Nom	Type	Description
formatVersion	string	Format Version, propriété
optimizedWaypoints	RouteOptimizedWaypoint[]	Séquence optimisée de points de route. Il affiche l’index de l’utilisateur fourni une séquence waypoint pour la liste d’origine et optimisée. Par exemple, une réponse : `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` 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 « premier, deuxième, troisième », tandis que l’optimise est « second, troisième, first ».
report	RouteReport	Signale les paramètres effectifs utilisés dans l’appel actuel.
routes	Route[]	Tableau d’itinéraires

RouteGuidance

Contient des éléments associés à des conseils. Ce champ n’est présent que lorsque des conseils ont été demandés et sont disponibles.

Nom	Type	Description
instructionGroups	RouteInstructionGroup[]	Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres.
instructions	RouteInstruction[]	Une liste d’instructions décrivant les manœuvres.

RouteInstruction

Ensemble d’attributs décrivant une manœuvre, par exemple « Tourner à droite », « Garder à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ».

Nom	Type	Description
combinedMessage	string	Message lisible par l’homme pour la manœuvre combinée avec le message de l’instruction suivante. Parfois, il est possible de combiner deux instructions successives en une seule instruction, ce qui facilite le suivi. Lorsque c’est le cas, l’indicateur possibleCombineWithNext sera vrai. Par exemple: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` L’indicateur possibleCombineWithNext sur l’instruction 10 est vrai. Cela indique aux clients des instructions codées qu’il peut être combiné avec l’instruction 11. Les instructions seront combinées automatiquement pour les clients demandant des conseils lisibles par l’homme. Le champ combinéMessage contient le message combiné : `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3 caractères code de pays ISO 3166-1 alpha-3. C’est-à-dire les États-Unis.
drivingSide	DrivingSide	Indique la main gauche et le côté droit à la conduite 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	GuidanceInstructionType	Type de l’instruction, par exemple, tourner ou changer de forme routière.
junctionType	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 quitter le rond-point.
maneuver	GuidanceManeuver	Code identifiant la manœuvre.
message	string	Un message lisible par l’homme pour la manœuvre.
point	LatLongPair	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 vers la droite ».
roadNumbers	string[]	Le ou les numéros de route des segments de route importants suivants après la manœuvre, ou de la ou des routes à suivre. Exemple : ["E34 », « N205"]
roundaboutExitNumber	integer	Cela indique quelle 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 qui doit être suivie.
stateCode	string	Sous-division (par exemple, état) du pays, représentée par la deuxième partie d’un code ISO 3166-2. Ceci n’est disponible que pour certains pays/régions comme les États-Unis, le Canada et le Mexique.
street	string	Nom de rue du prochain segment de route important après la manœuvre, ou de la rue qui devrait être suivie.
travelTimeInSeconds	integer	Durée de trajet estimée jusqu’au point correspondant à routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indique la direction d’une instruction. Si junctionType indique une instruction de tour : 180 = U-turn [-179, -1] = Tour gauche 0 = Droite sur (tour '0 degré') [1, 179] = Virage droit Si junctionType indique une instruction de bifurcation : <0 - conserver à gauche >0 - gardez à droite

RouteInstructionGroup

Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée avec firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés pour obtenir des conseils (instructionType=text ou étiqueté), le groupe d’instructions a un message de synthèse retourné lorsqu’il est disponible.

Nom	Type	Description
firstInstructionIndex	integer	Index de la première instruction dans les 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 pour obtenir des conseils (instructionType=text 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

Nom	Type	Description
coded	string	Retourne des données d’instruction brutes sans messages lisibles par l’homme.
tagged	string	Retourne des données d’instruction brutes avec des messages lisibles par l’homme étiquetés pour permettre la mise en forme. Un message lisible par l’homme est créé à partir d’éléments identifiés reproductibles. Ils sont étiquetés pour permettre aux applications clientes de les mettre en forme correctement. Les composants de message suivants sont marqués lorsque instructionsType=tagged : street, roadNumber, signpostText, exitNumber, rondExitNumber. Exemple de message intitulé « Tourner à gauche » : `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Retourne des données d’instructions brutes avec des messages lisibles par l’utilisateur en texte brut.

string

Retourne des données d’instruction brutes sans messages lisibles par l’homme.

tagged

string

Retourne des données d’instruction brutes avec des messages lisibles par l’homme étiquetés pour permettre la mise en forme. Un message lisible par l’homme est créé à partir d’éléments identifiés reproductibles. Ils sont étiquetés pour permettre aux applications clientes de les mettre en forme correctement. Les composants de message suivants sont marqués lorsque instructionsType=tagged : street, roadNumber, signpostText, exitNumber, rondExitNumber.

Exemple de message intitulé « Tourner à gauche » :

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

text

string

Retourne des données d’instructions brutes avec des messages lisibles par l’utilisateur en texte brut.

RouteLeg

Description d’une partie d’une route, composée d’une liste de points. Chaque point de route supplémentaire fourni dans la requête entraîne une étape supplémentaire dans l’itinéraire retourné.

Nom	Type	Description
points	LatLongPair[]	Tableau de points
summary	RouteLegSummary	Objet de synthèse pour la section route.

RouteLegSummary

Objet de synthèse pour la section route.

Nom	Type	Description
arrivalTime	string	Heure d’arrivée estimée pour l’itinéraire ou la jambe. L’heure est au format UTC.
batteryConsumptionInkWh	number	Consommation d’énergie électrique estimée en kWh (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 l’acquisition d’énergie). Si maxChargeInkWh et currentChargeInkWh sont spécifiés, la récupération est limitée pour s’assurer 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 non contrainte est supposée dans le calcul de la consommation.
departureTime	string	Heure de départ estimée pour l’itinéraire ou la jambe. L’heure est au format UTC.
fuelConsumptionInLiters	number	Consommation estimée 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 est non négative.
historicTrafficTravelTimeInSeconds	integer	Durée de déplacement estimée calculée à l’aide de données de trafic historique dépendantes du temps. Inclus uniquement si computeHotelTimeFor = tout est utilisé dans la requête.
lengthInMeters	integer	Length In Meters, propriété
liveTrafficIncidentsTravelTimeInSeconds	integer	Temps de voyage estimé calculé à l’aide de données de vitesse en temps réel. Inclus uniquement si computeHotelTimeFor = tout est utilisé dans la requête.
noTrafficTravelTimeInSeconds	integer	Estimation du temps de trajet calculé comme s’il n’y a pas de retards sur l’itinéraire en raison de conditions de circulation (par exemple, congestion). Inclus uniquement si computeHotelTimeFor = tout est utilisé dans la requête.
trafficDelayInSeconds	integer	Délai estimé en secondes provoqué par les incidents en temps réel en fonction des informations de trafic. Pour les itinéraires prévus avec l’heure de départ à l’avenir, les retards sont toujours 0. Pour retourner des temps de voyage supplémentaires à l’aide de différents types d’informations de trafic, le paramètre computeTravelTimeFor=all doit être ajouté.
travelTimeInSeconds	integer	Durée de voyage estimée en secondes qui inclut le délai en raison du trafic en temps réel. Notez que même lorsque traffic=false travelTimeInSeconds inclut toujours le délai en raison du 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 façon optimisée à partir du système.
providedIndex	integer	Index de point de chemin fourni par l’utilisateur.

RouteReport

Signale les paramètres effectifs utilisés dans l’appel actuel.

Nom	Type	Description
effectiveSettings	EffectiveSetting[]	Paramètres ou données effectifs utilisés lors de l’appel de cette API route.

RouteRepresentationForBestOrder

Spécifie la représentation de l’ensemble d’itinéraires fournis en tant que réponse.

Nom	Type	Description
none	string	Inclut uniquement les index waypoint optimisés, mais n’inclut pas la géométrie de routage dans la réponse. Cette valeur de paramètre ne peut être utilisée que conjointement avec computeBestOrder=true.
polyline	string	Inclut la géométrie de routage dans la réponse.
summaryOnly	string	Résumé en fonction de la polyligne, mais à l’exclusion des éléments de géométrie 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, endPointIndexet 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 (offset 0) dans l’itinéraire auquel cette section s’applique.
magnitudeOfDelay	DelayMagnitude	Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse de la 'API Get Traffic Incident Detail.
sectionType	ResponseSectionType	Types de section de la réponse de routage signalée
simpleCategory	SimpleCategory	Type de l’incident. Peut actuellement être JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Pour plus d’informations, consultez « tec ».
startPointIndex	integer	Index du premier point (offset 0) dans l’itinéraire auquel cette section s’applique.
tec	RouteSectionTec	Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC. Peut contenir effectCode et provoquer des éléments.
travelMode	ResponseTravelMode	Mode de déplacement pour l’itinéraire calculé. La valeur est définie sur `other` si le mode de transport demandé n’est pas possible dans cette section

RouteSectionTec

Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC. Peut contenir effectCode et provoquer des éléments.

Nom	Type	Description
causes	RouteSectionTecCause[]	Causes du tableau
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 les événements de trafic de code couleur 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	La principale cause de l’événement de trafic. Contient une valeur dans la table tec002 :CauseCode, telle que définie dans la norme TPEG2- TEC.
subCauseCode	integer	Sous-analyse de l’événement de trafic. Contient une valeur dans la table de sous-cause définie par le mainCauseCode, tel que 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 la jambe. L’heure est au format UTC.
departureTime	string	Heure de départ estimée pour l’itinéraire ou la jambe. L’heure est au format UTC.
lengthInMeters	integer	Length In Meters, propriété
trafficDelayInSeconds	integer	Délai estimé en secondes provoqué par les incidents en temps réel en fonction des informations de trafic. Pour les itinéraires prévus avec l’heure de départ à l’avenir, les retards sont toujours 0. Pour retourner des temps de voyage supplémentaires à l’aide de différents types d’informations de trafic, le paramètre computeTravelTimeFor=all doit être ajouté.
travelTimeInSeconds	integer	Durée de voyage estimée en secondes qui inclut le délai en raison du trafic en temps réel. Notez que même lorsque traffic=false travelTimeInSeconds inclut toujours le délai en raison du 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	Itinéraire le plus rapide.
shortest	string	Itinéraire le plus court par distance.
thrilling	string	Inclut des routes intéressantes ou difficiles et utilise autant d’autoroutes que possible. Vous pouvez choisir le niveau de tours inclus et aussi le degré de colline. Découvrez les paramètres de colline et d’enroulement pour savoir comment définir cela. Il y a une limite de 900 km sur les itinéraires prévus avec `routeType`=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

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 des voies de stationnement (HOV/High Occupationy Vehicle).
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 ferries.
motorway	string	Sections de l’itinéraire qui sont des autoroutes.
pedestrian	string	Sections de la route qui ne conviennent qu’aux piétons.
tollRoad	string	Sections de l’itinéraire qui nécessitent un péage à payer.
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 de trafic.
travelMode	string	Sections par rapport au paramètre de requête `travelMode`.
tunnel	string	Sections de l’itinéraire qui sont des tunnels.
urban	string	Sections de la route situées dans les zones urbaines.

SimpleCategory

Type de l’incident. Peut actuellement être JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. 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 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.

Nom	Type	Description
bicycle	string	Les itinéraires retournés sont optimisés pour les vélos, y compris l’utilisation de voies cyclables.
bus	string	Les itinéraires retournés sont optimisés pour les bus, y compris l’utilisation des voies de bus uniquement. 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 vans. 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 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.

Nom	Type	Description
USHazmatClass1	string	Explosifs
USHazmatClass2	string	Gaz compressé
USHazmatClass3	string	Liquides combustibles
USHazmatClass4	string	Solides insinsibles
USHazmatClass5	string	Oxydants
USHazmatClass6	string	Poisons
USHazmatClass7	string	Radioactif
USHazmatClass8	string	Corrosifs
USHazmatClass9	string	Divers
otherHazmatExplosive	string	Explosifs
otherHazmatGeneral	string	Divers
otherHazmatHarmfulToWater	string	Nuisible à l’eau

WindingnessLevel

Niveau de virages pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

Nom	Type	Description
high	string	haut
low	string	bas
normal	string	normal

Partager via

Route - Get Route Directions

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

subscription-key

SAS Token

Exemples

Successfully retrieve a route between an origin and a destination

Exemple de requête

Exemple de réponse

Définitions

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Ressources supplémentaires