Partager via

Route - Post Route Matrix Sync

  • Référence
Service:
Maps
Version d'API:
1.0

Permet d’obtenir une matrice d’itinéraire montrant le temps de trajet et la distance pour toutes les paires possibles dans une liste d’origines et de destinations, à l’aide d’une requête synchrone.

L’API Post Route Matrix Sync est une requête HTTP POST qui permet le calcul d’une matrice de résumés d’itinéraires pour un ensemble d’itinéraires définis par les emplacements d’origine et de destination à l’aide d’une seule requête synchrone (synchronisation). Pour effectuer une requête asynchrone (asynchrone), consultez matrice de post-routage. Pour chaque origine donnée, le service calcule le coût du routage de cette origine vers chaque destination donnée. L’ensemble d’origines et l’ensemble de destinations peuvent être considérés comme les en-têtes de colonne et de ligne d’une table et chaque cellule du tableau contient les coûts de routage de l’origine vers la destination de cette cellule. Par exemple, supposons qu’une entreprise de livraison alimentaire a 20 chauffeurs et qu’elle doit trouver le chauffeur le plus proche pour récupérer la livraison du restaurant. Pour résoudre ce cas d’usage, ils peuvent appeler l’API Matrix Route.

Pour chaque itinéraire, les temps de trajet et les distances sont retournés. Vous pouvez utiliser les coûts calculés pour déterminer les itinéraires détaillés à calculer à l’aide de l’API Route Directions.

La taille maximale d’une matrice pour la requête asynchrone est 700 et pour la demande de synchronisation, elle est 100 (le nombre d’origines multiplié par le nombre de destinations).

Envoyer une demande de matrice de routage synchrone

Si votre scénario nécessite des requêtes synchrones et que la taille maximale de la matrice est inférieure ou égale à 100, vous souhaiterez peut-être effectuer une requête synchrone. La taille maximale d’une matrice pour cette API est 100 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, les exemples de dimensions de matrice possibles sont : 10x10, 6x8, 9x8 (il n’est pas nécessaire d’être carré).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Envoyer une demande de matrice de routage asynchrone

L’API asynchrone convient au traitement de gros volumes de demandes de routage relativement complexes. Lorsque vous effectuez une requête à l’aide d’une requête asynchrone, par défaut, le service retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. Si waitForResults paramètre dans la requête a la valeur true, l’utilisateur obtient une réponse 200 si la requête est terminée sous 120 secondes.

La taille maximale d’une matrice pour cette API est 700 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, des exemples de dimensions de matrice possibles sont : 50x10, 10x10, 28x25. 10x70 (il n’a pas besoin d’être carré).

Les réponses asynchrones sont stockées pendant 24 heures. L’URL de redirection retourne une réponse 404 si elle est utilisée après la période d’expiration.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Voici une séquence classique d’opérations asynchrones :

  1. Le client envoie une requête POST de matrice de routage à Azure Maps

  2. Le serveur répond avec l’une des options suivantes :

    HTTP 202 Accepted : la demande de matrice de routage a été acceptée.

    HTTP Error : une erreur s’est produite lors du traitement de votre demande de matrice de routage. Il peut s’agir d’une demande incorrecte 400 ou d’un autre code d’état d’erreur.

  3. Si la demande Matrix Route a été acceptée avec succès, l’en-tête Location dans la réponse contient l’URL pour télécharger les résultats de la demande. Cet URI d’état se présente comme suit :

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Le client émet une requête GET sur l’URL de téléchargement obtenue à l’étape 3 pour télécharger les résultats

Télécharger les résultats de synchronisation

Lorsque vous effectuez une requête POST pour l’API Route Matrix Sync, le service retourne le code de réponse 200 pour une requête réussie et un tableau de réponses. Le corps de la réponse contiendra les données et il n’y aura aucune possibilité de récupérer les résultats ultérieurement.

Télécharger les résultats asynchrones

Lorsqu’une demande émet une réponse 202 Accepted, la demande est traitée à l’aide de notre pipeline asynchrone. Vous recevrez une URL pour vérifier la progression de votre demande asynchrone dans l’en-tête d’emplacement de la réponse. Cet URI d’état se présente comme suit :

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L’URL fournie par l’en-tête d’emplacement retourne les réponses suivantes lorsqu’une demande de GET est émise.

