Citymapper (независимый издатель) (предварительная версия)
Citymapper позволяет добавлять планирование путешествий и пошаговое навигацию к продуктам. Наши услуги работают на основе наших ведущих мировых транспортных данных и пользовательских алгоритмов маршрутизации, подготовленных на миллиарды поездок.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Трой Тейлор |
| URL | https://www.hitachisolutions.com |
| Адрес электронной почты | ttaylor@hitachisolutions.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Трой Тейлор |
| Website | https://citymapper.com/ |
| Политика конфиденциальности | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Категории | Образ жизни и развлечения |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение велосипедного маршрута между двумя точками |
Получает велосипедный маршрут между двумя точками, предоставляя достаточно информации для отрисовки его на карте вместе с оценкой длительности. В этом вызове предполагается, что всадник имеет велосипед в точке начала и предоставляет велосипедный маршрут оттуда к конечной точке, если оба находятся в поддерживаемых областях Citymapper. Результирующий маршрут должен содержать одну велосипедную ногу, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с велосипедом. Этот звонок не включает в себя какие-либо сведения о охвате или парковке операторов велосипедов, но другие вызовы услуг могут быть доступны для этого. Максимальное расстояние между началом и окончанием ограничено 200 км для этой службы. |
| Получение времени перемещения между двумя расположениями |
Определяет время перемещения в различных режимах перемещения между заданными двумя точками во время выполнения запроса. |
| Получение маршрута вождения между двумя точками |
Получает маршрут автомобиля между двумя точками, предоставляя достаточную информацию для отрисовки его на карте, а также оценку длительности. В этом вызове предполагается, что всадник имеет автомобиль в точке начала и предоставляет маршрут автомобиля оттуда к конечной точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу автомобиля. Максимальное расстояние между началом и окончанием ограничено 1000 км для этой службы. |
| Получение маршрута между двумя точками для сценария |
Вычисляет маршруты между двумя точками на основе предоставленного сценария. В зависимости от сценария можно предоставить одну или несколько групп маршрутов. Каждая группа будет содержать несколько маршрутов. Каждый маршрут будет содержать одну или несколько ног. |
| Получение маршрута мотор-скутера между двумя точками |
Получает маршрут мотор-скутера между двумя точками, предоставляя достаточную информацию для отрисовки его на карте вместе с оценкой длительности. (Эти результаты оптимизированы для большего внутреннего горения или электрических скутеров, где всадник находится.) В этом вызове предполагается, что всадник имеет скутер в точке начала и предоставляет маршрут e-скутера оттуда к "конечной" точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу скутера, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с скутером. Этот звонок не включает никакой информации о охвате операторов скутера или зонах парковки, но другие вызовы услуг могут быть доступны для этого. |
| Получение маршрута такси между двумя точками |
Получает маршрут такси между двумя точками. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Маршрут может содержать начальные и конечные ноги, если точки сбора или удаления не близки к запрошенным координатам начала и окончания. Службы в ответе будут отличаться в зависимости от локальной доступности, времени дня и, кроме того, интеграции служб такси настроены для вашей учетной записи. Существует два рекомендуемых способа использования этой службы: вы можете запросить маршрут такси с динамическими оценками услуг по запросу, включенными заранее, позвонив с "?fetch_on_demand_services=true".; или вы можете выполнить первоначальный запрос без получения оценок, которые будут отвечать на неактивных маршрутах, а затем немедленно вызвать "1/live/routeupdates", чтобы получить дополнительные динамические оценки. Первый подход проще, но второй может лучше соответствовать вашему варианту использования. |
| Получение нанятого автокутер маршрута между двумя точками |
Получает нанятый автомобильный скутер маршрут между двумя точками, в том числе любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. (Эти результаты оптимизированы для большего внутреннего горения или электрических скутеров, где всадник находится.) ЗАМЕТКА: Результирующий маршрут в настоящее время предполагает, что пользователь может ездить непосредственно в указанное "конечное" расположение, не учитывая какие-либо зоны парковки или покрытия. Таким образом, результирующий маршрут будет содержать только начальный этап "travel_mode" "прогулка" и второй этап "travel_mode" "self_piloted". В будущем обновление будет включать парковку и зоны покрытия и добавить окончательный "прогулка" ногу. Этот вызов можно использовать различными способами: используйте любой скутер указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает скутер указанного бренда, если это возможно. Использование скутера в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что скутер находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя. |
| Получение нанятого велосипедного маршрута между двумя точками |
Получает нанятый велосипедный маршрут между двумя точками, включая любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Этот вызов можно использовать различными способами: используйте любой велосипед указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает велосипед указанного бренда, если это возможно. Использование велосипеда в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что велосипед находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя. |
| Получение нанятых электронных скутер направлений между двумя точками |
Получает нанятый маршрут скутера между двумя точками, включая любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Эти результаты оптимизированы для небольших аккумуляторных скутеров, на которых всадник стоит. Этот вызов можно использовать различными способами: используйте любой скутер указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает скутер указанного бренда, если это возможно. Использование скутера в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что скутер находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя. |
| Получение направлений e-скутера между двумя точками |
Получает маршрут скутера между двумя точками, предоставляя достаточно информации для отрисовки его на карте вместе с оценкой длительности. (Эти результаты оптимизированы для небольших аккумуляторных скутеров, на которых всадник стоит.) В этом вызове предполагается, что всадник имеет скутер в точке начала и предоставляет маршрут e-скутера оттуда к "конечной" точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу скутера, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с скутером. Этот звонок не включает никакой информации о охвате операторов скутера или зонах парковки, но другие вызовы услуг могут быть доступны для этого. Успешные ответы (HTTP-код "200") будут использовать один кредит "Скутер Маршрут" (или один кредит "Скутер Перенаправлять", если используется "reroute_signature" для каждого HTTP-ответа. Неудачные звонки не будут потреблять никаких кредитов. |
| Получение пешеходного маршрута между двумя точками |
Получает маршрут ходьбы между двумя точками, предоставляя достаточную информацию для отрисовки его на карте, а также оценку длительности. Ожидается, что пешеходные маршруты имеют одну ногу с "travel_mode" "прогулки". Если Citymapper не может вычислить маршруты для этих точек (как правило, по причинам покрытия), служба вернет ответ "400". Максимальное расстояние между "start" и "end" ограничено 100 км для этой службы. |
| Получение сведений о динамическом отъезде и доступности для нескольких маршрутов |
Это извлекает текущую и динамическую информацию об отъезде и динамическую цитату по запросу для нескольких маршрутов, полученных ранее из конечных точек "направления". С помощью этой службы можно обновить только маршруты, имеющие по крайней мере одну ногу с обновляемыми данными. Обратите внимание, что это не всегда возможно для Citymapper, чтобы предоставить текущее время или динамическую информацию о отъезде и нарушениях для ноги. Успешные ответы (HTTP-код 200) будут использовать один кредит Live Update для каждого HTTP-ответа. Неудачные звонки не будут потреблять никаких кредитов. |
| Получение транзитного маршрута между двумя точками |
Вычисляет несколько маршрутов общественного транспорта между двумя точками. По умолчанию результаты будут содержать до 5 маршрутов. Каждая из них будет содержать несколько ног: обычно один в начале и конце маршрута с "travel_mode" "прогулка", по крайней мере один с "travel_mode" "транзит" между ними. |
Получение велосипедного маршрута между двумя точками
Получает велосипедный маршрут между двумя точками, предоставляя достаточно информации для отрисовки его на карте вместе с оценкой длительности. В этом вызове предполагается, что всадник имеет велосипед в точке начала и предоставляет велосипедный маршрут оттуда к конечной точке, если оба находятся в поддерживаемых областях Citymapper. Результирующий маршрут должен содержать одну велосипедную ногу, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с велосипедом. Этот звонок не включает в себя какие-либо сведения о охвате или парковке операторов велосипедов, но другие вызовы услуг могут быть доступны для этого. Максимальное расстояние между началом и окончанием ограничено 200 км для этой службы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Profiles
|
profiles | string |
Указывает, какие профили используются при вычислении направлений велосипеда. Каждый профиль может создать другой вариант маршрута, поэтому запросы на дополнительные профили обычно дают больше параметров. Обратите внимание, что иногда некоторые из результирующего маршрута будут идентичными (в случае оптимального маршрута в нескольких способах), а профиль может не всегда давать маршрут. | значение | description | | ----- | ----------- | | тихая | Попытки использовать дороги с меньшим трафиком | | regular | Профиль по умолчанию балансирует трафик с прямой нагрузкой | | fast | Пытается найти самый короткий разумный маршрут | Если профили не указаны, будет использоваться "обычный". |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
|
|
Прошлые расположения
|
past_loc_coords | string |
Необязательный параметр для улучшения поведения перенаправки. Координаты до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Координаты должны находиться в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Должно быть хронологично упорядочено, последнее последнее. "past_loc_ages" и "past_loc_accuracies" должны быть предоставлены вместе. Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Прошлое расположение возрастов
|
past_loc_ages | string |
Необязательный параметр для улучшения поведения перенаправки. Возраст до 10 прошлых расположений пользователя в виде разделенного запятыми списка. Возраст должен находиться в целых секундах с текущего расположения. Должно быть хронологично упорядочено, последнее последнее. Необходимо предоставить past_loc_coords и "past_loc_accuracies". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Точность прошлых расположений
|
past_loc_accuracies | string |
Необязательный параметр для улучшения поведения перенаправки. Точность GPS до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Точность должна быть в целочисленных метрах. Должно быть хронологично упорядочено, последнее последнее. Необходимо указать past_loc_ages и "past_loc_coords". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение времени перемещения между двумя расположениями
Определяет время перемещения в различных режимах перемещения между заданными двумя точками во время выполнения запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | string |
Географическая точка начала поездки в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. |
|
Конец
|
end | True | string |
Географическая конечная точка поездки в формате "широта, долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. |
|
Типы путешествий
|
traveltime_types | array |
Разделенный запятыми список различных типов времени путешествия для попытки запроса. Каждое значение запроса соответствует определенному полю в ответе (поля ответа будут присутствовать только в том случае, если Citymapper смог вычислить время для этого типа времени путешествия). | значение | Свойство response | description | | ----- | ----------------- | ------------| | прогулка | walk_travel_time_minutes | Прогулка | | транзит | transit_time_minutes | Поездки по общественному транспорту | | велосипед | bike_time_minutes | Велосипедные поездки (езда весь путь) | | скутер | scooter_time_minutes | Стоящий электронный скутер путешествия (езда весь путь) | | motorscooter | motorscooter_time_minutes | Сидячий двигатель скутер путешествия (езда весь путь) | | автомобиль | car_time_minutes | Автомобиль путешествия (езда весь путь). Доступно только в планах Enterprise | Если это поле опущено или пусто, будет использоваться значение по умолчанию "walk,transit". |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Время прогулки
|
walk_travel_time_minutes | integer |
Предполагаемое время ходьбы между двумя заданными точками в минутах. |
|
Время передачи
|
transit_time_minutes | integer |
Предполагаемое время поездки общественного транспорта между двумя заданными точками в минутах. |
|
Время велосипеда
|
bike_time_minutes | integer |
Предполагаемое время путешествия велосипеда между двумя точками в минутах. |
|
Время скутера
|
scooter_time_minutes | integer |
Предполагаемое время поездки на электронный скутер между двумя точками в минутах. |
|
Время Motorscooter
|
motorscooter_time_minutes | integer |
Предполагаемое время движения мотор-скутера между двумя точками в минутах. |
|
Время диска
|
car_time_minutes | integer |
Предполагаемое время путешествия автомобиля между двумя точками в минутах. |
Получение маршрута вождения между двумя точками
Получает маршрут автомобиля между двумя точками, предоставляя достаточную информацию для отрисовки его на карте, а также оценку длительности. В этом вызове предполагается, что всадник имеет автомобиль в точке начала и предоставляет маршрут автомобиля оттуда к конечной точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу автомобиля. Максимальное расстояние между началом и окончанием ограничено 1000 км для этой службы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение маршрута между двумя точками для сценария
Вычисляет маршруты между двумя точками на основе предоставленного сценария. В зависимости от сценария можно предоставить одну или несколько групп маршрутов. Каждая группа будет содержать несколько маршрутов. Каждый маршрут будет содержать одну или несколько ног.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор сценария
|
scenario_id | True | string |
Идентификатор сценария для направлений. |
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Time
|
time | string |
Время, используемое в качестве ограничения времени отъезда или прибытия при получении направлений. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
|
Тип времени
|
time_type | string |
Если задано значение time, это определяет, как будет использоваться время для ограничения возвращаемых направлений. Если это не указано, используется depart_approximate. Если "время" не задано, это не влияет. | значение | description | | ----- | ----------- | | прибыть | Маршруты выбираются, чтобы пользователь попал в место назначения или до "time" | | ушли | Направления выбираются при условии, что пользователь покидает свой источник как можно скорее после "time" | | depart_approximate | Похоже на "отъезд", но позволяя позже отъезда, чтобы вернуть более предпочтительнее варианты, даже если они покидают немного позже. Это способ выбора направлений по умолчанию в Citymapper, если время не указано | |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение маршрута мотор-скутера между двумя точками
Получает маршрут мотор-скутера между двумя точками, предоставляя достаточную информацию для отрисовки его на карте вместе с оценкой длительности. (Эти результаты оптимизированы для большего внутреннего горения или электрических скутеров, где всадник находится.) В этом вызове предполагается, что всадник имеет скутер в точке начала и предоставляет маршрут e-скутера оттуда к "конечной" точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу скутера, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с скутером. Этот звонок не включает никакой информации о охвате операторов скутера или зонах парковки, но другие вызовы услуг могут быть доступны для этого.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение маршрута такси между двумя точками
Получает маршрут такси между двумя точками. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Маршрут может содержать начальные и конечные ноги, если точки сбора или удаления не близки к запрошенным координатам начала и окончания. Службы в ответе будут отличаться в зависимости от локальной доступности, времени дня и, кроме того, интеграции служб такси настроены для вашей учетной записи. Существует два рекомендуемых способа использования этой службы: вы можете запросить маршрут такси с динамическими оценками услуг по запросу, включенными заранее, позвонив с "?fetch_on_demand_services=true".; или вы можете выполнить первоначальный запрос без получения оценок, которые будут отвечать на неактивных маршрутах, а затем немедленно вызвать "1/live/routeupdates", чтобы получить дополнительные динамические оценки. Первый подход проще, но второй может лучше соответствовать вашему варианту использования.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Получение локальных доменных служб
|
fetch_on_demand_services | string |
Если задано значение true, дополнительные сведения будут запрашиваться из интеграции службы такси, чтобы обеспечить более точные и полные цены, длительность и доступность служб, возвращенные в обновляемых подробностях ноги по запросу. Для этого необходимо передать места начала и окончания маршрута в эти сторонние службы, в том числе в том случае, если одно или другое является текущим или недавним расположением пользователя. Помните, что вам может потребоваться явное информированное согласие от конечного пользователя, чтобы задать это значение true в зависимости от применимых законов и правил. Если задано значение false или опущено, запросы к каким-либо сторонним службам не будут выполняться. |
|
|
Идентификаторы фирменной символики
|
brand_ids | array |
Разделенный запятыми список идентификаторов бренда, чтобы ограничить запрос на это направление. Если опущено (по умолчанию), все бренды, доступные вам, будут возвращены маршрут такси. |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение нанятого автокутер маршрута между двумя точками
Получает нанятый автомобильный скутер маршрут между двумя точками, в том числе любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. (Эти результаты оптимизированы для большего внутреннего горения или электрических скутеров, где всадник находится.) ЗАМЕТКА: Результирующий маршрут в настоящее время предполагает, что пользователь может ездить непосредственно в указанное "конечное" расположение, не учитывая какие-либо зоны парковки или покрытия. Таким образом, результирующий маршрут будет содержать только начальный этап "travel_mode" "прогулка" и второй этап "travel_mode" "self_piloted". В будущем обновление будет включать парковку и зоны покрытия и добавить окончательный "прогулка" ногу. Этот вызов можно использовать различными способами: используйте любой скутер указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает скутер указанного бренда, если это возможно. Использование скутера в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что скутер находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Идентификатор бренда
|
brand_id | True | string |
Идентификатор бренда скутеров, используемых для этого маршрута. Это необходимо для определения расположения доступных скутеров, а также любых связанных ограничений покрытия и парковки. |
|
Государство
|
ride_state | string |
Указывает, где находится пользователь по маршруту. Если опущено, используется walking_to_vehicle. Это свойство вместе с "current_location" позволяет получить обновленный маршрут, который отражает текущий ход выполнения пользователя через него. | значение | description | | ----- | ----------- | | walking_to_vehicle | Указывает, что пользователь идет для сбора транспортного средства | | езда | Указывает, что пользователь ездит на автомобиле | | walking_to_end | Указывает, что пользователь покинул транспортное средство и идет к месту назначения | |
|
|
Текущее расположение
|
current_location | string |
Текущее расположение пользователя для обновления маршрута в зависимости от расположения пользователя. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Этот параметр используется для получения обновленного маршрута, который отражает фактическое расположение пользователя, если он отступит от пути, заданного в маршруте. Если это указано, возвращенный маршрут будет содержать это расположение. Какая часть маршрута будет содержать это расположение, определяется значением параметра "ride_state". |
|
|
Начальная папка
|
ride_start_location | string |
Расположение используемого транспортного средства в начале поездки автомобиля по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо обеспечить, если "ride_state" является "ездой" или "walking_to_end". Если значение "ride_state" не указано "walking_to_vehicle" (или не указано), Citymapper попытается найти наиболее подходящий автомобиль, принадлежащий указанному "brand_id". Для совместимости "original_vehicle_location" — это псевдоним для этого параметра. |
|
|
Конечное расположение
|
ride_end_location | string |
Расположение транспортного средства было удалено в конце поездки автомобиля части поездки пользователя по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо указать, если "ride_state" имеет значение "walking_to_end". Во всех остальных состояниях этот параметр игнорируется. |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение нанятого велосипедного маршрута между двумя точками
Получает нанятый велосипедный маршрут между двумя точками, включая любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Этот вызов можно использовать различными способами: используйте любой велосипед указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает велосипед указанного бренда, если это возможно. Использование велосипеда в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что велосипед находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Идентификатор бренда
|
brand_id | True | string |
Идентификатор бренда велосипеда, используемого для этого маршрута. Это необходимо для определения расположения доступных велосипедов, а также любых связанных ограничений покрытия и парковки. |
|
Государство
|
ride_state | string |
Указывает, где находится пользователь по маршруту. Если опущено, используется walking_to_vehicle. Это свойство вместе с "current_location" позволяет получить обновленный маршрут, который отражает текущий ход выполнения пользователя через него. | значение | description | | ----- | ----------- | | walking_to_vehicle | Указывает, что пользователь идет для сбора транспортного средства | | езда | Указывает, что пользователь ездит на автомобиле | | walking_to_end | Указывает, что пользователь покинул транспортное средство и идет к месту назначения | |
|
|
Текущее расположение
|
current_location | string |
Текущее расположение пользователя для обновления маршрута в зависимости от расположения пользователя. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Этот параметр используется для получения обновленного маршрута, который отражает фактическое расположение пользователя, если он отступит от пути, заданного в маршруте. Если это указано, возвращенный маршрут будет содержать это расположение. Какая часть маршрута будет содержать это расположение, определяется значением параметра "ride_state". |
|
|
Начальная папка
|
ride_start_location | string |
Расположение используемого транспортного средства в начале поездки автомобиля по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо обеспечить, если "ride_state" является "ездой" или "walking_to_end". Если значение "ride_state" не указано "walking_to_vehicle" (или не указано), Citymapper попытается найти наиболее подходящий автомобиль, принадлежащий указанному "brand_id". Для совместимости "original_vehicle_location" — это псевдоним для этого параметра. |
|
|
Конечное расположение
|
ride_end_location | string |
Расположение транспортного средства было удалено в конце поездки автомобиля части поездки пользователя по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо указать, если "ride_state" имеет значение "walking_to_end". Во всех остальных состояниях этот параметр игнорируется. |
|
|
Profiles
|
profiles | string |
Указывает, какие профили используются при вычислении направлений велосипеда. Каждый профиль может создать другой вариант маршрута, поэтому запросы на дополнительные профили обычно дают больше параметров. Обратите внимание, что иногда некоторые из результирующего маршрута будут идентичными (в случае оптимального маршрута в нескольких способах), а профиль может не всегда давать маршрут. | значение | description | | ----- | ----------- | | тихая | Попытки использовать дороги с меньшим трафиком | | regular | Профиль по умолчанию балансирует трафик с прямой нагрузкой | | fast | Пытается найти самый короткий разумный маршрут | Если профили не указаны, будет использоваться "обычный". |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
|
|
Прошлые расположения
|
past_loc_coords | string |
Необязательный параметр для улучшения поведения перенаправки. Координаты до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Координаты должны находиться в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Должно быть хронологично упорядочено, последнее последнее. "past_loc_ages" и "past_loc_accuracies" должны быть предоставлены вместе. Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Прошлое расположение возрастов
|
past_loc_ages | string |
Необязательный параметр для улучшения поведения перенаправки. Возраст до 10 прошлых расположений пользователя в виде разделенного запятыми списка. Возраст должен находиться в целых секундах с текущего расположения. Должно быть хронологично упорядочено, последнее последнее. Необходимо предоставить past_loc_coords и "past_loc_accuracies". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Точность прошлых расположений
|
past_loc_accuracies | string |
Необязательный параметр для улучшения поведения перенаправки. Точность GPS до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Точность должна быть в целочисленных метрах. Должно быть хронологично упорядочено, последнее последнее. Необходимо указать past_loc_ages и "past_loc_coords". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение нанятых электронных скутер направлений между двумя точками
Получает нанятый маршрут скутера между двумя точками, включая любые начальные и окончательные прогулки. Результирующий маршрут предоставляет достаточно сведений для отрисовки на карте, а также оценки длительности. Эти результаты оптимизированы для небольших аккумуляторных скутеров, на которых всадник стоит. Этот вызов можно использовать различными способами: используйте любой скутер указанной торговой марки Это самый простой вызов, требующий только "start", "end" и "brand_id". Citymapper предполагает, что пользователь находится в точке начала и выбирает скутер указанного бренда, если это возможно. Использование скутера в указанном расположении Добавив "original_vehicle_location" в "start", "end" и "brand_id", Citymapper планирует маршрут, который предполагает, что скутер находится в заданном расположении. Обновление маршрута, выполняемого Чтобы получить обновленный маршрут, включающий повторное перенаправление из текущего расположения пользователя, если он разорван от запланированного маршрута, вызывающий объект может добавить свойства "current_location" и "ride_state", указывающие, какая нога результирующего маршрута должна быть перенаправлена вокруг current_location пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Идентификатор бренда
|
brand_id | True | string |
Идентификатор бренда электронных скутеров, используемых для этого маршрута. Это необходимо для определения расположения доступных скутеров, а также любых связанных ограничений покрытия и парковки. |
|
Государство
|
ride_state | string |
Указывает, где находится пользователь по маршруту. Если опущено, используется walking_to_vehicle. Это свойство вместе с "current_location" позволяет получить обновленный маршрут, который отражает текущий ход выполнения пользователя через него. | значение | description | | ----- | ----------- | | walking_to_vehicle | Указывает, что пользователь идет для сбора транспортного средства | | езда | Указывает, что пользователь ездит на автомобиле | | walking_to_end | Указывает, что пользователь покинул транспортное средство и идет к месту назначения | |
|
|
Текущее расположение
|
current_location | string |
Текущее расположение пользователя для обновления маршрута в зависимости от расположения пользователя. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Этот параметр используется для получения обновленного маршрута, который отражает фактическое расположение пользователя, если он отступит от пути, заданного в маршруте. Если это указано, возвращенный маршрут будет содержать это расположение. Какая часть маршрута будет содержать это расположение, определяется значением параметра "ride_state". |
|
|
Начальная папка
|
ride_start_location | string |
Расположение используемого транспортного средства в начале поездки автомобиля по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо обеспечить, если "ride_state" является "ездой" или "walking_to_end". Если значение "ride_state" не указано "walking_to_vehicle" (или не указано), Citymapper попытается найти наиболее подходящий автомобиль, принадлежащий указанному "brand_id". Для совместимости "original_vehicle_location" — это псевдоним для этого параметра. |
|
|
Конечное расположение
|
ride_end_location | string |
Расположение транспортного средства было удалено в конце поездки автомобиля части поездки пользователя по маршруту. Предоставляется в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Это необходимо указать, если "ride_state" имеет значение "walking_to_end". Во всех остальных состояниях этот параметр игнорируется. |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
|
|
Прошлые расположения
|
past_loc_coords | string |
Необязательный параметр для улучшения поведения перенаправки. Координаты до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Координаты должны находиться в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Должно быть хронологично упорядочено, последнее последнее. "past_loc_ages" и "past_loc_accuracies" должны быть предоставлены вместе. Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Прошлое расположение возрастов
|
past_loc_ages | string |
Необязательный параметр для улучшения поведения перенаправки. Возраст до 10 прошлых расположений пользователя в виде разделенного запятыми списка. Возраст должен находиться в целых секундах с текущего расположения. Должно быть хронологично упорядочено, последнее последнее. Необходимо предоставить past_loc_coords и "past_loc_accuracies". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Точность прошлых расположений
|
past_loc_accuracies | string |
Необязательный параметр для улучшения поведения перенаправки. Точность GPS до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Точность должна быть в целочисленных метрах. Должно быть хронологично упорядочено, последнее последнее. Необходимо указать past_loc_ages и "past_loc_coords". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение направлений e-скутера между двумя точками
Получает маршрут скутера между двумя точками, предоставляя достаточно информации для отрисовки его на карте вместе с оценкой длительности. (Эти результаты оптимизированы для небольших аккумуляторных скутеров, на которых всадник стоит.) В этом вызове предполагается, что всадник имеет скутер в точке начала и предоставляет маршрут e-скутера оттуда к "конечной" точке, если оба находятся в поддерживаемых районах Citymapper. Результирующий маршрут должен содержать одну ногу скутера, хотя свойство "path_annotations" ноги может указывать разделы, в течение которых пользователь должен ходить рядом с скутером. Этот звонок не включает никакой информации о охвате операторов скутера или зонах парковки, но другие вызовы услуг могут быть доступны для этого. Успешные ответы (HTTP-код "200") будут использовать один кредит "Скутер Маршрут" (или один кредит "Скутер Перенаправлять", если используется "reroute_signature" для каждого HTTP-ответа. Неудачные звонки не будут потреблять никаких кредитов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
|
|
Прошлые расположения
|
past_loc_coords | string |
Необязательный параметр для улучшения поведения перенаправки. Координаты до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Координаты должны находиться в формате WGS84 "широта,долгота". Координаты должны быть десятичными, и будут использоваться только первые 6 цифр точности. Должно быть хронологично упорядочено, последнее последнее. "past_loc_ages" и "past_loc_accuracies" должны быть предоставлены вместе. Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Прошлое расположение возрастов
|
past_loc_ages | string |
Необязательный параметр для улучшения поведения перенаправки. Возраст до 10 прошлых расположений пользователя в виде разделенного запятыми списка. Возраст должен находиться в целых секундах с текущего расположения. Должно быть хронологично упорядочено, последнее последнее. Необходимо предоставить past_loc_coords и "past_loc_accuracies". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
|
|
Точность прошлых расположений
|
past_loc_accuracies | string |
Необязательный параметр для улучшения поведения перенаправки. Точность GPS до 10 из прошлых расположений пользователя в виде разделенного запятыми списка. Точность должна быть в целочисленных метрах. Должно быть хронологично упорядочено, последнее последнее. Необходимо указать past_loc_ages и "past_loc_coords". Сервер будет рассматриваться не более 10 расположений, если указано более 10 расположений, то последние расположения будут игнорироваться. Сервер, скорее всего, игнорирует любые расположения старше 30 секунд или любое из них меньше 1 секунды. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение пешеходного маршрута между двумя точками
Получает маршрут ходьбы между двумя точками, предоставляя достаточную информацию для отрисовки его на карте, а также оценку длительности. Ожидается, что пешеходные маршруты имеют одну ногу с "travel_mode" "прогулки". Если Citymapper не может вычислить маршруты для этих точек (как правило, по причинам покрытия), служба вернет ответ "400". Максимальное расстояние между "start" и "end" ограничено 100 км для этой службы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Profiles
|
profiles | string |
Указывает, какие "профили" следует использовать при вычислении направлений ходьбы. Каждый профиль может создать другой вариант маршрута, поэтому запросы на дополнительные профили обычно дают больше параметров. Обратите внимание, что иногда некоторые из результирующего маршрута будут идентичными (в случае оптимального маршрута в нескольких способах), а профиль может не всегда давать маршрут. Не все профили будут доступны для всех начальных и конечных маршрутов. Недоступные профили будут опущены из ответа. | значение | description | | ----- | ----------- | | fast | Профиль по умолчанию пытается найти самый быстрый разумный маршрут | | main_roads | Попытки избежать обратных полос и парков | Если профили не указаны, будет использоваться функция fast. |
|
|
Перенаправка подписи
|
reroute_signature | string |
При повторной маршрутизации (запрос обновления на предыдущий ответ, который учитывает обновленное расположение пользователя), это значение должно быть задано в качестве подписи, указанной в исходном маршруте. Это позволяет более эффективно определять обновленный маршрут. Это значение должно быть закодировано URL-адресом. При предоставлении этого параметра необходимо задать расположение current_location (если применимо) или "start" в последнем расположении пользователя. Если этот параметр включен, Citymapper может не возвращать результаты в случаях, когда запрос значительно отличается от исходного, например, если расположение end отличается, или если с момента исходного запроса прошло более 1 часа. |
|
|
Начальный нести
|
start_bearing | integer |
Угол по часовой стрелке от Севера от 0 до 359, где север составляет 0 и восток составляет 90. Этот знак используется для влияния на текст начальной инструкции и (или) маршрутизацию, чаще всего, чтобы избежать того, чтобы пользователь попросил сделать u-turn, если продолжается на текущем сносе дает сопоставимый маршрут. Это должно быть указано только в том случае, если вы хотите повлиять на начальное направление путешествия для маршрута. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |
Получение сведений о динамическом отъезде и доступности для нескольких маршрутов
Это извлекает текущую и динамическую информацию об отъезде и динамическую цитату по запросу для нескольких маршрутов, полученных ранее из конечных точек "направления". С помощью этой службы можно обновить только маршруты, имеющие по крайней мере одну ногу с обновляемыми данными. Обратите внимание, что это не всегда возможно для Citymapper, чтобы предоставить текущее время или динамическую информацию о отъезде и нарушениях для ноги. Успешные ответы (HTTP-код 200) будут использовать один кредит Live Update для каждого HTTP-ответа. Неудачные звонки не будут потреблять никаких кредитов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Подписи
|
signatures | True | array of string |
Массив свойств сигнатуры из ранее полученных маршрутов |
|
Получение служб по запросу
|
fetch_on_demand_services | boolean |
При обновлении с помощью одной или нескольких подписей из маршрутов, содержащих ноги по запросу с обновляемыми сведениями (например, из службы "Маршруты такси"), если это значение равно true, дополнительные сведения будут запрашиваться из службы такси для получения более точной и полной цены, длительности и доступности служб. Чтобы обеспечить это, исходные расположения начала и окончания маршрута должны передаваться в эти сторонние службы, в том числе в том случае, если одно или другое является текущим или недавним расположением пользователя. Помните, что вам может потребоваться явное информированное согласие от конечного пользователя, чтобы задать это значение true в зависимости от применимых законов и правил. Если задано значение false или опущено, запросы к каким-либо сторонним службам не будут выполняться. Если обновление не может быть создано для ноги без заданного параметра true, ответ будет указывать на это в пределах обновляемой детали. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Обновления ног
|
route_updates.leg_updates | array of |
Это параллельный массив объектов Updatable Detail, по одному для каждой ноги в исходном маршруте, обновляемом. Те, которые соответствуют ходьбе ноги будут пустыми, но подробности, соответствующие транзитной ноге, будут содержать обновленные сведения об отъезде. |
|
Время вылета
|
route_updates.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута во время запроса. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
route_updates.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута во время запроса. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Продолжительность
|
route_updates.route_duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах. Это значение заменяет значение "duration_seconds" из исходного маршрута, так как оно будет перекомпилировано для использования определенных сведений об отъезде, содержащихся в ответе на обновление маршрута. Может быть опущен в редких случаях, когда длительность не может быть вычислена, например, если маршрут не может быть завершен в заданное время, так как задействованные службы не выполняются. |
|
ДлительностьAccuracy
|
route_updates.route_duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Подпись запроса
|
route_updates.request_signature | string |
Это маршрут "подпись" из запроса на обновление, который должен использоваться для связывания этого обновления с правильным маршрутом. |
Получение транзитного маршрута между двумя точками
Вычисляет несколько маршрутов общественного транспорта между двумя точками. По умолчанию результаты будут содержать до 5 маршрутов. Каждая из них будет содержать несколько ног: обычно один в начале и конце маршрута с "travel_mode" "прогулка", по крайней мере один с "travel_mode" "транзит" между ними.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Start
|
start | True | array |
Географическое начало маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Конец
|
end | True | array |
Географический конец маршрута в формате "широта,долгота" в формате WGS84. Координаты должны быть десятичными, и будут использоваться только первые 6 десятичных разрядов. |
|
Time
|
time | string |
Время, используемое в качестве ограничения времени отъезда или прибытия при получении направлений. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
|
Тип времени
|
time_type | string |
Если задано значение time, это определяет, как будет использоваться время для ограничения возвращаемых направлений. Если это не указано, используется depart_approximate. Если "время" не задано, это не влияет. | значение | description | | ----- | ----------- | | прибыть | Маршруты выбираются, чтобы пользователь попал в место назначения или до "time" | | ушли | Направления выбираются при условии, что пользователь покидает свой источник как можно скорее после "time" | | depart_approximate | Похоже на "отъезд", но позволяя позже отъезда, чтобы вернуть более предпочтительнее варианты, даже если они покидают немного позже. Это способ выбора направлений по умолчанию в Citymapper, если время не указано | |
|
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык конечного пользователя. При указании ответ будет содержать свойство "language", указывающее язык, используемый для любых локализованных элементов ответа (например, инструкции по повороту). Этот язык будет лучше всего пытаться выполнить выраженное предпочтение, но он может содержать значение, которое не было выражено в запросе (это обычно будет "en-US" как резервный вариант). Обратите внимание, что предпочтения языка обычно влияют только на содержимое, созданное Citymapper, например инструкции поворота. Внешнее содержимое, например имена остановки и описания состояния, обычно передаются на исходном языке. |
|
|
Лимит
|
limit | integer |
Максимальное количество возвращаемых маршрутов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Широта
|
routes.start.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.start.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Широта
|
routes.end.coordinates.lat | float |
Широта в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Долгота
|
routes.end.coordinates.lon | float |
Долгота в кодировке WGS84 с 6 цифрами десятичной точности. |
|
Расстояние в метрах
|
routes.distance_meters | integer |
Общее расстояние всего маршрута в метрах. |
|
Продолжительность
|
routes.duration_seconds | integer |
Общее предполагаемое время для обхода всего маршрута в секундах на основе выбранного транспортного средства или отъезда в ответе. |
|
Точность длительности
|
routes.duration_accuracy | string |
Оценка citymapper о том, как должен отображаться уровень точности duration_seconds для пользователя. Это в значительной степени основано на типе отъездов, используемых в течение времени, но он включает дополнительные эвристики, разработанные со временем для приложения Citymapper. Если это поле не указано, следует использовать значение "scheduled". | значение | description | | ----- | ----------- | | Оценка | Длительность, которую следует считать приблизительной, так как ее вычисление включало большую неопределенность, чем обычно. Это самая низкая точность. | | scheduled | Обычная продолжительность, как правило, на основе опубликованных сведений о расписании. | | live | Длительность в значительной степени основана на сведениях о вылете в режиме реального времени или в реальном времени. Это самая высокая точность. | |
|
Форматированные
|
routes.price.formatted | string |
Указанная цена как отформатированная строка. По умолчанию это в собственном формате валюты региона, где происходит маршрут. |
|
Сумма
|
routes.price.amount | string |
Цена в виде десятичного значения, закодированная в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Минимальный диапазон сумм
|
routes.price.amount_range_minimum | string |
Если эта цена представляет собой диапазон возможных значений, минимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. |
|
Максимальный диапазон сумм
|
routes.price.amount_range_maximum | string |
Если эта цена представляет собой диапазон возможных значений, максимальная цена в виде десятичного значения закодирована в виде строки, чтобы избежать проблем с точностью с плавающей запятой. Он не будет включать символы валюты, а разделитель между основными и незначительными единицами всегда будет "." независимо от региона. Это может не быть включено, если диапазон открыт. |
|
Валюта
|
routes.price.currency | string |
Валюта, в которой указана цена, в трехбуквеной форме ISO 4217. |
|
Умножение спроса
|
routes.price.demand_multipler | float |
Указывает, что цены выше, чем обычно из-за спроса, как правило, для ног такси (по запросу). В редких случаях может быть меньше 1,0 |
|
Выбросы CO2e
|
routes.emissions_grams_co2e | float |
Оценка выбросов парниковых газов маршрута, выраженная в граммах эквивалента углекислого газа (CO2e). |
|
Ноги
|
routes.legs | array of object |
Массив ног, состоящий из маршрута, в порядке, в котором они должны проходить. Каждый допустимый маршрут будет иметь по крайней мере один. |
|
Режим путешествия
|
routes.legs.travel_mode | string |
Режим перемещения. |
|
Продолжительность
|
routes.legs.duration_seconds | integer |
Время, необходимое для прохождения этой ноги, исключая любое время ожидания или посадки в начале. Может быть опущен в редких случаях, когда длительность не может быть вычислена. |
|
Путь
|
routes.legs.path | string |
Географический путь, который проходит по ногам, в виде ряда координат WGS84, закодированных в формате Google Polyline, с десятичной точностью 5 цифр. Например, значение "_flyHbjPDZBTBNDJ" кодирует следующие ряды координат (широты, долготы): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0,08915), (51.51334, -0.08921)] '' |
|
Инструкции
|
routes.legs.instructions | array of object |
Это содержит список инструкций по повороту, которые помогут пользователю перемещаться по ногам, например при ходьбе или использовании скутера или велосипеда. |
|
Индекс пути
|
routes.legs.instructions.path_index | integer |
0-й индекс в список координат, предоставляемых свойством path ноги. Это указывает расположение, в котором следует следовать инструкции, поэтому оно будет расположением поворота пути, или начала или конца ноги. |
|
Расстояние
|
routes.legs.instructions.distance_meters | integer |
Расстояние в метрах раздела "путь" до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Время в секундах, которое пользователь, как ожидается, будет проходить по разделу пути до этой инструкции. Это свойство будет опущено для начальных инструкций типа "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Описание инструкции пользователю в виде обычного текста. |
|
Формат описания
|
routes.legs.instructions.description_format | string |
Текстовый формат для отрисовки инструкции с выделенными элементами, где "{key}" указывает часть строки, которая должна быть заменена содержимым, определенным записью, соответствующей "ключ" в "description_format_replacements". Это позволяет элементам, описанным заменами, форматироваться по-разному клиентом при необходимости. Строки ключей будут содержать только символы [a-zA-Z0-9]. "{ }" не будет вложен, а литеральные символы "{" и "}" кодируются по escape-последовательности "{" и "}" соответственно. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Ключ, соответствующий строке, заключенной в "{}" в "description_format". |
|
Текст
|
routes.legs.instructions.description_format_replacements.text | string |
Текст, используемый для замены подстроки "{key}" в description_format. |
|
Тип
|
routes.legs.instructions.description_format_replacements.type | string |
Значение, указывающее, какой вид реальной вещи определяется заменой этого формата. Это позволяет клиентам служб применять форматирование для конкретного приложения при необходимости. | значение | description | | ----- | ----------- | | street_name | Имя улицы, дороги или другого пути | | exit_number | Число выходов, как правило, из круглого обхода | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Тег языка IETF BCP 47, указывающий, какой язык связан с текстом. Обратите внимание, что это может отличаться от языка окружающего описания- это наиболее распространено, когда замена является именем места на локальном языке, а описание находится на другом языке. |
|
Тип
|
routes.legs.instructions.type | string |
Указывает тип инструкции. |
|
Направление типа
|
routes.legs.instructions.type_direction | string |
Указывает направление, которое изменяет эту инструкцию. |
|
Время вылета
|
routes.route_departure_time | string |
Время, в котором Citymapper считает, что пользователь будет указан на этом маршруте, учитывая доступные сведения о отъезде. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
Время прибытия
|
routes.route_arrival_time | string |
Время, в течение которого Citymapper считает, что пользователь будет поступать в конце этого маршрута, учитывая доступные сведения о отъезде и ожидаемую скорость перемещения. Это вычисляется при условии, что пользователь находится в начале маршрута. Обновленные значения для "route_departure_time" и "route_arrival_time" возвращаются "service/1/live/routeupdates" для отражения всех обновленных сведений об отъезде. Время выражается в формате ISO 8601 , включая дату, время и часовой пояс, в котором происходит событие. Например, "2020-08-19T08:10:42-04:00" выражает 19 августа 2020 г. в 8:10 утра в Восточном дневном времени. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Идентификатор группы
|
routes.route_metadata.groups.group_id | string |
Идентификатор группы, в который содержится маршрут. |
|
Группа
|
routes.route_metadata.groups.group_name | string |
Локализованное имя группы маршрутов, например "Транзит" или "Le metro". |
|
Позиция маршрута
|
routes.route_metadata.groups.route_position | integer |
Отсчитываемая от нуля позиция маршрута в определенной группе. |
|
Имя профиля
|
routes.route_metadata.profile_name | string |
Читаемое человеком локализованное имя идентификатора профиля. |
|
Profile
|
routes.profile | string |
Указывает, какой профиль маршрутизации использовался для вычисления этого маршрута. Например, ответ от конечной точки маршрутизации велосипедов может возвращать несколько маршрутов, один с профилем "тихий" и другим с "быстрым" профилем. Обратите внимание, что новые значения можно добавлять в любое время, поэтому любой анализ кода этого поля должен иметь возможность обрабатывать непредвиденные значения. Это значение будет соответствовать параметру запроса "профили" на конечных точках, которые поддерживают выбор определенных профилей маршрутизации. Это значение предназначено только для чтения компьютера. Чтобы имя профиля отображалось пользователю, используйте profile_name в объекте "route_metadata". |
|
Signature
|
routes.signature | string |
Значение, которое необходимо передать серверу в последующих вызовах, чтобы ссылаться на этот маршрут (например, при запросе сведений о динамическом отъезде через "service/1/live/routeupdates"). Он должен рассматриваться как непрозрачное значение. |
|
Запрошено время
|
routes.requested_time | string |
Содержит параметр time, используемый в качестве ограничения времени отъезда или прибытия при получении направлений, если применимо. |
|
Запрошенный тип времени
|
routes.requested_time_type | string |
Содержит параметр "time_type", используемый для определения того, как будет использоваться время для ограничения возвращаемых направлений, если применимо. Если в запросе не задан параметр, возвращает значение "time_type", используемое по умолчанию для планирования маршрута. |
|
Language
|
language | string |
Тег языка IETF BCP 47, указывающий язык, используемый для кодирования локализуемого содержимого, например инструкции поворота в этом ответе. Это будет отражать лучшие усилия, чтобы выполнить любые предпочтения языка, выраженные параметром запроса "язык", или "en-US" как по умолчанию. |