Partager via

Route - Post Route Directions

Service:
Maps
Version d'API:
2025-01-01

Permet d’obtenir le meilleur itinéraire entre une origine et une destination pour les véhicules automobiles, les camions commerciaux et les itinéraires de marche.

L’API Route Directions est une requête HTTP POST qui retourne l’itinéraire idéal entre une origine et une destination pour l’automobile (conduite), les camions commerciaux et les itinéraires de marche. L’itinéraire passe par une série de points de route s’il est spécifié. Un point de route est un emplacement géographique défini par longitude et latitude utilisé à des fins de navigation. L’itinéraire considère des facteurs tels que le trafic actuel et les vitesses de route classiques le jour demandé de la semaine et de l’heure de la journée.

L’API retourne la distance, le temps de trajet estimé et une représentation de la géométrie de l’itinéraire. Des informations de routage supplémentaires telles qu’un ordre de point de route optimisé ou un tour par tour sont également disponibles, en fonction des paramètres utilisés.

Les itinéraires considèrent les lois locales, les dimensions du véhicule, le type de cargaison, la vitesse maximale, le pont et les hauteurs de tunnel pour calculer les itinéraires spécifiques du camion et éviter les manœuvres complexes et les routes difficiles. Tous les camions ne peuvent pas parcourir les mêmes itinéraires que d’autres véhicules en raison de certaines restrictions en fonction du profil de véhicule ou du type de cargaison. Par exemple, les autoroutes ont souvent des limites de vitesse distinctes pour les camions, certaines routes n’autorisent pas les camions avec des matières dangereuses ou dangereuses, et il peut y avoir une restriction de hauteur et de poids sur les ponts.

Jusqu’à 25 points de route et 10 viaWaypoints entre les deux points de route sont pris en charge pour les itinéraires de conduite et de marche. Chaque ensemble de points de route crée une étape d’itinéraire distincte. ViaWaypoints définissent le chemin d’itinéraire et peuvent être utilisés pour la création d’itinéraires via des emplacements spécifiques, mais ils ne créent pas de jambes d’itinéraire. Les itinéraires de camion prennent en charge jusqu’à 150 points de route, mais ne prennent pas en charge viaWaypoints.

Pour plus d’informations sur la disponibilité du routage dans les pays/régions, consultez couverture du routage Azure Maps.

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
 query True

string

Numéro de version de l’API Azure Maps.

En-tête de la demande

Media Types: "application/geo+json"

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. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.
Accept-Language

string

Langue dans laquelle les résultats de routage doivent être retournés.

Pour plus d’informations, consultez prise en charge de la localisation dans Azure Maps.

Corps de la demande

Media Types: "application/geo+json"

Nom Obligatoire Type Description
features True

InputWaypointFeaturesItem[]

Les itinéraires de conduite et de marche sont définis par un ensemble de points de route (arrêts) et viaWaypoints (emplacements intermédiaires que l’itinéraire doit traverser). Vous pouvez avoir un maximum de 25 points de route et un maximum de 10 viaWaypoints entre chaque ensemble de points de route. L’itinéraire de camion prend en charge jusqu’à 150 points de route et viaWaypoints ne sont pas pris en charge.

Un itinéraire doit avoir un minimum de 2 points de route et les points de début et de fin de l’itinéraire ne peuvent pas être viaWaypoints.

Les emplacements waypoint et viaWaypoint doivent être spécifiés en tant qu’objet de fonctionnalité GeoJSON Point valide, ainsi que pointIndex qui spécifie l’ordre des emplacements. For more information on the GeoJSON format, see RFC 7946.
type True

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.
arriveAt

string (date-time)

Date et heure d’arrivée au point de destination mis en forme sous forme de valeur dateTime définie par RFC 3339, section 5.6. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, l’heure UTC est supposée.

Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt.

Exemple : « arriveAt » : « 2023-06-01T09:30:00.000-07:00 »
avoid

AvoidEnum[]

Spécifie les restrictions que le calcul de l’itinéraire doit respecter lors de la détermination de l’itinéraire. Évitez de prendre en charge plusieurs valeurs dans une demande et n’est prise en charge que pour la conduite et le travelMode de camion.

Exemple : « avoid » : ["limitedAccessHighways », « tollRoads"]
departAt

string (date-time)

Date et heure de départ du point d’origine mis en forme comme valeur de dateTime définie par RFC 3339, section 5.6. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, l’heure UTC est supposée.

Si le departAt n’est pas défini, la valeur par défaut est l’heure actuelle.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"
heading

integer (int64)

minimum: 0
maximum: 359

Le titre directionnel initial du véhicule en degrés commençant à true Nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degrés, est de 90 degrés, le sud est de 180 degrés, l’ouest est de 270 degrés.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Nombre maximal d’itinéraires à retourner. Disponible pour les modes de conduite et de transport par camion.

Default: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

Spécifie le paramètre à utiliser pour optimiser l’itinéraire. S’il n’est pas défini, la valeur par défaut est « fastestWithoutTraffic » qui retourne l’itinéraire pour réduire le temps de trajet sans utiliser les informations de trafic actuelles.

Example: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

Récommandez les points de route à l’aide d’un algorithme heuristique rapide pour réduire le coût de routage spécifié avec le paramètre d’optimisation. L’origine et la destination sont exclues du point de route optimisé et leur position est considérée comme fixe. Les valeurs acceptables sont vraies ou false.
routeOutputOptions

RouteOutputOptionEnum[]

Incluez les informations de routage souhaitées à partir de la réponse. Par défaut, l’itinéraire est inclus dans la réponse.

Prend en charge plusieurs valeurs telles que « routeOutputOptions » : ["routePath », « itinerary"]
travelMode

TravelModeEnum

Mode de voyage pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « conduite » qui retourne l’itinéraire optimisé pour les voitures.

Note: Pour le camion travelMode, l’itinéraire du camion demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque l’itinéraire du camion n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ».

Example: "travelMode":"driving"
vehicleSpec

RouteDirectionVehicleSpec

Spécifie les attributs du véhicule tels que la taille, le poids, la vitesse maximale, le type de cargaison, etc. pour le routage des camions uniquement. Cela permet d’éviter les dégagements de pont faibles, les restrictions routières, les virages de droite difficiles pour fournir l’itinéraire optimisé des camions en fonction des spécifications du véhicule.

Note: uniquement pris en charge pour le travelMode de camion

Réponses

