Route - Post Route Matrix

Referenz

Service:: Maps

API Version:: 1.0

Verwenden Sie , um mithilfe einer asynchronen Anforderung eine Routenmatrix abzurufen, die die Reisezeit und die Entfernung für alle möglichen Paare in einer Liste von Ursprüngen und Zielen anzeigt.

Die Post Route Matrix API ist eine HTTP-Anforderung POST , die mithilfe einer asynchronen (asynchronen) Anforderung die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen ermöglicht, die von Ursprungs- und Zielstandorten definiert sind. Informationen zum Ausführen einer synchronen Anforderung (Synchronisierung) finden Sie unter Post Route Matrix Sync. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu lösen, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderungen 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln einer synchronen Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie eine synchrone Anforderung durchführen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

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

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung erstellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf true festgelegt ist, erhält der Benutzer eine 200-Antwort, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

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

Dies ist eine typische Abfolge von asynchronen Vorgängen:

Der Client sendet eine POST-Anforderung der Routenmatrix an Azure Maps
Der Server antwortet mit einer der folgenden Aktionen:

HTTP 202 Accepted : Route Matrix-Anforderung wurde akzeptiert.

HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400 ungültige Anforderung oder ein anderer Fehler status Code sein.
Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP 202 Accepted : Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0

With optional parameters:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
arriveAt	query		string date-time	Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als `dateTime` Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6 definiert, mit einem optionalen Zeitzonenoffset. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Des Zielpunkts handelt. Beispiele: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 Der `arriveAt` Parameter kann nicht in Verbindung mit `departAt`, `minDeviationDistance` oder `minDeviationTime`verwendet werden.
avoid	query		RouteAvoidType[]	Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.
computeTravelTimeFor	query		ComputeTravelTime	Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen.
departAt	query		string date-time	Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt, der als `dateTime` Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6 definiert, mit einem optionalen Zeitzonenoffset. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Ursprungspunkts handelt. Standardwert: jetzt Anderer Wert: `dateTime` Beispiele: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 Der `departAt` Parameter kann nicht in Verbindung mit `arriveAt`verwendet werden.
hilliness	query		InclineLevel	Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.
routeType	query		RouteType	Der Typ der angeforderten Route.
sectionType	query		SectionType	Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.
traffic	query		boolean	Mögliche Werte: true: Berücksichtigen Sie während des Routings alle verfügbaren Datenverkehrsinformationen. false: Aktuelle Datenverkehrsdaten während des Routings ignorieren. Beachten Sie, dass die aktuellen Verkehrsdaten zwar beim Routing ignoriert werden, die Auswirkungen des historischen Verkehrs auf die effektiven Straßengeschwindigkeiten jedoch weiterhin berücksichtigt werden.
travelMode	query		TravelMode	Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.
vehicleAxleWeight	query		integer	Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtsbeschränkungen pro Achse nicht berücksichtigt werden.
vehicleHeight	query		number double	Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.
vehicleLength	query		number double	Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden.
vehicleLoadType	query		VehicleLoadType	Arten von Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für US-Routing, während otherHazmat für alle anderen Länder/Regionen verwendet werden sollte. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.
vehicleMaxSpeed	query		integer	Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Die Höchstgeschwindigkeit im Fahrzeugprofil wird verwendet, um zu überprüfen, ob ein Fahrzeug auf Autobahnen zugelassen ist. Der Wert 0 bedeutet, dass bei der Routenplanung ein geeigneter Wert für das Fahrzeug ermittelt und angewendet wird. Ein Wert ungleich 0 kann während der Routenplanung überschrieben werden. Beispielsweise beträgt der aktuelle Verkehrsfluss 60 km/h. Wenn die Höchstgeschwindigkeit des Fahrzeugs auf 50 km/h festgelegt ist, berücksichtigt der Routingmotor 60 km/h, da dies die aktuelle Situation ist. Wenn die Höchstgeschwindigkeit des Fahrzeugs mit 80 km/h angegeben wird, der aktuelle Verkehrsfluss jedoch 60 km/h beträgt, verwendet der Routingmotor wieder 60 km/h.
vehicleWeight	query		integer	Gewicht des Fahrzeugs in Kilogramm.
vehicleWidth	query		number double	Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.
waitForResults	query		boolean	Boolescher Wert, um anzugeben, ob die Anforderung synchron ausgeführt werden soll. Wenn dieser Wert auf TRUE festgelegt ist, erhält der Benutzer eine Antwort vom Typ 200, wenn die Anforderung weniger als 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort vom Typ 202. Weitere Informationen zur Antwort 202 finden Sie in der API-Beschreibung. Wird nur für asynchrone Anforderungen unterstützt.
windingness	query		WindingnessLevel	Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.

