Citymapper (Onafhankelijke uitgever) (preview)
Met Citymapper kunt u trajectplanning en kant-en-klare navigatie toevoegen aan uw producten. Onze diensten worden mogelijk gemaakt door onze toonaangevende wereldwijde transportgegevens en aangepaste routeringsalgoritmen die zijn getraind op miljarden reizen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| E-mailen | ttaylor@hitachisolutions.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | Troy Taylor |
| Webpagina | https://citymapper.com/ |
| Privacybeleid | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Categorieën | Lifestyle en entertainment |
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| E-scooter routebeschrijving tussen twee punten ophalen |
Hiermee haalt u een scooterroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor kleine op accu's aangedreven scooters waarop de ruiter staat.) Bij deze aanroep wordt ervan uitgegaan dat de ruiter een scooter heeft op het beginpunt en een e-scooterroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één scooterpoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de scooter moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van scooteroperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen. Geslaagde antwoorden (HTTP-code '200') verbruiken één 'Scooter Route' tegoed (of één 'Scooter Reroute' tegoed als 'reroute_signature' wordt gebruikt) voor elk HTTP-antwoord. Mislukte aanroepen verbruiken geen tegoeden. |
| Een fietsroute tussen twee punten ophalen |
Hiermee haalt u een fietsroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Bij deze aanroep wordt ervan uitgegaan dat de ruiter een fiets heeft op het beginpunt en een fietsroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één fietspoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de fiets moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van de fietsoperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen. De maximale grote cirkelafstand tussen het begin en einde is beperkt tot 200 km voor deze service. |
| Een huurfietsroute tussen twee punten ophalen |
Hiermee krijgt u een gehuurde fietsroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik elke fiets van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een fiets van het opgegeven merk kiest. Een fiets gebruiken op een opgegeven locatie Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de fiets zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker. |
| Een ingehuurde motorscooterroute tussen twee punten ophalen |
Hiermee haalt u een gehuurde motorscooterroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor grotere interne verbrandings- of elektrische scooters waar de ruiter zit.) NOTITIE: Bij de resulterende route wordt ervan uitgegaan dat de gebruiker rechtstreeks naar de opgegeven 'eindlocatie' kan rijden, waarbij geen rekening wordt gehouden met parkeer- of dekkingszones. De resulterende route bevat dus slechts een eerste been van 'travel_mode' 'walk' en een tweede been van 'travel_mode' 'self_piloted'. Een toekomstige update omvat parkeer- en dekkingszones en voegt een laatste 'walk' been toe. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik een scooter van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een scooter van het opgegeven merk kiest. Een scooter op een opgegeven locatie gebruiken Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de scooter zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker. |
| Een motorscooterroute tussen twee punten ophalen |
Hiermee haalt u een motorscooterroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor grotere interne verbrandings- of elektrische scooters waar de ruiter zit.) Bij deze aanroep wordt ervan uitgegaan dat de ruiter een scooter heeft op het beginpunt en een e-scooterroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één scooterpoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de scooter moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van scooteroperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen. |
| Een rijroute tussen twee punten ophalen |
Hiermee haalt u een autoroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Bij deze aanroep wordt ervan uitgegaan dat de ruiter een auto heeft op het beginpunt en een autoroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één autobeen bevatten. De maximale cirkelafstand tussen het begin en einde is beperkt tot 1000 km voor deze service. |
| Een route tussen twee punten voor een scenario ophalen |
Berekent routes tussen twee punten op basis van een opgegeven scenario. Een of meer groepen routes kunnen worden opgegeven, afhankelijk van een scenario. Elke groep bevat verschillende routes. Elke route bevat een of meer benen. |
| Een taxiroute tussen twee punten ophalen |
Hiermee haalt u een taxiroute tussen twee punten op. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. De route kan beginnende en eindigende looppoten bevatten als de ophaal- of afgiftepunten niet dicht bij de aangevraagde begin- en eindcoördinaten liggen. De Services in het antwoord variëren afhankelijk van de lokale beschikbaarheid, het tijdstip van de dag en daarnaast welke taxiservice-integraties zijn geconfigureerd voor uw account. Er zijn twee aanbevolen manieren om deze service te gebruiken: u kunt een taxiroute aanvragen met live on-demand serviceramingen die vooraf zijn opgenomen door te bellen met '?fetch_on_demand_services=true'; of u kunt de eerste aanvraag indienen zonder schattingen op te halen die reageren met de niet-liveroute en vervolgens onmiddellijk '1/live/routeupdates' aanroepen om de aanvullende live schattingen te krijgen. De eerste benadering is eenvoudiger, maar de tweede kan beter passen bij uw use-case. |
| Een transitroute tussen twee punten ophalen |
Berekent verschillende openbaar vervoerroutes tussen twee punten. De resultaten bevatten standaard maximaal 5 routes. Elk zal meerdere benen bevatten: meestal een aan het begin en einde van de route met 'travel_mode' van 'wandeling', met ten minste één met 'travel_mode' van 'transit' ertussen. |
| Een wandelroute tussen twee punten ophalen |
Hiermee haalt u een looproute tussen twee punten op, zodat er voldoende informatie beschikbaar is om deze op een kaart weer te geven, samen met een schatting van de duur. Er wordt verwacht dat looproutes één been hebben met een 'travel_mode' van 'lopen'. Als Citymapper geen routebeschrijvingen voor deze punten kan berekenen (meestal om dekkingsredenen), retourneert de service een code '400'-antwoord. De maximale afstand tussen de 'start' en 'end' is beperkt tot 100 km voor deze service. |
| Huur een e-scooter routebeschrijving tussen twee punten |
Hiermee haalt u een ingehuurde e-scooterroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Deze resultaten zijn geoptimaliseerd voor kleine op accu's aangedreven scooters waarop de rijder staat. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik een scooter van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een scooter van het opgegeven merk kiest. Een scooter op een opgegeven locatie gebruiken Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de scooter zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker. |
| Live vertrek- en beschikbaarheidsgegevens voor meerdere routes ophalen |
Hiermee worden actuele en live vertrekgegevens en live aanhalingstekens op aanvraag opgehaald voor meerdere routes die eerder zijn verkregen via de eindpunten voor routebeschrijvingen. Alleen routes met ten minste één been met een been updatable Detail kunnen worden bijgewerkt met behulp van deze service. Houd er rekening mee dat het niet altijd mogelijk is voor Citymapper om actuele tijden of live vertrek- en onderbrekingsinformatie voor een been te verstrekken. Geslaagde antwoorden (HTTP-code '200') verbruiken één 'Live Update'-tegoed voor elk HTTP-antwoord. Mislukte aanroepen verbruiken geen tegoeden. |
| Reistijden tussen twee locaties ophalen |
Bepaalt de reistijd in verschillende manieren van reizen tussen de opgegeven twee punten op het moment dat de aanvraag wordt ingediend. |
E-scooter routebeschrijving tussen twee punten ophalen
Hiermee haalt u een scooterroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor kleine op accu's aangedreven scooters waarop de ruiter staat.) Bij deze aanroep wordt ervan uitgegaan dat de ruiter een scooter heeft op het beginpunt en een e-scooterroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één scooterpoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de scooter moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van scooteroperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen. Geslaagde antwoorden (HTTP-code '200') verbruiken één 'Scooter Route' tegoed (of één 'Scooter Reroute' tegoed als 'reroute_signature' wordt gebruikt) voor elk HTTP-antwoord. Mislukte aanroepen verbruiken geen tegoeden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
|
|
Eerdere locaties
|
past_loc_coords | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De coördinaten van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Coördinaten moeten de WGS84-indeling breedtegraad, lengtegraad hebben. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Leeftijden van eerdere locaties
|
past_loc_ages | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De leeftijden van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Leeftijden moeten in seconden voor gehele getallen zijn sinds de huidige locatie. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_coords' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Nauwkeurigheid van eerdere locaties
|
past_loc_accuracies | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De GPS-nauwkeurigheid van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Nauwkeurigheid moet in gehele getallen meters staan. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_coords' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een fietsroute tussen twee punten ophalen
Hiermee haalt u een fietsroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Bij deze aanroep wordt ervan uitgegaan dat de ruiter een fiets heeft op het beginpunt en een fietsroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één fietspoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de fiets moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van de fietsoperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen. De maximale grote cirkelafstand tussen het begin en einde is beperkt tot 200 km voor deze service.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Profiles
|
profiles | string |
Geeft aan welke 'profielen' u moet gebruiken bij het berekenen van fietsbeschrijvingen. Elk profiel kan een andere routeoptie genereren, zodat het aanvragen van meer profielen over het algemeen meer opties biedt. Houd er rekening mee dat sommige van de resulterende routes soms identiek zijn (in het geval van een route die op meer dan één manier optimaal is) en dat een profiel mogelijk niet altijd een route oplevert. | waarde | beschrijving | | ----- | ----------- | | stil | Pogingen om wegen met minder verkeer te gebruiken | | normaal | Het standaardprofiel zorgt voor balans tussen verkeer met directheid | | snel | Pogingen om de kortste verstandige route te vinden | Als er geen profielen zijn opgegeven, wordt 'normaal' gebruikt. |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
|
|
Eerdere locaties
|
past_loc_coords | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De coördinaten van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Coördinaten moeten de WGS84-indeling breedtegraad, lengtegraad hebben. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Leeftijden van eerdere locaties
|
past_loc_ages | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De leeftijden van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Leeftijden moeten in seconden voor gehele getallen zijn sinds de huidige locatie. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_coords' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Nauwkeurigheid van eerdere locaties
|
past_loc_accuracies | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De GPS-nauwkeurigheid van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Nauwkeurigheid moet in gehele getallen meters staan. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_coords' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een huurfietsroute tussen twee punten ophalen
Hiermee krijgt u een gehuurde fietsroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik elke fiets van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een fiets van het opgegeven merk kiest. Een fiets gebruiken op een opgegeven locatie Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de fiets zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Merk-id
|
brand_id | True | string |
De id van het merk fiets dat voor deze route moet worden gebruikt. Dit is noodzakelijk om de locatie van beschikbare fietsen te bepalen, samen met eventuele bijbehorende dekkings- en parkeerbeperkingen. |
|
Staat
|
ride_state | string |
Geeft aan waar de gebruiker zich bevindt op de route. Als u dit weglaat, wordt 'walking_to_vehicle' gebruikt. Met deze eigenschap samen met 'current_location' kan een bijgewerkte route worden opgehaald die overeenkomt met de huidige voortgang van de gebruiker. | waarde | beschrijving | | ----- | ----------- | | walking_to_vehicle | Geeft aan dat de gebruiker loopt om het voertuig te verzamelen | rijden | Geeft aan dat de gebruiker het voertuig rijdt | | walking_to_end | Geeft aan dat de gebruiker het voertuig heeft verlaten en naar zijn bestemming loopt | |
|
|
Huidige locatie
|
current_location | string |
De huidige locatie van de gebruiker om de route bij te werken op basis van de locatie van de gebruiker. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Deze parameter wordt gebruikt om een bijgewerkte route op te halen die de werkelijke locatie van de gebruiker weergeeft als deze afwijken van het pad dat is opgegeven in de route. Als dit wordt opgegeven, bevat de geretourneerde route deze locatie. Welk deel van de route deze locatie bevat, wordt bepaald door de waarde van de parameter 'ride_state'. |
|
|
Beginlocatie
|
ride_start_location | string |
De locatie van het voertuig dat moet worden gebruikt, aan het begin van het voertuigritgedeelte van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'rijden' of 'walking_to_end' is. Indien niet opgegeven wanneer 'ride_state' 'walking_to_vehicle' is (of niet opgegeven), probeert Citymapper het meest geschikte voertuig te vinden dat deel uitmaakt van de opgegeven 'brand_id'. Voor compatibiliteit is 'original_vehicle_location' een alias voor deze parameter |
|
|
Eindlocatie
|
ride_end_location | string |
De locatie waar het voertuig werd afgezet aan het einde van de rit van het voertuig deel van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'walking_to_end' is. In alle andere staten wordt deze parameter genegeerd. |
|
|
Profiles
|
profiles | string |
Geeft aan welke 'profielen' u moet gebruiken bij het berekenen van fietsbeschrijvingen. Elk profiel kan een andere routeoptie genereren, zodat het aanvragen van meer profielen over het algemeen meer opties biedt. Houd er rekening mee dat sommige van de resulterende routes soms identiek zijn (in het geval van een route die op meer dan één manier optimaal is) en dat een profiel mogelijk niet altijd een route oplevert. | waarde | beschrijving | | ----- | ----------- | | stil | Pogingen om wegen met minder verkeer te gebruiken | | normaal | Het standaardprofiel zorgt voor balans tussen verkeer met directheid | | snel | Pogingen om de kortste verstandige route te vinden | Als er geen profielen zijn opgegeven, wordt 'normaal' gebruikt. |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
|
|
Eerdere locaties
|
past_loc_coords | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De coördinaten van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Coördinaten moeten de WGS84-indeling breedtegraad, lengtegraad hebben. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Leeftijden van eerdere locaties
|
past_loc_ages | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De leeftijden van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Leeftijden moeten in seconden voor gehele getallen zijn sinds de huidige locatie. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_coords' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Nauwkeurigheid van eerdere locaties
|
past_loc_accuracies | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De GPS-nauwkeurigheid van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Nauwkeurigheid moet in gehele getallen meters staan. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_coords' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een ingehuurde motorscooterroute tussen twee punten ophalen
Hiermee haalt u een gehuurde motorscooterroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor grotere interne verbrandings- of elektrische scooters waar de ruiter zit.) NOTITIE: Bij de resulterende route wordt ervan uitgegaan dat de gebruiker rechtstreeks naar de opgegeven 'eindlocatie' kan rijden, waarbij geen rekening wordt gehouden met parkeer- of dekkingszones. De resulterende route bevat dus slechts een eerste been van 'travel_mode' 'walk' en een tweede been van 'travel_mode' 'self_piloted'. Een toekomstige update omvat parkeer- en dekkingszones en voegt een laatste 'walk' been toe. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik een scooter van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een scooter van het opgegeven merk kiest. Een scooter op een opgegeven locatie gebruiken Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de scooter zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Merk-id
|
brand_id | True | string |
De id van het merk scooters dat voor deze route moet worden gebruikt. Dit is noodzakelijk om de locatie van beschikbare scooters te bepalen, samen met eventuele bijbehorende dekking en parkeerbeperkingen. |
|
Staat
|
ride_state | string |
Geeft aan waar de gebruiker zich bevindt op de route. Als u dit weglaat, wordt 'walking_to_vehicle' gebruikt. Met deze eigenschap samen met 'current_location' kan een bijgewerkte route worden opgehaald die overeenkomt met de huidige voortgang van de gebruiker. | waarde | beschrijving | | ----- | ----------- | | walking_to_vehicle | Geeft aan dat de gebruiker loopt om het voertuig te verzamelen | rijden | Geeft aan dat de gebruiker het voertuig rijdt | | walking_to_end | Geeft aan dat de gebruiker het voertuig heeft verlaten en naar zijn bestemming loopt | |
|
|
Huidige locatie
|
current_location | string |
De huidige locatie van de gebruiker om de route bij te werken op basis van de locatie van de gebruiker. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Deze parameter wordt gebruikt om een bijgewerkte route op te halen die de werkelijke locatie van de gebruiker weergeeft als deze afwijken van het pad dat is opgegeven in de route. Als dit wordt opgegeven, bevat de geretourneerde route deze locatie. Welk deel van de route deze locatie bevat, wordt bepaald door de waarde van de parameter 'ride_state'. |
|
|
Beginlocatie
|
ride_start_location | string |
De locatie van het voertuig dat moet worden gebruikt, aan het begin van het voertuigritgedeelte van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'rijden' of 'walking_to_end' is. Indien niet opgegeven wanneer 'ride_state' 'walking_to_vehicle' is (of niet opgegeven), probeert Citymapper het meest geschikte voertuig te vinden dat deel uitmaakt van de opgegeven 'brand_id'. Voor compatibiliteit is 'original_vehicle_location' een alias voor deze parameter |
|
|
Eindlocatie
|
ride_end_location | string |
De locatie waar het voertuig werd afgezet aan het einde van de rit van het voertuig deel van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'walking_to_end' is. In alle andere staten wordt deze parameter genegeerd. |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een motorscooterroute tussen twee punten ophalen
Hiermee haalt u een motorscooterroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. (Deze resultaten zijn geoptimaliseerd voor grotere interne verbrandings- of elektrische scooters waar de ruiter zit.) Bij deze aanroep wordt ervan uitgegaan dat de ruiter een scooter heeft op het beginpunt en een e-scooterroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één scooterpoot bevatten, hoewel de eigenschap 'path_annotations' van het been kan wijzen op secties waarin de gebruiker naast de scooter moet lopen. Deze oproep bevat geen informatie over de dekking of parkeerplaatsen van scooteroperators, maar andere serviceoproepen zijn mogelijk beschikbaar om dit te doen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een rijroute tussen twee punten ophalen
Hiermee haalt u een autoroute tussen twee punten op, met voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Bij deze aanroep wordt ervan uitgegaan dat de ruiter een auto heeft op het beginpunt en een autoroute vanaf daar naar het 'eindpunt' biedt als beide zich in de ondersteunde gebieden van Citymapper bevinden. De resulterende route moet één autobeen bevatten. De maximale cirkelafstand tussen het begin en einde is beperkt tot 1000 km voor deze service.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een route tussen twee punten voor een scenario ophalen
Berekent routes tussen twee punten op basis van een opgegeven scenario. Een of meer groepen routes kunnen worden opgegeven, afhankelijk van een scenario. Elke groep bevat verschillende routes. Elke route bevat een of meer benen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Scenario-id
|
scenario_id | True | string |
Scenario-id voor routebeschrijvingen. |
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Time
|
time | string |
De tijd die moet worden gebruikt als een beperking voor vertrek of aankomsttijd bij het verkrijgen van een routebeschrijving. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
|
Tijdtype
|
time_type | string |
Wanneer een 'tijd'-waarde wordt opgegeven, bepaalt dit hoe de tijd wordt gebruikt om de geretourneerde aanwijzingen te beperken. Wanneer dit niet is opgegeven, wordt 'depart_approximate' gebruikt. Als er geen 'tijd' wordt gegeven, heeft dit geen effect. | waarde | beschrijving | | ----- | ----------- | | arrive | Routebeschrijvingen worden gekozen om de gebruiker op of vóór 'tijd' naar hun bestemming te krijgen | | vertrekken | Aanwijzingen worden gekozen, ervan uitgaande dat de gebruiker de oorsprong zo snel mogelijk na 'tijd' verlaat | | depart_approximate | Vergelijkbaar met 'vertrekken', maar het toestaan van latere vertrektijden om meer voorkeursopties te retourneren, zelfs als ze een beetje later vertrekken. Dit is de standaardoptie van Citymapper om een routebeschrijving te kiezen wanneer de tijd niet is opgegeven | |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een taxiroute tussen twee punten ophalen
Hiermee haalt u een taxiroute tussen twee punten op. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. De route kan beginnende en eindigende looppoten bevatten als de ophaal- of afgiftepunten niet dicht bij de aangevraagde begin- en eindcoördinaten liggen. De Services in het antwoord variëren afhankelijk van de lokale beschikbaarheid, het tijdstip van de dag en daarnaast welke taxiservice-integraties zijn geconfigureerd voor uw account. Er zijn twee aanbevolen manieren om deze service te gebruiken: u kunt een taxiroute aanvragen met live on-demand serviceramingen die vooraf zijn opgenomen door te bellen met '?fetch_on_demand_services=true'; of u kunt de eerste aanvraag indienen zonder schattingen op te halen die reageren met de niet-liveroute en vervolgens onmiddellijk '1/live/routeupdates' aanroepen om de aanvullende live schattingen te krijgen. De eerste benadering is eenvoudiger, maar de tweede kan beter passen bij uw use-case.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
On-Domain Services ophalen
|
fetch_on_demand_services | string |
Als deze optie is ingesteld op 'true', wordt aanvullende informatie aangevraagd bij uw Taxi-service-integraties om nauwkeurigere en volledige prijzen, duur en beschikbaarheid van services te bieden, geretourneerd in de details die op aanvraag kunnen worden bijgewerkt. Om dit te kunnen bieden, moeten de begin- en eindlocaties van de route worden verzonden naar deze services van derden, inclusief in het geval dat de ene of de andere de huidige of recente locatie van de gebruiker is. Houd er rekening mee dat u mogelijk expliciete geïnformeerde toestemming van uw eindgebruiker moet hebben om dit in te stellen op waar, afhankelijk van toepasselijke wetten en voorschriften. Als deze optie is ingesteld op 'false' of wordt weggelaten, worden er geen aanvragen gedaan bij services van derden. |
|
|
Merk-id's
|
brand_ids | array |
Door komma's gescheiden lijst met merk-id's om deze routebeschrijving te beperken tot. Als u dit weglaat (standaard), worden alle merken die voor u beschikbaar zijn een taxiroute geretourneerd. |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een transitroute tussen twee punten ophalen
Berekent verschillende openbaar vervoerroutes tussen twee punten. De resultaten bevatten standaard maximaal 5 routes. Elk zal meerdere benen bevatten: meestal een aan het begin en einde van de route met 'travel_mode' van 'wandeling', met ten minste één met 'travel_mode' van 'transit' ertussen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Time
|
time | string |
De tijd die moet worden gebruikt als een beperking voor vertrek of aankomsttijd bij het verkrijgen van een routebeschrijving. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
|
Tijdtype
|
time_type | string |
Wanneer een 'tijd'-waarde wordt opgegeven, bepaalt dit hoe de tijd wordt gebruikt om de geretourneerde aanwijzingen te beperken. Wanneer dit niet is opgegeven, wordt 'depart_approximate' gebruikt. Als er geen 'tijd' wordt gegeven, heeft dit geen effect. | waarde | beschrijving | | ----- | ----------- | | arrive | Routebeschrijvingen worden gekozen om de gebruiker op of vóór 'tijd' naar hun bestemming te krijgen | | vertrekken | Aanwijzingen worden gekozen, ervan uitgaande dat de gebruiker de oorsprong zo snel mogelijk na 'tijd' verlaat | | depart_approximate | Vergelijkbaar met 'vertrekken', maar het toestaan van latere vertrektijden om meer voorkeursopties te retourneren, zelfs als ze een beetje later vertrekken. Dit is de standaardoptie van Citymapper om een routebeschrijving te kiezen wanneer de tijd niet is opgegeven | |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Limit
|
limit | integer |
Maximum aantal routes dat moet worden geretourneerd. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Een wandelroute tussen twee punten ophalen
Hiermee haalt u een looproute tussen twee punten op, zodat er voldoende informatie beschikbaar is om deze op een kaart weer te geven, samen met een schatting van de duur. Er wordt verwacht dat looproutes één been hebben met een 'travel_mode' van 'lopen'. Als Citymapper geen routebeschrijvingen voor deze punten kan berekenen (meestal om dekkingsredenen), retourneert de service een code '400'-antwoord. De maximale afstand tussen de 'start' en 'end' is beperkt tot 100 km voor deze service.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Profiles
|
profiles | string |
Hiermee wordt aangegeven welke 'profielen' moeten worden gebruikt bij het berekenen van de routebeschrijving. Elk profiel kan een andere routeoptie genereren, zodat het aanvragen van meer profielen over het algemeen meer opties biedt. Houd er rekening mee dat sommige van de resulterende routes soms identiek zijn (in het geval van een route die op meer dan één manier optimaal is) en dat een profiel mogelijk niet altijd een route oplevert. Niet alle profielen zijn beschikbaar voor alle begin- en eindroutes. Niet-beschikbare profielen worden weggelaten uit het antwoord. | waarde | beschrijving | | ----- | ----------- | | snel | Het standaardprofiel, probeert de snelste verstandige route te vinden | | main_roads | Pogingen om backstreets en parken te voorkomen | Als er geen profielen zijn opgegeven, wordt 'snel' gebruikt. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Huur een e-scooter routebeschrijving tussen twee punten
Hiermee haalt u een ingehuurde e-scooterroute tussen twee punten, inclusief eventuele eerste en laatste wandelingen. De resulterende route biedt voldoende informatie om deze op een kaart weer te geven, samen met een schatting van de duur. Deze resultaten zijn geoptimaliseerd voor kleine op accu's aangedreven scooters waarop de rijder staat. Deze aanroep kan op verschillende manieren worden gebruikt: Gebruik een scooter van het opgegeven merk . Dit is de eenvoudigste aanroep, waarbij alleen 'start', 'end' en 'brand_id' nodig zijn. Citymapper gaat ervan uit dat de gebruiker zich op het beginpunt bevindt en indien mogelijk een scooter van het opgegeven merk kiest. Een scooter op een opgegeven locatie gebruiken Door 'original_vehicle_location' toe te voegen aan 'start', 'end' en 'brand_id', plant Citymapper een route die ervan uitgaat dat de scooter zich op de opgegeven locatie bevindt. Een route bijwerken die wordt uitgevoerd Als u een bijgewerkte route wilt ophalen die rerouting van de huidige locatie van de gebruiker omvat als deze is afgeleid van de geplande route, kan de beller de eigenschappen 'current_location' en 'ride_state' toevoegen, waarmee wordt aangegeven welk deel van de resulterende route moet worden omgeleid rond de 'current_location' van de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
Het geografische begin van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Einde
|
end | True | array |
Het geografische einde van de route, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 decimalen worden gebruikt. |
|
Merk-id
|
brand_id | True | string |
De id van het merk van e-scooters die voor deze route moeten worden gebruikt. Dit is noodzakelijk om de locatie van beschikbare scooters te bepalen, samen met eventuele bijbehorende dekking en parkeerbeperkingen. |
|
Staat
|
ride_state | string |
Geeft aan waar de gebruiker zich bevindt op de route. Als u dit weglaat, wordt 'walking_to_vehicle' gebruikt. Met deze eigenschap samen met 'current_location' kan een bijgewerkte route worden opgehaald die overeenkomt met de huidige voortgang van de gebruiker. | waarde | beschrijving | | ----- | ----------- | | walking_to_vehicle | Geeft aan dat de gebruiker loopt om het voertuig te verzamelen | rijden | Geeft aan dat de gebruiker het voertuig rijdt | | walking_to_end | Geeft aan dat de gebruiker het voertuig heeft verlaten en naar zijn bestemming loopt | |
|
|
Huidige locatie
|
current_location | string |
De huidige locatie van de gebruiker om de route bij te werken op basis van de locatie van de gebruiker. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Deze parameter wordt gebruikt om een bijgewerkte route op te halen die de werkelijke locatie van de gebruiker weergeeft als deze afwijken van het pad dat is opgegeven in de route. Als dit wordt opgegeven, bevat de geretourneerde route deze locatie. Welk deel van de route deze locatie bevat, wordt bepaald door de waarde van de parameter 'ride_state'. |
|
|
Beginlocatie
|
ride_start_location | string |
De locatie van het voertuig dat moet worden gebruikt, aan het begin van het voertuigritgedeelte van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'rijden' of 'walking_to_end' is. Indien niet opgegeven wanneer 'ride_state' 'walking_to_vehicle' is (of niet opgegeven), probeert Citymapper het meest geschikte voertuig te vinden dat deel uitmaakt van de opgegeven 'brand_id'. Voor compatibiliteit is 'original_vehicle_location' een alias voor deze parameter |
|
|
Eindlocatie
|
ride_end_location | string |
De locatie waar het voertuig werd afgezet aan het einde van de rit van het voertuig deel van de reis van de gebruiker langs de Route. Opgegeven in WGS84 'breedtegraad,lengtegraad'-indeling. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Dit moet worden opgegeven wanneer 'ride_state' 'walking_to_end' is. In alle andere staten wordt deze parameter genegeerd. |
|
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taalvoorkeur van de eindgebruiker aangeeft. Wanneer dit is opgegeven, bevat het antwoord een taaleigenschap die de taal aangeeft die wordt gebruikt voor lokaliseerbare elementen van het antwoord (zoals het draaien van instructies). Deze taal zal een best-effort poging zijn om te voldoen aan de uitgedrukte voorkeur, maar het kan een waarde bevatten die niet in de aanvraag is uitgedrukt (dit wordt meestal 'en-US' als een terugval). Houd er rekening mee dat taalvoorkeur doorgaans alleen van invloed is op door Citymapper gegenereerde inhoud, zoals het draaien van instructies. Externe inhoud, zoals stopnamen en statusbeschrijvingen, wordt doorgaans doorgegeven in de oorspronkelijke taal. |
|
|
Handtekening omleiden
|
reroute_signature | string |
Bij het opnieuw omleiden (aanvragen van een update naar een eerder antwoord dat accounts maakt voor de bijgewerkte locatie van de gebruiker), moet deze waarde worden ingesteld op de 'handtekening' die is opgegeven in de oorspronkelijke route. Dit maakt een efficiëntere bepaling van de bijgewerkte route mogelijk. Deze waarde moet url-gecodeerd zijn. Wanneer u deze parameter opgeeft, moet de locatie 'current_location' (indien van toepassing) of 'start' worden ingesteld op de meest recente locatie van de gebruiker. Wanneer deze parameter is opgenomen, retourneert Citymapper mogelijk geen resultaten in gevallen waarin de aanvraag aanzienlijk verschilt van het origineel, bijvoorbeeld als de locatie 'eind' anders is of als er meer dan 1 uur is verstreken sinds de oorspronkelijke aanvraag. |
|
|
Begin met lager
|
start_bearing | integer |
Een hoek met de klok mee van noord tussen 0 en 359, waar Noord 0 en Oost is 90. Dit lager wordt gebruikt om de initiële instructietekst en/of routering te beïnvloeden, meestal om te voorkomen dat de gebruiker wordt gevraagd om een u-turn te maken, als het huidige lager een vergelijkbare route geeft. Dit moet alleen worden verstrekt als u de initiële richting van de reis voor de route wilt beïnvloeden. |
|
|
Eerdere locaties
|
past_loc_coords | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De coördinaten van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Coördinaten moeten de WGS84-indeling breedtegraad, lengtegraad hebben. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Leeftijden van eerdere locaties
|
past_loc_ages | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De leeftijden van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Leeftijden moeten in seconden voor gehele getallen zijn sinds de huidige locatie. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_coords' en 'past_loc_accuracies' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
|
|
Nauwkeurigheid van eerdere locaties
|
past_loc_accuracies | string |
Optionele parameter om het herroutingsgedrag te verbeteren. De GPS-nauwkeurigheid van maximaal 10 van de eerdere locaties van de gebruiker als een door komma's gescheiden lijst. Nauwkeurigheid moet in gehele getallen meters staan. Moet chronologisch geordend zijn, meest recente laatste. 'past_loc_ages' en 'past_loc_coords' moeten naast elkaar worden verstrekt. De server beschouwt maximaal 10 locaties als er meer dan 10 locaties worden opgegeven, worden de minst recente locaties genegeerd. De server negeert waarschijnlijk alle locaties die ouder zijn dan 30 seconden of locaties die minder dan 1 seconde uit elkaar liggen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Breedtegraad
|
routes.start.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.start.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Breedtegraad
|
routes.end.coordinates.lat | float |
Een breedtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Lengtegraad
|
routes.end.coordinates.lon | float |
Een lengtegraad in WGS84-codering, met 6 cijfers decimale precisie. |
|
Afstand in meters
|
routes.distance_meters | integer |
De totale afstand van de hele route, in meters. |
|
Duur
|
routes.duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden, op basis van het geselecteerde voertuig of vertrek in het antwoord. |
|
Nauwkeurigheid van duur
|
routes.duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Geformatteerd
|
routes.price.formatted | string |
De opgegeven prijs als opgemaakte tekenreeks. Standaard heeft dit de systeemeigen valutanotatie van de regio waar de route plaatsvindt. |
|
Aantal
|
routes.price.amount | string |
De prijs als een decimale waarde, gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Minimumhoeveelheidsbereik
|
routes.price.amount_range_minimum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de minimumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. |
|
Maximum hoeveelheidsbereik
|
routes.price.amount_range_maximum | string |
Als deze prijs een bereik van mogelijke waarden vertegenwoordigt, wordt de maximumprijs als een decimale waarde gecodeerd als een tekenreeks om nauwkeurigheidsproblemen met drijvende komma te voorkomen. Het bevat geen valutasymbolen en het scheidingsteken tussen primaire en secundaire eenheden is altijd '.', ongeacht de regio. Dit kan niet worden opgenomen als het bereik open is |
|
Valuta
|
routes.price.currency | string |
De valuta waarin de prijs wordt gegeven, in drie letters ISO 4217 vorm. |
|
Vraagvermenigvuldiging
|
routes.price.demand_multipler | float |
Geeft aan dat de prijzen hoger zijn dan normaal vanwege de vraag, meestal voor Taxi(On-Demand) benen. Kan in zeldzame gevallen kleiner zijn dan 1,0 |
|
CO2e-uitstoot
|
routes.emissions_grams_co2e | float |
Een schatting van de uitstoot van broeikasgassen van de route, uitgedrukt in gram kooldioxide-equivalent (CO2e). |
|
Benen
|
routes.legs | array of object |
Matrix van benen die bestaan uit de Route, in de volgorde waarin ze moeten worden doorkruist. Elke geldige route heeft ten minste één route. |
|
Reismodus
|
routes.legs.travel_mode | string |
De reismodus. |
|
Duur
|
routes.legs.duration_seconds | integer |
De tijd die nodig is om dit been te doorlopen, met uitzondering van eventuele wachttijden of instaptijden aan het begin. Kan in zeldzame omstandigheden worden weggelaten wanneer de duur niet kan worden berekend. |
|
Path
|
routes.legs.path | string |
Het geografische pad dat het been doorkruist, als een reeks WGS84-coördinaten die zijn gecodeerd in Google Polyline Format, met een decimale precisie van 5 cijfers. Met de waarde '_flyHbjPDZBTBNDJ' worden bijvoorbeeld de volgende reeks coördinaten (breedtegraad, lengtegraad) gecodeerd: '' [(51,51344; -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Aanwijzingen
|
routes.legs.instructions | array of object |
Dit biedt de lijst met draaiinstructies om de gebruiker door benen te leiden waar de gebruiker moet navigeren, zoals bij het lopen of gebruiken van een scooter of fiets. |
|
Padindex
|
routes.legs.instructions.path_index | integer |
Index op basis van 0 in de lijst met coördinaten die worden geleverd door de eigenschap 'path' van het been. Dit geeft de locatie aan waarop de instructie moet worden gevolgd, dus het is de locatie van het inschakelen van het pad, of het begin of einde van het been. |
|
Afstand
|
routes.legs.instructions.distance_meters | integer |
De afstand in meters van het gedeelte van het pad voorafgaand aan deze instructie. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Time
|
routes.legs.instructions.time_seconds | integer |
De tijd in seconden die de gebruiker naar verwachting moet nemen om de sectie van het pad vóór deze instructie te doorlopen. Deze eigenschap wordt weggelaten voor de eerste instructies van het type 'vertrek'. |
|
Description
|
routes.legs.instructions.description_text | string |
Beschrijving van de instructie voor de gebruiker zonder opmaak. |
|
Beschrijvingsindeling
|
routes.legs.instructions.description_format | string |
Tekstindeling voor het weergeven van de instructie met benadrukte elementen, waarbij {key} een deel aangeeft van de tekenreeks die moet worden vervangen door inhoud die is gedefinieerd door de vermelding die overeenkomt met 'sleutel' in 'description_format_replacements'. Hierdoor kunnen de elementen die door de vervangingen worden beschreven, desgewenst anders worden opgemaakt door de client. Sleutelreeksen bevatten alleen de tekens '[a-zA-Z0-9]'. {} wordt niet genest en de letterlijke tekens {en }worden gecodeerd door de escapereeksen {en }. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Een sleutel die overeenkomt met een tekenreeks die is ingesloten in '{}' in 'description_format'. |
|
Tekst
|
routes.legs.instructions.description_format_replacements.text | string |
De tekst die moet worden gebruikt om de subtekenreeks {key} in de description_format te vervangen. |
|
Typologie
|
routes.legs.instructions.description_format_replacements.type | string |
Een waarde die aangeeft welk soort echte dingen worden geïdentificeerd door deze indelingsvervanging. Hiermee kunnen serviceclients toepassingsspecifieke opmaak toepassen, indien gewenst. | waarde | beschrijving | | ----- | ----------- | | street_name | De naam van een straat, weg of op een andere manier | exit_number | Het aantal uitgangen, over het algemeen vanaf een rotonde | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Een IETF BCP 47-taaltag die aangeeft in welke taal de bijbehorende 'tekst' zich bevindt. Houd er rekening mee dat dit anders kan zijn dan de taal van de omringende beschrijving. Dit komt het meest voor wanneer de vervanging een plaatsnaam is in een lokale taal terwijl de beschrijving zich in een andere taal bevindt. |
|
Typologie
|
routes.legs.instructions.type | string |
Geeft het type instructie aan. |
|
Typerichting
|
routes.legs.instructions.type_direction | string |
Geeft een richting aan die deze instructie wijzigt. |
|
Vertrektijd
|
routes.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
routes.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend als de gebruiker zich aan het begin van de route bevindt. Bijgewerkte waarden voor 'route_departure_time' en 'route_arrival_time' worden geretourneerd door 'service/1/live/routeupdates' om alle bijgewerkte vertrekgegevens weer te geven. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Groeps-id
|
routes.route_metadata.groups.group_id | string |
Id van een groep waarin een route zich bevindt. |
|
Groep
|
routes.route_metadata.groups.group_name | string |
Gelokaliseerde naam van een routegroep, bijvoorbeeld 'Transit' of 'Le metro'. |
|
Routepositie
|
routes.route_metadata.groups.route_position | integer |
Een op nul gebaseerde positie van een route binnen een specifieke groep. |
|
Profielnaam
|
routes.route_metadata.profile_name | string |
Door mensen leesbare gelokaliseerde naam van de profiel-id. |
|
Profile
|
routes.profile | string |
Geeft aan welk routeringsprofiel is gebruikt om deze route te berekenen. Een antwoord van een eindpunt voor fietsroutering kan bijvoorbeeld meerdere routes retourneren, een met een 'stil' profiel en een ander met een 'snel' profiel. Houd er rekening mee dat nieuwe waarden op elk gewenst moment kunnen worden toegevoegd, dus elke code die dit veld parseert, moet onverwachte waarden kunnen verwerken. Deze waarde komt overeen met de aanvraagparameter Profielen op eindpunten die ondersteuning bieden voor het selecteren van specifieke routeringsprofielen. Deze waarde is bedoeld als alleen machineleesbaar. Als u een profielnaam wilt weergeven aan een gebruiker, gebruikt u in plaats daarvan de 'profile_name' in het object 'route_metadata'. |
|
Signature
|
routes.signature | string |
Een waarde die moet worden doorgestuurd naar de server in volgende aanroepen om naar deze route te verwijzen (bijvoorbeeld bij het aanvragen van live vertrekgegevens via 'service/1/live/routeupdates'). Deze moet worden behandeld als een ondoorzichtige waarde. |
|
Aangevraagde tijd
|
routes.requested_time | string |
Bevat de parameter 'tijd' die wordt gebruikt als een beperking voor vertrek- of aankomsttijd bij het ophalen van een routebeschrijving, indien van toepassing. |
|
Type aangevraagde tijd
|
routes.requested_time_type | string |
Bevat de parameter 'time_type' die wordt gebruikt om te bepalen hoe de 'tijd' wordt gebruikt om de geretourneerde aanwijzingen te beperken, indien van toepassing. Als er geen parameter is opgegeven in de aanvraag, retourneert u de 'time_type' die standaard wordt gebruikt om de route te plannen. |
|
Language
|
language | string |
Een IETF BCP 47-taaltag die de taal aangeeft die wordt gebruikt voor het coderen van lokaliseerbare inhoud, zoals het inleveren van instructies, in dit antwoord. Dit weerspiegelt een poging om te voldoen aan elke taalvoorkeur die wordt uitgedrukt door de aanvraagparameter 'language' of 'en-US' als standaard. |
Live vertrek- en beschikbaarheidsgegevens voor meerdere routes ophalen
Hiermee worden actuele en live vertrekgegevens en live aanhalingstekens op aanvraag opgehaald voor meerdere routes die eerder zijn verkregen via de eindpunten voor routebeschrijvingen. Alleen routes met ten minste één been met een been updatable Detail kunnen worden bijgewerkt met behulp van deze service. Houd er rekening mee dat het niet altijd mogelijk is voor Citymapper om actuele tijden of live vertrek- en onderbrekingsinformatie voor een been te verstrekken. Geslaagde antwoorden (HTTP-code '200') verbruiken één 'Live Update'-tegoed voor elk HTTP-antwoord. Mislukte aanroepen verbruiken geen tegoeden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Handtekeningen
|
signatures | True | array of string |
Een matrix van 'handtekeningeigenschappen' van eerder verkregen routes |
|
Services op aanvraag ophalen
|
fetch_on_demand_services | boolean |
Bij het bijwerken met behulp van een of meer handtekeningen van routes met on-demand benen met updatable details (bijvoorbeeld van de service Taxi Directions), als dit is ingesteld op 'true', wordt aanvullende informatie aangevraagd bij taxiservice-intrgrations om nauwkeurigere en volledige prijzen, duur en beschikbaarheid van services te bieden. Hiervoor moeten de begin- en eindlocaties van de oorspronkelijke route worden verzonden naar deze services van derden, inclusief in het geval dat de ene of de andere de huidige of recente locatie van de gebruiker is. Houd er rekening mee dat u mogelijk expliciete geïnformeerde toestemming van uw eindgebruiker moet hebben om dit in te stellen op waar, afhankelijk van toepasselijke wetten en voorschriften. Als deze optie is ingesteld op 'false' of wordt weggelaten, worden er geen aanvragen gedaan bij services van derden. Als er geen update kan worden geproduceerd voor een been zonder dat deze parameter 'true' wordt ingesteld, wordt dit in het bijwerkbare detail aangegeven. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Beenupdates
|
route_updates.leg_updates | array of |
Dit is een parallelle matrix van leg Updatable Detail-objecten, één voor elk been in de oorspronkelijke route die wordt bijgewerkt. De waarden die overeenkomen met looppoten zijn leeg, maar de details die overeenkomen met transitbenen bevatten bijgewerkte vertrekgegevens. |
|
Vertrektijd
|
route_updates.route_departure_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker op deze route zal opgeven, op basis van de beschikbare vertrekinformatie. Dit wordt berekend, ervan uitgaande dat de gebruiker zich aan het begin van de route bevindt op het moment van de aanvraag. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Aankomsttijd
|
route_updates.route_arrival_time | string |
Het tijdstip waarop Citymapper denkt dat de gebruiker aan het einde van deze route aankomt, op basis van beschikbare vertrekinformatie en verwachte reissnelheid. Dit wordt berekend, ervan uitgaande dat de gebruiker zich aan het begin van de route bevindt op het moment van de aanvraag. De tijd wordt uitgedrukt in ISO 8601-indeling , inclusief een datum, tijd en tijdzone waarin de gebeurtenis plaatsvindt. '2020-08-19T08:10:42-04:00' geeft bijvoorbeeld 19 augustus 2020 om 8:10 uur in Eastern Daylight Time weer. |
|
Duur
|
route_updates.route_duration_seconds | integer |
De totale geschatte tijd voor het doorlopen van de hele route, in seconden. Deze waarde vervangt de waarde 'duration_seconds' van de oorspronkelijke route, omdat deze opnieuw wordt gecomputeerd om de specifieke vertrekgegevens in dit antwoord voor route-updates te gebruiken. Kan in zeldzame gevallen worden weggelaten wanneer de duur niet kan worden berekend, bijvoorbeeld als de route niet op het opgegeven moment kan worden voltooid omdat de betrokken Services niet worden uitgevoerd. |
|
DurationAccuracy
|
route_updates.route_duration_accuracy | string |
De beoordeling van de nauwkeurigheid van 'duration_seconds' van Citymapper moet worden weergegeven aan de gebruiker. Dit is grotendeels gebaseerd op het 'type' van de vertrektijden, maar het omvat aanvullende heuristieken die in de loop van de tijd zijn ontwikkeld voor de Citymapper-app. Wanneer dit veld niet is opgegeven, moet de waarde 'gepland' worden gebruikt. | waarde | beschrijving | | ----- | ----------- | | geschatte | Een duur die bij benadering moet worden beschouwd, omdat de berekening meer onzekerheid met zich mee brengt dan normaal. Dit is de laagste nauwkeurigheid. | | gepland | Een normale duur, meestal op basis van informatie over het gepubliceerde tijdschema. | | live | Een duur grotendeels gebaseerd op informatie over realtime/live vertrek. Dit is de hoogste nauwkeurigheid. | |
|
Handtekening aanvragen
|
route_updates.request_signature | string |
Dit is een routehandtekening uit de updateaanvraag, die moet worden gebruikt om deze update te koppelen aan de juiste route. |
Reistijden tussen twee locaties ophalen
Bepaalt de reistijd in verschillende manieren van reizen tussen de opgegeven twee punten op het moment dat de aanvraag wordt ingediend.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Start
|
start | True | string |
Het geografische beginpunt van de reis, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. |
|
Einde
|
end | True | string |
Het geografische eindpunt van de reis, in WGS84 'breedtegraad', lengtegraad. Coördinaten moeten decimaal zijn en alleen de eerste 6 cijfers van precisie worden gebruikt. |
|
Reistypen
|
traveltime_types | array |
Een door komma's gescheiden lijst met verschillende reistijdtypen die moeten worden aangevraagd. Elke aanvraagwaarde komt overeen met een bepaald veld in het antwoord (antwoordvelden zijn alleen aanwezig wanneer Citymapper een tijd voor dat reistijdtype kon berekenen). | waarde | antwoordeigenschap | beschrijving | | ----- | ----------------- | ------------| | walk | walk_travel_time_minutes | Wandelen | | doorvoer | transit_time_minutes | Openbaar vervoer | | fiets | bike_time_minutes | Fietsreizen (de hele weg rijden) | | scooter | scooter_time_minutes | Staande e-scooter reizen (helemaal rijden) | | motorscooter | motorscooter_time_minutes | Zitje motorscooter reizen (rijden in de hele weg) | | auto | car_time_minutes | Autoreizen (rijden op de hele weg). Alleen beschikbaar voor Enterprise-abonnementen | Wanneer dit veld wordt weggelaten of leeg is, wordt een standaardwaarde van 'walk,transit' gebruikt. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Looptijd
|
walk_travel_time_minutes | integer |
Geschatte wandeltijd tussen de twee opgegeven punten in minuten. |
|
Transittijd
|
transit_time_minutes | integer |
Geschatte reistijd voor openbaar vervoer tussen de twee opgegeven punten in minuten. |
|
Fietstijd
|
bike_time_minutes | integer |
Geschatte reistijd tussen twee punten in minuten. |
|
Scootertijd
|
scooter_time_minutes | integer |
Geschatte e-scooter reistijd tussen twee punten in minuten. |
|
Motorscooter Tijd
|
motorscooter_time_minutes | integer |
Geschatte reistijd van motorscooter tussen twee punten in minuten. |
|
Rijtijd
|
car_time_minutes | integer |
Geschatte reistijd tussen twee punten in minuten. |