Route - Post Route Directions Batch Sync

Referenz

Dienst:: Maps

API-Version:: 1.0

Dient zum Senden eines Batches von Abfragen an die Get Route Directions API in einer einzigen synchronen Anforderung.

Hinweis

Azure Maps Route v1-Dienst wird

Der Dienst "Azure Maps Route v1" ist jetzt veraltet und wird am 3.31.28 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Anrufe an den Route v1-Dienst aktualisiert werden, um Route v2025-01-01-01 Service um 3/31/28 zu verwenden. Weitere Informationen finden Sie unter Migrieren von Azure Maps Route 1.0-APIs.

Die Post Route Directions Batch Sync-API ist eine HTTP-POST Anforderung, die Batches von Abfragen mithilfe einer einzigen synchronen Anforderung an die Get Route Directions API sendet. Sie können Route Directions Batch-API aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Mit der asynchronen API können Aufrufer bis zu 700 Abfragen und Synchronisierungs-API bis zu 100 Abfragen stapeln. Informationen zum Aufrufen der Post Route Directions Batch-API in einer asynchronen Anforderung finden Sie unter Post Route Directions Batch.

Synchrone Batchanforderung übermitteln

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt.

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

Batchantwortmodell

Der zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine summary Komponente, die die totalRequests angibt, die Teil der ursprünglichen Batchanforderung waren, und successfulRequestsd. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede und jede Abfrage in der Batchanforderung enthält. Die batchItems enthält die Ergebnisse in der genauen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode- und response Felder. Jede response in batchItems weist einen der folgenden Typen auf:

RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.
Error – Wenn die Abfrage fehlgeschlagen ist. Die Antwort enthält in diesem Fall eine code und eine message.

Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen:

{
    "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/sync/json?api-version=1.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Anforderungstext

Name	Typ	Beschreibung
batchItems	BatchRequestItem[]	Die Liste der zu verarbeitenden Abfragen.

Antworten

Name	Typ	Beschreibung
200 OK	RouteDirectionsBatchResult	OKAY
Other Status Codes	ErrorResponse	Timeout: Die Anforderung dauerte länger als die in der API definierte maximale Zeitdauer.
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, 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 zur Microsoft Identity Platform finden Sie unter Übersicht über die 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 Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successfully retrieve the route direction batch result synchronously

Beispielanforderung

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/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

Statuscode:: 200

{
  "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
  }
}

Statuscode:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definitionen

Name	Beschreibung
BatchRequest	Dieser Typ stellt den Anforderungstext für den Batchdienst dar.
BatchRequestItem	Batchanforderungsobjekt
DelayMagnitude	Die Größe der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail API.
DrivingSide	Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.
EffectiveSetting	Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GuidanceInstructionType	Art der Anweisung, z. B. Abbiege- oder Straßenwechsel.
GuidanceManeuver	Ein Code, der das Manöver identifiziert.
JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
JunctionType	Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.
LatLongPair	Ein Ort, der als Breiten- und Längengrad dargestellt wird.
Response	Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
ResponseSectionType	Abschnittstypen der gemeldeten Routenantwort
ResponseTravelMode	Reisemodus für die berechnete Route. Der Wert wird auf `other` festgelegt, wenn der angeforderte Transportmodus in diesem Abschnitt nicht möglich ist.
Route
RouteDirectionsBatchItem	Ein Element, das vom Anruf des Route Directions Batch-Diensts zurückgegeben wurde.
RouteDirectionsBatchResult	Dieses Objekt wird von einem erfolgreichen Route Directions Batch-Dienstaufruf zurückgegeben.
RouteGuidance	Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind.
RouteInstruction	Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Turn right", "Keep left", "Take the ferry", "Take the autobahn", "Arrive".
RouteInstructionGroup	Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist mit firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn für Anleitungen lesbare Textnachrichten angefordert werden (instructionType=text oder tagged), wird von der instructionGroup eine Zusammenfassungsmeldung zurückgegeben, wenn sie verfügbar ist.
RouteLeg	Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung bereitgestellt wird, führt zu einem zusätzlichen Abschnitt in der zurückgegebenen Route.
RouteLegSummary	Summary-Objekt für den Routenabschnitt.
RouteOptimizedWaypoint	Optimierte Art des Punktobjekts.
RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.
RouteSection	Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente `startPointIndex`, `endPointIndex`und `sectionType`.
RouteSectionTec	Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.
RouteSectionTecCause	Die Ursache des Datenverkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Symbolografie und Beschreibungen zu definieren.
RouteSummary	Summary-Objekt
SimpleCategory	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