HTTP 202 Accepted : la demande de matrice a été acceptée, mais elle est toujours traitée. Réessayez dans un certain temps.

HTTP 200 OK - Requête de matrice traitée avec succès. Le corps de la réponse contient tous les résultats.

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0
Avec des paramètres facultatifs: 
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

Paramètres URI

Nom Dans Obligatoire Type Description
format
 path True

JsonFormat

Format souhaité de la réponse. Seul json format est pris en charge.
api-version
 query True

string

Numéro de version de l’API Azure Maps.
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.
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.
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é.
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.
hilliness
 query

InclineLevel

Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.
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.
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.
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.
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.
waitForResults
 query

boolean

Boolean pour indiquer s’il faut exécuter la requête de façon synchrone. Si la valeur est true, l’utilisateur obtient une réponse 200 si la demande est terminée sous 120 secondes. Sinon, l’utilisateur obtient immédiatement une réponse 202. Pour plus d’informations sur la réponse 202, reportez-vous à la description de l’API. pris en charge uniquement pour lesde requête asynchrone .
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.

Corps de la demande

Nom Type Description
destinations

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.
origins

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.

Réponses

Nom Type Description
200 OK

RouteMatrixResult

Requête de matrice traitée avec succès. Le corps de la réponse contient tous les résultats.
Other Status Codes

ErrorResponse

Délai d’expiration : la requête a pris plus de temps que la durée maximale définie dans l’API.
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.

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 matrix request result synchronously

Exemple de requête

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Exemple de réponse

Code d’état:
200 
{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}
Code d’état:
408 
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Définitions

Nom Description
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é.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.
InclineLevel

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

Format souhaité de la réponse. Seul json format est pris en charge.
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.
RouteLegSummary

Objet de synthèse pour la section route.
RouteMatrix

Objet de résultat de matrice
RouteMatrixQuery

Objet avec une matrice de coordonnées.
RouteMatrixResult

Cet objet est retourné à partir d’un appel de matrice de routage réussi. Par exemple, si 2 origines et 3 destinations sont fournies, il y a 2 tableaux avec 3 éléments dans chacun d’eux. Le contenu de chaque élément dépend des options fournies dans la requête.
RouteMatrixResultResponse

Objet réponse de la cellule active dans la matrice d’entrée.
RouteMatrixSummary

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

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.

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.

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.

Nom Type Description
coordinates

number[]

Coordonnées de la géométrie GeoJson MultiPoint.
type string:

MultiPoint

Spécifie le type GeoJSON. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

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

JsonFormat

Format souhaité de la réponse. Seul json format est pris en charge.

Nom Type Description
json

string

le format d’échange de données JavaScript Object Notation

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

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.

RouteMatrix

Objet de résultat de matrice

Nom Type Description
response

RouteMatrixResultResponse

Objet réponse de la cellule active dans la matrice d’entrée.
statusCode

integer

Propriété StatusCode pour la cellule active dans la matrice d’entrée.

RouteMatrixQuery

Objet avec une matrice de coordonnées.

Nom Type Description
destinations

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.
origins

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.

RouteMatrixResult

Cet objet est retourné à partir d’un appel de matrice de routage réussi. Par exemple, si 2 origines et 3 destinations sont fournies, il y a 2 tableaux avec 3 éléments dans chacun d’eux. Le contenu de chaque élément dépend des options fournies dans la requête.

Nom Type Description
formatVersion

string

Format Version, propriété
matrix

RouteMatrix[]

Résultats sous la forme d’un tableau 2 dimensions de résumés d’itinéraires.
summary

RouteMatrixSummary

Objet Summary

RouteMatrixResultResponse

Objet réponse de la cellule active dans la matrice d’entrée.

Nom Type Description
routeSummary

RouteLegSummary

Objet de synthèse pour la section route.

RouteMatrixSummary

Objet Summary

Nom Type Description
successfulRoutes

integer

Nombre d’itinéraires réussis dans la réponse.
totalRoutes

integer

Nombre total d’itinéraires demandés. Nombre de cellules dans la matrice d’entrée.

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.

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.

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