Nom Type Description
200 OK

RouteDirectionsResponse

OK

Media Types: "application/geo+json", "application/json"
Other Status Codes

MapsErrorResponse

Une erreur inattendue s’est produite.

Media Types: "application/geo+json", "application/json"

En-têtes

x-ms-error-code: string

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.

To implement scenarios, we recommend viewing authentication concepts. 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.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. Cela peut être acquis à partir de l’API de gestion Maps.
  • La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
  • Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
  • L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
  • Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

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

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

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

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Exemple de requête

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201399,
          47.608678
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 0,
        "pointType": "waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.20687,
          47.612002
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 1,
        "pointType": "viaWaypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201669,
          47.615076
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 2,
        "pointType": "waypoint"
      }
    }
  ],
  "optimizeRoute": "fastestWithTraffic",
  "routeOutputOptions": [
    "routePath"
  ],
  "maxRouteCount": 3,
  "travelMode": "driving"
}

Exemple de réponse

Code d’état:
200 
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.60868
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        },
        "order": {
          "inputIndex": 0
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.2016,
          47.61508
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 64
        },
        "order": {
          "inputIndex": 2
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.60868
            ],
            [
              -122.20148,
              47.60884
            ],
            [
              -122.20148,
              47.60906
            ],
            [
              -122.20148,
              47.60919
            ],
            [
              -122.20148,
              47.60953
            ],
            [
              -122.20148,
              47.60967
            ],
            [
              -122.20149,
              47.60997
            ],
            [
              -122.2015,
              47.61011
            ],
            [
              -122.2015,
              47.61019
            ],
            [
              -122.20192,
              47.61021
            ],
            [
              -122.20199,
              47.61021
            ],
            [
              -122.20252,
              47.61019
            ],
            [
              -122.20264,
              47.61018
            ],
            [
              -122.20271,
              47.61015
            ],
            [
              -122.20276,
              47.61015
            ],
            [
              -122.20281,
              47.61015
            ],
            [
              -122.20286,
              47.61015
            ],
            [
              -122.20329,
              47.61016
            ],
            [
              -122.20346,
              47.61016
            ],
            [
              -122.20414,
              47.61017
            ],
            [
              -122.20416,
              47.61057
            ],
            [
              -122.20418,
              47.61083
            ],
            [
              -122.20418,
              47.61092
            ],
            [
              -122.20419,
              47.61103
            ],
            [
              -122.20419,
              47.61121
            ],
            [
              -122.2042,
              47.61126
            ],
            [
              -122.20478,
              47.61127
            ],
            [
              -122.20555,
              47.61128
            ],
            [
              -122.20569,
              47.61128
            ],
            [
              -122.20596,
              47.61128
            ],
            [
              -122.20617,
              47.61127
            ],
            [
              -122.20624,
              47.61125
            ],
            [
              -122.2066,
              47.61126
            ],
            [
              -122.20669,
              47.61127
            ],
            [
              -122.20686,
              47.61129
            ],
            [
              -122.20687,
              47.61158
            ],
            [
              -122.20689,
              47.61187
            ],
            [
              -122.20691,
              47.61233
            ],
            [
              -122.20691,
              47.61247
            ],
            [
              -122.20694,
              47.61317
            ],
            [
              -122.20695,
              47.61342
            ],
            [
              -122.20696,
              47.61362
            ],
            [
              -122.20697,
              47.61384
            ],
            [
              -122.20683,
              47.61384
            ],
            [
              -122.20638,
              47.61384
            ],
            [
              -122.20612,
              47.61384
            ],
            [
              -122.20568,
              47.61383
            ],
            [
              -122.20559,
              47.6138
            ],
            [
              -122.20467,
              47.61379
            ],
            [
              -122.20443,
              47.61379
            ],
            [
              -122.20405,
              47.61379
            ],
            [
              -122.20325,
              47.6138
            ],
            [
              -122.203,
              47.6138
            ],
            [
              -122.20274,
              47.6138
            ],
            [
              -122.20241,
              47.61381
            ],
            [
              -122.20222,
              47.6138
            ],
            [
              -122.20202,
              47.6138
            ],
            [
              -122.20193,
              47.6138
            ],
            [
              -122.20181,
              47.61386
            ],
            [
              -122.20167,
              47.61386
            ],
            [
              -122.20155,
              47.61386
            ],
            [
              -122.20158,
              47.61464
            ],
            [
              -122.20159,
              47.61475
            ],
            [
              -122.2016,
              47.61503
            ],
            [
              -122.2016,
              47.61508
            ]
          ]
        ]
      },
      "properties": {
        "distanceInMeters": 1520,
        "durationInSeconds": 307,
        "departureAt": "2025-06-17T09:08:10+00:00",
        "arrivalAt": "2025-06-17T09:13:10+00:00",
        "durationTrafficInSeconds": 300,
        "trafficCongestion": "Medium",
        "type": "RoutePath",
        "legs": [
          {
            "distanceInMeters": 1520,
            "durationInSeconds": 307,
            "durationTrafficInSeconds": 300,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:13:10+00:00",
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                64
              ]
            }
          }
        ]
      },
      "bbox": [
        -122.20697,
        47.60868,
        -122.20147,
        47.61508
      ]
    }
  ],
  "alternativeRoutes": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.20147,
              47.60868
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 0
            },
            "order": {
              "inputIndex": 0
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.2016,
              47.61508
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 29
            },
            "order": {
              "inputIndex": 1
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": [
              [
                [
                  -122.20147,
                  47.60868
                ],
                [
                  -122.20148,
                  47.60884
                ],
                [
                  -122.20148,
                  47.60906
                ],
                [
                  -122.20148,
                  47.60919
                ],
                [
                  -122.20148,
                  47.60953
                ],
                [
                  -122.20148,
                  47.60967
                ],
                [
                  -122.20149,
                  47.60997
                ],
                [
                  -122.2015,
                  47.61011
                ],
                [
                  -122.2015,
                  47.61019
                ],
                [
                  -122.20151,
                  47.61072
                ],
                [
                  -122.20152,
                  47.61092
                ],
                [
                  -122.20152,
                  47.61097
                ],
                [
                  -122.20149,
                  47.611
                ],
                [
                  -122.20147,
                  47.61104
                ],
                [
                  -122.20145,
                  47.61117
                ],
                [
                  -122.20145,
                  47.61122
                ],
                [
                  -122.20145,
                  47.61126
                ],
                [
                  -122.20146,
                  47.61149
                ],
                [
                  -122.20147,
                  47.61166
                ],
                [
                  -122.20148,
                  47.61197
                ],
                [
                  -122.20148,
                  47.61203
                ],
                [
                  -122.2015,
                  47.61268
                ],
                [
                  -122.20151,
                  47.61289
                ],
                [
                  -122.20152,
                  47.61297
                ],
                [
                  -122.20153,
                  47.61338
                ],
                [
                  -122.20155,
                  47.61386
                ],
                [
                  -122.20158,
                  47.61464
                ],
                [
                  -122.20159,
                  47.61475
                ],
                [
                  -122.2016,
                  47.61503
                ],
                [
                  -122.2016,
                  47.61508
                ]
              ]
            ]
          },
          "properties": {
            "distanceInMeters": 713,
            "durationInSeconds": 92,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:09:40+00:00",
            "durationTrafficInSeconds": 90,
            "trafficCongestion": "Medium",
            "type": "RoutePath",
            "legs": [
              {
                "distanceInMeters": 713,
                "durationInSeconds": 92,
                "durationTrafficInSeconds": 90,
                "departureAt": "2025-06-17T09:08:10+00:00",
                "arrivalAt": "2025-06-17T09:09:40+00:00",
                "routePathRange": {
                  "legIndex": 0,
                  "range": [
                    0,
                    29
                  ]
                }
              }
            ]
          },
          "bbox": [
            -122.2016,
            47.60868,
            -122.20145,
            47.61508
          ]
        }
      ]
    }
  ]
}

