Citymapper (Unabhängiger Herausgeber) (Vorschau)
Mit Citymapper können Sie Ihren Produkten Die Reiseplanung und turn-by-Turn-Navigation hinzufügen. Unsere Dienstleistungen werden von unseren branchenführenden globalen Transportdaten und benutzerdefinierten Routingalgorithmen unterstützt, die auf Milliarden von Reisen trainiert wurden.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Troy Taylor |
| Webseite | https://citymapper.com/ |
| Datenschutzrichtlinie | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Kategorien | Lifestyle und Unterhaltung |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen einer Fahrradroute zwischen zwei Punkten |
Ruft eine Fahrradroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Dieser Aufruf geht davon aus, dass der Fahrer am Startpunkt ein Fahrrad hat und eine Fahrradroute von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte ein einzelnes Fahrradstück enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Fahrrad gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Fahrradbetreibern, aber andere Serviceanrufe sind dazu möglicherweise verfügbar. Der maximale Großkreisabstand zwischen Start und Ende ist für diesen Service auf 200 km begrenzt. |
| Abrufen einer Fahrroute zwischen zwei Punkten |
Ruft eine Autoroute zwischen zwei Punkten ab und stellt genügend Informationen bereit, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Dieser Aufruf geht davon aus, dass der Fahrer am Startpunkt ein Auto hat und eine Autoroute von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Autoabschnitt enthalten. Der maximale Großkreisabstand zwischen Start und Ende ist für diesen Dienst auf 1000 km begrenzt. |
| Abrufen einer Route zwischen zwei Punkten für ein Szenario |
Berechnet Routen zwischen zwei Punkten basierend auf einem bereitgestellten Szenario. Je nach Szenario können je nach Szenario eine oder mehrere Gruppen von Routen bereitgestellt werden. Jede Gruppe enthält mehrere Routen. Jede Route enthält eine oder mehrere Beine. |
| Abrufen einer Taxiroute zwischen zwei Punkten |
Ruft eine Taxiroute zwischen zwei Punkten ab. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Die Route kann Anfangs- und Endläufe enthalten, wenn die Abhol- oder Abgabepunkte nicht nahe an den angeforderten Anfangs- und Endkoordinaten liegen. Die Dienste in der Antwort variieren je nach lokaler Verfügbarkeit, Tageszeit und zusätzlich, welche Taxi-Service-Integrationen für Ihr Konto konfiguriert wurden. Es gibt zwei empfohlene Möglichkeiten, diesen Service zu verwenden: Sie können eine Taxiroute mit Live-On-Demand-Serviceschätzungen im Voraus anfordern, indem Sie mit "?fetch_on_demand_services=true" anrufen; oder Sie können die ursprüngliche Anforderung vornehmen, ohne Schätzungen abzurufen, die mit der Nicht-Live-Route antworten, und dann sofort "1/live/routeupdates" aufrufen, um die zusätzlichen Live-Schätzungen zu erhalten. Der erste Ansatz ist einfacher, aber der zweite eignet sich möglicherweise besser für Ihren Anwendungsfall. |
| Abrufen einer Transitroute zwischen zwei Punkten |
Berechnet mehrere öffentliche Verkehrswege zwischen zwei Punkten. Standardmäßig enthalten die Ergebnisse bis zu 5 Routen. Jeder wird mehrere Beine enthalten: in der Regel am Anfang und Ende der Route mit "travel_mode" von "Walk", wobei mindestens eine mit "travel_mode" von "Transit" dazwischen. |
| Abrufen einer Wanderroute zwischen zwei Punkten |
Ruft eine Wanderroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Zu Fußrouten wird erwartet, dass ein einzelnes Bein mit einem "travel_mode" von "Walk" vorhanden ist. Wenn Citymapper keine Wegbeschreibungen für diese Punkte berechnen kann (im Allgemeinen aus Abdeckungsgründen), gibt der Dienst eine Codeantwort "400" zurück. Der maximale Großkreisabstand zwischen "Start" und "End" ist für diesen Dienst auf 100 km begrenzt. |
| Abrufen von Live-Abfahrts- und Verfügbarkeitsinformationen für mehrere Routen |
Dadurch werden aktuelle und Live-Abfahrtsinformationen und Live-On-Demand-Angebote für mehrere Routen abgerufen, die zuvor von den Endpunkten "Wegbeschreibungen" abgerufen wurden. Nur Routen mit mindestens einem Bein mit einem Aktualisierbaren Detail können mit diesem Dienst aktualisiert werden. Beachten Sie, dass citymapper möglicherweise nicht immer möglich ist, aktuelle Zeiten oder Live-Abfahrts- und Unterbrechungsinformationen für ein Bein bereitzustellen. Erfolgreiche Antworten (HTTP-Code '200') verbrauchen für jede HTTP-Antwort eine "Live Update"-Gutschrift. Nicht erfolgreiche Anrufe verbrauchen keine Gutschriften. |
| Abrufen von Reisezeiten zwischen zwei Standorten |
Bestimmt die Reisezeit in verschiedenen Reisearten zwischen den angegebenen zwei Punkten zum Zeitpunkt der Anforderung. |
| E-Scooter Wegbeschreibungen zwischen zwei Punkten erhalten |
Ruft eine Rollerroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. (Diese Ergebnisse sind für kleine batteriebetriebene Roller optimiert, auf denen der Fahrer steht.) Dieser Aufruf geht davon aus, dass der Fahrer einen Roller am Startpunkt hat und eine E-Scooter-Route von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Rollerfuß enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Roller gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Rollerbetreibern, aber andere Serviceanrufe können dazu zur Verfügung stehen. Erfolgreiche Antworten (HTTP-Code '200') verbrauchen für jede HTTP-Antwort eine "Scooter Route"-Gutschrift (oder eine "Scooter Reroute"-Gutschrift, wenn "reroute_signature" verwendet wird). Nicht erfolgreiche Anrufe verbrauchen keine Gutschriften. |
| Erhalten Sie eingestellte E-Scooter Wegbeschreibungen zwischen zwei Punkten |
Ruft eine eingestellte E-Scooter-Route zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Diese Ergebnisse sind für kleine batteriebetriebene Roller optimiert, auf denen der Fahrer steht. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jeden Roller der angegebenen Marke . Dies ist der einfachste Anruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit einen Roller der angegebenen Marke aus. Verwenden eines Rollers an einer bestimmten Position Durch das Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich der Roller an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll. |
| Holen Sie sich eine eingestellte Fahrradroute zwischen zwei Punkten |
Ruft eine eingestellte Fahrradroute zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jedes Fahrrad der angegebenen Marke . Dies ist der einfachste Aufruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit ein Fahrrad der angegebenen Marke aus. Verwenden eines Fahrrads an einer bestimmten Position Durch Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich das Fahrrad an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll. |
| Holen Sie sich eine eingestellte Motorrollerroute zwischen zwei Punkten |
Ruft eine eingestellte Motorrollerroute zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. (Diese Ergebnisse sind für größere Verbrennungs- oder Elektroroller optimiert, bei denen der Fahrer sitzt.) ANMERKUNG: Die resultierende Route geht derzeit davon aus, dass der Benutzer direkt zum angegebenen "Endstandort" fahren kann und dabei keine Park- oder Abdeckungszonen berücksichtigt. Daher enthält die resultierende Route nur einen ersten Teil von "travel_mode" "Walk" und einen zweiten Abschnitt von "travel_mode" "self_piloted". Ein zukünftiges Update wird Park- und Abdeckungszonen enthalten und ein letztes "Walk"-Leg hinzufügen. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jeden Roller der angegebenen Marke . Dies ist der einfachste Anruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit einen Roller der angegebenen Marke aus. Verwenden eines Rollers an einer bestimmten Position Durch das Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich der Roller an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll. |
| Holen Sie sich eine Motorrollerroute zwischen zwei Punkten |
Ruft eine Motorrollerroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. (Diese Ergebnisse sind für größere Verbrennungs- oder Elektroroller optimiert, bei denen der Fahrer sitzt.) Dieser Aufruf geht davon aus, dass der Fahrer einen Roller am Startpunkt hat und eine E-Scooter-Route von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Rollerfuß enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Roller gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Rollerbetreibern, aber andere Serviceanrufe können dazu zur Verfügung stehen. |
Abrufen einer Fahrradroute zwischen zwei Punkten
Ruft eine Fahrradroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Dieser Aufruf geht davon aus, dass der Fahrer am Startpunkt ein Fahrrad hat und eine Fahrradroute von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte ein einzelnes Fahrradstück enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Fahrrad gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Fahrradbetreibern, aber andere Serviceanrufe sind dazu möglicherweise verfügbar. Der maximale Großkreisabstand zwischen Start und Ende ist für diesen Service auf 200 km begrenzt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Profile
|
profiles | string |
Gibt an, welche "Profile" beim Berechnen von Fahrradbeschreibungen verwendet werden sollen. Jedes Profil kann eine andere Routenoption generieren, sodass das Anfordern weiterer Profile in der Regel mehr Optionen gibt. Beachten Sie, dass manchmal einige der resultierenden Routen identisch sind (im Falle einer optimalen Route auf mehr als eine Weise), und ein Profil führt möglicherweise nicht immer zu einer Route. | Wert | beschreibung | | ----- | ----------- | | ruhig | Versuche, Straßen mit weniger Verkehr zu verwenden | | normal | Das Standardprofil, glich Datenverkehr mit Direktheit | | schnell | Versuche, die kürzeste vernünftigste Route zu finden | Wenn keine Profile angegeben sind, wird "normal" verwendet. |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
|
|
Vergangene Speicherorte
|
past_loc_coords | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die Koordinaten von bis zu 10 der letzten Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Koordinaten müssen im WGS84-Format "Breitengrad,Längengrad" sein. Koordinaten müssen in Dezimalstellen angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangenes Ortsalter
|
past_loc_ages | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Das Alter von bis zu 10 der vergangenen Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Altersstufen müssen in ganzzahligen Sekunden seit der aktuellen Position betragen. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_coords" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangene Positionsgenauigkeiten
|
past_loc_accuracies | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die GPS-Genauigkeiten von bis zu 10 der letzten Standorte des Benutzers als durch Trennzeichen getrennte Liste. Genauigkeiten müssen in ganzzahligen Metern angegeben werden. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_coords" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen einer Fahrroute zwischen zwei Punkten
Ruft eine Autoroute zwischen zwei Punkten ab und stellt genügend Informationen bereit, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Dieser Aufruf geht davon aus, dass der Fahrer am Startpunkt ein Auto hat und eine Autoroute von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Autoabschnitt enthalten. Der maximale Großkreisabstand zwischen Start und Ende ist für diesen Dienst auf 1000 km begrenzt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen einer Route zwischen zwei Punkten für ein Szenario
Berechnet Routen zwischen zwei Punkten basierend auf einem bereitgestellten Szenario. Je nach Szenario können je nach Szenario eine oder mehrere Gruppen von Routen bereitgestellt werden. Jede Gruppe enthält mehrere Routen. Jede Route enthält eine oder mehrere Beine.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenario_id | True | string |
Szenario-ID für Wegbeschreibungen. |
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Uhrzeit
|
time | string |
Die Zeit, die als Abfahrts- oder Ankunftszeiteinschränkung verwendet werden soll, wenn Sie Wegbeschreibungen erhalten. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
|
Zeittyp
|
time_type | string |
Wenn ein "time"-Wert angegeben wird, bestimmt dies, wie die Zeit verwendet wird, um die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn dies nicht angegeben ist, wird "depart_approximate" verwendet. Wenn keine "Zeit" angegeben wird, hat dies keine Auswirkung. | Wert | beschreibung | | ----- | ----------- | | ankommen | Wegbeschreibungen werden ausgewählt, die den Benutzer zu ihrem Ziel am oder vor dem 'Time' | | depart | Wegbeschreibungen werden ausgewählt, wenn der Benutzer seinen Ursprung so bald wie möglich hinterlässt | | depart_approximate | Ähnlich wie "Abfahrt", aber für spätere Abfahrten erlauben, um mehr bevorzugte Optionen zurückzugeben, auch wenn sie ein bisschen später verlassen. Dies ist die Standardart von Citymapper zum Auswählen von Wegbeschreibungen, wenn die Uhrzeit nicht angegeben wird | |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen einer Taxiroute zwischen zwei Punkten
Ruft eine Taxiroute zwischen zwei Punkten ab. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Die Route kann Anfangs- und Endläufe enthalten, wenn die Abhol- oder Abgabepunkte nicht nahe an den angeforderten Anfangs- und Endkoordinaten liegen. Die Dienste in der Antwort variieren je nach lokaler Verfügbarkeit, Tageszeit und zusätzlich, welche Taxi-Service-Integrationen für Ihr Konto konfiguriert wurden. Es gibt zwei empfohlene Möglichkeiten, diesen Service zu verwenden: Sie können eine Taxiroute mit Live-On-Demand-Serviceschätzungen im Voraus anfordern, indem Sie mit "?fetch_on_demand_services=true" anrufen; oder Sie können die ursprüngliche Anforderung vornehmen, ohne Schätzungen abzurufen, die mit der Nicht-Live-Route antworten, und dann sofort "1/live/routeupdates" aufrufen, um die zusätzlichen Live-Schätzungen zu erhalten. Der erste Ansatz ist einfacher, aber der zweite eignet sich möglicherweise besser für Ihren Anwendungsfall.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
On-Domain Services abrufen
|
fetch_on_demand_services | string |
Bei Festlegung auf "true" werden zusätzliche Informationen von Ihren Taxi-Serviceintegrationen angefordert, um genauere und vollständige Preise, Dauer und Serviceverfügbarkeit bereitzustellen, die im aktualisierten Detail des On-Demand-Legs zurückgegeben werden. Um dies bereitzustellen, müssen die Start- und Endstandorte der Route an diese Drittanbieterdienste übertragen werden, einschließlich der Fälle, in denen ein oder der andere der aktuelle oder der aktuelle Standort des Benutzers ist. Beachten Sie, dass Sie je nach anwendbaren Gesetzen und Vorschriften möglicherweise über eine explizite informierte Zustimmung Ihres Endbenutzers verfügen müssen, um dies auf "true" festzulegen. Wenn dieser Wert auf "false" festgelegt oder weggelassen wird, werden keine Anforderungen an Drittanbieterdienste gestellt. |
|
|
Marken-IDs
|
brand_ids | array |
Durch Trennzeichen getrennte Liste von Marken-IDs, auf die diese Anforderung für wegbeschreibungen beschränkt werden soll. Wenn nicht angegeben (Standard), haben alle Marken, die Ihnen zur Verfügung stehen, eine Taxi-Route zurückgegeben. |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen einer Transitroute zwischen zwei Punkten
Berechnet mehrere öffentliche Verkehrswege zwischen zwei Punkten. Standardmäßig enthalten die Ergebnisse bis zu 5 Routen. Jeder wird mehrere Beine enthalten: in der Regel am Anfang und Ende der Route mit "travel_mode" von "Walk", wobei mindestens eine mit "travel_mode" von "Transit" dazwischen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Uhrzeit
|
time | string |
Die Zeit, die als Abfahrts- oder Ankunftszeiteinschränkung verwendet werden soll, wenn Sie Wegbeschreibungen erhalten. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
|
Zeittyp
|
time_type | string |
Wenn ein "time"-Wert angegeben wird, bestimmt dies, wie die Zeit verwendet wird, um die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn dies nicht angegeben ist, wird "depart_approximate" verwendet. Wenn keine "Zeit" angegeben wird, hat dies keine Auswirkung. | Wert | beschreibung | | ----- | ----------- | | ankommen | Wegbeschreibungen werden ausgewählt, die den Benutzer zu ihrem Ziel am oder vor dem 'Time' | | depart | Wegbeschreibungen werden ausgewählt, wenn der Benutzer seinen Ursprung so bald wie möglich hinterlässt | | depart_approximate | Ähnlich wie "Abfahrt", aber für spätere Abfahrten erlauben, um mehr bevorzugte Optionen zurückzugeben, auch wenn sie ein bisschen später verlassen. Dies ist die Standardart von Citymapper zum Auswählen von Wegbeschreibungen, wenn die Uhrzeit nicht angegeben wird | |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Limit
|
limit | integer |
Maximale Anzahl der zurückzugebenden Routen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen einer Wanderroute zwischen zwei Punkten
Ruft eine Wanderroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. Zu Fußrouten wird erwartet, dass ein einzelnes Bein mit einem "travel_mode" von "Walk" vorhanden ist. Wenn Citymapper keine Wegbeschreibungen für diese Punkte berechnen kann (im Allgemeinen aus Abdeckungsgründen), gibt der Dienst eine Codeantwort "400" zurück. Der maximale Großkreisabstand zwischen "Start" und "End" ist für diesen Dienst auf 100 km begrenzt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Profile
|
profiles | string |
Gibt an, welche "Profile" beim Berechnen von Wegbeschreibungen verwendet werden sollen. Jedes Profil kann eine andere Routenoption generieren, sodass das Anfordern weiterer Profile in der Regel mehr Optionen gibt. Beachten Sie, dass manchmal einige der resultierenden Routen identisch sind (im Falle einer optimalen Route auf mehr als eine Weise), und ein Profil führt möglicherweise nicht immer zu einer Route. Nicht alle Profile sind für alle Start- und Endrouten verfügbar. Nicht verfügbare Profile werden aus der Antwort weggelassen. | Wert | beschreibung | | ----- | ----------- | | schnell | Das Standardprofil, versucht, die schnellste vernünftige Route zu finden | | main_roads | Versuche, Backstreets und Parks zu vermeiden | Wenn keine Profile angegeben werden, wird "fast" verwendet. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Abrufen von Live-Abfahrts- und Verfügbarkeitsinformationen für mehrere Routen
Dadurch werden aktuelle und Live-Abfahrtsinformationen und Live-On-Demand-Angebote für mehrere Routen abgerufen, die zuvor von den Endpunkten "Wegbeschreibungen" abgerufen wurden. Nur Routen mit mindestens einem Bein mit einem Aktualisierbaren Detail können mit diesem Dienst aktualisiert werden. Beachten Sie, dass citymapper möglicherweise nicht immer möglich ist, aktuelle Zeiten oder Live-Abfahrts- und Unterbrechungsinformationen für ein Bein bereitzustellen. Erfolgreiche Antworten (HTTP-Code '200') verbrauchen für jede HTTP-Antwort eine "Live Update"-Gutschrift. Nicht erfolgreiche Anrufe verbrauchen keine Gutschriften.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Signaturen
|
signatures | True | array of string |
Ein Array von "Signatur"-Eigenschaften aus zuvor abgerufenen Routen |
|
On-Demand-Dienste abrufen
|
fetch_on_demand_services | boolean |
Bei der Aktualisierung einer oder mehrerer Signaturen von Routen, die On-Demand-Beine mit aktualisierbaren Details (z. B. vom Taxi-Wegbeschreibungsdienst) enthalten, werden zusätzliche Informationen von Taxi-Service-Intrgrationen angefordert, um genauere und vollständige Preise, Dauer und Serviceverfügbarkeit bereitzustellen. Um dies bereitzustellen, müssen die ursprünglichen Start- und Endstandorte der Route an diese Drittanbieterdienste übertragen werden, einschließlich der Fälle, in denen eine oder andere der aktuelle oder der aktuelle Standort des Benutzers ist. Beachten Sie, dass Sie je nach anwendbaren Gesetzen und Vorschriften möglicherweise über eine explizite informierte Zustimmung Ihres Endbenutzers verfügen müssen, um dies auf "true" festzulegen. Wenn dieser Wert auf "false" festgelegt oder weggelassen wird, werden keine Anforderungen an Drittanbieterdienste gestellt. Wenn kein Update für ein Bein erstellt werden kann, ohne dass dieser Parameter auf "true" festgelegt wird, gibt die Antwort dies innerhalb des aktualisierbaren Details an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Leg Updates
|
route_updates.leg_updates | array of |
Dies ist ein paralleles Array von Aktualisierbaren Detailobjekten, eines für jedes Bein in der ursprünglichen Route, die aktualisiert wird. Die entsprechenden Fußbeine sind leer, aber die Details, die transitschen Beinen entsprechen, enthalten aktualisierte Abfahrtsinformationen. |
|
Abfahrtszeit
|
route_updates.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, dass der Benutzer zum Zeitpunkt der Anforderung am Anfang der Route steht. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
route_updates.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, dass der Benutzer zum Zeitpunkt der Anforderung am Anfang der Route steht. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Dauer
|
route_updates.route_duration_seconds | integer |
Die geschätzte Gesamtzeit, um die gesamte Route in Sekunden zu durchlaufen. Dieser Wert ersetzt den Wert "duration_seconds" aus der ursprünglichen Route, da er neu komputiert wird, um die spezifischen Abfahrtsinformationen zu verwenden, die in dieser Antwort zur Routenaktualisierung enthalten sind. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann, z. B. wenn die Route zu dem angegebenen Zeitpunkt nicht abgeschlossen werden kann, da die beteiligten Dienste nicht ausgeführt werden. |
|
DurationAccuracy
|
route_updates.route_duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Signatur anfordern
|
route_updates.request_signature | string |
Dies ist eine Route "Signatur" aus der Updateanforderung, die verwendet werden sollte, um dieses Update der richtigen Route zuzuordnen. |
Abrufen von Reisezeiten zwischen zwei Standorten
Bestimmt die Reisezeit in verschiedenen Reisearten zwischen den angegebenen zwei Punkten zum Zeitpunkt der Anforderung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | string |
Der geografische Ausgangspunkt der Reise, im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. |
|
ENDE
|
end | True | string |
Der geografische Endpunkt der Reise im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. |
|
Reisetypen
|
traveltime_types | array |
Eine durch Trennzeichen getrennte Liste verschiedener Reisezeittypen, um eine Anforderung anzufordern. Jeder Anforderungswert entspricht einem bestimmten Feld in der Antwort (Antwortfelder sind nur vorhanden, wenn Citymapper eine Zeit für diesen Reisezeittyp berechnen konnte). | Wert | response-Eigenschaft | beschreibung | | ----- | ----------------- | ------------| | Walk | walk_travel_time_minutes | Gehen | | Transit | transit_time_minutes | Öffentliche Verkehrsmittel | | Bike | bike_time_minutes | Fahrradreisen (fahren auf dem ganzen Weg) | | Roller | scooter_time_minutes | Steh-E-Scooter Reisen (auf dem ganzen Weg) | | Motorenkooter | motorscooter_time_minutes | Sitzender Motorroller reisen (fahren auf dem ganzen Weg) | | Auto | car_time_minutes | Autoreisen (fahren auf dem ganzen Weg). Nur für Enterprise-Pläne verfügbar | Wenn dieses Feld nicht angegeben oder leer ist, wird ein Standardwert von "walk,transit" verwendet. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Walk Time
|
walk_travel_time_minutes | integer |
Geschätzte Gehzeit zwischen den beiden angegebenen Punkten in Minuten. |
|
Durchgangszeit
|
transit_time_minutes | integer |
Geschätzte Fahrzeit für den öffentlichen Verkehr zwischen den beiden angegebenen Punkten in Minuten. |
|
Fahrradzeit
|
bike_time_minutes | integer |
Geschätzte Fahrradreisezeit zwischen zwei Punkten in Minuten. |
|
Rollerzeit
|
scooter_time_minutes | integer |
Geschätzte E-Scooter-Fahrtzeit zwischen zwei Punkten in Minuten. |
|
Motorscooterzeit
|
motorscooter_time_minutes | integer |
Geschätzte Motorroller-Fahrtzeit zwischen zwei Punkten in Minuten. |
|
Laufwerkszeit
|
car_time_minutes | integer |
Geschätzte Autoreisezeit zwischen zwei Punkten in Minuten. |
E-Scooter Wegbeschreibungen zwischen zwei Punkten erhalten
Ruft eine Rollerroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. (Diese Ergebnisse sind für kleine batteriebetriebene Roller optimiert, auf denen der Fahrer steht.) Dieser Aufruf geht davon aus, dass der Fahrer einen Roller am Startpunkt hat und eine E-Scooter-Route von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Rollerfuß enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Roller gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Rollerbetreibern, aber andere Serviceanrufe können dazu zur Verfügung stehen. Erfolgreiche Antworten (HTTP-Code '200') verbrauchen für jede HTTP-Antwort eine "Scooter Route"-Gutschrift (oder eine "Scooter Reroute"-Gutschrift, wenn "reroute_signature" verwendet wird). Nicht erfolgreiche Anrufe verbrauchen keine Gutschriften.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
|
|
Vergangene Speicherorte
|
past_loc_coords | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die Koordinaten von bis zu 10 der letzten Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Koordinaten müssen im WGS84-Format "Breitengrad,Längengrad" sein. Koordinaten müssen in Dezimalstellen angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangenes Ortsalter
|
past_loc_ages | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Das Alter von bis zu 10 der vergangenen Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Altersstufen müssen in ganzzahligen Sekunden seit der aktuellen Position betragen. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_coords" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangene Positionsgenauigkeiten
|
past_loc_accuracies | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die GPS-Genauigkeiten von bis zu 10 der letzten Standorte des Benutzers als durch Trennzeichen getrennte Liste. Genauigkeiten müssen in ganzzahligen Metern angegeben werden. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_coords" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Erhalten Sie eingestellte E-Scooter Wegbeschreibungen zwischen zwei Punkten
Ruft eine eingestellte E-Scooter-Route zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Diese Ergebnisse sind für kleine batteriebetriebene Roller optimiert, auf denen der Fahrer steht. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jeden Roller der angegebenen Marke . Dies ist der einfachste Anruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit einen Roller der angegebenen Marke aus. Verwenden eines Rollers an einer bestimmten Position Durch das Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich der Roller an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Marken-ID
|
brand_id | True | string |
Die ID der Marke von E-Scootern, die für diese Route verwendet werden sollen. Dies ist notwendig, um den Standort der verfügbaren Roller zusammen mit den damit verbundenen Abdeckungs- und Parkbeschränkungen zu bestimmen. |
|
Staat
|
ride_state | string |
Gibt an, wo sich der Benutzer entlang der Route befindet. Wird "walking_to_vehicle" nicht angegeben, wird "walking_to_vehicle" verwendet. Diese Eigenschaft zusammen mit "current_location" ermöglicht den Abruf einer aktualisierten Route, die den aktuellen Fortschritt des Benutzers widerspiegelt. | Wert | beschreibung | | ----- | ----------- | | walking_to_vehicle | Gibt an, dass der Benutzer zum Sammeln des Fahrzeugs | | Reiten | Gibt an, dass der Benutzer das Fahrzeug fährt | | walking_to_end | Gibt an, dass der Benutzer das Fahrzeug verlassen hat und zu ihrem Ziel geht | |
|
|
Aktueller Speicherort
|
current_location | string |
Der aktuelle Standort des Benutzers, um die Route basierend auf dem Standort des Benutzers zu aktualisieren. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dieser Parameter wird verwendet, um eine aktualisierte Route abzurufen, die den tatsächlichen Standort des Benutzers widerspiegelt, wenn er vom Pfad in der Route abweicht. Wenn dies angegeben wird, enthält die zurückgegebene Route diesen Speicherort. Welcher Teil der Route diese Position enthält, wird durch den Wert des Parameters "ride_state" festgelegt. |
|
|
Startspeicherort
|
ride_start_location | string |
Die Position des zu verwendenden Fahrzeugs am Anfang der Fahrzeugfahrt entlang der Route. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "Reiten" oder "walking_to_end" ist. Wenn "ride_state" nicht "walking_to_vehicle" (oder nicht angegeben) ist, versucht Citymapper, das am besten geeignete Fahrzeug zu finden, das zum angegebenen "brand_id" gehört. Aus Kompatibilitätsgründen ist "original_vehicle_location" ein Alias für diesen Parameter. |
|
|
Endspeicherort
|
ride_end_location | string |
Die Position, an der das Fahrzeug am Ende des Fahrzeugfahrens am Ende der Fahrt des Benutzers entlang der Route abgesetzt wurde. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "walking_to_end" ist. In allen anderen Zuständen wird dieser Parameter ignoriert. |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
|
|
Vergangene Speicherorte
|
past_loc_coords | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die Koordinaten von bis zu 10 der letzten Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Koordinaten müssen im WGS84-Format "Breitengrad,Längengrad" sein. Koordinaten müssen in Dezimalstellen angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangenes Ortsalter
|
past_loc_ages | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Das Alter von bis zu 10 der vergangenen Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Altersstufen müssen in ganzzahligen Sekunden seit der aktuellen Position betragen. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_coords" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangene Positionsgenauigkeiten
|
past_loc_accuracies | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die GPS-Genauigkeiten von bis zu 10 der letzten Standorte des Benutzers als durch Trennzeichen getrennte Liste. Genauigkeiten müssen in ganzzahligen Metern angegeben werden. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_coords" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Holen Sie sich eine eingestellte Fahrradroute zwischen zwei Punkten
Ruft eine eingestellte Fahrradroute zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jedes Fahrrad der angegebenen Marke . Dies ist der einfachste Aufruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit ein Fahrrad der angegebenen Marke aus. Verwenden eines Fahrrads an einer bestimmten Position Durch Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich das Fahrrad an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Marken-ID
|
brand_id | True | string |
Die ID der Marke des Fahrrads, die für diese Route verwendet werden soll. Dies ist erforderlich, um den Standort der verfügbaren Fahrräder zusammen mit den damit verbundenen Abdeckungs- und Parkbeschränkungen zu bestimmen. |
|
Staat
|
ride_state | string |
Gibt an, wo sich der Benutzer entlang der Route befindet. Wird "walking_to_vehicle" nicht angegeben, wird "walking_to_vehicle" verwendet. Diese Eigenschaft zusammen mit "current_location" ermöglicht den Abruf einer aktualisierten Route, die den aktuellen Fortschritt des Benutzers widerspiegelt. | Wert | beschreibung | | ----- | ----------- | | walking_to_vehicle | Gibt an, dass der Benutzer zum Sammeln des Fahrzeugs | | Reiten | Gibt an, dass der Benutzer das Fahrzeug fährt | | walking_to_end | Gibt an, dass der Benutzer das Fahrzeug verlassen hat und zu ihrem Ziel geht | |
|
|
Aktueller Speicherort
|
current_location | string |
Der aktuelle Standort des Benutzers, um die Route basierend auf dem Standort des Benutzers zu aktualisieren. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dieser Parameter wird verwendet, um eine aktualisierte Route abzurufen, die den tatsächlichen Standort des Benutzers widerspiegelt, wenn er vom Pfad in der Route abweicht. Wenn dies angegeben wird, enthält die zurückgegebene Route diesen Speicherort. Welcher Teil der Route diese Position enthält, wird durch den Wert des Parameters "ride_state" festgelegt. |
|
|
Startspeicherort
|
ride_start_location | string |
Die Position des zu verwendenden Fahrzeugs am Anfang der Fahrzeugfahrt entlang der Route. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "Reiten" oder "walking_to_end" ist. Wenn "ride_state" nicht "walking_to_vehicle" (oder nicht angegeben) ist, versucht Citymapper, das am besten geeignete Fahrzeug zu finden, das zum angegebenen "brand_id" gehört. Aus Kompatibilitätsgründen ist "original_vehicle_location" ein Alias für diesen Parameter. |
|
|
Endspeicherort
|
ride_end_location | string |
Die Position, an der das Fahrzeug am Ende des Fahrzeugfahrens am Ende der Fahrt des Benutzers entlang der Route abgesetzt wurde. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "walking_to_end" ist. In allen anderen Zuständen wird dieser Parameter ignoriert. |
|
|
Profile
|
profiles | string |
Gibt an, welche "Profile" beim Berechnen von Fahrradbeschreibungen verwendet werden sollen. Jedes Profil kann eine andere Routenoption generieren, sodass das Anfordern weiterer Profile in der Regel mehr Optionen gibt. Beachten Sie, dass manchmal einige der resultierenden Routen identisch sind (im Falle einer optimalen Route auf mehr als eine Weise), und ein Profil führt möglicherweise nicht immer zu einer Route. | Wert | beschreibung | | ----- | ----------- | | ruhig | Versuche, Straßen mit weniger Verkehr zu verwenden | | normal | Das Standardprofil, glich Datenverkehr mit Direktheit | | schnell | Versuche, die kürzeste vernünftigste Route zu finden | Wenn keine Profile angegeben sind, wird "normal" verwendet. |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
|
|
Vergangene Speicherorte
|
past_loc_coords | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die Koordinaten von bis zu 10 der letzten Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Koordinaten müssen im WGS84-Format "Breitengrad,Längengrad" sein. Koordinaten müssen in Dezimalstellen angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangenes Ortsalter
|
past_loc_ages | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Das Alter von bis zu 10 der vergangenen Speicherorte des Benutzers als durch Trennzeichen getrennte Liste. Altersstufen müssen in ganzzahligen Sekunden seit der aktuellen Position betragen. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_coords" und "past_loc_accuracies" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
|
|
Vergangene Positionsgenauigkeiten
|
past_loc_accuracies | string |
Optionaler Parameter zur Verbesserung des Umleitungsverhaltens. Die GPS-Genauigkeiten von bis zu 10 der letzten Standorte des Benutzers als durch Trennzeichen getrennte Liste. Genauigkeiten müssen in ganzzahligen Metern angegeben werden. Muss chronologisch sortiert sein, zuletzt zuletzt. "past_loc_ages" und "past_loc_coords" müssen zusammen bereitgestellt werden. Der Server berücksichtigt nur maximal 10 Speicherorte, wenn mehr als 10 Speicherorte bereitgestellt werden, werden die zuletzt verwendeten Speicherorte ignoriert. Der Server ignoriert wahrscheinlich alle Speicherorte, die älter als 30 Sekunden oder weniger als 1 Sekunde sind. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Holen Sie sich eine eingestellte Motorrollerroute zwischen zwei Punkten
Ruft eine eingestellte Motorrollerroute zwischen zwei Punkten ab, einschließlich aller anfänglichen und letzten Wanderungen. Die resultierende Route stellt genügend Informationen bereit, um sie auf einer Karte zusammen mit einer Dauerschätzung zu rendern. (Diese Ergebnisse sind für größere Verbrennungs- oder Elektroroller optimiert, bei denen der Fahrer sitzt.) ANMERKUNG: Die resultierende Route geht derzeit davon aus, dass der Benutzer direkt zum angegebenen "Endstandort" fahren kann und dabei keine Park- oder Abdeckungszonen berücksichtigt. Daher enthält die resultierende Route nur einen ersten Teil von "travel_mode" "Walk" und einen zweiten Abschnitt von "travel_mode" "self_piloted". Ein zukünftiges Update wird Park- und Abdeckungszonen enthalten und ein letztes "Walk"-Leg hinzufügen. Dieser Aufruf kann auf verschiedene Arten verwendet werden: Verwenden Sie jeden Roller der angegebenen Marke . Dies ist der einfachste Anruf, der nur "start", "end" und "brand_id" erfordert. Citymapper geht davon aus, dass sich der Benutzer am Startpunkt befindet, und wählt nach Möglichkeit einen Roller der angegebenen Marke aus. Verwenden eines Rollers an einer bestimmten Position Durch das Hinzufügen von "original_vehicle_location" zu "start", "end" und "brand_id" plant Citymapper eine Route, die davon ausgeht, dass sich der Roller an der angegebenen Position befindet. Aktualisieren einer laufenden Route Um eine aktualisierte Route abzurufen, die eine Umleitung vom aktuellen Standort des Benutzers umfasst, wenn sie von der geplanten Route abweichen, kann der Anrufer die Eigenschaften "current_location" und "ride_state" hinzufügen, die angibt, welche Etappe der resultierenden Route um den "current_location" des Benutzers umgeleitet werden soll.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Marken-ID
|
brand_id | True | string |
Die ID der Marke der Roller, die für diese Route verwendet werden sollen. Dies ist notwendig, um den Standort der verfügbaren Roller zusammen mit den damit verbundenen Abdeckungs- und Parkbeschränkungen zu bestimmen. |
|
Staat
|
ride_state | string |
Gibt an, wo sich der Benutzer entlang der Route befindet. Wird "walking_to_vehicle" nicht angegeben, wird "walking_to_vehicle" verwendet. Diese Eigenschaft zusammen mit "current_location" ermöglicht den Abruf einer aktualisierten Route, die den aktuellen Fortschritt des Benutzers widerspiegelt. | Wert | beschreibung | | ----- | ----------- | | walking_to_vehicle | Gibt an, dass der Benutzer zum Sammeln des Fahrzeugs | | Reiten | Gibt an, dass der Benutzer das Fahrzeug fährt | | walking_to_end | Gibt an, dass der Benutzer das Fahrzeug verlassen hat und zu ihrem Ziel geht | |
|
|
Aktueller Speicherort
|
current_location | string |
Der aktuelle Standort des Benutzers, um die Route basierend auf dem Standort des Benutzers zu aktualisieren. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dieser Parameter wird verwendet, um eine aktualisierte Route abzurufen, die den tatsächlichen Standort des Benutzers widerspiegelt, wenn er vom Pfad in der Route abweicht. Wenn dies angegeben wird, enthält die zurückgegebene Route diesen Speicherort. Welcher Teil der Route diese Position enthält, wird durch den Wert des Parameters "ride_state" festgelegt. |
|
|
Startspeicherort
|
ride_start_location | string |
Die Position des zu verwendenden Fahrzeugs am Anfang der Fahrzeugfahrt entlang der Route. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "Reiten" oder "walking_to_end" ist. Wenn "ride_state" nicht "walking_to_vehicle" (oder nicht angegeben) ist, versucht Citymapper, das am besten geeignete Fahrzeug zu finden, das zum angegebenen "brand_id" gehört. Aus Kompatibilitätsgründen ist "original_vehicle_location" ein Alias für diesen Parameter. |
|
|
Endspeicherort
|
ride_end_location | string |
Die Position, an der das Fahrzeug am Ende des Fahrzeugfahrens am Ende der Fahrt des Benutzers entlang der Route abgesetzt wurde. Im WGS84-Format "Breitengrad,Längengrad" bereitgestellt. Koordinaten sollten in dezimaler Form angegeben werden, und nur die ersten 6 Ziffern der Genauigkeit werden verwendet. Dies muss angegeben werden, wenn "ride_state" "walking_to_end" ist. In allen anderen Zuständen wird dieser Parameter ignoriert. |
|
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |
Holen Sie sich eine Motorrollerroute zwischen zwei Punkten
Ruft eine Motorrollerroute zwischen zwei Punkten ab, die genügend Informationen bereitstellt, um sie auf einer Karte zu rendern, zusammen mit einer Dauerschätzung. (Diese Ergebnisse sind für größere Verbrennungs- oder Elektroroller optimiert, bei denen der Fahrer sitzt.) Dieser Aufruf geht davon aus, dass der Fahrer einen Roller am Startpunkt hat und eine E-Scooter-Route von dort zum "Endpunkt" bereitstellt, wenn beide in den von Citymapper unterstützten Bereichen liegen. Die resultierende Route sollte einen einzelnen Rollerfuß enthalten, obwohl die Eigenschaft "path_annotations" des Beins möglicherweise Abschnitte angeben kann, in denen der Benutzer neben dem Roller gehen sollte. Dieser Anruf enthält keine Informationen über die Abdeckung oder Parkplätze von Rollerbetreibern, aber andere Serviceanrufe können dazu zur Verfügung stehen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
start | True | array |
Der geografische Start der Route im WGS84 -Format "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
ENDE
|
end | True | array |
Das geografische Ende der Route im Format WGS84 "Breitengrad,Längengrad". Koordinaten sollten in dezimal sein, und nur die ersten 6 Dezimalstellen werden verwendet. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Spracheinstellung des Endbenutzers angibt. Wenn angegeben, enthält die Antwort eine "language"-Eigenschaft, die die sprache angibt, die für alle lokalisierbaren Elemente der Antwort verwendet wird (z. B. Drehanweisungen). Diese Sprache wird ein Best-Effort-Versuch sein, die ausgedrückte Einstellung zu erfüllen, aber es kann einen Wert enthalten, der nicht in der Anforderung ausgedrückt wurde (dies wird im Allgemeinen "en-US" als Fallback). Beachten Sie, dass sich die Spracheinstellung in der Regel nur auf von Citymapper generierte Inhalte wie das Drehen von Anweisungen auswirkt. Externe Inhalte wie Stoppnamen und Statusbeschreibungen werden in der Regel in ihrer Originalsprache übergeben. |
|
|
Signatur umleiten
|
reroute_signature | string |
Beim Umleiten (Anfordern einer Aktualisierung an eine vorherige Antwort, die den aktualisierten Speicherort des Benutzers angibt), sollte dieser Wert auf die in der ursprünglichen Route bereitgestellte "Signatur" festgelegt werden. Dies ermöglicht eine effizientere Bestimmung der aktualisierten Route. Dieser Wert muss URL-codiert sein. Wenn Sie diesen Parameter angeben, sollte der Standort "current_location" (falls zutreffend) oder "start" auf den neuesten Standort des Benutzers festgelegt werden. Wenn dieser Parameter enthalten ist, gibt Citymapper möglicherweise keine Ergebnisse zurück, wenn sich die Anforderung erheblich vom Original unterscheidet, z. B. wenn sich der Speicherort "End" unterscheidet oder mehr als 1 Stunde seit der ursprünglichen Anforderung vergangen ist. |
|
|
Lager beginnen
|
start_bearing | integer |
Ein Winkel im Uhrzeigersinn zwischen 0 und 359, wobei Nord 0 und Ost ist 90. Dieses Lager wird verwendet, um den anfänglichen Anweisungstext und/oder die Weiterleitung zu beeinflussen, am häufigsten, um zu vermeiden, dass der Benutzer aufgefordert wird, eine U-Turn vorzunehmen, wenn ein Fortsetzen des aktuellen Lagers eine vergleichbare Route gibt. Dies sollte nur bereitgestellt werden, wenn Sie die Erste Reiserichtung für die Route beeinflussen möchten. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breitengrad
|
routes.start.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.start.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Breitengrad
|
routes.end.coordinates.lat | float |
Ein Breitengrad in der WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Längengrad
|
routes.end.coordinates.lon | float |
Längengrad in WGS84-Codierung mit 6 Ziffern dezimaler Genauigkeit. |
|
Entfernung in Metern
|
routes.distance_meters | integer |
Die Gesamtstrecke der gesamten Route in Metern. |
|
Dauer
|
routes.duration_seconds | integer |
Die gesamt geschätzte Zeit, um die gesamte Route in Sekunden zu durchlaufen, basierend auf dem ausgewählten Fahrzeug oder der Abfahrt in der Antwort. |
|
Dauergenauigkeit
|
routes.duration_accuracy | string |
Citymapper bewertet, wie der Genauigkeitsgrad von "duration_seconds" dem Benutzer angezeigt werden soll. Dies basiert weitgehend auf dem "Typ" der für Zeiten verwendeten Abfahrten, aber es beinhaltet zusätzliche Heuristiken, die im Laufe der Zeit für die Citymapper-App entwickelt wurden. Wenn dieses Feld nicht angegeben wird, sollte der Wert "geplant" verwendet werden. | Wert | beschreibung | | ----- | ----------- | | geschätzt | Eine Dauer, die als ungefähr betrachtet werden sollte, da ihre Berechnung mehr Unsicherheit als üblich war. Dies ist die niedrigste Genauigkeit. | | geplant | Eine normale Dauer, in der Regel basierend auf veröffentlichten Zeitplaninformationen. | | live | Eine Dauer, die weitgehend auf Echtzeit-/Live-Abfahrtsinformationen basiert. Dies ist die höchste Genauigkeit. | |
|
Formatiert
|
routes.price.formatted | string |
Der angegebene Preis als formatierte Zeichenfolge. Dies befindet sich standardmäßig im Format der nativen Währung der Region, in der die Route stattfindet. |
|
Betrag
|
routes.price.amount | string |
Der Preis als Dezimalwert, codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Mindestbetrag
|
routes.price.amount_range_minimum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der Mindestpreis als Dezimalwert codiert als Zeichenfolge, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. |
|
Betragsbereich Maximalwert
|
routes.price.amount_range_maximum | string |
Wenn dieser Preis einen Bereich möglicher Werte darstellt, wird der maximale Preis als Dezimalwert codiert als Zeichenfolge codiert, um Gleitkommagenauigkeitsprobleme zu vermeiden. Es enthält keine Währungssymbole, und das Trennzeichen zwischen Haupt- und Hilfseinheiten lautet immer ".", unabhängig von der Region. Dies kann nicht eingeschlossen werden, wenn der Bereich geöffnet ist. |
|
Währung
|
routes.price.currency | string |
Die Währung, in der der Preis angegeben wird, in drei Buchstaben ISO 4217 Form. |
|
Bedarfsmultiplikator
|
routes.price.demand_multipler | float |
Gibt an, dass die Preise aufgrund der Nachfrage, in der Regel für Taxi -Beine (On-Demand) höher als üblich sind. Kann in seltenen Fällen kleiner als 1,0 sein |
|
CO₂e-Emissionen
|
routes.emissions_grams_co2e | float |
Eine Schätzung der Treibhausgasemissionen der Route, ausgedrückt in Gramm Kohlendioxidäquivalent (CO2e). |
|
Beine
|
routes.legs | array of object |
Array von Beinen, die die Route umfassen, in der Reihenfolge, in der sie durchlaufen werden sollen. Jede gültige Route hat mindestens eine. |
|
Reisemodus
|
routes.legs.travel_mode | string |
Der Reisemodus. |
|
Dauer
|
routes.legs.duration_seconds | integer |
Die zum Durchlaufen dieses Beins erforderliche Zeit, ausgenommen Wartezeiten oder Bordzeiten am Anfang. Kann in seltenen Fällen weggelassen werden, wenn die Dauer nicht berechnet werden kann. |
|
Pfad
|
routes.legs.path | string |
Der geografische Pfad, den das Bein durchläuft, als eine Reihe von WGS84-Koordinaten, die im Google Polyline-Format codiert sind, mit einer Dezimalgenauigkeit von 5 Ziffern. Beispielsweise codiert der Wert "_flyHbjPDZBTBNDJ" die folgende Reihe von Koordinaten (Breitengrad, Längengrad): "" [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Anweisungen
|
routes.legs.instructions | array of object |
Dies enthält die Liste der Turnanweisungen, um den Benutzer durch Beine zu führen, bei denen der Benutzer navigieren muss, z. B. beim Gehen oder Verwenden eines Rollers oder Fahrrads. |
|
Pfadindex
|
routes.legs.instructions.path_index | integer |
0-basierter Index in der Liste der Koordinaten, die von der Eigenschaft "Path" des Beins bereitgestellt werden. Dies gibt die Position an, an der die Anweisung befolgt werden soll, also die Position des Biegepfads oder das Start- oder Ende des Beins. |
|
Distanz
|
routes.legs.instructions.distance_meters | integer |
Die Entfernung in Metern des Abschnitts des "Pfads" vor dieser Anweisung. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Uhrzeit
|
routes.legs.instructions.time_seconds | integer |
Die Zeit in Sekunden, die der Benutzer erwartet, um den Abschnitt des "Pfads" vor dieser Anweisung zu durchlaufen. Diese Eigenschaft wird für anfängliche Anweisungen vom Typ "depart" weggelassen. |
|
Description
|
routes.legs.instructions.description_text | string |
Nur-Text-Beschreibung der Anweisung für den Benutzer. |
|
Beschreibungsformat
|
routes.legs.instructions.description_format | string |
Textformat zum Rendern der Anweisung mit hervorgehobenen Elementen, wobei "{key}" einen Teil der Zeichenfolge angibt, der durch den Eintrag ersetzt werden muss, der dem Schlüssel in "description_format_replacements" entspricht. Auf diese Weise können die von den Ersetzungen beschriebenen Elemente bei Bedarf vom Client anders formatiert werden. Schlüsselzeichenfolgen enthalten nur die Zeichen "[a-zA-Z0-9]". '{ }' wird nicht geschachtelt, und die Literalzeichen '{' und '}' werden durch die Escapesequenzen '{' bzw. '}' codiert. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ein Schlüssel, der einer in "{}description_format" eingeschlossenen Zeichenfolge entspricht. |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
Der Text, der verwendet werden soll, um die Teilzeichenfolge "{key}" in der description_format zu ersetzen. |
|
Typ
|
routes.legs.instructions.description_format_replacements.type | string |
Ein Wert, der angibt, welche Art von realen Dingen durch diesen Formatersatz identifiziert wird. Auf diese Weise können Dienstclients anwendungsspezifische Formatierungen bei Bedarf anwenden. | Wert | beschreibung | | ----- | ----------- | | street_name | Der Name einer Straße, Straße oder sonstigen Art | | exit_number | Die Anzahl einer Ausfahrt, im Allgemeinen von einem Kreisverkehr | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Ein IETF BCP 47-Sprachtag, das angibt, in welcher Sprache sich der zugehörige Text befindet. Beachten Sie, dass dies von der Sprache der umgebenden Beschreibung abweichen kann . Dies ist am häufigsten, wenn der Ersatz ein Ortsname in einer lokalen Sprache ist, während sich die Beschreibung in einer anderen Sprache befindet. |
|
Typ
|
routes.legs.instructions.type | string |
Gibt den Typ der Anweisung an. |
|
Typrichtung
|
routes.legs.instructions.type_direction | string |
Gibt eine Richtung an, die diese Anweisung ändert. |
|
Abfahrtszeit
|
routes.route_departure_time | string |
Die Zeit, zu der Citymapper glaubt, dass der Benutzer auf dieser Route unter Angabe der verfügbaren Abfahrtsinformationen festgelegt wird. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Ankunftszeit
|
routes.route_arrival_time | string |
Die Zeit, zu der Citymapper denkt, dass der Benutzer am Ende dieser Route ankommen wird, wenn verfügbare Abfahrtsinformationen und erwartete Reisegeschwindigkeit. Dies wird berechnet, vorausgesetzt, der Benutzer befindet sich am Anfang der Route. Aktualisierte Werte für "route_departure_time" und "route_arrival_time" werden von "service/1/live/routeupdates" zurückgegeben, um alle aktualisierten Abfluginformationen widerzuspiegeln. Die Uhrzeit wird im ISO 8601-Format ausgedrückt, einschließlich Datum, Uhrzeit und Zeitzone, in der das Ereignis eintritt. Beispiel: "2020-08-19T08:10:42-04:00" drückt den 19. August 2020 um 8:10 Uhr in Eastern Daylight Time aus. |
|
Gruppen
|
routes.route_metadata.groups | array of object | |
|
Gruppen-ID
|
routes.route_metadata.groups.group_id | string |
ID einer Gruppe, in der eine Route enthalten ist. |
|
Gruppe
|
routes.route_metadata.groups.group_name | string |
Lokalisierter Name einer Routengruppe, z. B. "Transit" oder "Le Metro". |
|
Routenposition
|
routes.route_metadata.groups.route_position | integer |
Eine nullbasierte Position einer Route innerhalb einer bestimmten Gruppe. |
|
Profilname
|
routes.route_metadata.profile_name | string |
Lesbarer lokalisierter Name des Profilbezeichners. |
|
Profile
|
routes.profile | string |
Gibt an, welches Routing 'profile' zum Berechnen dieser Route verwendet wurde. Beispielsweise kann eine Antwort von einem Fahrradroutingendpunkt mehrere Routen zurückgeben, eine mit einem "ruhigen" Profil und ein anderes mit einem "schnellen" Profil. Beachten Sie, dass jederzeit neue Werte hinzugefügt werden können, sodass jede Codeanalyse dieses Felds unerwartete Werte verarbeiten kann. Dieser Wert entspricht dem Anforderungsparameter "profiles" auf Endpunkten, die das Auswählen bestimmter Routingprofile unterstützen. Dieser Wert soll nur maschinenlesbar sein. Verwenden Sie für einen Profilnamen, der einem Benutzer angezeigt werden soll, stattdessen den "profile_name" im Objekt "route_metadata". |
|
Signature
|
routes.signature | string |
Ein Wert, der in nachfolgenden Aufrufen zurück an den Server übergeben werden soll, um auf diese Route zu verweisen (z. B. beim Anfordern von Live-Abfluginformationen über "service/1/live/routeupdates"). Es muss als undurchsichtiger Wert behandelt werden. |
|
Angeforderte Zeit
|
routes.requested_time | string |
Enthält den Parameter "time", der als Einschränkung der Abflug- oder Ankunftszeit beim Abrufen von Wegbeschreibungen verwendet wird, falls zutreffend. |
|
Angeforderter Zeittyp
|
routes.requested_time_type | string |
Enthält den Parameter "time_type", der verwendet wird, um zu bestimmen, wie die "time" verwendet wird, um gegebenenfalls die zurückgegebenen Wegbeschreibungen einzuschränken. Wenn in der Anforderung kein Parameter angegeben wurde, wird standardmäßig die "time_type" zurückgegeben, die zum Planen der Route verwendet wird. |
|
Language
|
language | string |
Ein IETF BCP 47-Sprachtag, das die Sprache angibt, die verwendet wird, um lokalisierbare Inhalte zu codieren, z. B. Anweisungen zum Drehen von Anweisungen in dieser Antwort. Dies spiegelt einen best-effort-Versuch wider, alle vom Anforderungsparameter "language" ausgedrückten Spracheinstellungen oder "en-US" als Standardeinstellung zu erfüllen. |