Freigeben über


Route - Post Route Matrix Async

Die Route Matrix Async-API ist eine HTTP-POST-Anforderung, die die Berechnung einer Matrix von Routenzusammenfassungen für eine Reihe von Routen ermöglicht, die von Ursprungs- und Zielspeicherorten mithilfe einer asynchronen (asynchronen) Anforderung definiert wurden. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten des Routings von diesem Ursprung an jedes bestimmte Ziel. Der Satz von Ursprüngen 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 an das Ziel für diese Zelle. Routenmatrizen können für Fahr-, Fuß- und Lkw-Routen berechnet werden.

Route Matrices werden in verschiedenen Arten von Anwendungen verwendet, die am häufigsten zur Lösung des Problems "Traveling Salesman" (TSP) und des Fahrzeugroutingproblems (Vehicle Routing Problem, VRP) verwendet werden. Für jedes Ursprungszielpaar in der Matrix werden die Fahrzeit und die Entfernung zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen.

Die maximale Größe einer Matrix für asynchrone Anforderung ist 50000 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Asynchrone Routenmatrixanforderung übermitteln

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung stellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer URL im feld operation-Location des Antwortheaders mit dem Azure Maps-Geografieendpunkt "{geography}.atlas.microsoft.com" zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis der Status erfolgreich ist.

Die maximale Größe einer Matrix für diese API ist 500000 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 500x100, 100x100, 280x170. 100x50 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

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

Hier ist eine typische Abfolge asynchroner Vorgänge:

  1. Der Client sendet eine POST-Anforderung der Route-Matrix an Azure Maps.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP-202 Accepted – Route Matrix-Anforderung wurde akzeptiert.

    HTTP-Error – Fehler beim Verarbeiten der Route Matrix-Anforderung. Dies kann entweder ein 400 Ungültiger Anforderungscode oder ein anderer Fehlerstatuscode sein.

  3. Wenn die Matrixroute-Anforderung erfolgreich akzeptiert wurde, enthält der operation-location Header in der Antwort die URL, um den Status der Anforderung abzurufen. Dieser Status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01?subscription-key={subscription-key}
  1. Der Client gibt eine GET-Anforderung für die in Schritt 3 abgerufene resultUrl aus, um die Ergebnisse abzurufen.
  GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01?subscription-key={subscription-key}

API-Einschränkungen

Die asynchrone Verarbeitung der Matrix eignet sich am besten für größere Matrizen, die eine hohe Routenberechnung erfordern. Die folgende Einschränkung gilt für die asynchronen Anforderungen. Wenn keine der Zeilen in der folgenden Tabelle mit den Parametern der Anforderung übereinstimmt, erfüllt die Anforderung nicht die Anforderungen und wird nicht verarbeitet.

Maximale Matrixgröße Maximale Anzahl von Ursprüngen Maximale Anzahl von Zielen Zusätzliche Grenzwerte
2500 1000 1000 Alle Ursprünge und Ziele sollten in einem achsenbündigen 400 km x 400 km umgebenden Feld enthalten sein. Andernfalls werden einige Matrixzellen als OUT_OF_REGION aufgelöst. 
50.000 10,000 10,000 - departAt oder arriveAt müssen beliebig sein.
- traffic muss historisch sein.
- optimizeRoute müssen am schnellsten sein.
- travelMode müssen entweder Fahren oder Lkw sein. 
- Es können keine anderen Parameter explizit verwendet werden. 
POST https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
query True

string

Versionsnummer der Azure Maps-API.

Anforderungsheader

Media Types: "application/geo+json"

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

Media Types: "application/geo+json"

Name Erforderlich Typ Beschreibung
features True

InputRouteMatrixFeaturesItem[]

Eine Reihe von Ursprungs- und Zielpunkten, die als GeoJSON MultiPoint-Features für die Eingabematrix übergeben werden. Einzelheiten zum GeoJSON-Format finden Sie unter RFC 7946-.

type True

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

arriveAt

string

Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als dateTime Wert formatiert ist, der durch RFC 3339, Abschnitt 5.6definiert ist. Wenn kein Zeitzonenoffset angegeben wird, wird UTC angenommen.