Définitions

Nom Description
Address

Le district administratif et la région du pays pour les points de cheminement et les points de manœuvre sur l’itinéraire.
AdminDistrict

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
AdrTunnelRestrictionCodeEnum

Code de restriction du tunnel ADR. L’ADR est un accord européen concernant le transport international de marchandises dangereuses par route. Le code de restriction du tunnel ADR est utilisé pour déterminer si un véhicule est autorisé à traverser un tunnel avec des restrictions sur le transport de marchandises dangereuses.
AvoidEnum

Spécifie les restrictions que le calcul de l’itinéraire doit respecter lors de la détermination de l’itinéraire. Évitez de prendre en charge plusieurs valeurs dans une demande et n’est prise en charge que pour la conduite et le travelMode de camion.

Exemple : « avoid » : ["limitedAccessHighways », « tollRoads"]
CountryRegion

Représente un pays ou une région contenant des détails connexes.
DirectionsRequest

Cet objet est le corps de la requête.
DrivingSideEnum

Indique la main gauche et le côté droit à la conduite au point de la manœuvre.
FeatureCollection

GeoJSON FeatureCollection objet qui contient une liste de fonctionnalités. Pour plus d’informations, consultez RFC 7946, section 3.3.
FeaturesItem

Objet de fonctionnalité GeoJSON qui contient l’objet Geometry et les propriétés supplémentaires de l’itinéraire.
FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. For more information, see RFC 7946.
FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.
GeoJsonPoint

Type de géométrie GeoJSON Point valide. Please refer to RFC 7946 for details.
InputWaypointFeaturesItem

Spécifie le point de route d’entrée et viaWaypoint GeoJSON objet de fonctionnalité et des propriétés supplémentaires. For more information, see RFC 7946.
InputWaypointProperties

Spécifie les propriétés d’un point de route qui est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.
InputWaypointTypeEnum

Type Waypoint sur l’itinéraire. Il peut s’agir d’un arrêt ou d’un emplacement intermédiaire que l’itinéraire doit traverser.
Instruction

Description d’une manœuvre dans un ensemble de directions.
Leg

Informations sur une section d’un itinéraire entre deux points de route. Pour plus d’informations sur les champs contenus dans une étape d’itinéraire :
ManeuverPointProperties

Spécifie les instructions de conduite et les propriétés supplémentaires pour chaque point de manœuvre dans la jambe de route.
ManeuverTypeEnum

Type de manœuvre décrit dans cette collection détaillée. Le ManoeuvreType fournit des informations pour une partie de la manœuvre spécifiée par l’instruction correspondante. Par exemple, le type de manœuvre d’une instruction peut spécifier TurnLeftThenTurnRight, tandis que les éléments de détail associés peuvent fournir des détails spécifiques sur les manœuvres TurnLeft et TurnRight
MapsErrorDetail

Détail de l’erreur.
MapsErrorResponse

Réponse d’erreur courante pour les API Azure Maps pour retourner les détails d’erreur pour les opérations ayant échoué.
MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
MultiLineStringGeometry

Spécifie l’objet GeoJSON MultiLineString Geometry. For more information, see RFC 7946.
OptimizedWaypoint

Objet point de chemin optimisé.
Order

Séquence de visite des points de cheminement.
PointGeometry

Point d’origine passé en tant qu’objet Geometry GeoJSON valide, à partir duquel le polygone de plage doit être calculé. Please refer to RFC 7946 for details.

Note: l’API aligne le point d’origine demandé sur le réseau routier le plus proche et l’utilise pour le calcul de plage. Elle est retournée en tant que point de center dans la réponse.
RouteDirectionOptimizeRouteEnum

Spécifie le paramètre à utiliser pour optimiser l’itinéraire. S’il n’est pas défini, la valeur par défaut est « fastestWithoutTraffic » qui retourne l’itinéraire pour réduire le temps de trajet sans utiliser les informations de trafic actuelles.

Example: "optimizeRoute":"shortest"
RouteDirectionsResponse

Cet objet est retourné à partir d’un appel réussi.
RouteDirectionVehicleSpec

Spécifie les attributs du véhicule tels que la taille, le poids, la vitesse maximale, le type de cargaison, etc. pour le routage des camions uniquement. Cela permet d’éviter les dégagements de pont faibles, les restrictions routières, les virages de droite difficiles pour fournir l’itinéraire optimisé des camions en fonction des spécifications du véhicule.

ISNote: uniquement pris en charge pour le travelMode de camion.
RouteOutputOptionEnum

Incluez les informations de routage souhaitées à partir de la réponse. Par défaut, l’itinéraire est inclus dans la réponse.

Prend en charge plusieurs valeurs telles que « routeOutputOptions » : ["routePath », « itinerary"]
RoutePathPoint

Fait référence à l’index d’un point dans une jambe spécifique d’une route.
RoutePathProperties

