Route - Post Route Matrix Sync
Verwenden Sie, um eine Routenmatrix abzurufen, die die Reisezeit und die Entfernung für alle möglichen Paare in einer Liste von Ursprüngen und Zielen mit einer synchronen Anforderung anzeigt.
Die Post Route Matrix Sync
API ist eine HTTP-Anforderung POST
, die die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen ermöglicht, die von Ursprungs- und Zielstandorten definiert sind, indem sie eine einzelne synchrone Anforderung (Synchronisierung) verwenden. Informationen zum Stellen einer asynchronen (asynchronen) Anforderung finden Sie unter Post Route Matrix. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können 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 beheben, können sie die Matrixroute-API aufrufen.
Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen.
Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).
Übermitteln synchroner Routenmatrixanforderung
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 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 der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte 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 für die 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 ungültige Anforderung 400 oder ein anderer Fehlerstatuscode 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/sync/json?api-version=1.0
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}§ionType={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 |
Das gewünschte Format der Antwort. Nur das |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
arrive
|
query |
string date-time |
Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als Beispiele:
Der |
|
avoid
|
query |
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. |
||
compute
|
query |
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. |
||
depart
|
query |
string date-time |
Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt, der als
Beispiele:
Der |
|
hilliness
|
query |
Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
||
route
|
query |
Der Typ der angeforderten Route. |
||
section
|
query |
Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. |
||
traffic
|
query |
boolean |
Mögliche Werte:
|
|
travel
|
query |
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. |
||
vehicle
|
query |
integer |
Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtsbeschränkungen pro Achse nicht berücksichtigt werden. |
|
vehicle
|
query |
number double |
Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden. |
|
vehicle
|
query |
number double |
Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden. |
|
vehicle
|
query |
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. |
||
vehicle
|
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.
|
|
vehicle
|
query |
integer |
Gewicht des Fahrzeugs in Kilogramm. |
|
vehicle
|
query |
number double |
Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden. |
|
wait
|
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 |
Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln . |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
destinations |
Ein gültiger |
|
origins |
Ein gültiger |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse. |
|
Other Status Codes |
Timeout: Die Anforderung dauerte länger als die in der API definierte maximale Zeit. |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem 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.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
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.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
SAS Token
Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.
Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successfully retrieve a route matrix request result synchronously
Beispielanforderung
POST https://atlas.microsoft.com/route/matrix/sync/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
{
"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
}
}
{
"error": {
"code": "408 Timeout",
"message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
}
}
Definitionen
Name | Beschreibung |
---|---|
Compute |
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. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Geo |
Ein gültiger |
Incline |
Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
Json |
Das gewünschte Format der Antwort. Nur das |
Route |
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. |
Route |
Zusammenfassungsobjekt für den Routenabschnitt. |
Route |
Matrixergebnisobjekt |
Route |
Ein Objekt mit einer Matrix von Koordinaten. |
Route |
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. |
Route |
Antwortobjekt der aktuellen Zelle in der Eingabematrix. |
Route |
Zusammenfassungsobjekt |
Route |
Der Typ der angeforderten Route. |
Section |
Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. |
Travel |
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. |
Vehicle |
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. |
Windingness |
Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
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 |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
GeoJsonMultiPoint
Ein gültiger GeoJSON MultiPoint
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Koordinaten für die |
type |
string:
Multi |
Gibt den |
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 |
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 |
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
Zusammenfassungsobjekt für den Routenabschnitt.
Name | Typ | Beschreibung |
---|---|---|
arrivalTime |
string |
Die geschätzte Ankunftszeit für die Route oder Strecke. Die Zeit wird in UTC angegeben. |
batteryConsumptionInkWh |
number |
Geschätzter Stromverbrauch in Kilowattstunden (kWh) nach dem Stromverbrauchsmodell. Enthalten, wenn vehicleEngineType auf electric und constantSpeedConsumptionInkWhPerHundredkm festgelegt ist. Der Wert von batteryConsumptionInkWh umfasst 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 niemals maxChargeInkWh überschreitet. Wenn weder maxChargeInkWh noch currentChargeInkWh angegeben werden, wird bei der Verbrauchsberechnung von einer nicht eingeschränkten Rekuperation ausgegangen. |
departureTime |
string |
Die geschätzte Abflugzeit für die Route oder Strecke. Die Zeit wird in UTC angegeben. |
fuelConsumptionInLiters |
number |
Geschätzter Kraftstoffverbrauch in Litern unter Verwendung des Verbrennungsverbrauchsmodells. Enthalten, wenn vehicleEngineType auf verbrennung und constantSpeedConsumptionInLitersPerHundredkm festgelegt ist. Der Wert ist nicht negativ. |
historicTrafficTravelTimeInSeconds |
integer |
Geschätzte Reisezeit, die anhand zeitabhängiger historischer Verkehrsdaten 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, die so berechnet wird, als ob es aufgrund der Verkehrslage (z. B. Staus) zu keinen Verspätungen auf der Strecke kommt. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird. |
trafficDelayInSeconds |
integer |
Geschätzte Verzögerung in Sekunden, die durch den/die Echtzeit-Incident(en) gemäß Verkehrsinformationen verursacht wird. Für Routen, die mit abflugzeit in der Zukunft geplant sind, beträgt die Verspätung immer 0. Um zusätzliche Reisezeiten mithilfe verschiedener Arten von Verkehrsinformationen 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 immer noch die Verzögerung aufgrund des Datenverkehrs enthält. Wenn DepartAt in der Zukunft liegt, wird die Reisezeit mithilfe zeitabhängiger historischer Datenverkehrsdaten berechnet. |
RouteMatrix
Matrixergebnisobjekt
Name | Typ | Beschreibung |
---|---|---|
response |
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 |
Ein gültiger |
|
origins |
Ein gültiger |
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 |
Ergebnisse als zweidimensionales Array von Routenzusammenfassungen. |
|
summary |
Summary-Objekt |
RouteMatrixResultResponse
Antwortobjekt der aktuellen Zelle in der Eingabematrix.
Name | Typ | Beschreibung |
---|---|---|
routeSummary |
Zusammenfassungsobjekt für den Routenabschnitt. |
RouteMatrixSummary
Zusammenfassungsobjekt
Name | Typ | Beschreibung |
---|---|---|
successfulRoutes |
integer |
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 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 |
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 |
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 |
Beizmittel |
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 |