Objekt

Dieser Typ stellt den Anforderungstext für den Batchdienst dar.

Name	Typ	Beschreibung
batchItems	BatchRequestItem[]	Die Liste der zu verarbeitenden Abfragen.

BatchRequestItem

Objekt

Batchanforderungsobjekt

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 an die Such-API übergeben.

DelayMagnitude

Enumeration

Die Größe der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail API.

Wert	Beschreibung
0	Unbekannt.
1	Kleiner.
2	Mäßig.
3	Haupt.
4	Nicht definiert, für Straßenschließungen und andere unbestimmte Verzögerungen verwendet.

DrivingSide

Enumeration

Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.

Wert	Beschreibung
LEFT	Linke Seite.
RIGHT	Rechte Seite.

EffectiveSetting

Objekt

Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.

Name	Typ	Beschreibung
key	string	Name des verwendeten Parameters.
value	string	Wert des verwendeten Parameters.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GuidanceInstructionType

Enumeration

Art der Anweisung, z. B. Abbiege- oder Straßenwechsel.

Wert	Beschreibung
DIRECTION_INFO	Richtungsinformationen.
LOCATION_ARRIVAL	Ankunftsort.
LOCATION_DEPARTURE	Abfahrtsort.
LOCATION_WAYPOINT	Position des Wegpunkts.
ROAD_CHANGE	Straßenänderung.
TURN	Drehen.

GuidanceManeuver

Enumeration

Ein Code, der das Manöver identifiziert.

Wert	Beschreibung
ARRIVE	Sie sind angekommen.
ARRIVE_LEFT	Sie sind angekommen. Ihr Ziel befindet sich links.
ARRIVE_RIGHT	Sie sind angekommen. Ihr Ziel befindet sich auf der rechten Seite.
BEAR_LEFT	Bär links.
BEAR_RIGHT	Bär rechts.
DEPART	Verlassen.
ENTER_FREEWAY	Nehmen Sie den Freiweg.
ENTER_HIGHWAY	Nehmen Sie die Autobahn.
ENTER_MOTORWAY	Nehmen Sie die Autobahn.
ENTRANCE_RAMP	Nehmen Sie die Rampe.
FOLLOW	Folgen.
KEEP_LEFT	Bleiben Sie links.
KEEP_RIGHT	Behalten Sie das Recht bei.
MAKE_UTURN	Machen Sie eine U-Turn.
MOTORWAY_EXIT_LEFT	Nehmen Sie den linken Ausgang.
MOTORWAY_EXIT_RIGHT	Nehmen Sie den rechten Ausgang.
ROUNDABOUT_BACK	Fahren Sie mit dem Kreisverkehr um.
ROUNDABOUT_CROSS	Kreuzen Sie den Kreisverkehr.
ROUNDABOUT_LEFT	Im Kreisverkehr nehmen Sie die Ausfahrt auf der linken Seite.
ROUNDABOUT_RIGHT	Im Kreisverkehr nehmen Sie die Ausfahrt auf der rechten Seite.
SHARP_LEFT	Drehen Sie scharf nach links.
SHARP_RIGHT	Drehen Sie scharf nach rechts.
STRAIGHT	Halten Sie es gerade.
SWITCH_MAIN_ROAD	Wechseln Sie zur Hauptstraße.
SWITCH_PARALLEL_ROAD	Wechseln Sie zur parallelen Straße.
TAKE_EXIT	Nehmen Sie den Ausgang.
TAKE_FERRY	Nehmen Sie die Fähre.
TRY_MAKE_UTURN	Versuchen Sie, eine U-Turn zu erstellen.
TURN_LEFT	Biege links ab.
TURN_RIGHT	Rechts abbiegen.
WAYPOINT_LEFT	Sie haben den Wegpunkt erreicht. Sie befindet sich auf der linken Seite.
WAYPOINT_REACHED	Sie haben den Wegpunkt erreicht.
WAYPOINT_RIGHT	Sie haben den Wegpunkt erreicht. Es befindet sich auf der rechten Seite.