Spécifie les propriétés qui décrivent le chemin d’accès de l’itinéraire dans la réponse.
RoutePathRange

Fait référence à la plage couverte par une étape spécifique d’un itinéraire ou d’un chemin d’accès.
RoutePathTravelModeEnum

Mode de déplacement pour le chemin d’itinéraire dans la réponse.
SideOfStreetEnum

Côté de la rue où la destination est trouvée en fonction du sens de l’arrivée. Ce champ s’applique uniquement au dernier point de manœuvre.
Step

Une jambe d’itinéraire contient des instructions de tour par tour. Une étape fait référence à une plage d’itinéraires entre deux manœuvres consécutives.
TrafficCongestionEnum

Niveau de congestion du trafic le long de la route. Note: uniquement pris en charge pour la conduite de travelMode
TravelModeEnum

Mode de voyage pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « conduite » qui retourne l’itinéraire optimisé pour les voitures.

Note: Pour le camion travelMode, l’itinéraire du camion demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque l’itinéraire du camion n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ».

Example: "travelMode":"driving"
VehicleLoadTypeEnum

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. 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. vehicleLoadType prend en charge plusieurs valeurs dans une requête.
WaypointProperties

Spécifie les propriétés d’un point de route qui est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.

Address

Object

Le district administratif et la région du pays pour les points de cheminement et les points de manœuvre sur l’itinéraire.

Nom Type Description
adminDistricts

AdminDistrict[]

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
countryRegion

CountryRegion

Représente un pays ou une région contenant des détails connexes.

AdminDistrict

Object

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.

Nom Type Description
shortName

string

Nom court du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir d’un nom court d’état tel que WA. Ceci n’est disponible que pour les États-Unis, le Canada et le Mexique.

AdrTunnelRestrictionCodeEnum

Énumération

Code de restriction du tunnel ADR. L’ADR est un accord européen concernant le transport international de marchandises dangereuses par route. Le code de restriction du tunnel ADR est utilisé pour déterminer si un véhicule est autorisé à traverser un tunnel avec des restrictions sur le transport de marchandises dangereuses.

Valeur Description
B

Les véhicules avec le code B sont limités aux routes avec les catégories de tunnel ADR B, C, D et E.
C

Les véhicules avec le code C sont limités aux routes avec les catégories de tunnel ADR C, D et E
D

Les véhicules avec le code D sont limités aux routes avec les catégories de tunnel ADR D et E.
E

Les véhicules avec le code E sont limités aux routes avec la catégorie de tunnel ADR E.

AvoidEnum

Énumération

Spécifie les restrictions que le calcul de l’itinéraire doit respecter lors de la détermination de l’itinéraire. Évitez de prendre en charge plusieurs valeurs dans une demande et n’est prise en charge que pour la conduite et le travelMode de camion.

Exemple : « avoid » : ["limitedAccessHighways », « tollRoads"]

Valeur Description
limitedAccessHighways

Évite l’utilisation d’autoroutes à accès limité dans l’itinéraire.
tollRoads

Évite l’utilisation des routes de péage dans l’itinéraire.
ferries

Évite l’utilisation de ferrys en route.
tunnels

Évite l’utilisation de tunnels dans l’itinéraire.
borderCrossings

Évite de traverser les frontières du pays en route.
lowEmissionZones

Évite les zones à faible émission dans l’itinéraire.
unpavedRoads

Évite les routes non pavées dans l’itinéraire.

CountryRegion

Object

Représente un pays ou une région contenant des détails connexes.

Nom Type Description
ISO

string

ISO de pays/région représente un code ISO 3166-1 Alpha-2 région/pays
name

string

nom du pays/de la région

DirectionsRequest

Object

Cet objet est le corps de la requête.

Nom Type Valeur par défaut Description
arriveAt

string (date-time)

Date et heure d’arrivée au point de destination mis en forme sous forme de valeur dateTime définie par RFC 3339, section 5.6. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, l’heure UTC est supposée.

Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt.

Exemple : « arriveAt » : « 2023-06-01T09:30:00.000-07:00 »
avoid

AvoidEnum[]

Spécifie les restrictions que le calcul de l’itinéraire doit respecter lors de la détermination de l’itinéraire. Évitez de prendre en charge plusieurs valeurs dans une demande et n’est prise en charge que pour la conduite et le travelMode de camion.

Exemple : « avoid » : ["limitedAccessHighways », « tollRoads"]
departAt

string (date-time)

Date et heure de départ du point d’origine mis en forme comme valeur de dateTime définie par RFC 3339, section 5.6. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, l’heure UTC est supposée.

Si le departAt n’est pas défini, la valeur par défaut est l’heure actuelle.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"
features

InputWaypointFeaturesItem[]

Les itinéraires de conduite et de marche sont définis par un ensemble de points de route (arrêts) et viaWaypoints (emplacements intermédiaires que l’itinéraire doit traverser). Vous pouvez avoir un maximum de 25 points de route et un maximum de 10 viaWaypoints entre chaque ensemble de points de route. L’itinéraire de camion prend en charge jusqu’à 150 points de route et viaWaypoints ne sont pas pris en charge.

Un itinéraire doit avoir un minimum de 2 points de route et les points de début et de fin de l’itinéraire ne peuvent pas être viaWaypoints.

Les emplacements waypoint et viaWaypoint doivent être spécifiés en tant qu’objet de fonctionnalité GeoJSON Point valide, ainsi que pointIndex qui spécifie l’ordre des emplacements. For more information on the GeoJSON format, see RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

Le titre directionnel initial du véhicule en degrés commençant à true Nord et continuant dans le sens des aiguilles d’une montre. Le nord est de 0 degrés, est de 90 degrés, le sud est de 180 degrés, l’ouest est de 270 degrés.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Nombre maximal d’itinéraires à retourner. Disponible pour les modes de conduite et de transport par camion.

Default: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Spécifie le paramètre à utiliser pour optimiser l’itinéraire. S’il n’est pas défini, la valeur par défaut est « fastestWithoutTraffic » qui retourne l’itinéraire pour réduire le temps de trajet sans utiliser les informations de trafic actuelles.

Example: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Récommandez les points de route à l’aide d’un algorithme heuristique rapide pour réduire le coût de routage spécifié avec le paramètre d’optimisation. L’origine et la destination sont exclues du point de route optimisé et leur position est considérée comme fixe. Les valeurs acceptables sont vraies ou false.
routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

