Route - Get Route Range

Référence

Service:: Maps

API Version:: 1.0

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

L’API Get Route Range (Isochrone) est une requête HTTP GET qui calcule un ensemble d’emplacements qui peuvent ê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 dans le sens inverse des aiguilles d’une montre, ainsi que dans le centre de polygone précis qui a été le résultat du point d’origine.

Le polygone retourné peut être utilisé pour un traitement ultérieur, par exemple Recherche Inside Geometry pour rechercher des POINTS dans l’isochrone fourni.

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

With optional parameters:

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	Spécifie l’efficacité de la conversion de l’énergie chimique stockée dans le carburant en énergie cinétique lorsque le véhicule accélère (c’est-à-dire, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide du carburantEnergyDensityInMJoulesPerLiter. Doit être associé à decelerationEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/décélérationEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,33, pour le modèle électrique : 0,66
auxiliaryPowerInkW	query		number double	Spécifie la quantité d’énergie consommée pour le maintien en puissance des systèmes auxiliaires, en kilowatts (kW). Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc. Valeurs sensibles : 1.7
auxiliaryPowerInLitersPerHour	query		number double	Spécifie la quantité de carburant consommée pour le maintien des systèmes auxiliaires du véhicule, en litres par heure. Il peut être utilisé pour spécifier la consommation due à des appareils et des systèmes tels que les systèmes de climatisation, la radio, le chauffage, etc. Valeurs sensibles : 0,2
avoid	query		RouteAvoidType[]	Spécifie un élément que le calcul de la route doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une seule demande, par exemple, « &avoid=autoroutes&avoid=tollRoads&avoid=ferries ». Dans les demandes de plage de routage, la valeur alreadyUsedRoads ne doit pas être utilisée.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Spécifie le composant dépendant de la vitesse de consommation. Fourni sous la forme d’une liste non triée de paires vitesse/débit de consommation. La liste définit des points sur une courbe de consommation. Les taux de consommation pour les vitesses qui ne figurent pas dans la liste sont les suivants : par interpolation linéaire, si la vitesse donnée se situe 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 ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire. La consommation spécifiée pour la plus grande vitesse doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs. De même, les valeurs de consommation spécifiées pour les deux plus petites vitesses de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse inférieure. La plage valide pour les valeurs de consommation (exprimées en kWh/100 km) est comprise entre 0,01 et 100000.0. Valeurs sensibles : 50,8.2 :130,21.3 Ce paramètre est requis pour le modèle de consommation électrique.
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 sont les suivants : par interpolation linéaire, si la vitesse donnée se situe 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 ne peut pas contenir de points en double pour la même vitesse. S’il ne contient qu’un seul point, le taux de consommation de ce point est utilisé sans traitement supplémentaire. La consommation spécifiée pour la plus grande vitesse doit être supérieure ou égale à celle de l’avant-dernière vitesse la plus grande. Cela garantit que l’extrapolation n’entraîne pas de taux de consommation négatifs. De même, les valeurs de consommation spécifiées pour les deux plus petites vitesses de la liste ne peuvent pas conduire à un taux de consommation négatif pour une vitesse inférieure. La plage valide pour les valeurs de consommation (exprimées en l/100 km) est comprise entre 0,01 et 100000,0. Valeurs sensibles : 50,6.3 :130,11.5 Remarque : Ce paramètre est requis pour le modèle de consommation de combustion.
currentChargeInkWh	query		number double	Spécifie l’alimentation électrique actuelle en kilowattheures (kWh). Ce paramètre coexiste avec le paramètre maxChargeInkWh . La plage de valeurs autorisées est comprise entre 0,0 et maxChargeInkWh. Valeurs sensibles : 43
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 ralentit (c’est-à-dire, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide du carburantEnergyDensityInMJoulesPerLiter. Doit être associé à accelerationEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/accelerationEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,83, pour le modèle électrique : 0,91
departAt	query		string date-time	Date et heure de départ du point d’origine mis en forme sous la forme d’une `dateTime` valeur telle que définie dans la section 5.6 de la RFC 3339, 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 `departAt` paramètre ne peut pas être utilisé conjointement avec `arriveAt`.
distanceBudgetInMeters	query		number double	Budget de distance en compteurs qui détermine la portée maximale qui peut être parcourue à l’aide de la distance de conduite. Le modèle de consommation affecte uniquement la plage lorsque routeType est écologique. Un seul budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
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 de l’élévation (c’est-à-dire, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved est obtenu en convertissant le carburant économisé (non consommé) en énergie à l’aide du carburantEnergyDensityInMJoulesPerLiter. Doit être associé à uphillEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/uphillEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,51, pour le modèle électrique : 0,73
energyBudgetInkWh	query		number double	Budget d’énergie électrique en kilowattheures (kWh) qui détermine la plage maximale qui peut être parcourue à l’aide du modèle de consommation électrique spécifié. Quand energyBudgetInkWh est utilisé, il est obligatoire de spécifier un modèle de consommation électrique détaillé. Un seul budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec ou distanceBudgetInMeters) doit être utilisé.
fuelBudgetInLiters	query		number double	Budget de 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 seul budget (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égajoules (MJ). Il est utilisé conjointement avec les paramètres *Efficacité pour les conversions entre l’énergie économisée ou consommée et le carburant. Par exemple, la densité énergétique est de 34,2 MJ/l pour l’essence et de 35,8 MJ/l pour le diesel. Ce paramètre est obligatoire si un paramètre *Efficiency est défini. Valeurs sensibles : 34.2
hilliness	query		InclineLevel	Degré de colline pour un itinéraire palpitant. Ce paramètre peut uniquement être utilisé conjointement avec `routeType`=thrilling.
maxChargeInkWh	query		number double	Spécifie la quantité maximale d’énergie électrique en kWh qui peut être stockée dans la batterie du véhicule. Ce paramètre coexiste avec le paramètre currentChargeInkWh . La valeur minimale doit être supérieure ou égale à currentChargeInkWh. Valeurs sensibles : 85
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 écologique. Un seul budget (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 la circulation soient ignorées pendant le routage, l’effet du trafic historique sur la vitesse effective des routes est toujours incorporé.
travelMode	query		TravelMode	Mode de déplacement pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’ensemble de l’itinéraire. Si le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse pour cette section sera « autre ». Notez que les modes de voyage bus, moto, taxi et fourgon sont des fonctionnalités BETA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.
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 en élévation (par exemple, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed est obtenu en convertissant le carburant consommé en énergie chimique à l’aide du carburantEnergyDensityInMJoulesPerLiter. Doit être associé à downhillEfficiency. La plage de valeurs autorisées est comprise entre 0,0 et 1/downhillEfficiency. Valeurs sensibles : pour le modèle de combustion : 0,27, pour le modèle électrique : 0,74
vehicleAxleWeight	query		integer	Poids par essieu du véhicule en kg. La valeur 0 signifie que les restrictions de poids par essieu 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 à circuler 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 marchandises qui peuvent être classées comme des matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes US Hazmat 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays/régions. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.
vehicleMaxSpeed	query		integer	Vitesse maximale du véhicule en km/heure. La vitesse maximale dans le profil du véhicule est utilisée pour case activée si un véhicule est autorisé sur les autoroutes. La valeur 0 signifie qu’une valeur appropriée pour le véhicule sera déterminée et appliquée lors de la planification de l’itinéraire. Une valeur autre que zéro peut être remplacée pendant la planification de l’itinéraire. Par exemple, le flux de trafic actuel est de 60 km/heure. Si la vitesse maximale du véhicule est définie sur 50 km/heure, le moteur de routage considérera 60 km/heure, car c’est la situation actuelle. Si la vitesse maximale du véhicule est de 80 km/heure, mais que la circulation actuelle est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.
vehicleWeight	query		integer	Poids du véhicule en kilogrammes. Il est obligatoire si l’un des paramètres Efficacité est défini. Il doit être strictement positif lorsqu’il est utilisé dans le contexte du modèle de consommation. Les restrictions de poids sont prises en compte. Si aucun modèle de consommation* détaillé n’est spécifié et que la valeur de vehicleWeight est différente de zéro, les restrictions de poids sont prises en compte. Dans tous les autres cas, ce paramètre est ignoré. Valeurs sensibles : pour le modèle de combustion : 1600, pour le modèle électrique : 1900
vehicleWidth	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 un itinéraire palpitant. Ce paramètre peut uniquement être utilisé conjointement avec `routeType`=thrilling.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	RouteRangeResult	Ok
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é au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

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

Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous Create un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
In: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain 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, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
In: header

Exemples

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

Sample Request

HTTP

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

Sample Response

Status code:: 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 de 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 un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’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 quelque chose que le calcul de l’itinéraire doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une même demande, par exemple , '&avoid=highways&avoid=tollRoads&avoid=ferries'. Dans les demandes de plage de routes, la valeur alreadyUsedRoads ne doit pas être utilisée.
RouteRange	Plage accessible
RouteRangeResult	Cet objet est retourné à partir d’un appel de plage accessible par route réussi
RouteReport	Indique les paramètres effectifs utilisés dans l’appel actuel.
RouteType	Type d’itinéraire demandé.
TravelMode	Mode de déplacement pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’ensemble de l’itinéraire. Si le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse pour cette section sera « other ». Notez que les modes de voyage bus, moto, taxi et fourgonnette sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.
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 qui peuvent être classées comme des matières dangereuses et interdites à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes US Hazmat 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. Les valeurs commençant par USHazmat sont destinées au routage des États-Unis, tandis que otherHazmat doit être utilisé pour tous les autres pays/régions. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.
WindingnessLevel	Niveau de virages pour un itinéraire palpitant. Ce paramètre ne peut être utilisé qu’avec `routeType`=thrilling.

EffectiveSetting

Paramètre ou données effectifs utilisés lors de l’appel de cette API de route.

Nom	Type	Description
key	string	Nom du paramètre utilisé.
value	string	Valeur du paramètre utilisé.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	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 error.

InclineLevel

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

Nom	Type	Description
high	string	high
low	string	low
normal	string	normal

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é

ResponseFormat

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

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript
xml	string	Langage de balisage extensible

RouteAvoidType

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

Nom	Type	Description
alreadyUsedRoads	string	Évite d’utiliser la même route plusieurs fois. Plus utile en conjonction avec `routeType`=palpitant.
borderCrossings	string	Évite les passages aux frontières dans le calcul de l’itinéraire.
carpools	string	Évite les itinéraires qui nécessitent l’utilisation de voies de covoiturage (HOV/High Occupationy Vehicle).
ferries	string	Évite les traversiers
motorways	string	Évite les autoroutes
tollRoads	string	Évite les routes à péage.
unpavedRoads	string	Évite les routes non pavées

RouteRange

Plage accessible

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

RouteRangeResult

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

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

RouteReport

Indique 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 de route.

RouteType

Type d’itinéraire demandé.

Nom	Type	Description
eco	string	Un itinéraire équilibré par l’économie et la vitesse.
fastest	string	L’itinéraire le plus rapide.
shortest	string	Itinéraire le plus court par distance.
thrilling	string	Comprend des routes intéressantes ou difficiles et utilise aussi peu d’autoroutes que possible. Vous pouvez choisir le niveau de virages inclus et aussi le degré de colline. Consultez les paramètres de colline et d’enroulement pour savoir comment le définir. Il y a une limite de 900 km sur les itinéraires planifiés avec `routeType`=palpitant

TravelMode

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

Nom	Type	Description
bus	string	Les itinéraires retournés sont optimisés pour les autobus, y compris l’utilisation de voies réservées aux autobus. Fonctionnalité BÊTA.
car	string	Les itinéraires retournés sont optimisés pour les voitures.
motorcycle	string	Les itinéraires retournés sont optimisés pour les motocyclettes. Fonctionnalité BÊTA.
taxi	string	Les itinéraires retournés sont optimisés pour les taxis. Fonctionnalité BÊTA.
truck	string	Les itinéraires retournés sont optimisés pour les véhicules commerciaux, comme pour les camions.
van	string	Les itinéraires retournés sont optimisés pour les fourgonnettes. Fonctionnalité BÊTA.

VehicleEngineType

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

Nom	Type	Description
combustion	string	Moteur à combustion interne.
electric	string	Moteur électrique.

VehicleLoadType

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

Nom	Type	Description
USHazmatClass1	string	Explosifs
USHazmatClass2	string	Gaz compressé
USHazmatClass3	string	Liquides inflammables
USHazmatClass4	string	Matières solides inflammables
USHazmatClass5	string	Oxydants
USHazmatClass6	string	Poisons
USHazmatClass7	string	Matières radioactives
USHazmatClass8	string	Substances corrosives
USHazmatClass9	string	Divers
otherHazmatExplosive	string	Explosifs
otherHazmatGeneral	string	Divers
otherHazmatHarmfulToWater	string	Nocif pour l’eau

WindingnessLevel

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

Nom	Type	Description
high	string	high
low	string	low
normal	string	normal

Partager via