Freigeben über

Route - Post Route Matrix

  • Referenz
Dienst:
Maps
API-Version:
1.0

Dient zum Abrufen einer Routenmatrix, die die Fahrzeit und Entfernung für alle möglichen Paare in einer Liste von Ursprüngen und Zielen mithilfe einer asynchronen Anforderung anzeigt.

Die Post Route Matrix-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. Informationen zum Erstellen einer synchronen (Synchronisierungsanforderung) finden Sie unter Post Route Matrix Sync. 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. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und sie müssen den nächstgelegenen Fahrer finden, um die Lieferung aus dem Restaurant aufzunehmen. Um diesen Anwendungsfall zu lösen, können sie die Matrixrouten-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen 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 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Anmerkung

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.

Synchrone Routenmatrixanforderung übermitteln

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 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}

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 vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults Parameter in der Anforderung auf "true" festgelegt ist, erhält der Benutzer eine Antwort von 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (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/json?api-version=1.0&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 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}
  1. Der Client gibt eine GET-Anforderung für die download-URL aus, die in Schritt 3 abgerufen wurde, um die Ergebnisse herunterzuladen.

Synchronisierungsergebnisse herunterladen

Wenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, 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.

Asynchrone Ergebnisse herunterladen

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 Speicherortheader 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 Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP-202 Accepted – Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Versuchen Sie es bitte in irgendeiner 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
Mit optionalen Parametern: 
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

Gewünschtes Format der Antwort. Nur 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.6definiert, mit einem optionalen Offset der Zeitzone. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Zielpunkt handelt.

Beispiele:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Der parameter arriveAt kann nicht in Verbindung mit departAt, minDeviationDistance oder minDeviationTimeverwendet werden.
avoid
 query

RouteAvoidType[]

Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen darf der Wert "AlreadyUsedRoads" nicht verwendet werden.
computeTravelTimeFor
 query

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.
departAt
 query

string

date-time

Das Datum und die Uhrzeit des Abflugpunkts, der als dateTime Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6definiert, mit einem optionalen Offset der Zeitzone. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Ursprungspunkt handelt.

  • Standardwert: jetzt
  • Anderer Wert: dateTime

Beispiele:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Der parameter departAt kann nicht in Verbindung mit arriveAtverwendet werden.
hilliness
 query

InclineLevel

Grad der Hügeligkeit für spannende 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, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig auf "Auto" festgelegt.
traffic
 query

boolean

Mögliche Werte:

  • true – Berücksichtigen Sie alle verfügbaren Datenverkehrsinformationen während des Routings.
  • false – Aktuelle Datenverkehrsdaten während des Routings ignorieren. Beachten Sie, dass auch wenn die aktuellen Verkehrsdaten während der Weiterleitung ignoriert werden, die Auswirkungen des historischen Verkehrs auf effektive Straßengeschwindigkeiten immer noch integriert werden.
travelMode
 query

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.
vehicleAxleWeight
 query

integer

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

number

double

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

number

double

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

VehicleLoadType

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/Regionen. Werte, die mit USHazmat beginnen, gelten für us-routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.
vehicleMaxSpeed
 query

integer

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

integer

Gewicht des Fahrzeugs in Kilogramm.
vehicleWidth
 query

number

double

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

boolean

Boolescher Wert, der angibt, ob die Anforderung synchron ausgeführt werden soll. Wenn "true" festgelegt ist, erhält der Benutzer eine Antwort von 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort von 202. Weitere Informationen zur Antwort auf 202 finden Sie in der API-Beschreibung. wird nur für asynchrone Anforderungs-unterstützt.
windingness
 query

WindingnessLevel

Grad der Kurven für spannende 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 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
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

Die Matrixanforderung wurde erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.
202 Accepted

Wird nur für asynchrone Anforderung unterstützt. Anforderung angenommen: Die Anforderung wurde zur Verarbeitung akzeptiert. Verwenden Sie die URL im Speicherortheader, um die Ergebnisse erneut zu versuchen oder darauf zuzugreifen.

Header

Location: string
Other Status Codes

ErrorResponse

Unerwarteter Fehler.

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.

Notizen

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

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 submit a route matrix request

Beispielanforderung

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
      ]
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
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
  }
}
Statuscode:
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 unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
GeoJsonMultiPoint

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

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

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

Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen 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 bereitgestellt werden, gibt es jeweils 2 Arrays mit 3 Elementen. Der Inhalt jedes Elements hängt von den optionen ab, die in der Abfrage bereitgestellt werden.
RouteMatrixResultResponse

Antwortobjekt der aktuellen Zelle in der Eingabematrix.
RouteMatrixSummary

Summary-Objekt
RouteType

Der Typ der angeforderten Route.
SectionType

Gibt an, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig auf "Auto" festgelegt.
TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.
VehicleLoadType

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/Regionen. Werte, die mit USHazmat beginnen, gelten für us-routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.
WindingnessLevel

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

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.

Name Typ Beschreibung
all

string

Berechnet Die Reisezeiten für alle Arten von Verkehrsinformationen und gibt alle Ergebnisse in den Feldern noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds und liveTrafficIncidentsTravelTimeInSeconds an, die in die Zusammenfassungen in der Routenantwort einbezogen werden.
none

string

Berechnet keine zusätzlichen Reisezeiten.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

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

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 spannende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Name Typ Beschreibung
high

string

Hoch
low

string

Niedrig
normal

string

normal

JsonFormat

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

Name Typ Beschreibung
json

string

das JavaScript Object Notation Data Interchange Format

RouteAvoidType

Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen darf der Wert "AlreadyUsedRoads" nicht verwendet werden.

Name Typ Beschreibung
alreadyUsedRoads

string

Vermeiden Sie die Verwendung derselben Straße mehrmals. Am nützlichsten in Verbindung mit routeType=nervenkitzeln.
borderCrossings

string

Vermeidet Grenzübergänge bei der Routenberechnung.
carpools

string

Vermeidet Routen, die die Verwendung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug)-Fahrspuren erfordern.
ferries

string

Vermeiden von Fähren
motorways

string

Vermeiden von Autobahnen
tollRoads

string

Vermeidet mautpflichtige Straßen.
unpavedRoads

string

Vermeidet nicht gepavte Straßen

RouteLegSummary

Summary-Objekt für den Routenabschnitt.

Name Typ Beschreibung
arrivalTime

string

Die geschätzte Ankunftszeit für die Route oder den Abschnitt. Die Uhrzeit ist in UTC.
batteryConsumptionInkWh

number

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

Die geschätzte Abfahrtszeit für die Route oder den Bein. Die Uhrzeit ist in UTC.
fuelConsumptionInLiters

number

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.

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 bereitgestellt werden, gibt es jeweils 2 Arrays mit 3 Elementen. Der Inhalt jedes Elements hängt von den optionen ab, die in der Abfrage bereitgestellt werden.

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

Die Anzahl der erfolgreichen Routen in der Antwort.
totalRoutes

integer

Gesamtanzahl der angeforderten Routen. Anzahl der Zellen in der Eingabematrix.

RouteType

Der Typ der angeforderten Route.

Name Typ Beschreibung
eco

string

Eine Route, die durch Wirtschaft und Geschwindigkeit ausgeglichen ist.
fastest

string

Die schnellste Route.
shortest

string

Die kürzeste Strecke nach Entfernung.
thrilling

string

Beinhaltet interessante oder anspruchsvolle Straßen und nutzt so wenige Autobahnen wie möglich. Sie können das Niveau der enthaltenen Kurven und auch den Grad der Hügeligkeit auswählen. Sehen Sie sich die Hügel- und Windigkeitsparameter an, um dies festzulegen. Es gibt eine Grenze von 900 km auf Routen, die mit routeType=nervenkitzeln geplant sind.

SectionType

Gibt an, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig auf "Auto" festgelegt.

Name Typ Beschreibung
carTrain

string

Abschnitte der Strecke, die Autos oder Züge sind.
carpool

string

Abschnitte der Strecke, die die Nutzung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug) 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

Abschnitte der Autobahnen.
pedestrian

string

Abschnitte der Route, die nur für Fußgänger geeignet sind.
tollRoad

string

Abschnitte der Route, für die eine Gebührenzahlung erforderlich ist.
tollVignette

string

Abschnitte der Route, für die eine mautpflichtige Vignette vorhanden sein muss.
traffic

string

Abschnitte der Route, die Verkehrsinformationen enthalten.
travelMode

string

Abschnitte im Verhältnis zum Anforderungsparameter travelMode.
tunnel

string

Abschnitte der Route, die Tunnel sind.
urban

string

Abschnitte der Strecke, die sich in städtischen Gebieten befinden.

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.

Name Typ Beschreibung
bicycle

string

Die zurückgegebenen Routen sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.
bus

string

Die zurückgegebenen Strecken sind für Busse optimiert, einschließlich der Nutzung von Nur-Busspuren. BETA-Funktionalität.
car

string

Die zurückgegebenen Routen sind für Autos optimiert.
motorcycle

string

Die zurückgegebenen Strecken sind für Motorräder optimiert. BETA-Funktionalität.
pedestrian

string

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

string

Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.
truck

string

Die zurückgegebenen Routen sind für Nutzfahrzeuge wie für Lkw optimiert.
van

string

Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität.

VehicleLoadType

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/Regionen. Werte, die mit USHazmat beginnen, gelten für us-routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.

Name Typ Beschreibung
USHazmatClass1

string

Sprengstoff
USHazmatClass2

string

Komprimiertes Gas
USHazmatClass3

string

Brennbare Flüssigkeiten
USHazmatClass4

string

Brennbare Feststoffe
USHazmatClass5

string

Oxidizer
USHazmatClass6

string

Gifte
USHazmatClass7

string

Radioaktiv
USHazmatClass8

string

Beizmittel
USHazmatClass9

string

Verschiedenes
otherHazmatExplosive

string

Sprengstoff
otherHazmatGeneral

string

Verschiedenes
otherHazmatHarmfulToWater

string

Schädlich für Wasser

WindingnessLevel

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

Name Typ Beschreibung
high

string

Hoch
low

string

Niedrig
normal

string

normal