Der parameter arriveAt kann nicht in Verbindung mit departAtverwendet werden.

Die arriveAt unterstützt auch any Wert, der auf den Anwendungsfall zugeschnitten ist, in dem der Zeitkontext irrelevant ist. Der traffic=live Parameterwert kann nicht zusammen mit anyverwendet werden.

Standardwert: any, wenn arriveAt nicht angegeben ist.

Beispiel: "arriveAt": "2024-12-01T09:30:00.000-07:00"

avoid

RouteMatrixAvoidEnum[]

Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.

departAt

string

Das Datum und die Uhrzeit des Abflugpunkts, der als dateTime Wert formatiert ist, der durch RFC 3339, Abschnitt 5.6definiert ist. Wenn kein Zeitzonenoffset angegeben wird, wird UTC angenommen.

Der parameter departAt kann nicht in Verbindung mit arriveAtverwendet werden.

Die departAt unterstützt außerdem Folgendes:

any Wert, der auf den Anwendungsfall zugeschnitten ist, in dem der Zeitkontext irrelevant ist. Der traffic=live Parameterwert kann nicht zusammen mit anyverwendet werden.

now Wert, um die Abflugzeit auf die Verarbeitungszeit jeder einzelnen Zelle festzulegen. Die Verarbeitungszeit kann jederzeit zwischen Übermittlung und Abschluss erfolgen. Dieser Modus wird am besten zusammen mit traffic=live verwendet.

Standardwert: any, wenn departAt nicht angegeben ist.

Beispiel:

"departAt": "2024-12-01T09:30:00.000-07:00"

optimizeRoute

RouteMatrixAsyncOptimizeRouteEnum

Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "schnellste" und gibt die Route zurück, um die Fahrzeit zu minimieren.

Beispiel: "optimizeRoute":"shortest"

traffic

RouteMatrixTrafficEnum

Gibt an, wie Datenverkehr für die Berechnung von Routen berücksichtigt wird.

Standardwert: historical

travelMode

RouteMatrixTravelModeEnum

Gibt das Reiseprofil an, das beim Berechnen der Matrix berücksichtigt werden soll. Wenn nicht angegeben, lautet der Standardwert "Driving".

Beispiel: "travelMode":"driving"

vehicleSpec

RouteMatrixVehicleSpec

Gibt die Fahrzeugattribute wie Fahrzeughöhe, Gewicht, Höchstgeschwindigkeit, Frachttyp usw. an, die bei der Berechnung der Routenmatrix berücksichtigt werden sollen. Dies trägt dazu bei, niedrige Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Route basierend auf den Fahrzeugspezifikationen bereitzustellen. Fahrzeugattribute werden innerhalb der Eigenschaft "vehicleSpec" angegeben.

Antworten

Name Typ Beschreibung
202 Accepted

Angenommen

Header

Operation-Location: string

Other Status Codes

MapsErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Header

x-ms-error-code: string

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.

Hinweis

  • 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 das konfigurationsbasierte Einrichten 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 gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

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

Submit an asynchronous request for matrix

Beispielanforderung

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck",
  "avoid": [
    "unpavedRoads"
  ]
}

Beispiel für eine Antwort

Operation-Location: https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Definitionen

Name Beschreibung
AdrTunnelRestrictionCodeEnum

Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf.

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

GeoJsonMultiPoint

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

InputRouteMatrixFeaturesItem

Gibt die Eingabeursprung- und Zielpunkte sowie zusätzliche Eigenschaften für das GeoJSON MultiPoint-Featureobjekt an. Ausführliche Informationen finden Sie unter RFC 7946-.

InputRouteMatrixProperties

Gibt das Eigenschaftenobjekt für die Eingabematrix an.

MapsErrorDetail

Das Fehlerdetails.

MapsErrorResponse

Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

RouteMatrixAsyncOptimizeRouteEnum

Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "schnellste" und gibt die Route zurück, um die Fahrzeit zu minimieren.

Beispiel: "optimizeRoute":"shortest"

RouteMatrixAsyncRequest

Dient zum Abrufen einer Routenmatrix, die die Fahrzeit und Entfernung für alle möglichen Paare in einer Liste der Ursprünge und des Ziels anzeigt. GeoJSON Featureobjekt und zusätzliche Eigenschaften. Ausführliche Informationen finden Sie unter RFC 7946-.

