Citymapper (Éditeur indépendant) (préversion)
Citymapper vous permet d’ajouter la planification du parcours et la navigation à tour de tour à vos produits. Nos services sont alimentés par nos données de transport mondiales de pointe et nos algorithmes de routage personnalisés formés sur des milliards de voyages.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Messagerie électronique | ttaylor@hitachisolutions.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Troy Taylor |
| Site internet | https://citymapper.com/ |
| Politique de confidentialité | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Catégories | Style de vie et divertissement |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé d’API | securestring | Clé API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Obtenir des informations de départ et de disponibilité en direct pour plusieurs itinéraires |
Cela récupère les informations actuelles et de départ en direct et les guillemets à la demande pour plusieurs itinéraires précédemment obtenus à partir des points de terminaison « directions ». Seuls les itinéraires qui ont au moins une jambe avec un détail pouvant être mis à jour à l’aide de ce service peuvent être mis à jour. Notez qu’il peut ne pas toujours être possible pour Citymapper de fournir des heures actuelles ou des départs en direct et des informations d’interruption pour une jambe. Les réponses réussies (code HTTP « 200 ») consomment un crédit « Live Update » pour chaque réponse HTTP. Les appels non réussis ne consomment aucun crédit. |
| Obtenir des itinéraires de scooter électronique loués entre deux points |
Obtient un itinéraire e-scooter engagé entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Ces résultats sont optimisés pour les petits scooters alimentés par batterie sur utilisant le pilote. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel scooter de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un scooter de la marque spécifiée, si possible. Utiliser un scooter à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le scooter est à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur. |
| Obtenir des itinéraires d’e-scooter entre deux points |
Obtient un itinéraire de scooter entre deux points, fournissant suffisamment d’informations pour le rendre sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour les petits scooters alimentés par batterie sur utilisant le pilote.) Cet appel suppose que le pilote a un scooter au point de départ et fournit un itinéraire de scooter électronique de là au point de fin si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de scooter, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du scooter. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de scooter, mais d’autres appels de service peuvent être disponibles pour le faire. Les réponses réussies (code HTTP « 200 ») consomment un crédit « Scooter Route » (ou un crédit « Scooter Reroute » si « reroute_signature » est utilisé) pour chaque réponse HTTP. Les appels non réussis ne consomment aucun crédit. |
| Obtenir des temps de déplacement entre deux emplacements |
Détermine le temps de voyage dans différents modes de déplacement entre les deux points donnés au moment où la demande est effectuée. |
| Obtenir un itinéraire de conduite entre deux points |
Obtient un itinéraire de voiture entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel suppose que le pilote a une voiture au point de départ et fournit un itinéraire de voiture de là à l’extrémité si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de voiture. La distance maximale de grand cercle entre le début et la fin est limitée à 1 000 km pour ce service. |
| Obtenir un itinéraire de marche entre deux points |
Obtient un itinéraire de marche entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Les itinéraires de marche devraient avoir une seule jambe avec un 'travel_mode' de 'walk'. Si Citymapper ne peut pas calculer les itinéraires de marche pour ces points (généralement pour des raisons de couverture), le service retourne une réponse « 400 » de code. La distance maximale de grand cercle entre le « début » et la « fin » est limitée à 100 km pour ce service. |
| Obtenir un itinéraire de scooter automobile entre deux points |
Obtient un itinéraire de scooter automobile entre deux points, fournissant suffisamment d’informations pour le rendre sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour une combustion interne plus grande ou des scooters électriques où le pilote est assis.) Cet appel suppose que le pilote a un scooter au point de départ et fournit un itinéraire de scooter électronique de là au point de fin si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de scooter, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du scooter. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de scooter, mais d’autres appels de service peuvent être disponibles pour le faire. |
| Obtenir un itinéraire de scooter automobile loué entre deux points |
Obtient un itinéraire de scooter à moteur loué entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour une combustion interne plus grande ou des scooters électriques où le pilote est assis.) NOTE: L’itinéraire résultant suppose actuellement que l’utilisateur peut monter directement à l’emplacement « final » spécifié, sans tenir compte des zones de stationnement ou de couverture spécifiées. Ainsi, la route résultante ne contiendra qu’une jambe initiale de 'travel_mode' 'walk' et une deuxième étape de 'travel_mode' 'self_piloted'. Une prochaine mise à jour intégrera les zones de stationnement et de couverture et ajoutera une dernière étape de marche. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel scooter de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un scooter de la marque spécifiée, si possible. Utiliser un scooter à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le scooter est à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur. |
| Obtenir un itinéraire de transit entre deux points |
Calcule plusieurs itinéraires de transport public entre deux points. Par défaut, les résultats contiennent jusqu’à 5 itinéraires. Chacun d’eux contiendra plusieurs jambes : généralement un au début et à la fin de la route avec « travel_mode » de « marche », avec au moins un avec « travel_mode » de « transit » entre eux. |
| Obtenir un itinéraire de vélo entre deux points |
Obtient une route de vélo entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel suppose que le cycliste a un vélo au point de départ et fournit un itinéraire de vélo de là à l’extrémité si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de vélo, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du vélo. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de vélo, mais d’autres appels de service peuvent être disponibles pour le faire. La distance maximale de grand cercle entre le début et la fin est limitée à 200 km pour ce service. |
| Obtenir un itinéraire entre deux points pour un scénario |
Calcule les itinéraires entre deux points en fonction d’un scénario fourni. Un ou plusieurs groupes d’itinéraires peuvent être fournis en fonction d’un scénario. Chaque groupe contient plusieurs itinéraires. Chaque itinéraire contiendra une ou plusieurs jambes. |
| Obtenir une route de taxi entre deux points |
Obtient une route de taxi entre deux points. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. L’itinéraire peut contenir des jambes de départ et de fin si les points de récupération ou de dépôt ne sont pas proches des coordonnées de début et de fin demandées. Les services de la réponse varient en fonction de la disponibilité locale, de l’heure de la journée et, en outre, des intégrations de service Taxi qui ont été configurées pour votre compte. Il existe deux façons recommandées d’utiliser ce service : vous pouvez demander un itinéraire de taxi avec des estimations de service à la demande incluses à l’avance en appelant avec « ?fetch_on_demand_services=true » ; ou vous pouvez effectuer la requête initiale sans extraire des estimations qui répondront avec l’itinéraire non actif, puis appeler immédiatement « 1/live/routeupdates » pour obtenir les estimations en direct supplémentaires. La première approche est plus simple, mais la seconde peut mieux correspondre à votre cas d’usage. |
| Obtenir une route à vélo louée entre deux points |
Obtient une route à vélo louée entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel vélo de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un vélo de la marque spécifiée, si possible. Utiliser un vélo à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le vélo se trouve à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur. |
Obtenir des informations de départ et de disponibilité en direct pour plusieurs itinéraires
Cela récupère les informations actuelles et de départ en direct et les guillemets à la demande pour plusieurs itinéraires précédemment obtenus à partir des points de terminaison « directions ». Seuls les itinéraires qui ont au moins une jambe avec un détail pouvant être mis à jour à l’aide de ce service peuvent être mis à jour. Notez qu’il peut ne pas toujours être possible pour Citymapper de fournir des heures actuelles ou des départs en direct et des informations d’interruption pour une jambe. Les réponses réussies (code HTTP « 200 ») consomment un crédit « Live Update » pour chaque réponse HTTP. Les appels non réussis ne consomment aucun crédit.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Signatures
|
signatures | True | array of string |
Tableau de propriétés « signature » à partir d’itinéraires précédemment obtenus |
|
Récupérer des services à la demande
|
fetch_on_demand_services | boolean |
Lors de la mise à jour à l’aide d’une ou plusieurs signatures provenant d’itinéraires contenant des jambes à la demande avec des détails pouvant être mis à jour (par exemple, à partir du service Taxi Directions), si cette valeur est définie sur « true », des informations supplémentaires seront demandées auprès des intrgrations du service Taxi pour fournir des tarifs, une durée et une disponibilité de service plus précis et complets. Pour ce faire, les emplacements de début et de fin de l’itinéraire d’origine doivent être transmis à ces services tiers, y compris dans le cas où l’un ou l’autre est l’emplacement actuel ou récent de l’utilisateur. N’oubliez pas que vous devrez peut-être avoir un consentement éclairé explicite de votre utilisateur final pour définir cette valeur sur « true » en fonction des lois et réglementations applicables. Si la valeur est « false » ou omise, aucune demande n’est adressée à des services tiers. Si aucune mise à jour ne peut être produite pour une jambe sans que ce paramètre soit défini « true », la réponse indique cela dans les détails pouvant être mis à jour. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Mises à jour des jambes
|
route_updates.leg_updates | array of |
Il s’agit d’un tableau parallèle d’objets Detail updatables de jambe, un pour chaque jambe de la route d’origine mise à jour. Les jambes correspondant aux jambes de marche seront vides, mais les détails correspondant aux jambes de transit contiennent des informations de départ mises à jour. |
|
Heure de départ
|
route_updates.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire au moment de la demande. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
route_updates.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire au moment de la demande. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Durée
|
route_updates.route_duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes. Cette valeur remplace la valeur « duration_seconds » de l’itinéraire d’origine, car elle sera recomputée pour utiliser les informations de départ spécifiques contenues dans cette réponse de mise à jour de route. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée, par exemple si l’itinéraire ne peut pas être terminé à l’heure donnée, car les services impliqués ne sont pas en cours d’exécution. |
|
DurationAccuracy
|
route_updates.route_duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Signature de la demande
|
route_updates.request_signature | string |
Il s’agit d’une « signature » de route à partir de la demande de mise à jour, qui doit être utilisée pour associer cette mise à jour à la route correcte. |
Obtenir des itinéraires de scooter électronique loués entre deux points
Obtient un itinéraire e-scooter engagé entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Ces résultats sont optimisés pour les petits scooters alimentés par batterie sur utilisant le pilote. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel scooter de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un scooter de la marque spécifiée, si possible. Utiliser un scooter à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le scooter est à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
ID de marque
|
brand_id | True | string |
ID de la marque de scooters électroniques à utiliser pour cette route. Cela est nécessaire pour déterminer l’emplacement des scooters disponibles, ainsi que les restrictions de couverture et de stationnement associées. |
|
État
|
ride_state | string |
Indique où se trouve le long de l’itinéraire que l’utilisateur est. S’il est omis, « walking_to_vehicle » est utilisé. Cette propriété ainsi que « current_location » permet la récupération d’une route mise à jour qui reflète la progression actuelle de l’utilisateur. | value | description | | ----- | ----------- | | walking_to_vehicle | Indique que l’utilisateur marche pour collecter le véhicule | | circonscription | Indique que l’utilisateur roule le véhicule | | walking_to_end | Indique que l’utilisateur a quitté le véhicule et qu’il marche vers sa destination | |
|
|
Emplacement actuel
|
current_location | string |
Emplacement actuel de l’utilisateur, afin de mettre à jour l’itinéraire en fonction de l’emplacement de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Ce paramètre est utilisé pour obtenir un itinéraire mis à jour qui reflète l’emplacement réel de l’utilisateur s’il diffère du chemin d’accès donné dans l’itinéraire. Si cela est fourni, l’itinéraire retourné contient cet emplacement. L’étape de l’itinéraire qui contiendra cet emplacement est décidé par la valeur du paramètre « ride_state ». |
|
|
Emplacement de démarrage
|
ride_start_location | string |
Emplacement du véhicule à utiliser, au début du trajet de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « cheval » ou « walking_to_end ». S’il n’est pas fourni lorsque 'ride_state' est 'walking_to_vehicle' (ou non spécifié), Citymapper tente de trouver le véhicule le plus approprié qui appartient au 'brand_id' spécifié. Pour la compatibilité, ' original_vehicle_location' est un alias pour ce paramètre |
|
|
Emplacement final
|
ride_end_location | string |
L’emplacement où le véhicule a été déposé à la fin de la partie du trajet de l’utilisateur le long de l’itinéraire. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « walking_to_end ». Dans tous les autres états, ce paramètre est ignoré. |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
|
|
Emplacements passés
|
past_loc_coords | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Coordonnées allant jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les coordonnées doivent être au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Âge de l’emplacement passé
|
past_loc_ages | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Les âges de jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les âges doivent être en secondes entières depuis l’emplacement actuel. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_coords' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Précisions d’emplacement passées
|
past_loc_accuracies | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Précisions GPS allant jusqu’à 10 des emplacements passés de l’utilisateur sous forme de liste séparées par des virgules. Les précisions doivent être en mètres entiers. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_coords' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir des itinéraires d’e-scooter entre deux points
Obtient un itinéraire de scooter entre deux points, fournissant suffisamment d’informations pour le rendre sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour les petits scooters alimentés par batterie sur utilisant le pilote.) Cet appel suppose que le pilote a un scooter au point de départ et fournit un itinéraire de scooter électronique de là au point de fin si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de scooter, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du scooter. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de scooter, mais d’autres appels de service peuvent être disponibles pour le faire. Les réponses réussies (code HTTP « 200 ») consomment un crédit « Scooter Route » (ou un crédit « Scooter Reroute » si « reroute_signature » est utilisé) pour chaque réponse HTTP. Les appels non réussis ne consomment aucun crédit.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
|
|
Emplacements passés
|
past_loc_coords | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Coordonnées allant jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les coordonnées doivent être au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Âge de l’emplacement passé
|
past_loc_ages | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Les âges de jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les âges doivent être en secondes entières depuis l’emplacement actuel. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_coords' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Précisions d’emplacement passées
|
past_loc_accuracies | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Précisions GPS allant jusqu’à 10 des emplacements passés de l’utilisateur sous forme de liste séparées par des virgules. Les précisions doivent être en mètres entiers. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_coords' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir des temps de déplacement entre deux emplacements
Détermine le temps de voyage dans différents modes de déplacement entre les deux points donnés au moment où la demande est effectuée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | string |
Point de départ géographique du voyage, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. |
|
Fin
|
end | True | string |
Point de fin géographique du voyage, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. |
|
Types de voyages
|
traveltime_types | array |
Liste séparée par des virgules de différents types de temps de voyage pour tenter de demander. Chaque valeur de requête correspond à un champ particulier dans la réponse (les champs de réponse ne seront présents que lorsque Citymapper a pu calculer une heure pour ce type de temps de voyage). | value | propriété response | description | | ----- | ----------------- | ------------| | walk | walk_travel_time_minutes | Marche | | | transit | transit_time_minutes | Transports en commun | | bike | bike_time_minutes | Voyage à vélo (à vélo tout au long de la route) | | scooter | scooter_time_minutes | Voyage en e-scooter debout (en voiture tout le chemin) | | | motorscooter | motorscooter_time_minutes | Voyage en scooter à moteur assis (en voiture tout le chemin) | | voiture | car_time_minutes | Voyage en voiture (en voiture tout au long de la route). Disponible uniquement sur les plans Entreprise | Lorsque ce champ est omis ou vide, une valeur par défaut de « walk, transit » est utilisée. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Temps de marche
|
walk_travel_time_minutes | integer |
Durée estimée de marche entre les deux points donnés en minutes. |
|
Temps de transit
|
transit_time_minutes | integer |
Durée estimée du trajet en transport en commun entre les deux points donnés en minutes. |
|
Temps de vélo
|
bike_time_minutes | integer |
Durée estimée du trajet à vélo entre deux points en minutes. |
|
Temps de scooter
|
scooter_time_minutes | integer |
Durée estimée du trajet en scooter électronique entre deux points en minutes. |
|
Motorscooter Time
|
motorscooter_time_minutes | integer |
Durée estimée du trajet du scooter automobile entre deux points en minutes. |
|
Durée du lecteur
|
car_time_minutes | integer |
Durée estimée du trajet de voiture entre deux points en minutes. |
Obtenir un itinéraire de conduite entre deux points
Obtient un itinéraire de voiture entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel suppose que le pilote a une voiture au point de départ et fournit un itinéraire de voiture de là à l’extrémité si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de voiture. La distance maximale de grand cercle entre le début et la fin est limitée à 1 000 km pour ce service.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire de marche entre deux points
Obtient un itinéraire de marche entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Les itinéraires de marche devraient avoir une seule jambe avec un 'travel_mode' de 'walk'. Si Citymapper ne peut pas calculer les itinéraires de marche pour ces points (généralement pour des raisons de couverture), le service retourne une réponse « 400 » de code. La distance maximale de grand cercle entre le « début » et la « fin » est limitée à 100 km pour ce service.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Profiles
|
profiles | string |
Indique les « profils » à utiliser lors du calcul des itinéraires de marche. Chaque profil peut générer une option d’itinéraire différente, de sorte que la demande de profils supplémentaires donnera généralement plus d’options. Notez que parfois certains itinéraires résultants sont identiques (dans le cas d’une route optimale de plusieurs manières) et qu’un profil peut ne pas toujours générer une route. Tous les profils ne seront pas disponibles pour tous les itinéraires de début et de fin. Les profils non disponibles sont omis de la réponse. | value | description | | ----- | ----------- | | fast | Le profil par défaut tente de trouver l’itinéraire le plus sensible le plus rapide | | main_roads | Tentatives d’éviter les rues et les parcs | Si aucun profil n’est spécifié, « rapide » est utilisé. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire de scooter automobile entre deux points
Obtient un itinéraire de scooter automobile entre deux points, fournissant suffisamment d’informations pour le rendre sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour une combustion interne plus grande ou des scooters électriques où le pilote est assis.) Cet appel suppose que le pilote a un scooter au point de départ et fournit un itinéraire de scooter électronique de là au point de fin si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de scooter, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du scooter. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de scooter, mais d’autres appels de service peuvent être disponibles pour le faire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire de scooter automobile loué entre deux points
Obtient un itinéraire de scooter à moteur loué entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. (Ces résultats sont optimisés pour une combustion interne plus grande ou des scooters électriques où le pilote est assis.) NOTE: L’itinéraire résultant suppose actuellement que l’utilisateur peut monter directement à l’emplacement « final » spécifié, sans tenir compte des zones de stationnement ou de couverture spécifiées. Ainsi, la route résultante ne contiendra qu’une jambe initiale de 'travel_mode' 'walk' et une deuxième étape de 'travel_mode' 'self_piloted'. Une prochaine mise à jour intégrera les zones de stationnement et de couverture et ajoutera une dernière étape de marche. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel scooter de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un scooter de la marque spécifiée, si possible. Utiliser un scooter à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le scooter est à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
ID de marque
|
brand_id | True | string |
ID de la marque de scooters à utiliser pour cette route. Cela est nécessaire pour déterminer l’emplacement des scooters disponibles, ainsi que les restrictions de couverture et de stationnement associées. |
|
État
|
ride_state | string |
Indique où se trouve le long de l’itinéraire que l’utilisateur est. S’il est omis, « walking_to_vehicle » est utilisé. Cette propriété ainsi que « current_location » permet la récupération d’une route mise à jour qui reflète la progression actuelle de l’utilisateur. | value | description | | ----- | ----------- | | walking_to_vehicle | Indique que l’utilisateur marche pour collecter le véhicule | | circonscription | Indique que l’utilisateur roule le véhicule | | walking_to_end | Indique que l’utilisateur a quitté le véhicule et qu’il marche vers sa destination | |
|
|
Emplacement actuel
|
current_location | string |
Emplacement actuel de l’utilisateur, afin de mettre à jour l’itinéraire en fonction de l’emplacement de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Ce paramètre est utilisé pour obtenir un itinéraire mis à jour qui reflète l’emplacement réel de l’utilisateur s’il diffère du chemin d’accès donné dans l’itinéraire. Si cela est fourni, l’itinéraire retourné contient cet emplacement. L’étape de l’itinéraire qui contiendra cet emplacement est décidé par la valeur du paramètre « ride_state ». |
|
|
Emplacement de démarrage
|
ride_start_location | string |
Emplacement du véhicule à utiliser, au début du trajet de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « cheval » ou « walking_to_end ». S’il n’est pas fourni lorsque 'ride_state' est 'walking_to_vehicle' (ou non spécifié), Citymapper tente de trouver le véhicule le plus approprié qui appartient au 'brand_id' spécifié. Pour la compatibilité, ' original_vehicle_location' est un alias pour ce paramètre |
|
|
Emplacement final
|
ride_end_location | string |
L’emplacement où le véhicule a été déposé à la fin de la partie du trajet de l’utilisateur le long de l’itinéraire. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « walking_to_end ». Dans tous les autres états, ce paramètre est ignoré. |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire de transit entre deux points
Calcule plusieurs itinéraires de transport public entre deux points. Par défaut, les résultats contiennent jusqu’à 5 itinéraires. Chacun d’eux contiendra plusieurs jambes : généralement un au début et à la fin de la route avec « travel_mode » de « marche », avec au moins un avec « travel_mode » de « transit » entre eux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Heure
|
time | string |
Heure à utiliser comme contrainte de départ ou d’arrivée lors de l’obtention de directions. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
|
Type d’heure
|
time_type | string |
Lorsqu’une valeur « time » est donnée, cela détermine la façon dont l’heure sera utilisée pour limiter les directions retournées. Quand cela n’est pas spécifié, ' depart_approximate' est utilisé. Si aucun « temps » n’est donné, cela n’a aucun effet. | value | description | | ----- | ----------- | | arrive | Les instructions sont choisies pour permettre à l’utilisateur d’accéder à sa destination sur ou avant « time » | | départ | Les instructions sont choisies en supposant que l’utilisateur quitte son origine dès que possible « time » | | depart_approximate | Similaire à « départ », mais en autorisant les départs ultérieurs afin de retourner des options plus préférables même s’ils quittent un peu plus tard. Il s’agit du moyen par défaut de citymapper de choisir des directions lorsque l’heure n’est pas spécifiée | |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Limit
|
limit | integer |
Nombre maximal d’itinéraires à retourner. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire de vélo entre deux points
Obtient une route de vélo entre deux points, fournissant suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel suppose que le cycliste a un vélo au point de départ et fournit un itinéraire de vélo de là à l’extrémité si les deux se trouvent dans les zones prises en charge par Citymapper. La route résultante doit contenir une seule jambe de vélo, bien que la propriété « path_annotations » de la jambe puisse indiquer les sections pendant lesquelles l’utilisateur doit marcher à côté du vélo. Cet appel n’intègre aucune information sur la couverture ou les parkings des opérateurs de vélo, mais d’autres appels de service peuvent être disponibles pour le faire. La distance maximale de grand cercle entre le début et la fin est limitée à 200 km pour ce service.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Profiles
|
profiles | string |
Indique les « profils » à utiliser lors du calcul des itinéraires de vélo. Chaque profil peut générer une option d’itinéraire différente, de sorte que la demande de profils supplémentaires donnera généralement plus d’options. Notez que parfois certains itinéraires résultants sont identiques (dans le cas d’une route optimale de plusieurs manières) et qu’un profil peut ne pas toujours générer une route. | value | description | | ----- | ----------- | | quiet | Tentatives d’utilisation des routes avec moins de trafic | | régulière | Le profil par défaut équilibre le trafic avec directness | | fast | Tente de trouver l’itinéraire le plus court | Si aucun profil n’est spécifié, « normal » est utilisé. |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
|
|
Emplacements passés
|
past_loc_coords | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Coordonnées allant jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les coordonnées doivent être au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Âge de l’emplacement passé
|
past_loc_ages | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Les âges de jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les âges doivent être en secondes entières depuis l’emplacement actuel. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_coords' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Précisions d’emplacement passées
|
past_loc_accuracies | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Précisions GPS allant jusqu’à 10 des emplacements passés de l’utilisateur sous forme de liste séparées par des virgules. Les précisions doivent être en mètres entiers. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_coords' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir un itinéraire entre deux points pour un scénario
Calcule les itinéraires entre deux points en fonction d’un scénario fourni. Un ou plusieurs groupes d’itinéraires peuvent être fournis en fonction d’un scénario. Chaque groupe contient plusieurs itinéraires. Chaque itinéraire contiendra une ou plusieurs jambes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de scénario
|
scenario_id | True | string |
ID de scénario pour les instructions. |
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Heure
|
time | string |
Heure à utiliser comme contrainte de départ ou d’arrivée lors de l’obtention de directions. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
|
Type d’heure
|
time_type | string |
Lorsqu’une valeur « time » est donnée, cela détermine la façon dont l’heure sera utilisée pour limiter les directions retournées. Quand cela n’est pas spécifié, ' depart_approximate' est utilisé. Si aucun « temps » n’est donné, cela n’a aucun effet. | value | description | | ----- | ----------- | | arrive | Les instructions sont choisies pour permettre à l’utilisateur d’accéder à sa destination sur ou avant « time » | | départ | Les instructions sont choisies en supposant que l’utilisateur quitte son origine dès que possible « time » | | depart_approximate | Similaire à « départ », mais en autorisant les départs ultérieurs afin de retourner des options plus préférables même s’ils quittent un peu plus tard. Il s’agit du moyen par défaut de citymapper de choisir des directions lorsque l’heure n’est pas spécifiée | |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir une route de taxi entre deux points
Obtient une route de taxi entre deux points. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. L’itinéraire peut contenir des jambes de départ et de fin si les points de récupération ou de dépôt ne sont pas proches des coordonnées de début et de fin demandées. Les services de la réponse varient en fonction de la disponibilité locale, de l’heure de la journée et, en outre, des intégrations de service Taxi qui ont été configurées pour votre compte. Il existe deux façons recommandées d’utiliser ce service : vous pouvez demander un itinéraire de taxi avec des estimations de service à la demande incluses à l’avance en appelant avec « ?fetch_on_demand_services=true » ; ou vous pouvez effectuer la requête initiale sans extraire des estimations qui répondront avec l’itinéraire non actif, puis appeler immédiatement « 1/live/routeupdates » pour obtenir les estimations en direct supplémentaires. La première approche est plus simple, mais la seconde peut mieux correspondre à votre cas d’usage.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Récupérer les services sur domaine
|
fetch_on_demand_services | string |
Si la valeur est « true », des informations supplémentaires seront demandées à partir de vos intégrations de service Taxi pour fournir des tarifs, une durée et une disponibilité des services plus précis et complets, retournés dans les détails pouvant être mis à la demande. Pour ce faire, les emplacements de début et de fin de l’itinéraire doivent être transmis à ces services tiers, y compris dans le cas où l’un ou l’autre est l’emplacement actuel ou récent de l’utilisateur. N’oubliez pas que vous devrez peut-être avoir un consentement éclairé explicite de votre utilisateur final pour définir cette valeur sur « true » en fonction des lois et réglementations applicables. Si la valeur est « false » ou omise, aucune demande n’est adressée à des services tiers. |
|
|
ID de marque
|
brand_ids | array |
Liste séparée par des virgules des ID de marque pour limiter cette demande de direction. S’il est omis (valeur par défaut), toutes les marques disponibles sont retournées par une route de taxi. |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |
Obtenir une route à vélo louée entre deux points
Obtient une route à vélo louée entre deux points, y compris les promenades initiales et finales. L’itinéraire obtenu fournit suffisamment d’informations pour l’afficher sur une carte, ainsi qu’une estimation de durée. Cet appel peut être utilisé de plusieurs façons différentes : utilisez n’importe quel vélo de la marque spécifiée : il s’agit de l’appel le plus simple, nécessitant uniquement « start », « end » et « brand_id ». Citymapper suppose que l’utilisateur est au point de départ et choisit un vélo de la marque spécifiée, si possible. Utiliser un vélo à un emplacement spécifié En ajoutant « original_vehicle_location » à « start », « end » et « brand_id », Citymapper planifie un itinéraire qui suppose que le vélo se trouve à l’emplacement donné. Mettre à jour un itinéraire en cours Pour récupérer un itinéraire mis à jour qui inclut la réacheminement à partir de l’emplacement actuel de l’utilisateur s’il a divergé de l’itinéraire planifié, l’appelant peut ajouter les propriétés « current_location » et « ride_state », qui indique la partie de la route résultante devant être routée autour du « current_location » de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Démarrer
|
start | True | array |
Début géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
Fin
|
end | True | array |
Fin géographique de l’itinéraire, au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seules les 6 premières décimales seront utilisées. |
|
ID de marque
|
brand_id | True | string |
ID de la marque de vélo à utiliser pour cette route. Cela est nécessaire pour déterminer l’emplacement des vélos disponibles, ainsi que les restrictions de couverture et de stationnement associées. |
|
État
|
ride_state | string |
Indique où se trouve le long de l’itinéraire que l’utilisateur est. S’il est omis, « walking_to_vehicle » est utilisé. Cette propriété ainsi que « current_location » permet la récupération d’une route mise à jour qui reflète la progression actuelle de l’utilisateur. | value | description | | ----- | ----------- | | walking_to_vehicle | Indique que l’utilisateur marche pour collecter le véhicule | | circonscription | Indique que l’utilisateur roule le véhicule | | walking_to_end | Indique que l’utilisateur a quitté le véhicule et qu’il marche vers sa destination | |
|
|
Emplacement actuel
|
current_location | string |
Emplacement actuel de l’utilisateur, afin de mettre à jour l’itinéraire en fonction de l’emplacement de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Ce paramètre est utilisé pour obtenir un itinéraire mis à jour qui reflète l’emplacement réel de l’utilisateur s’il diffère du chemin d’accès donné dans l’itinéraire. Si cela est fourni, l’itinéraire retourné contient cet emplacement. L’étape de l’itinéraire qui contiendra cet emplacement est décidé par la valeur du paramètre « ride_state ». |
|
|
Emplacement de démarrage
|
ride_start_location | string |
Emplacement du véhicule à utiliser, au début du trajet de l’utilisateur. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « cheval » ou « walking_to_end ». S’il n’est pas fourni lorsque 'ride_state' est 'walking_to_vehicle' (ou non spécifié), Citymapper tente de trouver le véhicule le plus approprié qui appartient au 'brand_id' spécifié. Pour la compatibilité, ' original_vehicle_location' est un alias pour ce paramètre |
|
|
Emplacement final
|
ride_end_location | string |
L’emplacement où le véhicule a été déposé à la fin de la partie du trajet de l’utilisateur le long de l’itinéraire. Fourni au format WGS84 « latitude, longitude ». Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Cela doit être fourni lorsque « ride_state » est « walking_to_end ». Dans tous les autres états, ce paramètre est ignoré. |
|
|
Profiles
|
profiles | string |
Indique les « profils » à utiliser lors du calcul des itinéraires de vélo. Chaque profil peut générer une option d’itinéraire différente, de sorte que la demande de profils supplémentaires donnera généralement plus d’options. Notez que parfois certains itinéraires résultants sont identiques (dans le cas d’une route optimale de plusieurs manières) et qu’un profil peut ne pas toujours générer une route. | value | description | | ----- | ----------- | | quiet | Tentatives d’utilisation des routes avec moins de trafic | | régulière | Le profil par défaut équilibre le trafic avec directness | | fast | Tente de trouver l’itinéraire le plus court | Si aucun profil n’est spécifié, « normal » est utilisé. |
|
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la préférence de langue de l’utilisateur final. Lorsqu’elle est fournie, la réponse contient une propriété « language » qui indique la langue utilisée pour tous les éléments localisables de la réponse (par exemple, les instructions de rotation). Cette langue sera une tentative optimale pour répondre à la préférence exprimée, mais elle peut contenir une valeur qui n’a pas été exprimée dans la demande (cela sera généralement 'en-US' comme secours). Notez que la préférence de langue affecte généralement uniquement le contenu généré par Citymapper, tel que les instructions de rotation. Le contenu externe, tel que les noms d’arrêt et les descriptions d’état, est généralement transmis dans leur langue d’origine. |
|
|
Rerouter la signature
|
reroute_signature | string |
Lors de la réacheminement (en demandant une mise à jour vers une réponse précédente qui compte pour l’emplacement mis à jour de l’utilisateur), cette valeur doit être définie sur la « signature » fournie dans l’itinéraire d’origine. Cela permet une détermination plus efficace de l’itinéraire mis à jour. Cette valeur doit être encodée par URL. Lorsque vous fournissez ce paramètre, l’emplacement « current_location » (le cas échéant) ou « start » doit être défini sur l’emplacement le plus récent de l’utilisateur. Lorsque ce paramètre est inclus, Citymapper peut ne pas retourner de résultats dans les cas où la demande diffère considérablement de l’emplacement d’origine, par exemple si l’emplacement « end » est différent ou si plus de 1 heure est passée depuis la demande d’origine. |
|
|
Début du roulement
|
start_bearing | integer |
Angle dans le sens des aiguilles d’une montre du nord compris entre 0 et 359, où le nord est 0 et l’est est est. Ce roulement est utilisé pour influencer le texte d’instruction initial et/ou le routage, le plus souvent pour éviter que l’utilisateur ne soit invité à effectuer un u-turn, si la poursuite de leur roulement actuel donne une route comparable. Cela ne doit être fourni que si vous souhaitez influencer la direction initiale du voyage pour l’itinéraire. |
|
|
Emplacements passés
|
past_loc_coords | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Coordonnées allant jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les coordonnées doivent être au format « latitude, longitude » de WGS84. Les coordonnées doivent être en décimales, et seuls les 6 premiers chiffres de précision seront utilisés. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Âge de l’emplacement passé
|
past_loc_ages | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Les âges de jusqu’à 10 des emplacements passés de l’utilisateur en tant que liste séparée par des virgules. Les âges doivent être en secondes entières depuis l’emplacement actuel. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_coords' et 'past_loc_accuracies' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
|
|
Précisions d’emplacement passées
|
past_loc_accuracies | string |
Paramètre facultatif pour améliorer le comportement de réacheminement. Précisions GPS allant jusqu’à 10 des emplacements passés de l’utilisateur sous forme de liste séparées par des virgules. Les précisions doivent être en mètres entiers. Doit être trié chronologiquement, dernier le plus récent. 'past_loc_ages' et 'past_loc_coords' doivent être fournis en même temps. Le serveur prend uniquement en compte un maximum de 10 emplacements, si plus de 10 emplacements sont fournis, les emplacements les moins récents seront ignorés. Le serveur est susceptible d’ignorer les emplacements âgés de plus de 30 secondes ou les emplacements inférieurs à 1 seconde. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitude dans l’encodage WGS84, avec 6 chiffres de précision décimale. |
|
Distance en mètres
|
routes.distance_meters | integer |
Distance globale de l’itinéraire entier, en mètres. |
|
Durée
|
routes.duration_seconds | integer |
Durée estimée globale pour parcourir l’itinéraire entier, en secondes, en fonction du véhicule ou du départ sélectionné dans la réponse. |
|
Précision de durée
|
routes.duration_accuracy | string |
L’évaluation de Citymapper de la façon dont le niveau de précision de « duration_seconds » doit être affiché à l’utilisateur. Ceci est largement basé sur le « type » des départs utilisés pour les moments, mais il implique des heuristiques supplémentaires développées au fil du temps pour l’application Citymapper. Lorsque ce champ n’est pas fourni, la valeur « planifiée » doit être utilisée. | value | description | | ----- | ----------- | | estimé | Durée qui devrait être considérée comme approximative, car son calcul implique plus d’incertitude que d’habitude. Il s’agit de la plus faible précision. | | planifié | Une durée normale, généralement basée sur des informations de calendrier publiées. | | live | Durée largement basée sur les informations de départ en temps réel/en direct. Il s’agit de la précision la plus élevée. | |
|
Formaté
|
routes.price.formatted | string |
Prix donné sous forme de chaîne mise en forme. Par défaut, il s’agit du format monétaire natif de la région où l’itinéraire se produit. |
|
Montant
|
routes.price.amount | string |
Prix sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Valeur minimale de la plage de quantités
|
routes.price.amount_range_minimum | string |
Si ce prix représente une plage de valeurs possibles, le prix minimal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. |
|
Plage de quantité maximale
|
routes.price.amount_range_maximum | string |
Si ce prix représente une plage de valeurs possibles, le prix maximal sous forme de valeur décimale, encodé en tant que chaîne pour éviter les problèmes de précision à virgule flottante. Il n’inclut pas de symboles monétaires, et le séparateur entre les unités principales et mineures sera toujours « . », quelle que soit la région. Cela peut ne pas être inclus si la plage est ouverte |
|
Monnaie
|
routes.price.currency | string |
Devise dans laquelle le prix est donné, sous forme ISO 4217, en trois lettres. |
|
Multiplicateur de la demande
|
routes.price.demand_multipler | float |
Indique que les prix sont plus élevés que d’habitude en raison de la demande, généralement pour les jambes taxi (à la demande). Peut dans de rares cas être inférieur à 1,0 |
|
Émissions de CO2e
|
routes.emissions_grams_co2e | float |
Estimation des émissions de gaz à effet de serre de la route, exprimées en grammes de dioxyde de carbone équivalent (CO2e). |
|
Jambes
|
routes.legs | array of object |
Tableau de jambes comprenant l’itinéraire, dans l’ordre dans lequel ils doivent être parcourus. Chaque itinéraire valide aura au moins un itinéraire. |
|
Mode voyage
|
routes.legs.travel_mode | string |
Mode voyage. |
|
Durée
|
routes.legs.duration_seconds | integer |
Temps nécessaire pour traverser cette jambe, à l’exclusion de toute heure d’attente ou d’embarquement au début. Peut être omis dans de rares circonstances lorsque la durée ne peut pas être calculée. |
|
Chemin
|
routes.legs.path | string |
Chemin géographique que la jambe traverse, sous la forme d’une série de coordonnées WGS84 encodées au format Google Polyline, avec une précision décimale de 5 chiffres. Par exemple, la valeur '_flyHbjPDZBTBNDJ' encode la série suivante de coordonnées (latitude, longitude) : '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.5139, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instructions
|
routes.legs.instructions | array of object |
Cela fournit la liste des instructions de tour pour guider l’utilisateur à travers les jambes où l’utilisateur doit naviguer, par exemple lors de la marche ou de l’utilisation d’un scooter ou d’un vélo. |
|
Index de chemin d’accès
|
routes.legs.instructions.path_index | integer |
Index de base 0 dans la liste des coordonnées fournies par la propriété « path » de la jambe. Cela indique l’emplacement auquel l’instruction doit être suivie. Il s’agit donc de l’emplacement de l’activation sur le chemin, ou du début ou de la fin de la jambe. |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
Distance en mètres de la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Heure
|
routes.legs.instructions.time_seconds | integer |
Temps en secondes que l’utilisateur doit prendre pour parcourir la section du « chemin » avant cette instruction. Cette propriété est omise pour les instructions initiales de type « départ ». |
|
Descriptif
|
routes.legs.instructions.description_text | string |
Description en texte brut de l’instruction à l’utilisateur. |
|
Description Format
|
routes.legs.instructions.description_format | string |
Format de texte pour le rendu de l’instruction avec des éléments mis en évidence, où « {key} » indique une partie de la chaîne qui doit être remplacée par le contenu défini par l’entrée correspondant à « clé » dans « description_format_replacements ». Cela permet aux éléments décrits par les remplacements d’être mis en forme différemment par le client, si vous le souhaitez. Les chaînes de clé contiennent uniquement les caractères « [a-zA-Z0-9] ». '{ }' ne sera pas imbriqué, et les caractères littéraux « { » et « } » sont encodés respectivement par les séquences d’échappement « { » et « } ». |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clé correspondant à une chaîne placée dans '{}' dans 'description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texte à utiliser pour remplacer la sous-chaîne « {key} » dans la « description_format ». |
|
Type
|
routes.legs.instructions.description_format_replacements.type | string |
Valeur indiquant le type d’élément réel identifié par ce remplacement de format. Cela permet aux clients de service d’appliquer une mise en forme spécifique à l’application si vous le souhaitez. | value | description | | ----- | ----------- | | street_name | Nom d’une rue, d’une route ou d’une autre façon | | exit_number | Le nombre d’une sortie, généralement d’un rond-point | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Balise de langue IETF BCP 47 qui indique la langue dans laquelle se trouve le « texte » associé. Notez que cela peut être différent de la langue de la description environnante : ceci est le plus courant lorsque le remplacement est un nom de place dans une langue locale alors que la description se trouve dans une autre langue. |
|
Type
|
routes.legs.instructions.type | string |
Indique le type d’instruction. |
|
Type Direction
|
routes.legs.instructions.type_direction | string |
Indique une direction qui modifie cette instruction. |
|
Heure de départ
|
routes.route_departure_time | string |
Heure à laquelle Citymapper pense que l’utilisateur se présentera sur cette route, en fonction des informations de départ disponibles. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
Heure d’arrivée
|
routes.route_arrival_time | string |
Heure à laquelle Citymapper pense que l’utilisateur arrivera à la fin de cette route, étant donné les informations de départ disponibles et la vitesse de voyage attendue. Cela est calculé en supposant que l’utilisateur est au début de l’itinéraire. Les valeurs mises à jour pour « route_departure_time » et « route_arrival_time » sont retournées par « service/1/live/routeupdates » pour refléter les informations de départ mises à jour. L’heure est exprimée au format ISO 8601 , y compris une date, une heure et un fuseau horaire dans lequel l’événement se produit. Par exemple, « 2020-08-19T08:10:42-04:00 » exprime le 19 août 2020 à 8 h 10 dans l’est de l’heure d’été. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
ID de groupe
|
routes.route_metadata.groups.group_id | string |
ID d’un groupe dans lequel une route contient. |
|
Groupe
|
routes.route_metadata.groups.group_name | string |
Nom localisé d’un groupe de routes, par exemple « Transit » ou « Le metro ». |
|
Position de l’itinéraire
|
routes.route_metadata.groups.route_position | integer |
Position de base zéro d’un itinéraire au sein d’un groupe spécifique. |
|
Nom du profil
|
routes.route_metadata.profile_name | string |
Nom localisé lisible par l’homme de l’identificateur « profil ». |
|
Profil
|
routes.profile | string |
Indique le routage « profil » utilisé pour calculer cet itinéraire. Par exemple, une réponse d’un point de terminaison de routage de vélo peut retourner plusieurs itinéraires, un avec un profil « silencieux » et un autre avec un profil « rapide ». Notez que de nouvelles valeurs peuvent être ajoutées à tout moment, de sorte que tout code analysant ce champ doit être en mesure de gérer des valeurs inattendues. Cette valeur correspond au paramètre de requête « profils » sur les points de terminaison qui prennent en charge la sélection de profils de routage spécifiques. Cette valeur est destinée à être lisible par l’ordinateur uniquement. Pour qu’un nom de profil s’affiche à un utilisateur, utilisez plutôt le « profile_name » dans l’objet « route_metadata ». |
|
Signature
|
routes.signature | string |
Valeur à renvoyer au serveur dans les appels suivants pour faire référence à cet itinéraire (par exemple, lors de la demande d’informations de départ en direct via « service/1/live/routeupdates »). Elle doit être traitée comme une valeur opaque. |
|
Heure demandée
|
routes.requested_time | string |
Contient le paramètre « time » utilisé comme contrainte de départ ou d’heure d’arrivée lors de l’obtention de directions, le cas échéant. |
|
Type de temps demandé
|
routes.requested_time_type | string |
Contient le paramètre « time_type » utilisé pour déterminer la façon dont « time » sera utilisé pour limiter les directions retournées, le cas échéant. Si aucun paramètre n’a été donné dans la requête, retourne le « time_type » utilisé par défaut pour planifier l’itinéraire. |
|
Language
|
language | string |
Balise de langue IETF BCP 47 qui indique la langue utilisée pour encoder le contenu localisable, tel que les instructions de rotation, dans cette réponse. Cela reflète une tentative optimale de répondre aux préférences linguistiques exprimées par le paramètre de requête « language » ou «en-US» comme valeur par défaut. |