JsonFormat

Enumeration

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format

JunctionType

Enumeration

Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.

Wert	Beschreibung
BIFURCATION	Gabelung
REGULAR	regelmäßig
ROUNDABOUT	Kreisel

LatLongPair

Objekt

Ein Ort, der als Breiten- und Längengrad dargestellt wird.

Name	Typ	Beschreibung
latitude	number (double)	Latitude-Eigenschaft
longitude	number (double)	Longitude-Eigenschaft

Response

Objekt

Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.
formatVersion	string	Format Version-Eigenschaft
optimizedWaypoints	RouteOptimizedWaypoint[]	Optimierte Sequenz von Wegpunkten. Er zeigt den Index aus der vom Benutzer bereitgestellten Wegpunktsequenz für die ursprüngliche und optimierte Liste an. Beispielsweise eine Antwort: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` bedeutet, dass die ursprüngliche Sequenz [0, 1, 2] lautet und die optimierte Sequenz [1, 2, 0] ist. Da der Index mit 0 beginnt, lautet das Original "first, second, third", while the optimized is "second, third, first".
report	RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.
routes	Route[]	Routingarray

ResponseSectionType

Enumeration

Abschnittstypen der gemeldeten Routenantwort

Wert	Beschreibung
CARPOOL	Abschnitte der Strecke, die die Nutzung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug) erfordern.
CAR_TRAIN	Abschnitte der Strecke, die Autos oder Züge sind.
COUNTRY	Abschnitte, die angeben, in welchen Ländern/Regionen sich die Route befindet.
FERRY	Abschnitte der Route, die Fähren sind.
MOTORWAY	Abschnitte der Autobahnen.
PEDESTRIAN	Abschnitte der Route, die nur für Fußgänger geeignet sind.
TOLL_ROAD	Abschnitte der Route, für die eine Gebührenzahlung erforderlich ist.
TOLL_VIGNETTE	Abschnitte der Route, für die eine mautpflichtige Vignette vorhanden sein muss.
TRAFFIC	Abschnitte der Route, die Verkehrsinformationen enthalten.
TRAVEL_MODE	Abschnitte im Verhältnis zum Anforderungsparameter `travelMode`.
TUNNEL	Abschnitte der Route, die Tunnel sind.
URBAN	Abschnitte der Strecke, die sich in städtischen Gebieten befinden.

ResponseTravelMode

Enumeration

Reisemodus für die berechnete Route. Der Wert wird auf other festgelegt, wenn der angeforderte Transportmodus in diesem Abschnitt nicht möglich ist.

Wert	Beschreibung
bicycle	Die zurückgegebenen Routen sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.
bus	Die zurückgegebenen Strecken sind für Busse optimiert, einschließlich der Nutzung von Nur-Busspuren. BETA-Funktionalität.
car	Die zurückgegebenen Routen sind für Autos optimiert.
motorcycle	Die zurückgegebenen Strecken sind für Motorräder optimiert. BETA-Funktionalität.
other	Der angegebene Verkehrsträger ist in diesem Abschnitt nicht möglich.
pedestrian	Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich des Einsatzes von Gehwegen.
taxi	Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.
truck	Die zurückgegebenen Routen sind für Nutzfahrzeuge wie für Lkw optimiert.
van	Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität.

Route

Objekt

Name	Typ	Beschreibung
guidance	RouteGuidance	Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind.
legs	RouteLeg[]	Beinenarray
sections	RouteSection[]	Abschnittsarray
summary	RouteSummary	Summary-Objekt

RouteDirectionsBatchItem

Objekt

Ein Element, das vom Anruf des Route Directions Batch-Diensts zurückgegeben wurde.

Name	Typ	Beschreibung
response	Response	Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
statusCode	integer	HTTP-Anforderungsstatuscode.

RouteDirectionsBatchResult

Objekt

Dieses Objekt wird von einem erfolgreichen Route Directions Batch-Dienstaufruf zurückgegeben.

Name	Typ	Beschreibung
batchItems	RouteDirectionsBatchItem[]	Array, das die Batchergebnisse enthält.
summary	Summary	Zusammenfassung der Ergebnisse für die Batchanforderung

RouteGuidance

Objekt

Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind.

Name	Typ	Beschreibung
instructionGroups	RouteInstructionGroup[]	Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind.
instructions	RouteInstruction[]	Eine Liste der Anweisungen, die Manöver beschreiben.

RouteInstruction

Objekt

Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Turn right", "Keep left", "Take the ferry", "Take the autobahn", "Arrive".

Name	Typ	Beschreibung
combinedMessage	string	Eine menschlich 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, die es einfacher macht, zu folgen. Wenn dies der Fall ist, ist das möglicheCombineWithNext-Flag wahr. Beispiel: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` Das möglicheCombineWithNext-Flag für Anweisung 10 ist wahr. Dies weist auf die Clients von codierten Anleitungen hin, dass sie mit Anweisung 11 kombiniert werden kann. Die Anweisungen werden automatisch für Kunden kombiniert, die menschenlesbare Anleitungen anfordern. Das combinedMessage-Feld enthält die kombinierte Nachricht: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3-stellige ISO 3166-1 Alpha-3-Ländercode. Z.B. USA.
drivingSide	DrivingSide	Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.
exitNumber	string	Die Anzahl(n) einer Autobahnausfahrt, die vom aktuellen Manöver genommen wird. Wenn ein Exit mehrere Ausgangsnummern aufweist, werden sie durch "" getrennt und möglicherweise durch "-" aggregiert, z. B. "10, 13-15".
instructionType	GuidanceInstructionType	Art der Anweisung, z. B. Abbiege- oder Straßenwechsel.
junctionType	JunctionType	Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.
maneuver	GuidanceManeuver	Ein Code, der das Manöver identifiziert.
message	string	Eine lesbare Nachricht für das Manöver.
point	LatLongPair	Ein Ort, der als Breiten- und Längengrad dargestellt wird.
pointIndex	integer	Der Index des Punkts in der Liste der Polylinien "Punkte", die dem Punkt der Anweisung entsprechen.
possibleCombineWithNext	boolean	Optional ist es möglich, die Anweisung mit dem nächsten zu kombinieren. Dies kann verwendet werden, um Nachrichten wie "Nach links drehen und dann nach rechts zu drehen" zu erstellen.
roadNumbers	string[]	Die Straßennummer(n) des nächsten signifikanten Straßensegments(n) nach dem Manöver oder der zu verfolgenden Straße(n). Beispiel: ["E34"; "N205"]
roundaboutExitNumber	integer (int64)	Dies zeigt an, welche Ausfahrt bei einem Kreisverkehr zu nehmen ist.
routeOffsetInMeters	integer	Entfernung vom Anfang der Route zum Punkt der Anweisung.
signpostText	string	Der Text auf einem Wegweiser, der für das Manöver am relevantesten ist, oder für die Richtung, die verfolgt werden sollte.
stateCode	string	Eine Unterteilung (z. B. Bundesland) 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ßensegments nach dem Manöver oder der Straße, die verfolgt werden sollte.
travelTimeInSeconds	integer	Geschätzte Fahrzeit bis zum Punkt, der der RouteOffsetInMeters entspricht.
turnAngleInDecimalDegrees	integer	Gibt die Richtung einer Anweisung an. If junctionType indicates a turn instruction: 180 = U-Turn [-179, -1] = Linksdrehung 0 = Gerade ein (ein "0 Grad"-Drehung) [1, 179] = Rechtsdrehung Wenn junctionType eine Bifurcationsanweisung angibt: <0 - links halten >0 - rechts halten

