Route - Get Route Range

Referenz

Dienst:: Maps

API-Version:: 1.0

Dient zum Erstellen einer Karte, die den Bereich darstellt, der von einem bestimmten Punkt innerhalb eines bestimmten Schwellenwerts auf der Grundlage von Zeit, Entfernung oder Kraftstoffkapazität zugänglich ist.

Hinweis

Azure Maps Route v1-Dienst wird

Der Dienst "Azure Maps Route v1" ist jetzt veraltet und wird am 3.31.28 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Anrufe an den Route v1-Dienst aktualisiert werden, um Route v2025-01-01-01 Service um 3/31/28 zu verwenden. Weitere Informationen finden Sie unter Migrieren von Azure Maps Route 1.0-APIs.

Die Get Route Range -API (Isochrone) ist eine HTTP-GET-Anforderung, die eine Reihe von Standorten berechnet, die vom Ursprungspunkt basierend auf Kraftstoff, Energie, Zeit oder Entfernungsbudget erreicht werden können, das angegeben ist. Eine Polygongrenze (oder Isochrone) wird in einer gegen den Uhrzeigersinn ausgerichteten Ausrichtung sowie der genauen Polygonmitte zurückgegeben, die das Ergebnis des Ursprungspunkts war.

Das zurückgegebene Polygon kann für die weitere Verarbeitung wie Search Inside Geometry verwendet werden, um innerhalb der bereitgestellten Isochrone nach POIs zu suchen.

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}

