Route - Post Route Directions Batch
Verwenden Sie, um einen Batch von Abfragen an die GET ROUTE DIRECTIONS-API in einer einzigen asynchronen Anforderung zu senden.
Die Post Route Directions Batch
API ist eine HTTP-Anforderung POST
, die Mithilfe einer einzelnen asynchronen Anforderung Batches von Abfragen an die API zum Abrufen von Routenanweisungen sendet. Sie können die API aufrufen Route Directions Batch
, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Informationen zum Aufrufen der Post Route Directions Batch
API in einer synchronen Anforderung finden Sie unter Post Route Directions Batch Sync.
Übermitteln einer asynchronen Batchanforderung
Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.
- Es ermöglicht das Abrufen von Ergebnissen in einem separaten Aufruf (mehrere Downloads sind möglich).
- Die asynchrone API ist auf Zuverlässigkeit optimiert und es wird nicht erwartet, dass ein Timeout auftritt.
- Die Anzahl der Batchelemente ist für diese API auf 700 begrenzt.
Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Beachten Sie, dass es sich bei der asynchronen Batchanforderung um einen Vorgang mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:
- Der Client sendet eine Batchanforderung
POST
für Routenbeschreibungen an Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
Der Server antwortet mit einer der folgenden Aktionen:
HTTP
202 Accepted
: Batchanforderung wurde akzeptiert.HTTP
Error
: Fehler bei der Verarbeitung Ihrer Batch-Anforderung. Dies kann entweder ein oder ein400 Bad Request
andererError
Statuscode sein.Wenn die Batchanforderung erfolgreich angenommen wurde, enthält der
Location
Header in der Antwort die URL zum Herunterladen der Ergebnisse der Batchanforderung. Dieser Status-URI sieht wie folgt aus:
GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Der Client stellt eine
GET
Anforderung für die download-URL aus, die in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.
POST-Text für Batchanforderung
Zum Senden der Routenbeschreibungsabfragen verwenden Sie eine POST
Anforderung, bei der der Anforderungstext das batchItems
Array im json
Format enthält und der Content-Type
Header auf application/json
festgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 3 Routenbeschreibungsabfragen :
{
"batchItems": [
{ "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
{ "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
{ "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
]
}
Eine Routenbeschreibungsabfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, api-Version und Abonnementschlüssel. Er kann alle unterstützten Routenbeschreibungs-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibungsabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. "zeichen sollte mit \ ) gekennzeichnet werden, und es sollte auch ordnungsgemäß URL-codiert sein.
Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 700 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten.
Herunterladen asynchroner Batchergebnisse
Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET
Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location
Kopfzeile einer erfolgreichen POST
Batchanforderung abgerufen werden und sieht wie folgt aus:
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
Der Client sendet eine
GET
Anforderung über die Download-URL.Der Server antwortet mit einer der folgenden Aktionen:
HTTP
202 Accepted
: Batchanforderung wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.HTTP
200 OK
: Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.
Batchantwortmodell
Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary
Komponente, die angibt totalRequests
, dass Teil der ursprünglichen Batchanforderung war, d successfulRequests
. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems
Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems
die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems
enthält statusCode
und response
Felder. Jedes response
in batchItems
hat einen der folgenden Typen:
RouteDirections
– Wenn die Abfrage erfolgreich abgeschlossen wurde.Error
– Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall eincode
und einmessage
.
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
{
"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."
}
}
}
]
}
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
format
|
path | True |
Gewünschtes Format der Antwort. Nur das |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln . |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Die Liste der zu verarbeitenden Abfragen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse. |
|
202 Accepted |
Wird nur für asynchrone Anforderungen unterstützt. Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Location Header, um einen Wiederholungsversuch zu versuchen oder auf die Ergebnisse zuzugreifen. Header Location: string |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Ist Authorization URL
spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
SAS Token
Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.
Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successfully submit a route direction batch request
Beispielanforderung
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
},
{
"query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
},
{
"query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
}
]
}
Beispiel für eine Antwort
{
"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
}
}
operation-Location: URL to download the results of the long-running batch request.
Definitionen
Name | Beschreibung |
---|---|
Batch |
Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar. |
Batch |
Batch-Anforderungsobjekt |
Delay |
Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API. |
Driving |
Gibt an, dass links im Vergleich zur rechten Seite am Punkt des Manövers gefahren wird. |
Effective |
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Guidance |
Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform. |
Guidance |
Ein Code, der das Manöver identifiziert. |
Json |
Das gewünschte Format der Antwort. Nur das |
Junction |
Der Typ der Verbindung, auf der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert. |
Lat |
Ein Standort, der als Breiten- und Längengrad dargestellt wird. |
Response |
Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse. |
Response |
Abschnittstypen der gemeldeten Routenantwort |
Response |
Reisemodus für die berechnete Route. Der Wert wird auf |
Route | |
Route |
Ein Element, das vom Batch-Dienstaufruf "Route Directions" zurückgegeben wird. |
Route |
Dieses Objekt wird von einem erfolgreichen Aufruf des Batch-Diensts Route Directions zurückgegeben. |
Route |
Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist. |
Route |
Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Rechts abbiegen", "Links halten", "Fähre nehmen", "Autobahn nehmen", "Ankommen". |
Route |
Gruppiert eine Sequenz von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged), erhält die instructionGroup eine Zusammenfassungsmeldung, wenn sie verfügbar ist. |
Route |
Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung angegeben wird, führt zu einer zusätzlichen Etappe auf der zurückgegebenen Route. |
Route |
Summary-Objekt für den Routenabschnitt. |
Route |
Optimiertes Wegepunktobjekt. |
Route |
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden. |
Route |
Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente |
Route |
Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente. |
Route |
Die Ursache des Datenverkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Ikonographie und Beschreibungen zu definieren. |
Route |
Summary-Objekt |
Simple |
Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec". |
Summary |
Zusammenfassung der Ergebnisse für die Batchanforderung |
BatchRequest
Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Die Liste der zu verarbeitenden Abfragen. |
BatchRequestItem
Batch-Anforderungsobjekt
Name | Typ | Beschreibung |
---|---|---|
query |
string |
Dieser Parameter enthält eine Abfragezeichenfolge, die zum Ausführen eines unstrukturierten Geocodierungsvorgangs verwendet wird. Die Abfragezeichenfolge wird zur Verarbeitung wortwörtlich an die Such-API übergeben. |
DelayMagnitude
Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API.
Name | Typ | Beschreibung |
---|---|---|
0 |
string |
Unbekannt |
1 |
string |
Gering. |
2 |
string |
Mäßig. |
3 |
string |
Schwerwiegend. |
4 |
string |
Undefiniert, wird für Straßensperrungen und andere unbestimmte Verzögerungen verwendet. |
DrivingSide
Gibt an, dass links im Vergleich zur rechten Seite am Punkt des Manövers gefahren wird.
Name | Typ | Beschreibung |
---|---|---|
LEFT |
string |
Links. |
RIGHT |
string |
Rechte Seite. |
EffectiveSetting
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Der Name des verwendeten Parameters. |
value |
string |
Wert des verwendeten Parameters. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
GuidanceInstructionType
Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform.
Name | Typ | Beschreibung |
---|---|---|
DIRECTION_INFO |
string |
Richtungsinformationen. |
LOCATION_ARRIVAL |
string |
Ankunftsort. |
LOCATION_DEPARTURE |
string |
Abfahrtsort. |
LOCATION_WAYPOINT |
string |
Wegpunktposition. |
ROAD_CHANGE |
string |
Straßenänderung. |
TURN |
string |
Drehen. |
GuidanceManeuver
Ein Code, der das Manöver identifiziert.
Name | Typ | Beschreibung |
---|---|---|
ARRIVE |
string |
Sie sind angekommen. |
ARRIVE_LEFT |
string |
Sie sind angekommen. Ihr Ziel befindet sich auf der linken Seite. |
ARRIVE_RIGHT |
string |
Sie sind angekommen. Ihr Ziel befindet sich auf der rechten Seite. |
BEAR_LEFT |
string |
Bärt links. |
BEAR_RIGHT |
string |
Bärt recht. |
DEPART |
string |
Verlassen. |
ENTER_FREEWAY |
string |
Nehmen Sie die Autobahn. |
ENTER_HIGHWAY |
string |
Nehmen Sie die Autobahn. |
ENTER_MOTORWAY |
string |
Nehmen Sie die Autobahn. |
ENTRANCE_RAMP |
string |
Nehmen Sie die Rampe. |
FOLLOW |
string |
Folgen. |
KEEP_LEFT |
string |
Links halten. |
KEEP_RIGHT |
string |
Halten Sie sich rechts. |
MAKE_UTURN |
string |
Machen Sie eine Kehrtwende. |
MOTORWAY_EXIT_LEFT |
string |
Nehmen Sie die linke Ausfahrt. |
MOTORWAY_EXIT_RIGHT |
string |
Nehmen Sie die rechte Ausfahrt. |
ROUNDABOUT_BACK |
string |
Fahren Sie um den Kreisverkehr. |
ROUNDABOUT_CROSS |
string |
Überqueren Sie den Kreisverkehr. |
ROUNDABOUT_LEFT |
string |
Am Kreisverkehr nehmen Sie die Ausfahrt auf der linken Seite. |
ROUNDABOUT_RIGHT |
string |
Am Kreisverkehr nehmen Sie die Ausfahrt auf der rechten Seite. |
SHARP_LEFT |
string |
Drehen Sie sich scharf nach links. |
SHARP_RIGHT |
string |
Drehen Sie sich scharf nach rechts. |
STRAIGHT |
string |
Bleiben Sie geradeaus. |
SWITCH_MAIN_ROAD |
string |
Wechseln Sie zur Hauptstraße. |
SWITCH_PARALLEL_ROAD |
string |
Wechseln Sie zur parallelen Straße. |
TAKE_EXIT |
string |
Nehmen Sie die Ausfahrt. |
TAKE_FERRY |
string |
Nehmen Sie die Fähre. |
TRY_MAKE_UTURN |
string |
Versuchen Sie, eine Kehrtwende vorzunehmen. |
TURN_LEFT |
string |
Biege links ab. |
TURN_RIGHT |
string |
Rechts abbiegen. |
WAYPOINT_LEFT |
string |
Sie haben den Wegpunkt erreicht. Sie befindet sich auf der linken Seite. |
WAYPOINT_REACHED |
string |
Sie haben den Wegpunkt erreicht. |
WAYPOINT_RIGHT |
string |
Sie haben den Wegpunkt erreicht. Sie befindet sich auf der rechten Seite. |
JsonFormat
Das gewünschte Format der Antwort. Nur das json
-Format wird unterstützt.
Name | Typ | Beschreibung |
---|---|---|
json |
string |
JunctionType
Der Typ der Verbindung, auf der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert.
Name | Typ | Beschreibung |
---|---|---|
BIFURCATION |
string |
Gabelung |
REGULAR |
string |
regular |
ROUNDABOUT |
string |
Kreisel |
LatLongPair
Ein Standort, der als Breiten- und Längengrad dargestellt wird.
Name | Typ | Beschreibung |
---|---|---|
latitude |
number |
Latitude-Eigenschaft |
longitude |
number |
Longitude-Eigenschaft |
Response
Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
|
formatVersion |
string |
Format Version-Eigenschaft |
optimizedWaypoints |
Optimierte Sequenz von Wegpunkten. Es zeigt den Index aus der vom Benutzer bereitgestellten Wegpunktsequenz für die ursprüngliche und optimierte Liste an. Beispielsweise eine Antwort:
bedeutet, dass die ursprüngliche Sequenz [0, 1, 2] und die optimierte Sequenz [1, 2, 0] ist. Da der Index mit 0 beginnt, lautet das Original "first, second, third", and the optimized is "second, third, first". |
|
report |
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden. |
|
routes |
Route[] |
Routenarray |
ResponseSectionType
Abschnittstypen der gemeldeten Routenantwort
Name | Typ | Beschreibung |
---|---|---|
CARPOOL |
string |
Abschnitte der Strecke, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern. |
CAR_TRAIN |
string |
Abschnitte der Strecke, bei denen es sich um Autos oder Züge handelt. |
COUNTRY |
string |
Abschnitte, die angeben, in welchen Ländern/Regionen sich die Route befindet. |
FERRY |
string |
Abschnitte der Route, die Fähren sind. |
MOTORWAY |
string |
Streckenabschnitte, die Autobahnen sind. |
PEDESTRIAN |
string |
Streckenabschnitte, die nur für Fußgänger geeignet sind. |
TOLL_ROAD |
string |
Abschnitte der Strecke, für die eine Maut zu zahlen ist. |
TOLL_VIGNETTE |
string |
Streckenabschnitte, für die eine Mautvignette vorhanden sein muss. |
TRAFFIC |
string |
Abschnitte der Route, die Verkehrsinformationen enthalten. |
TRAVEL_MODE |
string |
Abschnitte in Bezug auf den Anforderungsparameter |
TUNNEL |
string |
Abschnitte der Route, die Tunnel sind. |
URBAN |
string |
Abschnitte der Route, die sich in städtischen Gebieten befinden. |
ResponseTravelMode
Reisemodus für die berechnete Route. Der Wert wird auf other
festgelegt, wenn die angeforderte Transportart in diesem Abschnitt nicht möglich ist.
Name | Typ | Beschreibung |
---|---|---|
bicycle |
string |
Die zurückgeführten Routen sind für Fahrräder optimiert, einschließlich der Nutzung von Radwegen. |
bus |
string |
Die zurückgeführten Strecken sind für Busse optimiert, einschließlich der Verwendung von Busspuren. BETA-Funktionalität. |
car |
string |
Die zurückgegebenen Routen sind für Autos optimiert. |
motorcycle |
string |
Die zurückgegebenen Routen sind für Motorräder optimiert. BETA-Funktionalität. |
other |
string |
Die angegebene Transportart ist in diesem Abschnitt nicht möglich. |
pedestrian |
string |
Die zurückgeführten Routen sind für Fußgänger optimiert, einschließlich der Nutzung von Gehwegen. |
taxi |
string |
Die zurückgeführten Routen sind für Taxis optimiert. BETA-Funktionalität. |
truck |
string |
Die rückgeführten Routen sind für Nutzfahrzeuge optimiert, z. B. für Lkw. |
van |
string |
Die zurückgegebenen Routen sind für Transporter optimiert. BETA-Funktionalität. |
Route
Name | Typ | Beschreibung |
---|---|---|
guidance |
Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist. |
|
legs |
Route |
Legs-Array |
sections |
Abschnittsarray |
|
summary |
Summary-Objekt |
RouteDirectionsBatchItem
Ein Element, das vom Batch-Dienstaufruf "Route Directions" zurückgegeben wird.
Name | Typ | Beschreibung |
---|---|---|
response |
Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse. |
|
statusCode |
integer |
HTTP-Anforderungsstatuscode. |
RouteDirectionsBatchResult
Dieses Objekt wird von einem erfolgreichen Aufruf des Batch-Diensts Route Directions zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Array mit den Batchergebnissen. |
|
summary |
Zusammenfassung der Ergebnisse für die Batchanforderung |
RouteGuidance
Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist.
Name | Typ | Beschreibung |
---|---|---|
instructionGroups |
Gruppiert eine Sequenz von Anweisungselementen, die miteinander verknüpft sind. |
|
instructions |
Eine Liste mit Anweisungen, die Manöver beschreiben. |
RouteInstruction
Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Rechts abbiegen", "Links halten", "Fähre nehmen", "Autobahn nehmen", "Ankommen".
Name | Typ | Beschreibung |
---|---|---|
combinedMessage |
string |
Eine lesbare Nachricht für das Manöver in Kombination mit der Nachricht aus der nächsten Anweisung. Manchmal ist es möglich, zwei aufeinander folgende Anweisungen in einer einzigen Anweisung zu kombinieren, um die Folgen zu erleichtern. Wenn dies der Fall ist, ist das flag possibleCombineWithNext true. Beispiel:
Das flag possibleCombineWithNext für Anweisung 10 ist true. Dies gibt den Clients der codierten Anleitung an, dass sie mit Anweisung 11 kombiniert werden kann. Die Anweisungen werden automatisch für Clients kombiniert, die eine lesbare Anleitung anfordern. Das Feld combinedMessage enthält die kombinierte Nachricht:
|
countryCode |
string |
3-stellige ISO 3166-1 Alpha-3-Ländercode. Z.B. USA. |
drivingSide |
Gibt an, dass links im Vergleich zur rechten Seite am Punkt des Manövers gefahren wird. |
|
exitNumber |
string |
Die Anzahl(n) einer Autobahnausfahrt, die vom aktuellen Manöver genommen wurde. Wenn ein Exit mehrere Exitnummern aufweist, werden sie durch "" getrennt und möglicherweise durch "-" aggregiert, z. B. "10, 13-15". |
instructionType |
Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform. |
|
junctionType |
Der Typ der Verbindung, auf der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert. |
|
maneuver |
Ein Code, der das Manöver identifiziert. |
|
message |
string |
Eine lesbare Nachricht für das Manöver. |
point |
Ein Standort, der als Breiten- und Längengrad dargestellt wird. |
|
pointIndex |
integer |
Der Index des Punkts in der Liste der Polylinienpunkte, die dem Punkt der Anweisung entsprechen. |
possibleCombineWithNext |
boolean |
Es ist möglich, die Anweisung optional mit der nächsten zu kombinieren. Dies kann verwendet werden, um Meldungen wie "Links abbiegen und dann nach rechts" zu erstellen. |
roadNumbers |
string[] |
Die Straßennummer(n) der nächsten signifikanten Straßenabschnitte nach dem Manöver oder der zu verfolgenden Straße(n). Beispiel: ["E34", "N205"] |
roundaboutExitNumber |
integer |
Dies gibt an, welche Ausfahrt an einem Kreisverkehr zu nehmen ist. |
routeOffsetInMeters |
integer |
Entfernung vom Anfang der Route bis zum Punkt der Anweisung. |
signpostText |
string |
Der Text auf einem Wegweiser, der für das Manöver oder die Richtung, die befolgt werden soll, am relevantesten ist. |
stateCode |
string |
Eine Unterteilung (z. B. Bundesstaat) des Landes, dargestellt durch den zweiten Teil eines ISO 3166-2-Codes . Dies ist nur für einige Länder/Regionen wie die USA, Kanada und Mexiko verfügbar. |
street |
string |
Straßenname des nächsten bedeutenden Straßenabschnitts nach dem Manöver oder der Straße, die befolgt werden soll. |
travelTimeInSeconds |
integer |
Geschätzte Reisezeit bis zu dem Punkt, der routeOffsetInMeters entspricht. |
turnAngleInDecimalDegrees |
integer |
Gibt die Richtung einer Anweisung an. Wenn junctionType eine Turn-Anweisung angibt:
Wenn junctionType eine Bifurcationsanweisung angibt:
|
RouteInstructionGroup
Gruppiert eine Sequenz von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged), erhält die instructionGroup eine Zusammenfassungsmeldung, wenn sie verfügbar ist.
Name | Typ | Beschreibung |
---|---|---|
firstInstructionIndex |
integer |
Index der ersten Anweisung in den Anweisungen und gehört zu dieser Gruppe. |
groupLengthInMeters |
integer |
Länge der Gruppe. |
groupMessage |
string |
Zusammenfassungsmeldung, wenn lesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged). |
lastInstructionIndex |
integer |
Index der letzten Anweisung in den Anweisungen und gehört zu dieser Gruppe. |
RouteLeg
Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung angegeben wird, führt zu einer zusätzlichen Etappe auf der zurückgegebenen Route.
Name | Typ | Beschreibung |
---|---|---|
points |
Punktarray |
|
summary |
Summary-Objekt für den Routenabschnitt. |
RouteLegSummary
Summary-Objekt für den Routenabschnitt.
Name | Typ | Beschreibung |
---|---|---|
arrivalTime |
string |
Die geschätzte Ankunftszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben. |
batteryConsumptionInkWh |
number |
Geschätzter Stromverbrauch in Kilowattstunden (kWh) unter Verwendung des Stromverbrauchsmodells. Enthalten, wenn vehicleEngineType auf electric und constantSpeedConsumptionInkWhPerHundredkm festgelegt ist. Der Wert von batteryConsumptionInkWh enthält die rekuperierte elektrische Energie und kann daher negativ sein (was auf die Gewinnung von Energie hinweist). Wenn sowohl maxChargeInkWh als auch currentChargeInkWh angegeben sind, wird die Rekuperation begrenzt, um sicherzustellen, dass der Akkuladestand maxChargeInkWh niemals überschreitet. Wenn weder maxChargeInkWh noch currentChargeInkWh angegeben sind, wird bei der Verbrauchsberechnung von einer uneingeschränkten Rekuperation ausgegangen. |
departureTime |
string |
Die geschätzte Abfahrtszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben. |
fuelConsumptionInLiters |
number |
Geschätzter Kraftstoffverbrauch in Litern unter Verwendung des Verbrennungsverbrauchsmodells. Enthalten, wenn vehicleEngineType auf combustion und constantSpeedConsumptionInLitersPerHundredkm festgelegt ist. Der Wert ist nicht negativ. |
historicTrafficTravelTimeInSeconds |
integer |
Geschätzte Reisezeit, die anhand zeitabhängiger Verlaufsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird. |
lengthInMeters |
integer |
Length In Meters-Eigenschaft |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Geschätzte Reisezeit, die mithilfe von Echtzeitgeschwindigkeitsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird. |
noTrafficTravelTimeInSeconds |
integer |
Geschätzte Reisezeit, berechnet, als ob es aufgrund von Verkehrsbedingungen (z. B. Staus) zu keinen Verzögerungen auf der Strecke kommt. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird. |
trafficDelayInSeconds |
integer |
Geschätzte Verzögerung in Sekunden, die durch die Echtzeitvorfälle gemäß Den Verkehrsinformationen verursacht wird. Bei routen, die in Zukunft mit Abfahrtszeit geplant sind, beträgt die Verspätung immer 0. Um zusätzliche Reisezeiten mithilfe verschiedener Arten von Datenverkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden. |
travelTimeInSeconds |
integer |
Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echtzeitdatenverkehr enthält. Beachten Sie, dass auch wenn traffic=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs enthält. Wenn DepartAt in der Zukunft liegt, wird die Reisezeit anhand zeitabhängiger historischer Verkehrsdaten berechnet. |
RouteOptimizedWaypoint
Optimiertes Wegepunktobjekt.
Name | Typ | Beschreibung |
---|---|---|
optimizedIndex |
integer |
Optimierter Wegpunktindex aus dem System. |
providedIndex |
integer |
Vom Benutzer bereitgestellter Wegpunktindex. |
RouteReport
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
effectiveSettings |
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden. |
RouteSection
Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente startPointIndex
, endPointIndex
und sectionType
.
Name | Typ | Beschreibung |
---|---|---|
delayInSeconds |
integer |
Verzögerung in Sekunden, die durch den Vorfall verursacht wird. |
effectiveSpeedInKmh |
integer |
Effektive Geschwindigkeit des Vorfalls in km/h, gemittelt über seine gesamte Länge. |
endPointIndex |
integer |
Index des letzten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt. |
magnitudeOfDelay |
Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API. |
|
sectionType |
Abschnittstypen der gemeldeten Routenantwort |
|
simpleCategory |
Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec". |
|
startPointIndex |
integer |
Index des ersten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt. |
tec |
Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente. |
|
travelMode |
Reisemodus für die berechnete Route. Der Wert wird auf |
RouteSectionTec
Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente.
Name | Typ | Beschreibung |
---|---|---|
causes |
Verursacht Array |
|
effectCode |
integer |
Die Auswirkung auf den Datenverkehrsfluss. Enthält einen Wert in der Tabelle tec001:EffectCode, wie im TPEG2-TEC-Standard definiert. Kann verwendet werden, um Datenverkehrsereignisse entsprechend dem Schweregrad einzufärben. |
RouteSectionTecCause
Die Ursache des Datenverkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Ikonographie und Beschreibungen zu definieren.
Name | Typ | Beschreibung |
---|---|---|
mainCauseCode |
integer |
Die Hauptursache des Datenverkehrsereignisses. Enthält einen Wert in der Tabelle tec002:CauseCode, wie im TPEG2-TEC-Standard definiert. |
subCauseCode |
integer |
Die Unterause des Datenverkehrsereignisses. Enthält einen Wert in der Unterursachentabelle, die durch mainCauseCode definiert wird, wie im TPEG2-TEC-Standard definiert. |
RouteSummary
Summary-Objekt
Name | Typ | Beschreibung |
---|---|---|
arrivalTime |
string |
Die geschätzte Ankunftszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben. |
departureTime |
string |
Die geschätzte Abfahrtszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben. |
lengthInMeters |
integer |
Length In Meters-Eigenschaft |
trafficDelayInSeconds |
integer |
Geschätzte Verzögerung in Sekunden, die durch die Echtzeitvorfälle gemäß Den Verkehrsinformationen verursacht wird. Bei routen, die in Zukunft mit Abfahrtszeit geplant sind, beträgt die Verspätung immer 0. Um zusätzliche Reisezeiten mithilfe verschiedener Arten von Datenverkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden. |
travelTimeInSeconds |
integer |
Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echtzeitdatenverkehr enthält. Beachten Sie, dass auch wenn traffic=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs enthält. Wenn DepartAt in der Zukunft liegt, wird die Reisezeit anhand zeitabhängiger historischer Verkehrsdaten berechnet. |
SimpleCategory
Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec".
Name | Typ | Beschreibung |
---|---|---|
JAM |
string |
Verkehrsstau. |
OTHER |
string |
Sonstiges |
ROAD_CLOSURE |
string |
Straßensperrung. |
ROAD_WORK |
string |
Straßenarbeiten. |
Summary
Zusammenfassung der Ergebnisse für die Batchanforderung
Name | Typ | Beschreibung |
---|---|---|
successfulRequests |
integer |
Anzahl der erfolgreichen Anforderungen im Batch |
totalRequests |
integer |
Gesamtanzahl der Anforderungen im Batch |