RouteInstructionGroup

Objekt

Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist mit firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn für Anleitungen lesbare Textnachrichten angefordert werden (instructionType=text oder tagged), wird von der instructionGroup eine Zusammenfassungsmeldung zurückgegeben, wenn sie verfügbar ist.

Name	Typ	Beschreibung
firstInstructionIndex	integer	Index der ersten Anweisung in den Anweisungen und Zugehörigkeit zu dieser Gruppe.
groupLengthInMeters	integer	Länge der Gruppe.
groupMessage	string	Zusammenfassungsmeldung, wenn textlesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged).
lastInstructionIndex	integer	Index der letzten Anweisung in den Anweisungen und Zugehörigkeit zu dieser Gruppe.

RouteLeg

Objekt

Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung bereitgestellt wird, führt zu einem zusätzlichen Abschnitt in der zurückgegebenen Route.

Name	Typ	Beschreibung
points	LatLongPair[]	Punktearray
summary	RouteLegSummary	Summary-Objekt für den Routenabschnitt.

RouteLegSummary

Objekt

Summary-Objekt für den Routenabschnitt.

Name	Typ	Beschreibung
arrivalTime	string (date-time)	Die geschätzte Ankunftszeit für die Route oder den Abschnitt. Die Uhrzeit ist in UTC.
batteryConsumptionInkWh	number (double)	Geschätzter elektrischer Energieverbrauch in Wattstunden (kWh) mit dem Elektroverbrauchsmodell. Enthalten, wenn vehicleEngineType auf elektro- und constantSpeedConsumptionInkWhPerHundredkm festgelegt ist. Der Wert von batteryConsumptionInkWh umfasst die recuperierte elektrische Energie und kann daher negativ sein (was auf energiegewinnende Energie hinweist). Wenn sowohl maxChargeInkWh als auch currentChargeInkWh angegeben werden, wird die Recuperation begrenzt, um sicherzustellen, dass der Akkuladestand niemals maxChargeInkWh überschreitet. Wenn weder maxChargeInkWh noch currentChargeInkWh angegeben werden, wird bei der Verbrauchsberechnung eine nicht eingeschränkte Rekuperation angenommen.
departureTime	string (date-time)	Die geschätzte Abfahrtszeit für die Route oder den Bein. Die Uhrzeit ist in UTC.
fuelConsumptionInLiters	number (double)	Geschätzter Kraftstoffverbrauch in Litern mit dem Verbrennungsverbrauchsmodell. Enthalten, wenn vehicleEngineType auf Verbrennung und constantSpeedConsumptionInLitersPerHundredkm festgelegt ist. Der Wert ist nicht negativ.
historicTrafficTravelTimeInSeconds	integer	Geschätzte Fahrzeit, die mit zeitabhängigen historischen Verkehrsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.
lengthInMeters	integer	Length In Meter-Eigenschaft
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschätzte Fahrzeit, die mithilfe von Echtzeitgeschwindigkeitsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.
noTrafficTravelTimeInSeconds	integer	Geschätzte Fahrzeit, die so berechnet wird, als ob es aufgrund von Verkehrsbedingungen keine Verzögerungen auf der Strecke gibt (z. B. Stau). Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.
trafficDelayInSeconds	integer	Geschätzte Verzögerung in Sekunden, die durch den(n) Echtzeitvorfall(n) nach Datenverkehrsinformationen verursacht wird. Bei künftig geplanten Routen mit Abfahrtszeit sind Verzögerungen immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.
travelTimeInSeconds	integer	Geschätzte Fahrzeit in Sekunden, die die Verzögerung aufgrund des Echtzeitdatenverkehrs enthält. Beachten Sie, dass auch wenn datenverkehr=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs noch enthält. Wenn "DepartAt" in Zukunft erfolgt, wird die Fahrzeit mit zeitabhängigen historischen Verkehrsdaten berechnet.