RouteMatrixAvoidEnum

Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.

RouteMatrixTrafficEnum

Gibt an, wie Datenverkehr für die Berechnung von Routen berücksichtigt wird.

Standardwert: historical

RouteMatrixTravelModeEnum

Gibt das Reiseprofil an, das beim Berechnen der Matrix berücksichtigt werden soll. Wenn nicht angegeben, lautet der Standardwert "Driving".

Beispiel: "travelMode":"driving"

RouteMatrixTypeEnum

Gibt den Ursprung MultiPoint-Typ und den Ziel-MultiPoint-Typ für die Eingabematrix an.

RouteMatrixVehicleSpec

Gibt die Fahrzeugattribute wie Fahrzeughöhe, Gewicht, Höchstgeschwindigkeit, Frachttyp usw. an, die bei der Berechnung der Routenmatrix berücksichtigt werden sollen. Dies trägt dazu bei, niedrige Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Route basierend auf den Fahrzeugspezifikationen bereitzustellen. Fahrzeugattribute werden innerhalb der Eigenschaft "vehicleSpec" angegeben.

VehicleLoadTypeEnum

Ladungstypen, die als gefährliche Stoffe eingestuft 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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung.

AdrTunnelRestrictionCodeEnum

Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf.

Wert Beschreibung
B

Fahrzeuge mit Code B sind von Straßen mit ADR-Tunnelkategorien B, C, D und E eingeschränkt.

C

Fahrzeuge mit Code C sind von Straßen mit ADR-Tunnelkategorien C, D und E eingeschränkt

D

Fahrzeuge mit Code D sind von Straßen mit ADR-Tunnelkategorien D und E eingeschränkt.

E

Fahrzeuge mit Code E sind von Straßen mit ADR-Tunnelkategorie E eingeschränkt.

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

Wert Beschreibung
Feature

Gibt den GeoJSON Featureobjekttyp an.

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

Wert Beschreibung
FeatureCollection

Gibt den GeoJSONFeatureCollection Objekttyp an.

GeoJsonMultiPoint

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

Name Typ Beschreibung
coordinates

number[] (double)

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.

InputRouteMatrixFeaturesItem

Gibt die Eingabeursprung- und Zielpunkte sowie zusätzliche Eigenschaften für das GeoJSON MultiPoint-Featureobjekt an. Ausführliche Informationen finden Sie unter RFC 7946-.

Name Typ Beschreibung
geometry

GeoJsonMultiPoint

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

properties

InputRouteMatrixProperties

MultiPoint-Featureeigenschaftenobjekt, das die Ursprungsfeatures und Zielfeatures für die Eingabematrix angibt.

type

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

InputRouteMatrixProperties

Gibt das Eigenschaftenobjekt für die Eingabematrix an.

Name Typ Beschreibung
pointType

RouteMatrixTypeEnum

Gibt den Ursprung MultiPoint-Typ und den Ziel-MultiPoint-Typ für die Eingabematrix an.

MapsErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