Mit optionalen Parametern:

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}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	ResponseFormat	Gewünschtes 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, von der die Bereichsberechnung gestartet werden soll.
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Gibt die Effizienz der Umwandlung chemischer Energie im Kraftstoff in kinetische Energie an, wenn das Fahrzeug beschleunigt (d. h.Kine EnergyGained/Chemical EnergyConsumed). ChemicalEnergieConsumed wird durch umwandlung verbrauchten Kraftstoff in chemische Energie mit fuel EnergyDensityInMJoulesPerLiter. Muss mit DeelerationEfficiencygekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/VerzögerungEffizienz. Vernünftige Werte : für Verbrennungsmodell : 0,33, für Elektromodell : 0,66
auxiliaryPowerInkW	query		number (double)	Gibt die Menge der verbrauchten Energie für die Aufrechterhaltung von Hilfssystemen in Watten (kW) an. Es kann verwendet werden, um den Verbrauch aufgrund von Geräten und Systemen wie Ac-Systemen, Funk, Heizung usw. anzugeben. Sensible Werte : 1,7
auxiliaryPowerInLitersPerHour	query		number (double)	Gibt die Menge des verbrauchten Kraftstoffs für die Erhaltung von Hilfssystemen des Fahrzeugs in Litern pro Stunde an. Es kann verwendet werden, um den Verbrauch aufgrund von Geräten und Systemen wie Ac-Systemen, Funk, Heizung usw. anzugeben. Sensible Werte : 0,2
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.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an. Wird als ungeordnete Liste der Geschwindigkeits-/Verbrauchsratenpaare bereitgestellt. Die Liste definiert Punkte für eine Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, sind wie folgt zu finden: durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt durch lineare Extrapolation andernfalls, vorausgesetzt, eine Konstante (ΔConsumption/ΔSpeed), die durch die nächsten zwei Punkte in der Liste bestimmt wird Die Liste muss zwischen 1 und 25 Punkt (einschließlich) enthalten und darf keine doppelten Punkte für dieselbe Geschwindigkeit enthalten. Wenn sie nur einen einzigen 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. Entsprechend können verbrauchsspezifische Werte für die beiden kleinsten Geschwindigkeiten in der Liste 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 Elektrische Verbrauchsmodellerforderlich.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an. Bereitgestellt als eine nicht geordnete Liste der durch Doppelpunkt getrennten Geschwindigkeiten & Verbrauchsratenpaare. Die Liste definiert Punkte für eine Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, sind wie folgt zu finden: durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt durch lineare Extrapolation andernfalls, vorausgesetzt, eine Konstante (ΔConsumption/ΔSpeed), die durch die nächsten zwei Punkte in der Liste bestimmt wird Die Liste muss zwischen 1 und 25 Punkt (einschließlich) enthalten und darf keine doppelten Punkte für dieselbe Geschwindigkeit enthalten. Wenn sie nur einen einzigen 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. Entsprechend können verbrauchsspezifische Werte für die beiden kleinsten Geschwindigkeiten in der Liste 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 Verbrennungsverbrauchsmodellerforderlich.
currentChargeInkWh	query		number (double)	Gibt die aktuelle elektrische Energieversorgung in Wattstunden (kWh) an. Dieser Parameter ist mit maxChargeInkWh Parameter koexistiert. Der zulässige Wertebereich beträgt 0,0 bis maxChargeInkWh. Sensible Werte : 43
currentFuelInLiters	query		number (double)	Gibt die aktuelle Kraftstoffversorgung in Litern an. Sensible Werte : 55
decelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Gibt die Effizienz der Umwandlung kinetischer Energie in gespeicherten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug verzögert (d. h. Chemical EnergySaved/Kine EnergyLost). ChemicalEnergieSaved wird durch Umwandlung von gespeicherten (nicht verbrauchten) Brennstoffen in Energie mit fuelEnergieDensityInMJoulesPerLitergewonnen. Muss mit accelerationEfficiencygekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/accelerationEfficiency. Vernünftige Werte : für Verbrennungsmodell : 0,83, für Elektromodell : 0,91
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 `arriveAt`verwendet werden.
distanceBudgetInMeters	query		number (double)	Entfernungsbudget in Metern, die maximal zulässige Reichweite bestimmen, die mithilfe der Fahrstrecke zurückgelegt werden kann. Das Verbrauchsmodell wirkt sich nur auf den Bereich aus, wenn routeType öko ist. Genau ein Budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec oder distanceBudgetInMeters) muss verwendet werden.
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	Gibt die Effizienz der Umwandlung potenzieller Energie in gespeicherten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug die Höhe verliert (d. h. Chemical EnergySaved/Potential EnergyLost). ChemicalEnergieSaved wird durch Umwandlung von gespeicherten (nicht verbrauchten) Brennstoffen in Energie mit fuelEnergieDensityInMJoulesPerLitergewonnen. Muss mit uphillEfficiencygekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/uphillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,51, für Elektromodell : 0,73
energyBudgetInkWh	query		number (double)	Elektrisches Energiebudget in Wattstunden (kWh), das die maximale Reichweite bestimmt, die mit dem angegebenen Elektrischen Verbrauchsmodell zurückgelegt werden kann. Bei Verwendung von energyBudgetInkWh ist es obligatorisch, ein detailliertes Modell für den elektrischen Verbrauch anzugeben. Genau ein Budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec oder distanceBudgetInMeters) muss verwendet werden.
fuelBudgetInLiters	query		number (double)	Kraftstoffbudget in Litern, die den maximalen Bereich bestimmen, der mit dem angegebenen Verbrennungsverbrauchsmodell gefahren werden kann. Bei Verwendung von FuelBudgetInLiters ist es obligatorisch, ein detailliertes Verbrennungsverbrauchsmodell anzugeben. Genau ein Budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec oder distanceBudgetInMeters) muss verwendet werden.
fuelEnergyDensityInMJoulesPerLiter	query		number (double)	Gibt die Menge an chemischer Energie an, die in einem Liter Kraftstoff in Megajoules (MJ) gespeichert ist. Es wird in Verbindung mit dem *Efficiency Parametern für Umwandlungen zwischen gespeicherter oder verbrauchter Energie und Kraftstoff verwendet. Die Energiedichte beträgt beispielsweise 34,2 MJ/l für Benzin und 35,8 MJ/l für Dieselkraftstoff. Dieser Parameter ist erforderlich, wenn *Efficiency Parameter festgelegt ist. Sensible Werte : 34,2
hilliness	query		InclineLevel	Grad der Hügeligkeit für spannende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.
maxChargeInkWh	query		number (double)	Gibt die maximale elektrische Energieversorgung in Wattstunden (kWh) an, die in der Batterie des Fahrzeugs gespeichert werden kann. Dieser Parameter ist mit currentChargeInkWh Parameter koexistiert. Der Mindestwert muss größer oder gleich currentChargeInkWhsein. Sensible Werte : 85
routeType	query		RouteType	Der Typ der angeforderten Route.
timeBudgetInSec	query		number (double)	Zeitbudget in Sekunden, das den maximalen Bereich bestimmt, der mithilfe der Fahrzeit gefahren werden kann. Das Verbrauchsmodell wirkt sich nur auf den Bereich aus, wenn routeType öko ist. Genau ein Budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec oder distanceBudgetInMeters) muss verwendet werden.
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.
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	Gibt die Effizienz der Umwandlung chemischer Energie im Kraftstoff in potenzielle Energie an, wenn das Fahrzeug eine Erhöhung erhält (d. h. PotentialEnergieGained/ChemicalEnergieConsumed). ChemicalEnergieConsumed wird durch umwandlung verbrauchten Kraftstoff in chemische Energie mit fuel EnergyDensityInMJoulesPerLiter. Muss mit downhillEfficiencygekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/downhillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,27, für Elektromodell : 0,74
vehicleAxleWeight	query		integer	Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden.
vehicleCommercial	query		boolean	Ob das Fahrzeug für gewerbliche Zwecke verwendet wird. Nutzfahrzeuge dürfen auf einigen Straßen möglicherweise nicht fahren.
vehicleEngineType	query		VehicleEngineType	Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineTypeübereinstimmen.
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. Es ist obligatorisch, wenn eine der Efficiency-Parameter festgelegt ist. Es muss streng positiv sein, wenn es im Rahmen des Verbrauchsmodells verwendet wird. Gewichtsbeschränkungen werden berücksichtigt. Wenn kein detailliertes Verbrauchsmodell* angegeben wird und der Wert fahrzeuggewichtige ungleich Null ist, werden Gewichtseinschränkungen berücksichtigt. In allen anderen Fällen wird dieser Parameter ignoriert. Vernünftige Werte : für Verbrennungsmodell : 1600, für Elektromodell : 1900
vehicleWidth	query		number (double)	Breite des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.
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.