Incluez les informations de routage souhaitées à partir de la réponse. Par défaut, l’itinéraire est inclus dans la réponse.

Prend en charge plusieurs valeurs telles que « routeOutputOptions » : ["routePath », « itinerary"]
travelMode

TravelModeEnum

driving

Mode de voyage pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « conduite » qui retourne l’itinéraire optimisé pour les voitures.

Note: Pour le camion travelMode, l’itinéraire du camion demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque l’itinéraire du camion n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ».

Example: "travelMode":"driving"
type

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

Spécifie les attributs du véhicule tels que la taille, le poids, la vitesse maximale, le type de cargaison, etc. pour le routage des camions uniquement. Cela permet d’éviter les dégagements de pont faibles, les restrictions routières, les virages de droite difficiles pour fournir l’itinéraire optimisé des camions en fonction des spécifications du véhicule.

Note: uniquement pris en charge pour le travelMode de camion

DrivingSideEnum

Énumération

Indique la main gauche et le côté droit à la conduite au point de la manœuvre.

Valeur Description
Left

Conduite à gauche.
Right

Conduite à droite.

FeatureCollection

Object

GeoJSON FeatureCollection objet qui contient une liste de fonctionnalités. Pour plus d’informations, consultez RFC 7946, section 3.3.

Nom Type Description
features

FeaturesItem[]

GeoJSON objet de fonctionnalité qui contient un objet Geometry et des propriétés supplémentaires. Pour plus d’informations, consultez RFC 7946, section 3.2.
type

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.

FeaturesItem

Object

Objet de fonctionnalité GeoJSON qui contient l’objet Geometry et les propriétés supplémentaires de l’itinéraire.

Nom Type Description
bbox

number[] (double)

Une zone rectangulaire sur la terre définie comme un objet de cadre englobant. Les côtés des rectangles sont définis par les valeurs de latitude et de longitude. Pour plus d’informations, consultez RFC 7946, section 5.