Anforderungsheader

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

Anforderungstext

Name	Typ	Beschreibung
destinations	GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
origins	GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Antworten

Name	Typ	Beschreibung
200 OK	RouteMatrixResult	Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.
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. Headers Location: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

RouteMatrixResult

Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

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.

Headers

Location: string

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in 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 Ressourcenkonto 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-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über 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 zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

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

Type: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Successfully submit a route matrix request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

Status code:: 202

operation-Location: New URL to check the status of the long-running operation.

Definitionen

Name	Beschreibung
ComputeTravelTime	Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
InclineLevel	Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
RouteAvoidType	Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.
RouteLegSummary	Summary-Objekt für den Routenabschnitt.
RouteMatrix	Matrixergebnisobjekt
RouteMatrixQuery	Ein -Objekt mit einer Matrix von Koordinaten.
RouteMatrixResult	Dieses Objekt wird von einem erfolgreichen Route Matrix-Aufruf zurückgegeben. Wenn z. B. 2 Ursprünge und 3 Ziele angegeben werden, werden zwei Arrays mit jeweils drei Elementen verwendet. Der Inhalt jedes Elements hängt von den in der Abfrage bereitgestellten Optionen ab.
RouteMatrixResultResponse	Antwortobjekt der aktuellen Zelle in der Eingabematrix.
RouteMatrixSummary	Summary-Objekt
RouteType	Der Typ der angeforderten Route.
SectionType	Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.
TravelMode	Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.
VehicleLoadType	Arten von Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für US-Routing, während otherHazmat für alle anderen Länder/Regionen verwendet werden sollte. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.
WindingnessLevel	Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen.