RouteOptimizedWaypoint

Objekt

Optimierte Art des Punktobjekts.

Name	Typ	Beschreibung
optimizedIndex	integer	Optimierter Wegpunktindex aus dem System.
providedIndex	integer	Wegpunktindex, der vom Benutzer bereitgestellt wird.

RouteReport

Objekt

Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.

Name	Typ	Beschreibung
effectiveSettings	EffectiveSetting[]	Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.

RouteSection

Objekt

Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente startPointIndex, endPointIndexund sectionType.

Name	Typ	Beschreibung
delayInSeconds	integer	Verzögerung in Sekunden, die durch den Vorfall verursacht werden.
effectiveSpeedInKmh	integer	Effektive Geschwindigkeit des Vorfalls in km/h, durchschnittlich über die gesamte Länge.
endPointIndex	integer	Index des letzten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt.
magnitudeOfDelay	DelayMagnitude	Die Größe der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail API.
sectionType	ResponseSectionType	Abschnittstypen der gemeldeten Routenantwort
simpleCategory	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	RouteSectionTec	Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.
travelMode	ResponseTravelMode	Reisemodus für die berechnete Route. Der Wert wird auf `other` festgelegt, wenn der angeforderte Transportmodus in diesem Abschnitt nicht möglich ist.

RouteSectionTec