Exemple : « bbox » : [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Objet Geometry GeoJSON valide. For more information, see RFC 7946.
properties FeatureProperties:

Spécifie les propriétés des caractéristiques de l’itinéraire, comme l’itinéraire, les jambes de route et la géométrie, le résumé du voyage.
type

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. For more information, see RFC 7946.

FeaturesItemTypeEnum

Énumération

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. For more information, see RFC 7946.

Valeur Description
Feature

Spécifie le type d’objet Feature GeoJSON.

FeatureTypeEnum

Énumération

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.

Valeur Description
FeatureCollection

Spécifie le type d’objet GeoJSONFeatureCollection.

GeoJsonPoint

Object

Type de géométrie GeoJSON Point valide. Please refer to RFC 7946 for details.

Nom Type Description
coordinates

number[] (double)

Un Position est un tableau de nombres avec deux éléments ou plus. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type string:

Point

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.

InputWaypointFeaturesItem

Object

Spécifie le point de route d’entrée et viaWaypoint GeoJSON objet de fonctionnalité et des propriétés supplémentaires. For more information, see RFC 7946.

Nom Type Description
geometry GeoJsonPoint:

PointGeometry

Type de géométrie GeoJSON Point valide. Please refer to RFC 7946 for details.
properties

InputWaypointProperties

Spécifie les propriétés d’un point de route qui est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.
type

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. For more information, see RFC 7946.

InputWaypointProperties

Object

Spécifie les propriétés d’un point de route qui est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.

Nom Type Valeur par défaut Description
pointIndex

integer (int64)

Identifiez et commandez la séquence de points de route dans l’itinéraire. La valeur par défaut est la index value d’un tableau de fonctionnalités.
pointType

InputWaypointTypeEnum

waypoint

Type Waypoint sur l’itinéraire. Il peut s’agir d’un arrêt ou d’un emplacement intermédiaire que l’itinéraire doit traverser.

InputWaypointTypeEnum

Énumération

Type Waypoint sur l’itinéraire. Il peut s’agir d’un arrêt ou d’un emplacement intermédiaire que l’itinéraire doit traverser.

Valeur Description
waypoint

Un point de route est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.
viaWaypoint

Un viaWaypoint est un point de route spécifique qui doit être traversé ou visité le long d’un itinéraire ou d’un voyage.

Instruction

Object

Description d’une manœuvre dans un ensemble de directions.

Nom Type Description
drivingSide

DrivingSideEnum

Indique la main gauche et le côté droit à la conduite au point de la manœuvre.
formattedText

string

Description textuelle mise en forme de l’instruction.
maneuverType

ManeuverTypeEnum

Type de manœuvre décrit dans cette collection détaillée. Le ManoeuvreType fournit des informations pour une partie de la manœuvre spécifiée par l’instruction correspondante. Par exemple, le type de manœuvre d’une instruction peut spécifier TurnLeftThenTurnRight, tandis que les éléments de détail associés peuvent fournir des détails spécifiques sur les manœuvres TurnLeft et TurnRight
text

string

Description en texte brut de l’instruction.

Leg

Object

Informations sur une section d’un itinéraire entre deux points de route. Pour plus d’informations sur les champs contenus dans une étape d’itinéraire :

Nom Type Description
arrivalAt

string (date-time)

L’heure d’arrivée estimée pour la jambe, qui prend en compte les conditions de trafic, est mise en forme comme valeur dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée.
departureAt

string (date-time)

L’heure de départ estimée pour la jambe, qui prend en compte les conditions de trafic, est mise en forme comme valeur dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée.
distanceInMeters

number

Distance physique en mètres couverte par une jambe de route.
durationInSeconds

integer (int64)

Temps de trajet estimé en secondes qui n’inclut pas de retards sur l’itinéraire en raison de conditions de trafic.
durationTrafficInSeconds

integer (int64)

Temps nécessaire, en secondes, pour parcourir un TravelDistance correspondant avec les conditions de trafic actuelles. Cette valeur est fournie si optimizeRoute inclut des considérations sur le trafic.
routePathRange

RoutePathRange

Fait référence à la plage couverte par une étape spécifique d’un itinéraire ou d’un chemin d’accès.

ManeuverPointProperties

Object

Spécifie les instructions de conduite et les propriétés supplémentaires pour chaque point de manœuvre dans la jambe de route.

Nom Type Valeur par défaut Description
address

Address

Le district administratif et la région du pays pour les points de cheminement et les points de manœuvre sur l’itinéraire.
distanceInMeters

number

Distance physique en mètres couverte par cette étape de route.
durationInSeconds

integer (int64)

Temps nécessaire, en secondes, pour voyager une TravelDistancecorrespondante.
exitIdentifier

string

Nom ou numéro de la sortie associée à cette étape de routage.
instruction

Instruction

Description d’une manœuvre dans un ensemble de directions.
order

Order

Séquence de visite des points de cheminement.
routePathPoint

RoutePathPoint

Fait référence à l’index d’un point dans une jambe spécifique d’une route.
sideOfStreet

SideOfStreetEnum

Côté de la rue où la destination est trouvée en fonction du sens de l’arrivée. Ce champ s’applique uniquement au dernier point de manœuvre.
signs

string[]

Texte de signalisation pour l’itinéraire. Il peut y avoir plusieurs valeurs de signe.
steps

Step[]

Étapes entre deux points de manœuvre consécutifs.
towardsRoadName

string

Nom de la rue vers laquelle la route va vers la première ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Mode de déplacement pour le chemin d’itinéraire dans la réponse.
type string:

ManeuverPoint

Output type.

ManeuverTypeEnum

Énumération

Type de manœuvre décrit dans cette collection détaillée. Le ManoeuvreType fournit des informations pour une partie de la manœuvre spécifiée par l’instruction correspondante. Par exemple, le type de manœuvre d’une instruction peut spécifier TurnLeftThenTurnRight, tandis que les éléments de détail associés peuvent fournir des détails spécifiques sur les manœuvres TurnLeft et TurnRight

Valeur Description
ArriveFinish

Arrivez à la destination finale.
ArriveIntermediate

Arrivez à un point de chemin intermédiaire.
BearLeft

Bear left.
BearLeftThenBearLeft

L’ours gauche, puis l’ours à gauche.
BearLeftThenBearRight

Ours à gauche, puis porter à droite.
BearLeftThenTurnLeft

Oursez à gauche, puis tournez vers la gauche.
BearLeftThenTurnRight

Oursez à gauche, puis tournez vers la droite.
BearRight

Bear right.
BearRightThenBearLeft

Porter à droite, puis porter à gauche.
BearRightThenBearRight

Portez la droite, puis resserez la droite.
BearRightThenTurnLeft

Oursez à droite, puis tournez vers la gauche.
BearRightThenTurnRight

Portez la droite, puis tournez vers la droite.
BearThenKeep

Instruction bear, puis une instruction keep
BearThenMerge

Indiquez l’instruction, puis une instruction de fusion.
Continue

Continuez sur la route actuelle.
DepartIntermediateStop

Laissez un point de route intermédiaire dans une direction et une route différente de celle sur laquelle vous êtes arrivé.
DepartIntermediateStopReturning

Laissez un point de chemin intermédiaire dans la même direction et sur la même route sur laquelle vous êtes arrivé.
DepartStart

Laissez le point de départ.
EnterRoundabout

Entrez un rond-point.
ExitRoundabout

Quittez un rond-point.
EnterThenExitRoundabout

Entrez et quittez un rond-point.
ExitRoundaboutRight

Au rond-point, prenez la sortie à droite.
ExitRoundaboutLeft

Au rond-point, prenez la sortie sur la gauche.
Follow

Follow.
GoAroundRoundabout

Tournez autour du rond-point.
KeepLeft

Restez à gauche sur une autre route.
KeepOnRampLeft

Restez à gauche et continuez sur la rampe.
KeepOnRampRight

Gardez à droite et continuez sur la rampe.
KeepOnRampStraight

Gardez droit et continuez sur la rampe.
KeepRight

Gardez la droite sur une autre route.
KeepStraight

Gardez droit sur une autre route.
KeepToStayLeft

Restez à gauche pour rester sur la même route.
KeepToStayRight

Gardez le droit de rester sur la même route.
KeepToStayStraight

Gardez droit pour rester sur la même route.
MergeFreeway

Fusionnez sur une voie libre.
MergeHighway

Fusionnez sur une autoroute.
MergeMotorway

Fusionnez sur une autoroute.
MotorwayExitLeft

Prenez la sortie gauche.
MotorwayExitRight

Prenez la sortie droite.
None

No instruction.
RampThenHighwayLeft

Prendre la rampe gauche sur l’autoroute. Cela fait partie d’une instruction combinée.
RampThenHighwayRight

Prenez la rampe droite sur l’autoroute. Cela fait partie d’une instruction combinée.
RampThenHighwayStraight

Restez droit pour prendre la rampe sur l’autoroute. Cela fait partie d’une instruction combinée.
RoadNameChange

Le nom de la route change.
SwitchToParallelRoad

Basculez vers la route parallèle.
SwitchToMainRoad

Basculez vers la route principale.
Take

Prenez la route. Cette instruction est utilisée lorsque vous entrez ou quittez un ferry.
TakeFerry

Prenez le ferry.
TakeExit

Prenez la sortie.
TakeRamp

Take ramp.
TakeRampLeft

Prenez la rampe à gauche.
TakeRampRight

Prenez la rampe à droite.
TakeRampStraight

Restez droit pour prendre la rampe.
TurnBack

Revenez en arrière.
TurnLeft

Turn left.
TurnLeftSharp

Prenez un virage à gauche aiguisé.
TurnLeftThenBearLeft

Tournez vers la gauche, puis portez à gauche.
TurnLeftThenBearRight

Tournez vers la gauche, puis portez la droite.
TurnLeftThenTurnLeft

Tournez à gauche, puis revenez à gauche.
TurnLeftThenTurnRight

Tournez vers la gauche, puis tournez vers la droite.
TurnRight

Turn right.
TurnRightSharp

Prenez un virage droit aigu.
TurnRightThenBearLeft

Tournez vers la droite, puis portez la gauche.
TurnRightThenBearRight

Tournez vers la droite, puis portez la droite.
TurnRightThenTurnLeft

Tournez vers la droite, puis tournez vers la gauche.
TurnRightThenTurnRight

Tourner à droite, puis réactiver la droite
TurnThenMerge

Retournez l’instruction suivie d’une instruction de fusion.
TurnToStayLeft

Tournez vers la gauche pour rester sur la même route.
TurnToStayRight

Tournez vers la droite pour rester sur la même route.
Unknown

L’instruction est inconnue.
UTurn

Faites un u-turn pour aller dans la direction opposée.
Wait

Wait
Walk

Walk

MapsErrorDetail

Object

Détail de l’erreur.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.
details

MapsErrorDetail[]

Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message

string

Représentation lisible par l’homme de l’erreur.
target

string

Cible de l’erreur.

MapsErrorResponse

Object

Réponse d’erreur courante pour les API Azure Maps pour retourner les détails d’erreur pour les opérations ayant échoué.

Nom Type Description
error

MapsErrorDetail

Détail de l’erreur.

MapsInnerError

Object

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom Type Description
code

string

Code d’erreur.
innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

MultiLineStringGeometry

Object

Spécifie l’objet GeoJSON MultiLineString Geometry. For more information, see RFC 7946.

Nom Type Description
coordinates

number[] (double)

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

MultiLineString

Spécifie le type de géométrie de l’objet geometry GeoJSON. For more information, see RFC 7946.

OptimizedWaypoint

Object

Objet point de chemin optimisé.

Nom Type Description
inputIndex

integer (int64)

Index de point de chemin fourni par l’utilisateur.
optimizedIndex

integer (int64)

Index de point de façon optimisée à partir du système.

Order

Object

Séquence de visite des points de cheminement.

Nom Type Description
inputIndex

integer (int64)

Index fourni par l’utilisateur pour le waypoint
optimizedIndex

integer (int64)

System-optimized waypoint

PointGeometry

Object

Point d’origine passé en tant qu’objet Geometry GeoJSON valide, à partir duquel le polygone de plage doit être calculé. Please refer to RFC 7946 for details.

Note: l’API aligne le point d’origine demandé sur le réseau routier le plus proche et l’utilise pour le calcul de plage. Elle est retournée en tant que point de center dans la réponse.

Nom Type Description
coordinates

number[] (double)

Un Position est un tableau de nombres avec deux éléments ou plus. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type string:

Point

Spécifie le type de géométrie de l’objet geometry GeoJSON. For more information, see RFC 7946.

RouteDirectionOptimizeRouteEnum

Énumération

Spécifie le paramètre à utiliser pour optimiser l’itinéraire. S’il n’est pas défini, la valeur par défaut est « fastestWithoutTraffic » qui retourne l’itinéraire pour réduire le temps de trajet sans utiliser les informations de trafic actuelles.

Example: "optimizeRoute":"shortest"

Valeur Description
shortest

L’itinéraire est calculé pour réduire la distance. Les informations de trafic ne sont pas utilisées.
fastestWithoutTraffic

Trouve l’itinéraire le plus rapide, sans prendre en compte les informations de trafic.
fastestAvoidClosureWithoutTraffic
fastestWithTraffic

L’itinéraire est calculé pour réduire le temps à l’aide des informations de trafic actuelles. Note: uniquement pris en charge pour la conduite et le camion travelMode.

RouteDirectionsResponse

Object

Cet objet est retourné à partir d’un appel réussi.

Nom Type Description
alternativeRoutes

FeatureCollection[]

Alternative route.
features

FeaturesItem[]

GeoJSON objet de fonctionnalité qui contient un objet Geometry et des propriétés supplémentaires. Pour plus d’informations, consultez RFC 7946, section 3.2.
type

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. For more information, see RFC 7946.

RouteDirectionVehicleSpec

Object

Spécifie les attributs du véhicule tels que la taille, le poids, la vitesse maximale, le type de cargaison, etc. pour le routage des camions uniquement. Cela permet d’éviter les dégagements de pont faibles, les restrictions routières, les virages de droite difficiles pour fournir l’itinéraire optimisé des camions en fonction des spécifications du véhicule.

ISNote: uniquement pris en charge pour le travelMode de camion.

Nom Type Valeur par défaut Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Code de restriction du tunnel ADR. L’ADR est un accord européen concernant le transport international de marchandises dangereuses par route. Le code de restriction du tunnel ADR est utilisé pour déterminer si un véhicule est autorisé à traverser un tunnel avec des restrictions sur le transport de marchandises dangereuses.
axleCount

integer (int64)

Nombre d’axes sur le véhicule.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

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

number (double)

minimum: 0
maximum: 1000000 		0

Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte.
isVehicleCommercial

boolean

False

Indique si le véhicule est utilisé à des fins commerciales. Les véhicules commerciaux peuvent ne pas être autorisés à conduire sur certaines routes.
length

number (double)

minimum: 0
maximum: 1000000 		0

Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte.
loadType

VehicleLoadTypeEnum[]

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. 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. vehicleLoadType prend en charge plusieurs valeurs dans une requête.
maxSpeed

integer (int64)

minimum: 0
maximum: 250 		0

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

integer (int64)

minimum: 0
maximum: 1000000 		0

Poids du véhicule en kilos. La valeur 0 signifie que les restrictions de poids ne sont pas prises en compte.
width

number (double)

minimum: 0
maximum: 1000000 		0

Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte.

RouteOutputOptionEnum

Énumération

Incluez les informations de routage souhaitées à partir de la réponse. Par défaut, l’itinéraire est inclus dans la réponse.

Prend en charge plusieurs valeurs telles que « routeOutputOptions » : ["routePath », « itinerary"]

Valeur Description
routeSummary

Incluez uniquement le temps de trajet et la distance pour l’itinéraire, et ne fournissez pas d’autres informations.
routePath

Incluez une RFC 7946, section 3.1.5 GeoJSON MultiLineString qui décrivent le chemin d’accès de l’itinéraire dans la réponse.
itinerary

Incluez des instructions détaillées dans la réponse. Des instructions détaillées sont fournies sous la forme « ManoeuvrePoints » et contiennent des détails tels que des instructions de tour par tour.

RoutePathPoint

Object

Fait référence à l’index d’un point dans une jambe spécifique d’une route.

Nom Type Description
legIndex

integer (int64)

L’index de la jambe de routage est un nombre séquentiel attribué à chaque étape de l’itinéraire pour vous aider à identifier et à distinguer les différents segments de l’itinéraire.
pointIndex

integer (int64)

Index d’un point dans une jambe spécifique.

RoutePathProperties

Object

Spécifie les propriétés qui décrivent le chemin d’accès de l’itinéraire dans la réponse.

Nom Type Description
arrivalAt

string (date-time)

L’heure d’arrivée estimée pour la jambe, qui prend en compte les conditions de trafic, est mise en forme comme valeur de dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée.
departureAt

string (date-time)

L’heure de départ estimée pour la jambe, qui prend en compte les conditions de trafic, est mise en forme comme valeur de dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée.
distanceInMeters

number

Distance physique en mètres couverte par toute la route.
durationInSeconds

integer (int64)

Temps de trajet estimé en secondes qui n’inclut pas de retards sur l’itinéraire en raison de conditions de trafic.
durationTrafficInSeconds

integer (int64)

Temps nécessaire, en secondes, pour parcourir un TravelDistance correspondant avec les conditions de trafic actuelles. Cette valeur est fournie si optimizeRoute inclut des considérations sur le trafic.
legs

Leg[]

Tableau de jambes d’itinéraire. Pour plus d’informations, consultez la description de l’objet Leg route.
optimizedWaypoints

OptimizedWaypoint[]

Séquence optimisée de points de route. Il affiche l’index de l’utilisateur fourni une séquence waypoint pour les listes d’origine et optimisées.
trafficCongestion

TrafficCongestionEnum

Niveau de congestion du trafic le long de la route. Note: uniquement pris en charge pour la conduite de travelMode
type string:

RoutePath

Output type.

RoutePathRange

Object

Fait référence à la plage couverte par une étape spécifique d’un itinéraire ou d’un chemin d’accès.

Nom Type Description
legIndex

integer (int64)

L’index de la jambe de routage est un nombre séquentiel attribué à chaque étape de l’itinéraire pour vous aider à identifier et à distinguer les différents segments de l’itinéraire.
range

integer[] (int64)

Fait référence à la plage couverte par une étape spécifique d’un itinéraire ou d’un chemin d’accès.

RoutePathTravelModeEnum

Énumération

Mode de déplacement pour le chemin d’itinéraire dans la réponse.

Valeur Description
driving

Itinéraires optimisés pour les voitures.
truck

Itinéraires optimisés pour les camions de grande taille en fonction de la spécification du véhicule.
walking

Itinéraires optimisés pour les piétons.
other

RouteTravelMode est retourné en tant qu'« autre » pour le travelMode de camion lorsque l’itinéraire du camion n’est pas disponible pour une section particulière d’un itinéraire.

SideOfStreetEnum

Énumération

Côté de la rue où la destination est trouvée en fonction du sens de l’arrivée. Ce champ s’applique uniquement au dernier point de manœuvre.

Valeur Description
Left

Left.
Right

Right.
Unknown

Unknown.

Step

Object

Une jambe d’itinéraire contient des instructions de tour par tour. Une étape fait référence à une plage d’itinéraires entre deux manœuvres consécutives.

Nom Type Description
maneuverType

ManeuverTypeEnum

Type de manœuvre décrit dans cette collection détaillée. Le ManoeuvreType fournit des informations pour une partie de la manœuvre spécifiée par l’instruction correspondante. Par exemple, le type de manœuvre d’une instruction peut spécifier TurnLeftThenTurnRight, tandis que les éléments de détail associés peuvent fournir des détails spécifiques sur les manœuvres TurnLeft et TurnRight
names

string[]

Une rue, une autoroute ou une intersection où se produit la manœuvre. Si la manœuvre est complexe, il peut y avoir plusieurs champs de nom dans la collection de détails. Le champ nom peut également ne pas avoir de valeur. Cela peut se produire si le nom n’est pas connu ou si une rue, une autoroute ou une intersection n’a pas de nom.
routePathRange

RoutePathRange

Fait référence à la plage couverte par une étape spécifique d’un itinéraire ou d’un chemin d’accès.

TrafficCongestionEnum

Énumération

Niveau de congestion du trafic le long de la route. Note: uniquement pris en charge pour la conduite de travelMode

Valeur Description
Unknown

Unknown.
None

None.
Mild

Mild.
Medium

Medium.
Heavy

Heavy.

TravelModeEnum

Énumération

Mode de voyage pour l’itinéraire demandé. Si elle n’est pas définie, la valeur par défaut est « conduite » qui retourne l’itinéraire optimisé pour les voitures.

Note: Pour le camion travelMode, l’itinéraire du camion demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque l’itinéraire du camion n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ».

Example: "travelMode":"driving"

Valeur Description
driving

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

Les itinéraires retournés sont optimisés pour les camions de grande taille en fonction de la spécification du véhicule.
walking

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

VehicleLoadTypeEnum

Énumération

Types de cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays. 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. vehicleLoadType prend en charge plusieurs valeurs dans une requête.

Valeur Description
USHazmatClass1

Explosives
USHazmatClass2

Compressed gas
USHazmatClass3

Flammable liquids
USHazmatClass4

Flammable solids
USHazmatClass5

Oxidizers
USHazmatClass6

Poisons
USHazmatClass7

Radioactive
USHazmatClass8

Corrosives
USHazmatClass9

Miscellaneous
otherHazmatExplosive

Explosives
otherHazmatGeneral

Miscellaneous
otherHazmatHarmfulToWater

Nuisible à l’eau

WaypointProperties

Object

Spécifie les propriétés d’un point de route qui est un emplacement ou un point spécifique le long d’une route ou d’un voyage qui sert de référence ou de point d’arrêt.

Nom Type Valeur par défaut Description
address

Address

Le district administratif et la région du pays pour les points de cheminement et les points de manœuvre sur l’itinéraire.
distanceInMeters

number

Distance physique en mètres couverte par cette étape de route.
durationInSeconds

integer (int64)

Temps nécessaire, en secondes, pour voyager une TravelDistancecorrespondante.
exitIdentifier

string

Nom ou numéro de la sortie associée à cette étape de routage.
instruction

Instruction

Description d’une manœuvre dans un ensemble de directions.
order

Order

Séquence de visite des points de cheminement.
routePathPoint

RoutePathPoint

Fait référence à l’index d’un point dans une jambe spécifique d’une route.
sideOfStreet

SideOfStreetEnum

Côté de la rue où la destination est trouvée en fonction du sens de l’arrivée. Ce champ s’applique uniquement au dernier point de manœuvre.
signs

string[]

Texte de signalisation pour l’itinéraire. Il peut y avoir plusieurs valeurs de signe.
steps

Step[]

Étapes entre deux points de manœuvre consécutifs.
towardsRoadName

string

Nom de la rue vers laquelle la route va vers la première ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Mode de déplacement pour le chemin d’itinéraire dans la réponse.
type string:

Waypoint

Output type.