Route - Get Route Range

Référence

Service:: Maps

Version d'API:: 1.0

Permet de créer une carte qui représente la zone accessible à partir d’un point donné dans un certain seuil en fonction du temps, de la distance ou de la capacité de carburant.

Remarque

la mise hors service Azure Maps Route v1

Le service azure Maps Route v1 est désormais déconseillé et sera mis hors service le 31/31/28. Pour éviter les interruptions de service, tous les appels au service Route v1 doivent être mis à jour pour utiliser Route v2025-01-01-01 service d'/31/28. Pour plus d’informations, consultez Migrer des API Azure Maps Route 1.0.

L’API Get Route Range (Isochrone) est une requête HTTP GET qui calcule un ensemble d’emplacements pouvant être atteints à partir du point d’origine en fonction du carburant, de l’énergie, du temps ou du budget de distance spécifié. Une limite de polygone (ou Isochrone) est retournée dans une orientation au sens inverse ainsi que le centre de polygones précis qui a été le résultat du point d’origine.

Le polygone retourné peut être utilisé pour un traitement supplémentaire, tel que Search Inside Geometry pour rechercher des POIs dans l’isochrone fourni.

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&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	number[]	Coordonnée à partir de laquelle le calcul de plage doit démarrer.
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	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
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.
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) minimum: 0 maximum: 1	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`.
distanceBudgetInMeters	query		number (double)	Budget de distance en mètres qui détermine la plage maximale qui peut être parcourue à l’aide de la distance de conduite. Le modèle de consommation affecte uniquement la plage lorsque routeType est éco. Un budget exactement (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	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
energyBudgetInkWh	query		number (double)	Budget de l’énergie électrique en kw heures (kWh) qui détermine la plage maximale qui peut être parcourue à l’aide du modèle de consommation électrique spécifié. Lorsque l’énergieBudgetInkWh est utilisée, il est obligatoire de spécifier un modèle de consommation électrique détaillé. Un budget exactement (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
fuelBudgetInLiters	query		number (double)	Budget carburant en litres qui détermine la plage maximale qui peut être parcourue à l’aide du modèle de consommation de combustion spécifié. Lorsque fuelBudgetInLiters est utilisé, il est obligatoire de spécifier un modèle de consommation de combustion détaillé. Un budget exactement (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
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.
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
routeType	query		RouteType	Type d’itinéraire demandé.
timeBudgetInSec	query		number (double)	Budget de temps en secondes qui détermine la plage maximale qui peut être parcourue à l’aide du temps de conduite. Le modèle de consommation affecte uniquement la plage lorsque routeType est éco. Un budget exactement (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
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) minimum: 0 maximum: 1	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.
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	RouteRangeResult	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.

Remarques

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 set of locations that can be reached from the origin point based on various conditions

Exemple de requête

HTTP

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Exemple de réponse

Code d’état:: 200

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

Définitions

Nom	Description
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
InclineLevel	Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec `routeType`=thrilling.
LatLongPair	Emplacement représenté sous la forme d’une latitude et d’une longitude.
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
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.
RouteRange	Plage accessible
RouteRangeResult	Cet objet est retourné à partir d’un appel de plage accessible par route réussi
RouteReport	Signale les paramètres effectifs utilisés dans l’appel actuel.
RouteType	Type d’itinéraire demandé.
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.

EffectiveSetting

Object

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

Object

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

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

InclineLevel

Énumération

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

Valeur	Description
high	haut
low	bas
normal	normal

LatLongPair

Object

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

Nom	Type	Description
latitude	number (double)	Latitude, propriété
longitude	number (double)	Longitude, propriété

ResponseFormat

Énumération

Format souhaité de la réponse. La valeur peut être json ou xml.

Valeur	Description
json	le format d’échange de données JavaScript Object Notation
xml	le langage de balisage extensible

RouteAvoidType

Énumération

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.

Valeur	Description
alreadyUsedRoads	Évite d’utiliser la même route plusieurs fois. Plus utile conjointement avec `routeType`=thrilling.
borderCrossings	Évite les passages à la frontière dans le calcul de l’itinéraire.
carpools	Évite les itinéraires qui nécessitent l’utilisation des voies de stationnement (HOV/High Occupationy Vehicle).
ferries	Évite les ferrys
motorways	Évite les autoroutes
tollRoads	Évite les routes à péage.
unpavedRoads	Évite les routes non pavées

RouteRange

Object

Plage accessible

Nom	Type	Description
boundary	LatLongPair[]	Limite de polygone de la plage accessible représentée sous la forme d’une liste de points.
center	LatLongPair	Point central de la plage accessible

RouteRangeResult

Object

Cet objet est retourné à partir d’un appel de plage accessible par route réussi

Nom	Type	Description
formatVersion	string	Format Version, propriété
reachableRange	RouteRange	Plage accessible
report	RouteReport	Signale les paramètres effectifs utilisés dans l’appel actuel.

RouteReport

Object

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.

RouteType

Énumération

Type d’itinéraire demandé.

Valeur	Description
eco	Un itinéraire équilibré par l’économie et la vitesse.
fastest	Itinéraire le plus rapide.
shortest	Itinéraire le plus court par distance.
thrilling	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

TravelMode

Énumération

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.

Valeur	Description
bus	Les itinéraires retournés sont optimisés pour les bus, y compris l’utilisation des voies de bus uniquement. Fonctionnalité BÊTA.
car	Les itinéraires retournés sont optimisés pour les voitures.
motorcycle	Les itinéraires retournés sont optimisés pour les motocyclettes. Fonctionnalité BÊTA.
taxi	Les itinéraires retournés sont optimisés pour les taxis. Fonctionnalité BÊTA.
truck	Les itinéraires retournés sont optimisés pour les véhicules commerciaux, comme pour les camions.
van	Les itinéraires retournés sont optimisés pour les vans. Fonctionnalité BÊTA.

VehicleEngineType

Énumération

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.

Valeur	Description
combustion	Moteur à combustion interne.
electric	Moteur électrique.

VehicleLoadType

Énumération

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.

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

WindingnessLevel

Énumération

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

Valeur	Description
high	haut
low	bas
normal	normal

Partager via

Route - Get Route Range

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Remarques

Étendues

subscription-key

SAS Token

Exemples

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Exemple de requête

Exemple de réponse

Définitions

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InclineLevel

LatLongPair

ResponseFormat

RouteAvoidType

RouteRange

RouteRangeResult

RouteReport

RouteType

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Ressources supplémentaires