Objekt

Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.

Name	Typ	Beschreibung
causes	RouteSectionTecCause[]	Verursacht Array
effectCode	integer	Der Effekt 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 farbcodieren zu können.

RouteSectionTecCause

Objekt

Die Ursache des Datenverkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Symbolografie 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 Unterkause des Datenverkehrsereignisses. Enthält einen Wert in der durch den mainCauseCode definierten Unterursachentabelle, wie im TPEG2-TEC- Standard definiert.

RouteSummary

Objekt

Summary-Objekt

Name	Typ	Beschreibung
arrivalTime	string (date-time)	Die geschätzte Ankunftszeit für die Route oder den Abschnitt. Die Uhrzeit ist in UTC.
departureTime	string (date-time)	Die geschätzte Abfahrtszeit für die Route oder den Bein. Die Uhrzeit ist in UTC.
lengthInMeters	integer	Length In Meter-Eigenschaft
trafficDelayInSeconds	integer	Geschätzte Verzögerung in Sekunden, die durch den(n) Echtzeitvorfall(n) nach Datenverkehrsinformationen verursacht wird. Bei künftig geplanten Routen mit Abfahrtszeit sind Verzögerungen immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.
travelTimeInSeconds	integer	Geschätzte Fahrzeit in Sekunden, die die Verzögerung aufgrund des Echtzeitdatenverkehrs enthält. Beachten Sie, dass auch wenn datenverkehr=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs noch enthält. Wenn "DepartAt" in Zukunft erfolgt, wird die Fahrzeit mit zeitabhängigen historischen Verkehrsdaten berechnet.

SimpleCategory

Enumeration

Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec".

Wert	Beschreibung
JAM	Verkehrsstau.
OTHER	Andere.
ROAD_CLOSURE	Straßenschließung.
ROAD_WORK	Straßenarbeiten.

Summary

Objekt

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

Freigeben über

Route - Post Route Directions Batch Sync

Synchrone Batchanforderung übermitteln

Batchantwortmodell

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Successfully retrieve the route direction batch result synchronously

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Zusätzliche Ressourcen