Share via

Route - Post Route Matrix Sync

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

Permet d’obtenir une matrice d’itinéraire montrant le temps de trajet et la distance de 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 de calculer 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 Post Route Matrix. 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 de la table contient les coûts de routage de l’origine à la destination pour cette cellule. Par exemple, supposons qu’une entreprise de livraison de nourriture a 20 chauffeurs et qu’elle doit trouver le chauffeur le plus proche pour récupérer la livraison au 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 Itinéraires.

La taille maximale d’une matrice pour une requête asynchrone est 700 et pour la demande de synchronisation, elle est de 100 (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 pouvez 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 est appropriée pour traiter de gros volumes de demandes de routage relativement complexes. Lorsque vous effectuez une demande à 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 le paramètre de la demande est défini sur true, l’utilisateur obtient une réponse 200 si la demande est terminée sous 120 secondes.

La taille maximale d’une matrice pour cette API est de 700 (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 14 jours. 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 opérations 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 requête incorrecte 400 ou de tout autre code d’erreur status.

  3. Si la demande Matrix Route a été acceptée avec succès, l’en-tête Emplacement dans la réponse contient l’URL permettant de télécharger les résultats de la demande. Cet URI status 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 de synchronisation de la matrice de routage, le service retourne le code de réponse 200 pour une demande réussie et un tableau de réponses. Le corps de la réponse contient les données et il n’est pas possible de récupérer les résultats ultérieurement.

Télécharger les résultats asynchrones

Lorsqu’une demande émet une 202 Accepted réponse, la demande est traitée à l’aide de notre pipeline asynchrone. Vous recevrez une URL pour case activée la progression de votre demande asynchrone dans l’en-tête d’emplacement de la réponse. Cet URI status 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 GET demande est émise.

HTTP 202 Accepted : la requête de matrice a été acceptée, mais elle est toujours en cours de traitement. 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
With optional parameters: 
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 le format json 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 en tant que dateTime valeur définie dans la section 5.6 de la RFC 3339, avec un décalage de fuseau horaire facultatif. Quand aucun décalage de fuseau horaire n’est 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 arriveAt paramètre ne peut pas être utilisé conjointement avec departAtou minDeviationTimeminDeviationDistance .
avoid
 query

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

ComputeTravelTime

Spécifie s’il faut retourner des temps de trajet supplémentaires à l’aide de différents types d’informations sur la circulation (aucun, historique, temps réel) ainsi que de la meilleure estimation par défaut du temps de trajet.
departAt
 query

string

date-time

Date et heure de départ du point d’origine mis en forme en tant que dateTime valeur définie dans la section 5.6 de la RFC 3339, avec un décalage de fuseau horaire facultatif. Lorsqu’aucun décalage de fuseau horaire n’est 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.
hilliness
 query

InclineLevel

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

RouteType

Type d’itinéraire demandé.
sectionType
 query

SectionType

Spécifie les types de section signalés dans la réponse d’itinéraire.

Par exemple, si sectionType = piéton, les sections qui conviennent uniquement aux piétons sont retournées. Plusieurs types peuvent être utilisés. Le sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur car
traffic
 query

boolean

Valeurs possibles :

  • true : tenez compte de toutes les informations de trafic disponibles pendant le routage
  • false : ignorer les données de trafic actuelles pendant le routage. Notez que bien que les données de trafic actuelles soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de circulation effectives 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 « 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.
vehicleAxleWeight
 query

integer

Poids par essieu du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.
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 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.
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 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 c’est la situation actuelle. Si la vitesse maximale du véhicule est de 80 km/heure, mais que le trafic actuel est de 60 km/heure, le moteur de routage utilisera à nouveau 60 km/heure.
vehicleWeight
 query

integer

Poids du véhicule en kilogrammes.
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 manière 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 obtiendra immédiatement une réponse 202. Pour plus d’informations sur la réponse 202, consultez la description de l’API. Pris en charge uniquement pour la requête asynchrone.
windingness
 query

WindingnessLevel

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

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie quel compte est 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.

Corps de la demande

Nom Type Description
destinations

GeoJsonMultiPoint

Type de géométrie valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .
origins

GeoJsonMultiPoint

Type de géométrie valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Réponses

Nom Type Description
200 OK

RouteMatrixResult

Requête matricielle 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 demande 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é 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.

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

Sample Request

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
      ]
    ]
  }
}

Sample Response

Status code:
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
  }
}
Status code:
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 trajet supplémentaires à l’aide de différents types d’informations sur la circulation (aucun, historique, temps réel) ainsi que de la meilleure estimation par défaut du temps de trajet.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .
InclineLevel

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

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

Objet récapitulative 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. Le contenu de chaque élément dépend des options fournies dans la requête.
RouteMatrixResultResponse

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

Objet Summary
RouteType

Type d’itinéraire demandé.
SectionType

Spécifie les types de section signalés dans la réponse d’itinéraire.

Par exemple, si sectionType = piéton, les sections qui conviennent uniquement aux piétons sont retournées. Plusieurs types peuvent être utilisés. Le sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur car
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.
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.

ComputeTravelTime

Spécifie s’il faut retourner des temps de trajet supplémentaires à l’aide de différents types d’informations sur la circulation (aucun, historique, temps réel) ainsi que de la meilleure estimation par défaut du temps de trajet.

Nom Type Description
all

string

Calcule les temps de trajet pour tous les types d’informations sur le trafic et spécifie tous les résultats dans les champs noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds et liveTrafficIncidentsTravelTimeInSeconds inclus dans les résumés dans la réponse d’itinéraire.
none

string

Ne calcule pas les temps de trajet supplémentaires.

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 d’erreur.

GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Coordonnées de la GeoJson MultiPoint géométrie.
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 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

JsonFormat

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

Nom Type Description
json

string

Format d’échange de données de notation d’objet JavaScript

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

RouteLegSummary

Objet récapitulative pour la section route.

Nom Type Description
arrivalTime

string

Heure d’arrivée estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC.
batteryConsumptionInkWh

number

Estimation de la consommation d’énergie électrique en kilowattheures (kWh) à l’aide du modèle de consommation électrique. Inclus si vehicleEngineType est défini sur électrique et constantSpeedConsumptionInkWhPerHundredkm est spécifié. La valeur de batteryConsumptionInkWh inclut l’énergie électrique récupérée et peut donc être négative (ce qui indique la prise d’énergie). Si maxChargeInkWh et currentChargeInkWh sont spécifiés, la récupération sera limitée pour garantir que le niveau de charge de la batterie ne dépasse jamais maxChargeInkWh. Si ni maxChargeInkWh ni currentChargeInkWh ne sont spécifiés, la récupération sans contrainte est supposée dans le calcul de la consommation.
departureTime

string

Heure de départ estimée de l’itinéraire ou de l’étape. L’heure est à l’échelle de temps UTC.
fuelConsumptionInLiters

number

Estimation de la consommation de carburant en litres à l’aide du modèle de consommation de combustion. Inclus si vehicleEngineType est défini sur combustion et constantSpeedConsumptionInLitersPerHundredkm est spécifié. La valeur n’est pas négative.
historicTrafficTravelTimeInSeconds

integer

Temps de trajet estimé calculé à l’aide de données de trafic historique dépendantes du temps. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête.
lengthInMeters

integer

Propriété Length In Meters
liveTrafficIncidentsTravelTimeInSeconds

integer

Temps de trajet estimé calculé à l’aide de données de vitesse en temps réel. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête.
noTrafficTravelTimeInSeconds

integer

Temps de trajet estimé calculé comme s’il n’y avait pas de retards sur l’itinéraire en raison des conditions de circulation (par exemple, la congestion). Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête.
trafficDelayInSeconds

integer

Délai estimé en secondes provoqué par le ou les incidents en temps réel en fonction des informations sur le trafic. Pour les itinéraires planifiés avec l’heure de départ à l’avenir, les retards sont toujours de 0. Pour retourner des temps de trajet supplémentaires à l’aide de différents types d’informations sur le trafic, le paramètre computeTravelTimeFor=all doit être ajouté.
travelTimeInSeconds

integer

Durée de trajet estimée en secondes, propriété qui inclut le retard dû au trafic en temps réel. Notez que même lorsque traffic=false travelTimeInSeconds inclut toujours le retard dû au trafic. Si DepartAt est à l’avenir, le temps de trajet est calculé à l’aide de données de trafic historique dépendantes du temps.

RouteMatrix

Objet de résultat de matrice

Nom Type Description
response

RouteMatrixResultResponse

Objet de 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 valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .
origins

GeoJsonMultiPoint

Type de géométrie valide GeoJSON MultiPoint . Pour plus d’informations, consultez 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. Le contenu de chaque élément dépend des options fournies dans la requête.

Nom Type Description
formatVersion

string

Propriété Format Version
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 de réponse de la cellule active dans la matrice d’entrée.

Nom Type Description
routeSummary

RouteLegSummary

Objet récapitulative 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

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

SectionType

Spécifie les types de section signalés dans la réponse d’itinéraire.

Par exemple, si sectionType = piéton, les sections qui conviennent uniquement aux piétons sont retournées. Plusieurs types peuvent être utilisés. Le sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur car

Nom Type Description
carTrain

string

Sections de l’itinéraire qui sont des voitures ou des trains.
carpool

string

Sections de l’itinéraire qui nécessitent l’utilisation de voies de covoiturage (HOV/Véhicule à occupation élevée).
country

string

Sections indiquant les pays/régions dans lesquels se trouve l’itinéraire.
ferry

string

Sections de l’itinéraire qui sont des traversiers.
motorway

string

Sections de l’itinéraire qui sont des autoroutes.
pedestrian

string

Sections de l’itinéraire qui ne conviennent qu’aux piétons.
tollRoad

string

Sections de l’itinéraire qui nécessitent le paiement d’un péage.
tollVignette

string

Sections de l’itinéraire qui nécessitent la présence d’une vignette de péage.
traffic

string

Sections de l’itinéraire qui contiennent des informations sur le trafic.
travelMode

string

Sections par rapport au paramètre travelModede requête .
tunnel

string

Sections de l’itinéraire qui sont des tunnels.
urban

string

Sections de l’itinéraire situées dans des zones urbaines.

TravelMode

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

Nom Type Description
bicycle

string

Les itinéraires retournés sont optimisés pour les vélos, y compris l’utilisation de pistes cyclables.
bus

string

Les itinéraires retournés sont optimisés pour les autobus, y compris l’utilisation de voies réservées aux autobus. Fonctionnalité BÊTA.
car

string

Les itinéraires retournés sont optimisés pour les voitures.
motorcycle

string

Les itinéraires retournés sont optimisés pour les motocyclettes. Fonctionnalité BÊTA.
pedestrian

string

Les itinéraires retournés sont optimisés pour les piétons, y compris l’utilisation des trottoirs.
taxi

string

Les itinéraires retournés sont optimisés pour les taxis. Fonctionnalité BÊTA.
truck

string

Les itinéraires retournés sont optimisés pour les véhicules commerciaux, comme pour les camions.
van

string

Les itinéraires retournés sont optimisés pour les fourgonnettes. Fonctionnalité BÊTA.

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