Route - Get Route Directions Batch
Permet d’envoyer un lot de requêtes à l’API Get Route Directions dans une requête asynchrone unique.
L’API Get Route Directions Batch
est une requête HTTP GET
qui envoie des lots de requêtes à l’API Get Route Directions à l’aide d’une seule requête. Vous pouvez appeler Get Route Directions Batch
l’API pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter par lot jusqu’à 700 requêtes et de synchroniser l’API jusqu’à 100 requêtes.
Télécharger les résultats de lot asynchrones
Pour télécharger les résultats du lot asynchrone, vous devez envoyer une GET
requête au point de terminaison de téléchargement par lots. Cette URL de téléchargement peut être obtenue à partir de l’en-tête Location
d’une demande de lot réussie POST
et se présente comme suit :
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Voici la séquence classique d’opérations pour télécharger les résultats du lot :
Le client envoie une
GET
requête à l’aide de l’URL de téléchargement.Le serveur répond avec l’un des éléments suivants :
HTTP
202 Accepted
: la demande par lots a été acceptée, mais elle est toujours en cours de traitement. Réessayez dans un certain temps.HTTP
200 OK
- Requête par lots traitée avec succès. Le corps de la réponse contient tous les résultats du lot.
Modèle de réponse par lot
Le contenu de données retourné est similaire pour les demandes asynchrones et de synchronisation. Lors du téléchargement des résultats d’une demande de lot asynchrone, si le traitement du lot est terminé, le corps de la réponse contient la réponse par lot. Cette réponse de lot contient un summary
composant qui indique les totalRequests
qui faisaient partie de la demande de lot d’origine et successfulRequests
c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un batchItems
tableau qui contient une réponse pour chaque requête de la demande de lot.
batchItems
contient les résultats exactement dans l’ordre que les requêtes d’origine ont été envoyées dans la demande de lot. Chaque élément dans batchItems
contient statusCode
des champs et response
. Chaque response
dans batchItems
est de l’un des types suivants :
RouteDirections
- Si la requête s’est terminée avec succès.Error
- Si la requête a échoué. La réponse contiendra uncode
et unmessage
dans ce cas.
Voici un exemple de réponse par lot avec 1 réussite et 1 échec :
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"statusCode": 200,
"response": {
"routes": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 40,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
GET https://atlas.microsoft.com/route/directions/batch/{format}?api-version=1.0
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
string |
ID de lot pour l’interrogation de l’opération. |
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
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é de l’ID Microsoft Entra. 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 la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Requête par lot traitée avec succès. Le corps de la réponse contient tous les résultats du lot. |
|
202 Accepted |
Pris en charge uniquement pour la requête asynchrone. Demande acceptée : la demande a été acceptée pour traitement. Utilisez l’URL de l’en-tête d’emplacement pour réessayer ou accéder aux résultats. En-têtes Location: string |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux OAuth Microsoft Entra 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 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 Ou sous-ressources Azure Maps. 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 aux API REST Azure Maps.
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 à 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 du 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 une 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 qui est provisionnée lorsque vous créez 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é principale dans le compte dans lequel elle est émise.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.
Type:
apiKey
Dans:
query
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure 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 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
Dans:
header
Exemples
Successfully retrieve the status for the route direction batch request
Exemple de requête
GET https://atlas.microsoft.com/route/directions/batch/11111111-2222-3333-4444-555555555555?api-version=1.0
Exemple de réponse
{
"batchItems": [
{
"statusCode": 400,
"response": {
"error": {
"code": "400 BadRequest",
"message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
}
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
},
{
"latitude": 47.60995,
"longitude": -122.34174
},
{
"latitude": 47.61011,
"longitude": -122.342
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 44,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"points": [
{
"latitude": 40.75982,
"longitude": -73.98493
},
{
"latitude": 40.7601,
"longitude": -73.98483
},
{
"latitude": 40.75984,
"longitude": -73.98417
},
{
"latitude": 40.76047,
"longitude": -73.9837
},
{
"latitude": 40.77095,
"longitude": -73.9736
},
{
"latitude": 40.77114,
"longitude": -73.97356
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 47,
"sectionType": "TRAVEL_MODE",
"travelMode": "pedestrian"
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 2,
"totalRequests": 3
}
}
Définitions
Nom | Description |
---|---|
Delay |
Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir le détail des incidents de trafic. |
Driving |
Indique la conduite côté gauche par rapport à droite au point de la manœuvre. |
Effective |
Paramètre ou données effectifs utilisés lors de l’appel de cette API de route. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Guidance |
Type de l’instruction, par exemple, virage ou changement de formulaire de route. |
Guidance |
Code identifiant la manœuvre. |
Junction |
Type de la jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et sortir du rond-point. |
Lat |
Emplacement représenté sous la forme d’une latitude et d’une longitude. |
Response |
Résultat de la requête. RouteDirections si la requête s’est terminée correctement, Sinon, ErrorResponse. |
Response |
Types de section de la réponse de routage signalée |
Response |
Mode voyage pour l’itinéraire calculé. La valeur est définie |
Route | |
Route |
Élément retourné à partir d’un appel de service Route Directions Batch. |
Route |
Cet objet est retourné à partir d’un appel de service Route Directions Batch réussi. |
Route |
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles. |
Route |
Ensemble d’attributs décrivant une manœuvre, par exemple« Tourner à droite », « Rester à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ». |
Route |
Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée par firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés pour obtenir des conseils (instructionType=text ou tagged), un message de synthèse est retourné au groupe d’instructions lorsqu’il est disponible. |
Route |
Description d’une partie d’un itinéraire, composée d’une liste de points. Chaque point de chemin supplémentaire fourni dans la demande entraîne une étape supplémentaire dans l’itinéraire retourné. |
Route |
Objet summary pour la section route. |
Route |
Objet point de chemin optimisé. |
Route |
Indique les paramètres effectifs utilisés dans l’appel actuel. |
Route |
Les sections de routage contiennent des informations supplémentaires sur les parties d’un itinéraire. Chaque section contient au moins les éléments |
Route |
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes. |
Route |
Cause de l’événement de trafic. Peut contenir des éléments mainCauseCode et subCauseCode. Peut être utilisé pour définir l’iconographie et les descriptions. |
Route |
Objet Summary |
Simple |
Type de l’incident. Actuellement, il peut s’agir de JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ». |
Summary |
Résumé des résultats de la demande de lot |
DelayMagnitude
Ampleur du délai causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir le détail des incidents de trafic.
Nom | Type | Description |
---|---|---|
0 |
string |
Inconnu. |
1 |
string |
Mineur. |
2 |
string |
Modéré. |
3 |
string |
Majeur. |
4 |
string |
Non défini, utilisé pour les fermetures de routes et autres retards indéfinis. |
DrivingSide
Indique la conduite côté gauche par rapport à droite au point de la manœuvre.
Nom | Type | Description |
---|---|---|
LEFT |
string |
Gauche. |
RIGHT |
string |
Côté droit. |
EffectiveSetting
Paramètre ou données effectifs utilisés lors de l’appel de cette API de route.
Nom | Type | Description |
---|---|---|
key |
string |
Nom du paramètre utilisé. |
value |
string |
Valeur du paramètre utilisé. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet error. |
GuidanceInstructionType
Type de l’instruction, par exemple, virage ou changement de formulaire de route.
Nom | Type | Description |
---|---|---|
DIRECTION_INFO |
string |
Informations de direction. |
LOCATION_ARRIVAL |
string |
Emplacement d’arrivée. |
LOCATION_DEPARTURE |
string |
Lieu de départ. |
LOCATION_WAYPOINT |
string |
Emplacement du point de chemin. |
ROAD_CHANGE |
string |
Changement de route. |
TURN |
string |
Tourner. |
GuidanceManeuver
Code identifiant la manœuvre.
Nom | Type | Description |
---|---|---|
ARRIVE |
string |
Tu es arrivé. |
ARRIVE_LEFT |
string |
Tu es arrivé. Votre destination se trouve à gauche. |
ARRIVE_RIGHT |
string |
Tu es arrivé. Votre destination est à droite. |
BEAR_LEFT |
string |
Ours à gauche. |
BEAR_RIGHT |
string |
Portez à droite. |
DEPART |
string |
Partir. |
ENTER_FREEWAY |
string |
Prenez l’autoroute. |
ENTER_HIGHWAY |
string |
Prenez l’autoroute. |
ENTER_MOTORWAY |
string |
Prendre l’autoroute. |
ENTRANCE_RAMP |
string |
Prenez la rampe. |
FOLLOW |
string |
Suivre. |
KEEP_LEFT |
string |
Restez à gauche. |
KEEP_RIGHT |
string |
Gardez la droite. |
MAKE_UTURN |
string |
Faites un demi-tour. |
MOTORWAY_EXIT_LEFT |
string |
Prendre la sortie de gauche. |
MOTORWAY_EXIT_RIGHT |
string |
Prendre la sortie à droite. |
ROUNDABOUT_BACK |
string |
Faire le tour du rond-point. |
ROUNDABOUT_CROSS |
string |
Traverser le rond-point. |
ROUNDABOUT_LEFT |
string |
Au rond-point, prendre la sortie à gauche. |
ROUNDABOUT_RIGHT |
string |
Au rond-point, prendre la sortie à droite. |
SHARP_LEFT |
string |
Tourner vers la gauche. |
SHARP_RIGHT |
string |
Tourner à droite. |
STRAIGHT |
string |
Restez droit. |
SWITCH_MAIN_ROAD |
string |
Passer à la route principale. |
SWITCH_PARALLEL_ROAD |
string |
Basculez vers la route parallèle. |
TAKE_EXIT |
string |
Prenez la sortie. |
TAKE_FERRY |
string |
Prenez le ferry. |
TRY_MAKE_UTURN |
string |
Essayez de faire un demi-tour. |
TURN_LEFT |
string |
Tourner à gauche. |
TURN_RIGHT |
string |
Tourner à droite. |
WAYPOINT_LEFT |
string |
Vous avez atteint le point de passage. Il est à gauche. |
WAYPOINT_REACHED |
string |
Vous avez atteint le point de passage. |
WAYPOINT_RIGHT |
string |
Vous avez atteint le point de passage. C’est à droite. |
JunctionType
Type de la jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et sortir du rond-point.
Nom | Type | Description |
---|---|---|
BIFURCATION |
string |
bifurcation |
REGULAR |
string |
regular |
ROUNDABOUT |
string |
rond-point |
LatLongPair
Emplacement représenté sous la forme d’une latitude et d’une longitude.
Nom | Type | Description |
---|---|---|
latitude |
number |
Propriété Latitude |
longitude |
number |
Longitude, propriété |
Response
Résultat de la requête. RouteDirections si la requête s’est terminée correctement, Sinon, ErrorResponse.
Nom | Type | Description |
---|---|---|
error |
Objet error. |
|
formatVersion |
string |
Propriété Format Version |
optimizedWaypoints |
Séquence optimisée de points de cheminement. Il affiche l’index de la séquence de point de chemin fournie par l’utilisateur pour la liste d’origine et optimisée. Par exemple, une réponse :
signifie que la séquence d’origine est [0, 1, 2] et la séquence optimisée est [1, 2, 0]. Étant donné que l’index commence par 0, l’original est « first, second, third » tandis que l’optimisé est « second, third, first ». |
|
report |
Indique les paramètres effectifs utilisés dans l’appel actuel. |
|
routes |
Route[] |
Tableau d’itinéraires |
ResponseSectionType
Types de section de la réponse de routage signalée
Nom | Type | Description |
---|---|---|
CARPOOL |
string |
Sections de l’itinéraire qui nécessitent l’utilisation de voies de covoiturage (HOV/High Occupationy Vehicle). |
CAR_TRAIN |
string |
Sections de l’itinéraire qui sont des voitures ou des trains. |
COUNTRY |
string |
Sections indiquant les pays/régions dans lesquels se trouve l’itinéraire. |
FERRY |
string |
Sections de la route qui sont des traversiers. |
MOTORWAY |
string |
Sections de la route qui sont des autoroutes. |
PEDESTRIAN |
string |
Sections de l’itinéraire qui ne sont adaptées qu’aux piétons. |
TOLL_ROAD |
string |
Sections de l’itinéraire qui nécessitent un péage à payer. |
TOLL_VIGNETTE |
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. |
TRAVEL_MODE |
string |
Sections relatives au paramètre |
TUNNEL |
string |
Sections de l’itinéraire qui sont des tunnels. |
URBAN |
string |
Sections de l’itinéraire situées dans des zones urbaines. |
ResponseTravelMode
Mode voyage pour l’itinéraire calculé. La valeur est définie other
sur si le mode de transport demandé n’est pas possible dans cette section
Nom | Type | Description |
---|---|---|
bicycle |
string |
Les itinéraires retournés sont optimisés pour les bicyclettes, y compris l’utilisation de voies 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 motos. Fonctionnalité BÊTA. |
other |
string |
Le mode de transport donné n’est pas possible dans cette section |
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. |
Route
Nom | Type | Description |
---|---|---|
guidance |
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles. |
|
legs |
Route |
Tableau d’jambes |
sections |
Tableau sections |
|
summary |
Objet Summary |
RouteDirectionsBatchItem
Élément retourné à partir d’un appel de service Route Directions Batch.
Nom | Type | Description |
---|---|---|
response |
Résultat de la requête. RouteDirections si la requête s’est terminée correctement, Sinon, ErrorResponse. |
|
statusCode |
integer |
Code d’état de la requête HTTP. |
RouteDirectionsBatchResult
Cet objet est retourné à partir d’un appel de service Route Directions Batch réussi.
Nom | Type | Description |
---|---|---|
batchItems |
Tableau contenant les résultats du lot. |
|
summary |
Résumé des résultats de la demande de lot |
RouteGuidance
Contient des éléments liés à l’aide. Ce champ est présent uniquement lorsque des conseils ont été demandés et sont disponibles.
Nom | Type | Description |
---|---|---|
instructionGroups |
Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres. |
|
instructions |
Liste d’instructions décrivant les manœuvres. |
RouteInstruction
Ensemble d’attributs décrivant une manœuvre, par exemple« Tourner à droite », « Rester à gauche », « Prendre le ferry », « Prendre l’autoroute », « Arriver ».
Nom | Type | Description |
---|---|---|
combinedMessage |
string |
Message lisible par l’homme pour la manœuvre combiné au message de l’instruction suivante. Il est parfois possible de combiner deux instructions successives en une seule instruction, ce qui facilite le suivi. Dans ce cas, l’indicateur possibleCombineWithNext est true. Par exemple :
L’indicateur possibleCombineWithNext de l’instruction 10 est true. Cela indique aux clients des instructions codées qu’elles peuvent être combinées à l’instruction 11. Les instructions seront combinées automatiquement pour les clients qui demandent des conseils lisibles par l’utilisateur. Le champ combinedMessage contient le message combiné :
|
countryCode |
string |
Code pays iso 3166-1 alpha-3 à 3 caractères. Par exemple, les États-Unis. |
drivingSide |
Indique la conduite côté gauche par rapport à droite au point de la manœuvre. |
|
exitNumber |
string |
Nombre(s) d’une sortie d’autoroute prise par la manœuvre actuelle. Si une sortie a plusieurs numéros de sortie, ils sont séparés par « », et éventuellement agrégés par « - », par exemple, « 10, 13-15 ». |
instructionType |
Type de l’instruction, par exemple, virage ou changement de formulaire de route. |
|
junctionType |
Type de la jonction où la manœuvre a lieu. Pour les grands ronds-points, deux instructions distinctes sont générées pour entrer et sortir du rond-point. |
|
maneuver |
Code identifiant la manœuvre. |
|
message |
string |
Un message lisible par l’homme pour la manœuvre. |
point |
Emplacement représenté sous la forme d’une latitude et d’une longitude. |
|
pointIndex |
integer |
Index du point dans la liste des « points » polylignes correspondant au point de l’instruction. |
possibleCombineWithNext |
boolean |
Il est possible de combiner éventuellement l’instruction avec la suivante. Cela peut être utilisé pour générer des messages tels que « Tourner à gauche, puis tourner à droite ». |
roadNumbers |
string[] |
Numéro(s) de route du ou des segments de route significatifs suivants après la manœuvre, ou des routes à suivre. Exemple : ["E34 », « N205"] |
roundaboutExitNumber |
integer |
Cela indique la sortie à prendre à un rond-point. |
routeOffsetInMeters |
integer |
Distance entre le début de l’itinéraire et le point de l’instruction. |
signpostText |
string |
Texte sur un panneau qui est le plus pertinent pour la manœuvre, ou pour la direction à suivre. |
stateCode |
string |
Subdivision (par exemple, état) du pays, représentée par la deuxième partie d’un code ISO 3166-2 . Cette option n’est disponible que pour certains pays/régions comme les États-Unis, le Canada et le Mexique. |
street |
string |
Nom de la rue du prochain segment de route significatif après la manœuvre, ou de la rue à suivre. |
travelTimeInSeconds |
integer |
Temps de trajet estimé jusqu’au point correspondant à routeOffsetInMeters. |
turnAngleInDecimalDegrees |
integer |
Indique la direction d’une instruction. Si junctionType indique une instruction de tour :
Si junctionType indique une instruction de bifurcation :
|
RouteInstructionGroup
Regroupe une séquence d’éléments d’instruction qui sont liés les uns aux autres. La plage de séquences est limitée par firstInstructionIndex et lastInstructionIndex. Lorsque des messages texte lisibles par l’homme sont demandés pour obtenir des conseils (instructionType=text ou tagged), un message de synthèse est retourné au groupe d’instructions lorsqu’il est disponible.
Nom | Type | Description |
---|---|---|
firstInstructionIndex |
integer |
Index de la première instruction des instructions et appartenant à ce groupe. |
groupLengthInMeters |
integer |
Longueur du groupe. |
groupMessage |
string |
Message de résumé lorsque des messages texte lisibles par l’homme sont demandés pour obtenir des conseils (instructionType=text ou étiqueté). |
lastInstructionIndex |
integer |
Index de la dernière instruction des instructions et appartenant à ce groupe. |
RouteLeg
Description d’une partie d’un itinéraire, composée d’une liste de points. Chaque point de chemin supplémentaire fourni dans la demande entraîne une étape supplémentaire dans l’itinéraire retourné.
Nom | Type | Description |
---|---|---|
points |
Tableau de points |
|
summary |
Objet summary pour la section route. |
RouteLegSummary
Objet summary 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 pour l’itinéraire ou 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 |
Durée estimée du trajet calculée à l’aide de données de trafic historiques dépendantes du temps. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête. |
lengthInMeters |
integer |
Propriété Length In Meters |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Durée estimée du trajet calculée à l’aide de données de vitesse en temps réel. Inclus uniquement si computeTravelTimeFor = all est utilisé dans la requête. |
noTrafficTravelTimeInSeconds |
integer |
Estimation du temps de trajet calculé comme s’il n’y avait aucun retard sur l’itinéraire en raison des conditions de circulation (par exemple, 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 prévus 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 de trafic, le paramètre computeTravelTimeFor=all doit être ajouté. |
travelTimeInSeconds |
integer |
Durée estimée du trajet en secondes 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. |
RouteOptimizedWaypoint
Objet point de chemin optimisé.
Nom | Type | Description |
---|---|---|
optimizedIndex |
integer |
Index de point de voie optimisé à partir du système. |
providedIndex |
integer |
Index de point de chemin fourni par l’utilisateur. |
RouteReport
Indique les paramètres effectifs utilisés dans l’appel actuel.
Nom | Type | Description |
---|---|---|
effectiveSettings |
Paramètres ou données effectifs utilisés lors de l’appel de cette API de route. |
RouteSection
Les sections de routage contiennent des informations supplémentaires sur les parties d’un itinéraire. Chaque section contient au moins les éléments startPointIndex
, endPointIndex
et sectionType
.
Nom | Type | Description |
---|---|---|
delayInSeconds |
integer |
Retard en secondes provoqué par l’incident. |
effectiveSpeedInKmh |
integer |
Vitesse effective de l’incident en km/h, moyenne sur toute sa longueur. |
endPointIndex |
integer |
Index du dernier point (décalage 0) dans l’itinéraire auquel cette section s’applique. |
magnitudeOfDelay |
L’ampleur du retard causé par l’incident. Ces valeurs correspondent aux valeurs du champ de réponse ty de l’API Obtenir les détails des incidents de trafic. |
|
sectionType |
Types de section de la réponse d’itinéraire signalée |
|
simpleCategory |
Type de l’incident. Peut actuellement être JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ». |
|
startPointIndex |
integer |
Index du premier point (décalage 0) dans l’itinéraire auquel cette section s’applique. |
tec |
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes. |
|
travelMode |
Mode de déplacement pour l’itinéraire calculé. La valeur est définie sur |
RouteSectionTec
Détails de l’événement de trafic, à l’aide de définitions dans la norme TPEG2-TEC . Peut contenir des éléments effectCode et causes.
Nom | Type | Description |
---|---|---|
causes |
Tableau de causes |
|
effectCode |
integer |
Effet sur le flux de trafic. Contient une valeur dans la table tec001 :EffectCode, telle que définie dans la norme TPEG2-TEC . Peut être utilisé pour colorer les événements de trafic en fonction de la gravité. |
RouteSectionTecCause
Cause de l’événement de trafic. Peut contenir des éléments mainCauseCode et subCauseCode. Peut être utilisé pour définir l’iconographie et les descriptions.
Nom | Type | Description |
---|---|---|
mainCauseCode |
integer |
Principale cause de l’événement de trafic. Contient une valeur dans la table tec002 :CauseCode, telle que définie dans la norme TPEG2-TEC . |
subCauseCode |
integer |
Sous-utilisation de l’événement de trafic. Contient une valeur dans la table de sous-cause définie par mainCauseCode, comme défini dans la norme TPEG2-TEC . |
RouteSummary
Objet Summary
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. |
departureTime |
string |
Heure de départ estimée pour l’itinéraire ou l’étape. L’heure est à l’échelle de temps UTC. |
lengthInMeters |
integer |
Propriété Length In Meters |
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 prévus 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 de trafic, le paramètre computeTravelTimeFor=all doit être ajouté. |
travelTimeInSeconds |
integer |
Durée estimée du trajet en secondes 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. |
SimpleCategory
Type de l’incident. Actuellement, il peut s’agir de JAM, ROAD_WORK, ROAD_CLOSURE ou AUTRE. Pour plus d’informations, consultez « tec ».
Nom | Type | Description |
---|---|---|
JAM |
string |
Embouteillage. |
OTHER |
string |
Autre. |
ROAD_CLOSURE |
string |
Fermeture de la route. |
ROAD_WORK |
string |
Travaux routiers. |
Summary
Résumé des résultats de la demande de lot
Nom | Type | Description |
---|---|---|
successfulRequests |
integer |
Nombre de demandes réussies dans le lot |
totalRequests |
integer |
Nombre total de demandes dans le lot |