Freigeben über

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Referenz
Paket:
@azure-rest/maps-route

Eigenschaften

arriveAt

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

Beispiele:

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

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

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

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

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

  • Standardwert: jetzt
  • Anderer Wert: dateTime

Beispiele:

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

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

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

Der Typ der angeforderten Route.
sectionType

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

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

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

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "other". Beachten Sie, dass Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.
vehicleAxleWeight

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

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

Länge des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Längenbeschränkungen nicht berücksichtigt werden.
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

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

Gewicht des Fahrzeugs in Kilogramm.
vehicleWidth

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

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

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

Details zur Eigenschaft

arriveAt

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

Beispiele:

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

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

arriveAt?: string | Date

Eigenschaftswert

string | Date

avoid

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.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Eigenschaftswert

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

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

computeTravelTimeFor?: "none" | "all"

Eigenschaftswert

"none" | "all"

departAt

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

  • Standardwert: jetzt
  • Anderer Wert: dateTime

Beispiele:

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

Der parameter departAt kann nicht in Verbindung mit arriveAtverwendet werden.

departAt?: string | Date

Eigenschaftswert

string | Date

hilliness

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

hilliness?: "low" | "normal" | "high"

Eigenschaftswert

"low" | "normal" | "high"

routeType

Der Typ der angeforderten Route.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Eigenschaftswert

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

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

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

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Eigenschaftswert

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

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.
traffic?: boolean

Eigenschaftswert

boolean

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.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Eigenschaftswert

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

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

vehicleAxleWeight?: number

Eigenschaftswert

number

vehicleHeight

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

vehicleHeight?: number

Eigenschaftswert

number

vehicleLength

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

vehicleLength?: number

Eigenschaftswert

number

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.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Eigenschaftswert

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

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.

vehicleMaxSpeed?: number

Eigenschaftswert

number

vehicleWeight

Gewicht des Fahrzeugs in Kilogramm.

vehicleWeight?: number

Eigenschaftswert

number

vehicleWidth

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

vehicleWidth?: number

Eigenschaftswert

number

waitForResults

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

waitForResults?: boolean

Eigenschaftswert

boolean

windingness

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

windingness?: "low" | "normal" | "high"

Eigenschaftswert

"low" | "normal" | "high"