Name	Typ	Beschreibung
all	string	Berechnet die Reisezeiten für alle Arten von Datenverkehrsinformationen und gibt alle Ergebnisse in den Feldern noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds und liveTrafficIncidentsTravelTimeInSeconds an, die in den Zusammenfassungen in der Routenantwort enthalten sind.
none	string	Berechnet keine zusätzlichen Reisezeiten.

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	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson MultiPoint` Geometrie.
type	string: MultiPoint	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

InclineLevel

Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Name	Typ	Beschreibung
high	string	high
low	string	niedrig
normal	string	normal

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

RouteAvoidType

Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.

Name	Typ	Beschreibung
alreadyUsedRoads	string	Es wird vermieden, dass dieselbe Straße mehrmals verwendet wird. Am nützlichsten in Verbindung mit `routeType`= spannend.
borderCrossings	string	Bei der Routenberechnung werden Grenzübergänge vermieden.
carpools	string	Vermeidet Routen, die die Verwendung von Fahrgemeinschaftsspuren (HOV/High Occupancy Vehicle) erfordern.
ferries	string	Vermeidet Fähren
motorways	string	Vermeidet Autobahnen
tollRoads	string	Vermeidet mautpflichtig straßen.
unpavedRoads	string	Vermeidet unbefestigte Straßen

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.

RouteMatrix

Matrixergebnisobjekt

Name	Typ	Beschreibung
response	RouteMatrixResultResponse	Antwortobjekt der aktuellen Zelle in der Eingabematrix.
statusCode	integer	StatusCode-Eigenschaft für die aktuelle Zelle in der Eingabematrix.

RouteMatrixQuery

Ein -Objekt mit einer Matrix von Koordinaten.

Name	Typ	Beschreibung
destinations	GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
origins	GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

RouteMatrixResult

Dieses Objekt wird von einem erfolgreichen Route Matrix-Aufruf zurückgegeben. Wenn z. B. 2 Ursprünge und 3 Ziele angegeben werden, werden zwei Arrays mit jeweils drei Elementen verwendet. Der Inhalt jedes Elements hängt von den in der Abfrage bereitgestellten Optionen ab.

Name	Typ	Beschreibung
formatVersion	string	Format Version-Eigenschaft
matrix	RouteMatrix[]	Ergebnisse als zweidimensionales Array von Routenzusammenfassungen.
summary	RouteMatrixSummary	Summary-Objekt

RouteMatrixResultResponse

Antwortobjekt der aktuellen Zelle in der Eingabematrix.

Name	Typ	Beschreibung
routeSummary	RouteLegSummary	Summary-Objekt für den Routenabschnitt.

RouteMatrixSummary

Summary-Objekt

Name	Typ	Beschreibung
successfulRoutes	integer	Anzahl der erfolgreichen Routen in der Antwort.
totalRoutes	integer	Gesamtzahl der angeforderten Routen. Anzahl der Zellen in der Eingabematrix.

RouteType

Der Typ der angeforderten Route.

Name	Typ	Beschreibung
eco	string	Eine Strecke, die nach Wirtschaftlichkeit und Geschwindigkeit ausgeglichen ist.
fastest	string	Die schnellste Route.
shortest	string	Der kürzeste Weg nach Entfernung.
thrilling	string	Umfasst interessante oder anspruchsvolle Straßen und nutzt so wenige Autobahnen wie möglich. Sie können die Stufe der enthaltenen Kurven und auch den Grad der Hügellichkeit auswählen. Sehen Sie sich die Parameter für Hügellichkeit und Windung an, um dies festzulegen. Es gibt eine Grenze von 900 km auf geplanten Routen mit `routeType`=aufregenden

SectionType

Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird.

Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.

Name	Typ	Beschreibung
carTrain	string	Abschnitte der Strecke, bei denen es sich um Autos oder Züge handelt.
carpool	string	Abschnitte der Strecke, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern.
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.
tollRoad	string	Abschnitte der Strecke, für die eine Maut zu zahlen ist.
tollVignette	string	Streckenabschnitte, für die eine Mautvignette vorhanden sein muss.
traffic	string	Abschnitte der Route, die Verkehrsinformationen enthalten.
travelMode	string	Abschnitte in Bezug auf den Anforderungsparameter `travelMode`.
tunnel	string	Abschnitte der Route, die Tunnel sind.
urban	string	Abschnitte der Route, die sich in städtischen Gebieten befinden.

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.

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

VehicleLoadType

Arten von Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für US-Routing, während otherHazmat für alle anderen Länder/Regionen verwendet werden sollte. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.

Name	Typ	Beschreibung
USHazmatClass1	string	explosive Stoffe
USHazmatClass2	string	Komprimiertes Gas
USHazmatClass3	string	Brennbare Flüssigkeiten
USHazmatClass4	string	Brennbare Feststoffe
USHazmatClass5	string	Oxidatoren
USHazmatClass6	string	Gifte
USHazmatClass7	string	radioaktive Stoffe
USHazmatClass8	string	Ätzende Stoffe
USHazmatClass9	string	Verschiedenes
otherHazmatExplosive	string	explosive Stoffe
otherHazmatGeneral	string	Verschiedenes
otherHazmatHarmfulToWater	string	Wasserschädlich

WindingnessLevel

Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Name	Typ	Beschreibung
high	string	high
low	string	niedrig
normal	string	normal

Route - Post Route Matrix

Übermitteln einer synchronen Routenmatrixanforderung

Übermitteln einer asynchronen Routenmatrixanforderung

Herunterladen von Synchronisierungsergebnissen

Herunterladen von Asynchronen Ergebnissen

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Hinweise

Scopes

subscription-key

SAS Token

Beispiele

Successfully submit a route matrix request

Sample Request

Sample Response

Definitionen

ComputeTravelTime

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonMultiPoint

InclineLevel

JsonFormat

RouteAvoidType

RouteLegSummary

RouteMatrix

RouteMatrixQuery

RouteMatrixResult

RouteMatrixResultResponse

RouteMatrixSummary

RouteType

SectionType

TravelMode

VehicleLoadType

WindingnessLevel

Zusätzliche Ressourcen