MapsErrorDetail[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message

string

Eine lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

MapsErrorResponse

Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

Name Typ Beschreibung
error

MapsErrorDetail

Das Fehlerdetails.

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

innererror

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

RouteMatrixAsyncOptimizeRouteEnum

Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "schnellste" und gibt die Route zurück, um die Fahrzeit zu minimieren.

Beispiel: "optimizeRoute":"shortest"

Wert Beschreibung
fastest

Findet die schnellste Route, um die Route nach Reisezeit zu optimieren.

shortest

Findet die kürzeste Route, um die Route nach Der Entfernung zu optimieren.

RouteMatrixAsyncRequest

Dient zum Abrufen einer Routenmatrix, die die Fahrzeit und Entfernung für alle möglichen Paare in einer Liste der Ursprünge und des Ziels anzeigt. GeoJSON Featureobjekt und zusätzliche Eigenschaften. Ausführliche Informationen finden Sie unter RFC 7946-.

Name Typ Standardwert Beschreibung
arriveAt

string

Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als dateTime Wert formatiert ist, der durch RFC 3339, Abschnitt 5.6definiert ist. Wenn kein Zeitzonenoffset angegeben wird, wird UTC angenommen.

Der parameter arriveAt kann nicht in Verbindung mit departAtverwendet werden.

Die arriveAt unterstützt auch any Wert, der auf den Anwendungsfall zugeschnitten ist, in dem der Zeitkontext irrelevant ist. Der traffic=live Parameterwert kann nicht zusammen mit anyverwendet werden.

Standardwert: any, wenn arriveAt nicht angegeben ist.

Beispiel: "arriveAt": "2024-12-01T09:30:00.000-07:00"

avoid

RouteMatrixAvoidEnum[]

Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.

departAt

string

Das Datum und die Uhrzeit des Abflugpunkts, der als dateTime Wert formatiert ist, der durch RFC 3339, Abschnitt 5.6definiert ist. Wenn kein Zeitzonenoffset angegeben wird, wird UTC angenommen.

Der parameter departAt kann nicht in Verbindung mit arriveAtverwendet werden.

Die departAt unterstützt außerdem Folgendes:

any Wert, der auf den Anwendungsfall zugeschnitten ist, in dem der Zeitkontext irrelevant ist. Der traffic=live Parameterwert kann nicht zusammen mit anyverwendet werden.

now Wert, um die Abflugzeit auf die Verarbeitungszeit jeder einzelnen Zelle festzulegen. Die Verarbeitungszeit kann jederzeit zwischen Übermittlung und Abschluss erfolgen. Dieser Modus wird am besten zusammen mit traffic=live verwendet.

Standardwert: any, wenn departAt nicht angegeben ist.

Beispiel:

"departAt": "2024-12-01T09:30:00.000-07:00"

features

InputRouteMatrixFeaturesItem[]

Eine Reihe von Ursprungs- und Zielpunkten, die als GeoJSON MultiPoint-Features für die Eingabematrix übergeben werden. Einzelheiten zum GeoJSON-Format finden Sie unter RFC 7946-.

optimizeRoute

RouteMatrixAsyncOptimizeRouteEnum

fastest

Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "schnellste" und gibt die Route zurück, um die Fahrzeit zu minimieren.

Beispiel: "optimizeRoute":"shortest"

traffic

RouteMatrixTrafficEnum

historical

Gibt an, wie Datenverkehr für die Berechnung von Routen berücksichtigt wird.

Standardwert: historical

travelMode

RouteMatrixTravelModeEnum

driving

Gibt das Reiseprofil an, das beim Berechnen der Matrix berücksichtigt werden soll. Wenn nicht angegeben, lautet der Standardwert "Driving".

Beispiel: "travelMode":"driving"

type

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

vehicleSpec

RouteMatrixVehicleSpec

Gibt die Fahrzeugattribute wie Fahrzeughöhe, Gewicht, Höchstgeschwindigkeit, Frachttyp usw. an, die bei der Berechnung der Routenmatrix berücksichtigt werden sollen. Dies trägt dazu bei, niedrige Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Route basierend auf den Fahrzeugspezifikationen bereitzustellen. Fahrzeugattribute werden innerhalb der Eigenschaft "vehicleSpec" angegeben.

RouteMatrixAvoidEnum

Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.

Wert Beschreibung
tollRoads

Vermeidet die Nutzung der mautpflichtigen Straßen auf der Route.

unpavedRoads

Vermeidet nicht gepavte Straßen in der Route.

RouteMatrixTrafficEnum

Gibt an, wie Datenverkehr für die Berechnung von Routen berücksichtigt wird.

Standardwert: historical

Wert Beschreibung
historical

Die Routenberechnung berücksichtigt historische Fahrzeiten und langfristige Schließungen. Staus und kurzlebige Schließungen während des Reisezeitfensters wirken sich nicht auf die Verteiler- oder Reisezeit aus.

live

Neben historischen Fahrzeiten berücksichtigt die Routenberechnung Staus und kurz- und langfristige Schließungen während des Reisezeitfensters.

Note: traffic=live dürfen in Verbindung mit arriveAt=any und departAt=any

RouteMatrixTravelModeEnum

Gibt das Reiseprofil an, das beim Berechnen der Matrix berücksichtigt werden soll. Wenn nicht angegeben, lautet der Standardwert "Driving".

Beispiel: "travelMode":"driving"

Wert Beschreibung
driving

Routingprofil, das für Autos geeignet ist, werden zur Routenmatrixberechnung verwendet.

truck

Routingprofil, das für Nutzfahrzeuge wie Lkw geeignet ist, werden zur Routenmatrixberechnung verwendet.

walking

Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich des Einsatzes von Gehwegen.

RouteMatrixTypeEnum

Gibt den Ursprung MultiPoint-Typ und den Ziel-MultiPoint-Typ für die Eingabematrix an.

Wert Beschreibung
destinations

MultiPoint-Features, die die Zielspeicherorte in der Eingabematrix definieren.

origins

MultiPoint-Features, die die Ursprungspositionen in der Eingabematrix definieren.

RouteMatrixVehicleSpec

Gibt die Fahrzeugattribute wie Fahrzeughöhe, Gewicht, Höchstgeschwindigkeit, Frachttyp usw. an, die bei der Berechnung der Routenmatrix berücksichtigt werden sollen. Dies trägt dazu bei, niedrige Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Route basierend auf den Fahrzeugspezifikationen bereitzustellen. Fahrzeugattribute werden innerhalb der Eigenschaft "vehicleSpec" angegeben.

Name Typ Standardwert Beschreibung
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf.

axleWeight

integer (int64)

minimum: 0
maximum: 1000000
0

Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden.

height

number (double)

minimum: 0
maximum: 1000000
0

Höhe des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.

isVehicleCommercial

boolean

False

Ob das Fahrzeug für gewerbliche Zwecke verwendet wird. Nutzfahrzeuge dürfen auf einigen Straßen möglicherweise nicht fahren.

length

number (double)

minimum: 0
maximum: 1000000
0

Länge des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Längenbeschränkungen nicht berücksichtigt werden.

loadType

VehicleLoadTypeEnum[]

Ladungstypen, die als gefährliche Stoffe eingestuft 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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung.

maxSpeed

integer (int64)

minimum: 0
maximum: 250
0

Maximale Geschwindigkeit des Fahrzeugs in km/Stunde. Die Höchstgeschwindigkeit im Fahrzeugprofil wird verwendet, um zu überprüfen, ob ein Fahrzeug auf Autobahnen erlaubt ist.

Ein Wert von 0 bedeutet, dass bei der Routenplanung ein entsprechender Wert für das Fahrzeug bestimmt und angewendet wird.

Ein Wert ungleich Null kann während der Routenplanung außer Kraft gesetzt werden. Beispielsweise beträgt der aktuelle Verkehrsfluss 60 km/Stunde. Wenn die Maximale Geschwindigkeit des Fahrzeugs auf 50 km/Stunde festgelegt ist, berücksichtigt der Routingmotor 60 km/Stunde, da dies die aktuelle Situation ist. Wenn die maximale Geschwindigkeit des Fahrzeugs als 80 km/Stunde angegeben wird, aber der aktuelle Verkehrsfluss 60 km/Stunde beträgt, wird der Routingmotor erneut 60 km/Stunde verwenden.

weight

integer (int64)

minimum: 0
maximum: 1000000
0

Gewicht des Fahrzeugs in Kilogramm. Ein Wert von 0 bedeutet, dass Gewichtseinschränkungen nicht berücksichtigt werden.

width

number (double)

minimum: 0
maximum: 1000000
0

Breite des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.

VehicleLoadTypeEnum

Ladungstypen, die als gefährliche Stoffe eingestuft 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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung.

Wert Beschreibung
USHazmatClass1

Sprengstoff

USHazmatClass2

Komprimiertes Gas

USHazmatClass3

Brennbare Flüssigkeiten

USHazmatClass4

Brennbare Feststoffe

USHazmatClass5

Oxidizer

USHazmatClass6

Gifte

USHazmatClass7

Radioaktiv

USHazmatClass8

Beizmittel

USHazmatClass9

Verschiedenes

otherHazmatExplosive

Sprengstoff

otherHazmatGeneral

Verschiedenes

otherHazmatHarmfulToWater

Schädlich für Wasser