Antworten

Name	Typ	Beschreibung
200 OK	RouteRangeResult	OKAY
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

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.

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

Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein 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 retrieve a set of locations that can be reached from the origin point based on various conditions

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Beispiel für eine Antwort

Statuscode:: 200

{
  "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
EffectiveSetting	Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InclineLevel	Grad der Hügeligkeit für spannende Route. Dieser Parameter kann nur in Verbindung mit `routeType`=thrilling verwendet werden.
LatLongPair	Ein Ort, der als Breiten- und Längengrad dargestellt wird.
ResponseFormat	Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.
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.
RouteRange	Erreichbarer Bereich
RouteRangeResult	Dieses Objekt wird von einem erfolgreichen Route Reachable Range-Aufruf zurückgegeben.
RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.
RouteType	Der Typ der angeforderten Route.
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.
VehicleEngineType	Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineTypeübereinstimmen.
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.

EffectiveSetting

Objekt

Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.

Name	Typ	Beschreibung
key	string	Name des verwendeten Parameters.
value	string	Wert des verwendeten Parameters.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InclineLevel

Enumeration

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

Wert	Beschreibung
high	Hoch
low	Niedrig
normal	normal

LatLongPair

Objekt

Ein Ort, der als Breiten- und Längengrad dargestellt wird.

Name	Typ	Beschreibung
latitude	number (double)	Latitude-Eigenschaft
longitude	number (double)	Longitude-Eigenschaft

ResponseFormat

Enumeration

Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format
xml	Extensible Markup Language

RouteAvoidType

Enumeration

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.

Wert	Beschreibung
alreadyUsedRoads	Vermeiden Sie die Verwendung derselben Straße mehrmals. Am nützlichsten in Verbindung mit `routeType`=nervenkitzeln.
borderCrossings	Vermeidet Grenzübergänge bei der Routenberechnung.
carpools	Vermeidet Routen, die die Verwendung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug)-Fahrspuren erfordern.
ferries	Vermeiden von Fähren
motorways	Vermeiden von Autobahnen
tollRoads	Vermeidet mautpflichtige Straßen.
unpavedRoads	Vermeidet nicht gepavte Straßen

RouteRange

Objekt

Erreichbarer Bereich

Name	Typ	Beschreibung
boundary	LatLongPair[]	Polygongrenze des erreichbaren Bereichs, der als Eine Liste von Punkten dargestellt wird.
center	LatLongPair	Mittelpunkt des erreichbaren Bereichs

RouteRangeResult

Objekt

Dieses Objekt wird von einem erfolgreichen Route Reachable Range-Aufruf zurückgegeben.

Name	Typ	Beschreibung
formatVersion	string	Format Version-Eigenschaft
reachableRange	RouteRange	Erreichbarer Bereich
report	RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.

RouteReport

Objekt

Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden.

Name	Typ	Beschreibung
effectiveSettings	EffectiveSetting[]	Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden.

RouteType

Enumeration

Der Typ der angeforderten Route.

Wert	Beschreibung
eco	Eine Route, die durch Wirtschaft und Geschwindigkeit ausgeglichen ist.
fastest	Die schnellste Route.
shortest	Die kürzeste Strecke nach Entfernung.
thrilling	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.

TravelMode

Enumeration

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.

Wert	Beschreibung
bus	Die zurückgegebenen Strecken sind für Busse optimiert, einschließlich der Nutzung von Nur-Busspuren. BETA-Funktionalität.
car	Die zurückgegebenen Routen sind für Autos optimiert.
motorcycle	Die zurückgegebenen Strecken sind für Motorräder optimiert. BETA-Funktionalität.
taxi	Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.
truck	Die zurückgegebenen Routen sind für Nutzfahrzeuge wie für Lkw optimiert.
van	Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität.

VehicleEngineType

Enumeration

Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineTypeübereinstimmen.

Wert	Beschreibung
combustion	Verbrennungsmotor.
electric	Elektrischer Motor.

VehicleLoadType

Enumeration

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.

Wert	Beschreibung
USHazmatClass1	Sprengstoff
USHazmatClass2	Komprimiertes Gas
USHazmatClass3	Brennbare Flüssigkeiten
USHazmatClass4	Brennbare Feststoffe
USHazmatClass5	Oxidizer
USHazmatClass6	Gifte
USHazmatClass7	Radioaktiv
USHazmatClass8	Beizmittel
USHazmatClass9	Verschiedenes
otherHazmatExplosive	Sprengstoff
otherHazmatGeneral	Verschiedenes
otherHazmatHarmfulToWater	Schädlich für Wasser

WindingnessLevel

Enumeration

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

Wert	Beschreibung
high	Hoch
low	Niedrig
normal	normal

Freigeben über

Route - Get Route Range

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Beispielanforderung

Beispiel für eine Antwort

Definitionen

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InclineLevel

LatLongPair

ResponseFormat

RouteAvoidType

RouteRange

RouteRangeResult

RouteReport

RouteType

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel