Route - Get Route Range
Verwenden Sie , um eine Karte zu erstellen, die den Bereich darstellt, auf den von einem bestimmten Punkt innerhalb eines bestimmten Schwellenwerts basierend auf Zeit, Entfernung oder Kraftstoffkapazität zugegriffen werden kann.
Die Get Route Range
(Isochrone)-API ist eine HTTP-Anforderung GET
, die eine Reihe von Standorten berechnet, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Budget für Kraftstoff, Energie, Zeit oder Entfernung. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war.
Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z . B. "Innerhalb der Geometrie suchen" , um innerhalb der bereitgestellten Isochrone nach POIs zu suchen.
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
format
|
path | True |
Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein. |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
query
|
query | True |
number[] |
Die Koordinate, ab der die Bereichsberechnung beginnen soll. |
acceleration
|
query |
number double |
Gibt die Effizienz der Umwandlung chemischer Energie, die im Kraftstoff gespeichert ist, in kinetische Energie, wenn das Fahrzeug beschleunigt (d. h. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wird durch Umwandlung von verbrauchtem Kraftstoff in chemische Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit "decelerationEfficiency" gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/decelerationEfficiency. Sensible Werte : für Verbrennungsmodell : 0,33, für elektrisches Modell : 0,66 |
|
auxiliary
|
query |
number double |
Gibt den Stromverbrauch für unterstützende Hilfssysteme in Kilowatt (kW) an. Es kann verwendet werden, um den Verbrauch durch Geräte und Systeme wie Ac-Systeme, Radio, Heizung usw. anzugeben. Sensible Werte: 1.7 |
|
auxiliary
|
query |
number double |
Gibt die Menge an Kraftstoff an, die für die Unterhaltshilfssysteme des Fahrzeugs verbraucht wird, in Liter pro Stunde. Es kann verwendet werden, um den Verbrauch durch Geräte und Systeme wie Ac-Systeme, Radio, Heizung usw. anzugeben. Sensible Werte: 0.2 |
|
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. |
||
constant
|
query |
string |
Gibt die geschwindigkeitsabhängige Verbrauchskomponente an. Wird als ungeordnete Liste von Geschwindigkeits-/Verbrauchsratenpaaren bereitgestellt. Die Liste definiert Punkte in einer Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, werden wie folgt ermittelt:
Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf keine doppelten Punkte für die gleiche Geschwindigkeit enthalten. Wenn er nur einen einzelnen Punkt enthält, wird die Verbrauchsrate dieses Punkts ohne weitere Verarbeitung verwendet. Der für die größte Geschwindigkeit angegebene Verbrauch muss größer oder gleich dem der vorletzten größten Geschwindigkeit sein. Dadurch wird sichergestellt, dass die Extrapolation nicht zu negativen Verbrauchsraten führt. Ebenso können Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine kleinere Geschwindigkeit führen. Der gültige Bereich für die Verbrauchswerte (ausgedrückt in kWh/100km) liegt zwischen 0,01 und 100000,0. Sensible Werte: 50,8.2:130,21.3 Dieser Parameter ist für das Stromverbrauchsmodell erforderlich. |
|
constant
|
query |
string |
Gibt die geschwindigkeitsabhängige Verbrauchskomponente an. Wird als ungeordnete Liste von durch Doppelpunkt getrennten Geschwindigkeits- & Verbrauchsratenpaaren bereitgestellt. Die Liste definiert Punkte in einer Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, werden wie folgt ermittelt:
Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf keine doppelten Punkte für die gleiche Geschwindigkeit enthalten. Wenn er nur einen einzelnen Punkt enthält, wird die Verbrauchsrate dieses Punkts ohne weitere Verarbeitung verwendet. Der für die größte Geschwindigkeit angegebene Verbrauch muss größer oder gleich dem der vorletzten größten Geschwindigkeit sein. Dadurch wird sichergestellt, dass die Extrapolation nicht zu negativen Verbrauchsraten führt. Ebenso können Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine kleinere Geschwindigkeit führen. Der gültige Bereich für die Verbrauchswerte (ausgedrückt in l/100km) liegt zwischen 0,01 und 100000,0. Sensible Werte: 50,6.3:130,11,5 Hinweis : Dieser Parameter ist für das Verbrennungsverbrauchsmodell erforderlich. |
|
current
|
query |
number double |
Gibt die aktuelle elektrische Energieversorgung in Kilowattstunden (kWh) an. Dieser Parameter ist zusammen mit dem MaxChargeInkWh-Parameter vorhanden. Der zulässige Wertebereich beträgt 0,0 bis maxChargeInkWh. Sensible Werte: 43 |
|
current
|
query |
number double |
Gibt die aktuelle Kraftstoffversorgung in Litern an. Sensible Werte: 55 |
|
deceleration
|
query |
number double |
Gibt den Wirkungsgrad der Umwandlung von kinetischer Energie in eingesparten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug abbremst (d. h. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved wird durch Umwandlung von gespeichertem (nicht verbrauchtem) Kraftstoff in Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit accelerationEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/accelerationEfficiency. Sensible Werte : für Verbrennungsmodell : 0,83, für elektrisches Modell : 0,91 |
|
depart
|
query |
string date-time |
Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt, der als
Beispiele:
Der |
|
distance
|
query |
number double |
Entfernungsbudget in Metern, das die maximale Reichweite bestimmt, die mithilfe der Fahrstrecke zurückgelegt werden kann. Das Verbrauchsmodell wirkt sich nur auf den Bereich aus, wenn routeType eco ist. |
|
downhill
|
query |
number double |
Gibt die Effizienz der Umwandlung potenzieller Energie in eingesparten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug an Höhe verliert (d. h. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved wird durch Umwandlung von gespeichertem (nicht verbrauchtem) Kraftstoff in Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit uphillEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/uphillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,51, für elektrisches Modell : 0,73 |
|
energy
|
query |
number double |
Strombudget in Kilowattstunden (kWh), das die maximale Reichweite bestimmt, die mit dem angegebenen Stromverbrauchsmodell zurückgelegt werden kann. |
|
fuel
|
query |
number double |
Kraftstoffbudget in Litern, das die maximale Reichweite bestimmt, die mit dem angegebenen Verbrennungsverbrauchsmodell zurückgelegt werden kann. |
|
fuel
|
query |
number double |
Gibt die Menge der chemischen Energie an, die in einem Liter Kraftstoff in Megajoules (MJ) gespeichert wird. Es wird in Verbindung mit den *Effizienzparametern für Umrechnungen zwischen eingesparter oder verbrauchter Energie und Kraftstoff verwendet. Beispielsweise beträgt die Energiedichte 34,2 MJ/l für Benzin und 35,8 MJ/l für Dieselkraftstoff. Dieser Parameter ist erforderlich, wenn ein *Efficiency-Parameter festgelegt ist. Sensible Werte: 34.2 |
|
hilliness
|
query |
Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
||
max
|
query |
number double |
Gibt die maximale elektrische Energieversorgung in Kilowattstunden (kWh) an, die in der Batterie des Fahrzeugs gespeichert werden kann. Dieser Parameter ist zusammen mit dem Parameter currentChargeInkWh vorhanden. Der Mindestwert muss größer oder gleich currentChargeInkWh sein. Sensible Werte: 85 |
|
route
|
query |
Der Typ der angeforderten Route. |
||
time
|
query |
number double |
Zeitbudget in Sekunden, das die maximale Reichweite bestimmt, die mit der Fahrzeit zurückgelegt werden kann. Das Verbrauchsmodell wirkt sich nur auf den Bereich aus, wenn routeType eco ist. |
|
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. |
||
uphill
|
query |
number double |
Gibt die Effizienz der Umwandlung chemischer Energie, die im Kraftstoff gespeichert ist, in potenzielle Energie, wenn das Fahrzeug an Höhe gewinnt (d. h. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wird durch Umwandlung von verbrauchtem Kraftstoff in chemische Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit downhillEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/downhillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,27, für elektrisches Modell : 0,74 |
|
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 |
boolean |
Gibt an, ob das Fahrzeug zu kommerziellen Zwecken verwendet wird. Nutzfahrzeuge dürfen möglicherweise nicht auf einigen Straßen fahren. |
|
vehicle
|
query |
Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein. |
||
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.
Sensible Werte : für Verbrennungsmodell : 1600, für elektrisches Modell : 1900 |
|
vehicle
|
query |
number double |
Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden. |
|
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 . |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Ist Authorization URL
spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von 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 die konfigurationsbasierte Einrichtung 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 gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.
Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
SAS Token
Dies ist 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 für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.
Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successfully retrieve a set of locations that can be reached from the origin point based on various conditions
Beispielanforderung
GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000
Beispiel für eine Antwort
{
"formatVersion": "0.0.1",
"reachableRange": {
"center": {
"latitude": 50.9745,
"longitude": 5.86605
},
"boundary": [
{
"latitude": 52.03704,
"longitude": 5.73602
},
{
"latitude": 52.09456,
"longitude": 5.59435
},
{
"latitude": 52.16815,
"longitude": 5.42279
},
{
"latitude": 52.25047,
"longitude": 5.21276
},
{
"latitude": 52.21374,
"longitude": 5.15355
},
{
"latitude": 52.25674,
"longitude": 4.96687
},
{
"latitude": 52.07834,
"longitude": 4.739
},
{
"latitude": 52.05647,
"longitude": 4.72513
},
{
"latitude": 51.94553,
"longitude": 4.53237
},
{
"latitude": 51.70119,
"longitude": 4.31165
},
{
"latitude": 51.5837,
"longitude": 4.28917
},
{
"latitude": 51.48463,
"longitude": 3.82685
},
{
"latitude": 51.21096,
"longitude": 3.62838
},
{
"latitude": 50.6814,
"longitude": 3.89244
},
{
"latitude": 50.66791,
"longitude": 3.93493
},
{
"latitude": 50.49042,
"longitude": 3.98156
},
{
"latitude": 50.30944,
"longitude": 4.47995
},
{
"latitude": 50.24448,
"longitude": 4.60502
},
{
"latitude": 50.24467,
"longitude": 4.89999
},
{
"latitude": 50.08735,
"longitude": 5.04206
},
{
"latitude": 49.99214,
"longitude": 5.23042
},
{
"latitude": 49.88478,
"longitude": 5.40994
},
{
"latitude": 49.85797,
"longitude": 5.46178
},
{
"latitude": 49.86279,
"longitude": 5.7196
},
{
"latitude": 49.83259,
"longitude": 5.74151
},
{
"latitude": 50.22239,
"longitude": 5.9387
},
{
"latitude": 50.0011,
"longitude": 6.08535
},
{
"latitude": 50.04616,
"longitude": 6.12089
},
{
"latitude": 50.09472,
"longitude": 6.28373
},
{
"latitude": 49.95863,
"longitude": 6.51654
},
{
"latitude": 50.00485,
"longitude": 6.61034
},
{
"latitude": 50.00587,
"longitude": 6.70295
},
{
"latitude": 50.2947,
"longitude": 6.65865
},
{
"latitude": 50.36903,
"longitude": 6.79276
},
{
"latitude": 50.31614,
"longitude": 7.32163
},
{
"latitude": 50.36737,
"longitude": 7.58782
},
{
"latitude": 50.46919,
"longitude": 7.7626
},
{
"latitude": 50.96246,
"longitude": 7.9826
},
{
"latitude": 51.07086,
"longitude": 7.55924
},
{
"latitude": 51.36614,
"longitude": 7.58138
},
{
"latitude": 51.52015,
"longitude": 7.67861
},
{
"latitude": 51.65781,
"longitude": 7.35175
},
{
"latitude": 51.81916,
"longitude": 7.21664
},
{
"latitude": 51.9587,
"longitude": 7.0467
},
{
"latitude": 51.82713,
"longitude": 6.67267
},
{
"latitude": 51.81133,
"longitude": 6.48424
},
{
"latitude": 51.9368,
"longitude": 6.27316
},
{
"latitude": 52.01701,
"longitude": 6.14452
},
{
"latitude": 52.20847,
"longitude": 6.09312
},
{
"latitude": 52.23705,
"longitude": 6.01297
}
]
}
}
Definitionen
Name | Beschreibung |
---|---|
Effective |
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Incline |
Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit |
Lat |
Ein Standort, der als Breiten- und Längengrad dargestellt wird. |
Response |
Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein. |
Route |
Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden 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 |
Erreichbarer Bereich |
Route |
Dieses Objekt wird von einem erfolgreichen Route Reachable Range-Aufruf zurückgegeben. |
Route |
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden. |
Route |
Der Typ der angeforderten Route. |
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 |
Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein. |
Vehicle |
Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus 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 das US-Routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. 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 |
EffectiveSetting
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Name des verwendeten Parameters. |
value |
string |
Wert des verwendeten Parameters. |
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. |
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 |
LatLongPair
Ein Standort, der als Breiten- und Längengrad dargestellt wird.
Name | Typ | Beschreibung |
---|---|---|
latitude |
number |
Latitude-Eigenschaft |
longitude |
number |
Längengradeigenschaft |
ResponseFormat
Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.
Name | Typ | Beschreibung |
---|---|---|
json |
string |
|
xml |
string |
RouteAvoidType
Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden 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 |
Vermeidet die mehrfache Verwendung derselben Straße. Am nützlichsten in Verbindung mit |
borderCrossings |
string |
Vermeidet Grenzübergänge bei der Routenberechnung. |
carpools |
string |
Vermeidet Routen, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern. |
ferries |
string |
Vermeidet Fähren |
motorways |
string |
Vermeidet Autobahnen |
tollRoads |
string |
Vermeidet mautpflichtige Straßen. |
unpavedRoads |
string |
Vermeidet unbefestigte Straßen |
RouteRange
Erreichbarer Bereich
Name | Typ | Beschreibung |
---|---|---|
boundary |
Polygongrenze des erreichbaren Bereichs, der als Liste von Punkten dargestellt wird. |
|
center |
Mittelpunkt des erreichbaren Bereichs |
RouteRangeResult
Dieses Objekt wird von einem erfolgreichen Route Reachable Range-Aufruf zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
formatVersion |
string |
Format Version-Eigenschaft |
reachableRange |
Erreichbarer Bereich |
|
report |
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden. |
RouteReport
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
effectiveSettings |
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden. |
RouteType
Der Typ der angeforderten Route.
Name | Typ | Beschreibung |
---|---|---|
eco |
string |
Eine Strecke, die durch Wirtschaftlichkeit und Geschwindigkeit ausgeglichen ist. |
fastest |
string |
Die schnellste Route. |
shortest |
string |
Die kürzeste Strecke. |
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. Wie Sie dies festlegen, sehen Sie sich die Parameter für Hügeligkeit und Windigkeit an. Es gibt eine Grenze von 900 km auf geplanten Routen mit |
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 |
---|---|---|
bus |
string |
Die zurückgegebenen Routen 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. |
taxi |
string |
Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität. |
truck |
string |
Die Rückgaberouten sind für Nutzfahrzeuge optimiert, z. B. für Lkw. |
van |
string |
Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität. |
VehicleEngineType
Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein.
Name | Typ | Beschreibung |
---|---|---|
combustion |
string |
Verbrennungsmotor. |
electric |
string |
Elektromotor. |
VehicleLoadType
Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus 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 das US-Routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. 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 |
Oxidationsmittel |
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 |