Route - Get Route Directions

Ссылка

Service:: Maps

API Version:: 1.0

Используется для вычисления маршрута между заданным источником и назначением, проходящим через любые указанные маршрутные точки.

Get Route Directions API — это HTTP-запросGET, который возвращает маршрут между источником и назначением, проходящий через путевые точки, если они указаны. Маршрут учитывает такие факторы, как текущий трафик и типичная скорость дороги в запрошенный день недели и время суток.

Возвращаемые сведения включают расстояние, предполагаемое время в пути и представление геометрии маршрута. В зависимости от выбранных параметров также доступны дополнительные сведения о маршрутизации, такие как оптимизированный порядок точек или по очереди.

Служба маршрутизации предоставляет набор параметров для подробного описания модели потребления для конкретного транспортного средства. Дополнительные сведения см. в разделе Модель потребления.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.
api-version	query	True	string	Номер версии API Azure Maps
query	query	True	string	Координаты, по которым вычисляется маршрут, разделенные двоеточием. Требуется не менее двух координат. Первый — это источник, а последний — место назначения маршрута. Необязательные координаты между ними действуют как точки Пути в маршруте. Можно передать до 150 wayPoints.
accelerationEfficiency	query		number double	Указывает эффективность преобразования химической энергии, хранящейся в топливе, в кинетической энергии при ускорении транспортного средства (т. е. KineticХергеяГайн/ChemicalЯКонсуме). ChemicalХинергияConsumed получается путем преобразования израсходованного топлива в химическую энергию с использованием топливаХиденситиInMJoulesPerLiter. Должен быть связан с замедлениемэффициентности. Допустимый диапазон значений : от 0,0 до 1/decelerationEfficiency. Разумные значения : для модели горения : 0,33, для электрической модели : 0,66
alternativeType	query		AlternativeRouteType	Управляет оптимальностью в отношении заданных критериев планирования вычисляемых альтернатив по сравнению с эталонным маршрутом.
arriveAt	query		string date-time	Дата и время прибытия в точку назначения, отформатированные как `dateTime` значение, определенное в RFC 3339, раздел 5.6, с необязательным смещением часового пояса. Если смещение часового пояса не указано, оно будет считаться смещением конечной точки. Примеры: 12.19.2023 Г.16:39:57 12.2023.19T16:39:57-08:00 Параметр `arriveAt` нельзя использовать в сочетании с `departAt`, `minDeviationDistance` или `minDeviationTime`.
auxiliaryPowerInkW	query		number double	Указывает объем энергии, потребляемой для поддержки вспомогательных систем, в киловаттах (кВт). Его можно использовать для указания потребления за счет устройств и систем, таких как системы переменного тока, радио, отопления и т. д. Разумные значения: 1.7
auxiliaryPowerInLitersPerHour	query		number double	Указывает количество топлива, потребляемого для поддержки вспомогательных систем транспортного средства, в литрах в час. Его можно использовать для указания потребления за счет устройств и систем, таких как системы переменного тока, радио, отопления и т. д. Разумные значения: 0,2
avoid	query		RouteAvoidType[]	Указывает то, чего следует избегать при вычислении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах диапазона маршрутов не следует использовать значение alreadyUsedRoads.
computeBestOrder	query		boolean	Переупорядочение точек маршрута с помощью быстрого эвристического алгоритма, чтобы уменьшить длину маршрута. Дает наилучшие результаты при использовании в сочетании с routeType shortest. Обратите внимание, что источник и назначение исключаются из оптимизированных индексов точек пути. Чтобы включить источник и назначение в ответ, увеличьте все индексы на 1, чтобы учесть источник, а затем добавьте назначение в качестве конечного индекса. Возможными значениями могут быть true или false. Значение True вычисляет лучший порядок, если это возможно, но не допускается использовать в сочетании со значением maxAlternatives больше 0 или в сочетании с точками пути круга. Значение False будет использовать расположения в заданном порядке и не может использоваться в сочетании с routeRepresentation none.
computeTravelTimeFor	query		ComputeTravelTime	Указывает, следует ли возвращать дополнительное время в пути, используя различные типы сведений о дорожном движении (нет, исторические, динамические), а также оптимальное время поездки по умолчанию.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Задает зависящий от скорости компонент потребления. Предоставляется в виде неупорядоченного списка пар скорости и скорости потребления. В списке определяются точки на кривой потребления. Коэффициенты потребления скоростей, отсутствуют в списке, приведены следующим образом: путем линейной интерполяции, если заданная скорость находится между двумя скоростями в списке путем линейной экстраполяции, в противном случае предполагая константу (ΔConsumption/ΔSpeed), определяемую ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для одной и той же скорости. Если она содержит только одну точку, то коэффициент потребления этой точки используется без дальнейшей обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно потреблению предпоследней наибольшей скорости. Это гарантирует, что экстраполяция не приведет к отрицательным показателям потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в кВт/100 км) составляет от 0,01 до 100000,0. Разумные значения: 50,8.2:130,21,3 Этот параметр является обязательным для модели потребления электроэнергии.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Задает зависящий от скорости компонент потребления. Предоставляется в виде неупорядоченного списка пар скорости с разделителями двоеточием & скорости потребления. В списке определяются точки на кривой потребления. Коэффициенты потребления скоростей, отсутствуют в списке, приведены следующим образом: путем линейной интерполяции, если заданная скорость находится между двумя скоростями в списке путем линейной экстраполяции, в противном случае предполагая константу (ΔConsumption/ΔSpeed), определяемую ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для одной и той же скорости. Если она содержит только одну точку, то коэффициент потребления этой точки используется без дальнейшей обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно потреблению предпоследней наибольшей скорости. Это гарантирует, что экстраполяция не приведет к отрицательным показателям потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в l/100km) составляет от 0,01 до 100000,0. Разумные значения: 50,6,3:130,11,5 Примечание . Этот параметр является обязательным для модели потребления горения.
currentChargeInkWh	query		number double	Указывает текущую подачу электроэнергии в киловатт-часах (кВт/ч). Этот параметр существует вместе с параметром maxChargeInkWh . Допустимый диапазон значений — от 0,0 до maxChargeInkWh. Разумные значения: 43
currentFuelInLiters	query		number double	Указывает текущую подачу топлива в литрах. Разумные значения: 55
decelerationEfficiency	query		number double	Указывает эффективность преобразования кинетической энергии в сохраненное (не потребляемое) топливо, когда транспортное средство замедляется (т. е. Chemical EnergySaved/Kinetic EnergyLost). Chemical EnergySaved получается путем преобразования сохраненного (не израсходованного) топлива в энергию с использованием топливаХериденситиInMJoulesPerLiter. Должен быть связан с ускорениемЭффициентность. Допустимый диапазон значений: от 0,0 до 1/accelerationEfficiency. Разумные значения: для модели горения : 0,83, для электрической модели : 0,91
departAt	query		string date-time	Дата и время отправления от точки начала, отформатированные в виде `dateTime` значения, как определено в RFC 3339, раздел 5.6, с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это смещение исходной точки. Значение по умолчанию: now Другое значение: `dateTime` Примеры: 12.19.2023 Г.16:39:57 12.2023.19T16:39:57-08:00 Параметр `departAt` нельзя использовать в сочетании с `arriveAt`.
downhillEfficiency	query		number double	Указывает эффективность преобразования потенциальной энергии в сэкономленное (не потребляемое) топливо, когда транспортное средство теряет высоту (т. е. Chemical EnergySaved/PotentialИнергияLost). Chemical EnergySaved получается путем преобразования сохраненного (не израсходованного) топлива в энергию с использованием топливаХериденситиInMJoulesPerLiter. Должен быть связан с uphillEfficiency. Допустимый диапазон значений: от 0,0 до 1/uphillEfficiency. Разумные значения: для модели горения : 0,51, для электрической модели : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Указывает количество химической энергии, хранящейся в одном литре топлива в мегаджоулях (MJ). Он используется в сочетании с *параметрами Эффективности для преобразований между сэкономленной или потребляемой энергией и топливом. Например, плотность энергии составляет 34,2 МДж/л для бензина и 35,8 МДж/л для дизельного топлива. Этот параметр является обязательным, если задан какой-либо параметр Efficiency* . Разумные значения: 34.2
hilliness	query		InclineLevel	Степень холмистости для захватывающего маршрута. Этот параметр можно использовать только в сочетании с `routeType`=thrilling.
instructionsType	query		RouteInstructionsType	Если этот параметр указан, будут возвращены инструкции. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.
language	query		string	Параметр language определяет язык сообщений руководства. Правильные существительные (названия улиц, площадей и т. д.) возвращаются на указанном языке или, если это недоступно, они возвращаются на доступном языке, близком к нему. Допустимыми значениями являются (подмножество) языковых тегов IETF. Поддерживаемые языки перечислены в разделе Поддерживаемые языки. Значение по умолчанию: en-GB
maxAlternatives	query		integer	Число требуемых альтернативных маршрутов для вычисления. По умолчанию: 0, минимум: 0 и максимум: 5
maxChargeInkWh	query		number double	Указывает максимальную подачу электроэнергии в киловатт-часах (кВт/ч), которая может храниться в аккумуляторе транспортного средства. Этот параметр со-существует с параметром currentChargeInkWh . Минимальное значение должно быть больше или равно currentChargeInkWh. Разумные значения: 85
minDeviationDistance	query		integer	Все возвращаемые альтернативные маршруты будут следовать ссылочным маршрутом (см. раздел Запросы POST) из исходной точки запроса calculateRoute по крайней мере для этого количества метров. Может использоваться только при восстановлении маршрута. Параметр minDeviationDistance нельзя использовать в сочетании с arriveAt.
minDeviationTime	query		integer	Все возвращаемые альтернативные маршруты будут следовать за эталонным маршрутом (см. раздел Запросы POST) из исходной точки запроса calculateRoute в течение по крайней мере этого количества секунд. Может использоваться только при восстановлении маршрута. Параметр minDeviationTime нельзя использовать в сочетании с arriveAt. По умолчанию установлено значение 0. Установка значения больше нуля для параметра )minDeviationTime_ приводит к следующим последствиям: Исходная точка запроса calculateRoute должна находиться на входном эталонном маршруте (или очень близко) к ней. Если это не так, возвращается ошибка. Однако точка начала не обязательно должна находиться в начале входного эталонного маршрута (ее можно рассматривать как текущую позицию транспортного средства на эталонном маршруте). Ссылочный маршрут, возвращаемый в качестве первого маршрута в ответе calculateRoute , будет начинаться с точки источника, указанной в запросе calculateRoute . Начальная часть входной ссылки маршрут до точки начала будет исключена из ответа. Значения minDeviationDistance и minDeviationTime определяют, насколько далеко альтернативные маршруты будут гарантированно следовать ссылочному маршруту от исходной точки и далее. Маршрут должен использовать тип departAt. Параметр vehicleHeading игнорируется.
report	query		Report	Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — effectiveSettings. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию значение по умолчанию будет отражаться там, где параметр не был указан вызывающим объектом.
routeRepresentation	query		RouteRepresentationForBestOrder	Указывает представление набора маршрутов, предоставленных в качестве ответа. Это значение параметра можно использовать только в сочетании с computeBestOrder=true.
routeType	query		RouteType	Тип запрошенного маршрута.
sectionType	query		SectionType	Указывает, какой из типов разделов указывается в ответе маршрута. Например, если sectionType = пешеход, возвращаются разделы, которые подходят только для пешеходов. Можно использовать несколько типов. Значение по умолчанию sectionType относится к входным данным travelMode. По умолчанию travelMode имеет значение car
traffic	query		boolean	Возможные значения: true — учитывайте все доступные сведения о трафике во время маршрутизации. false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные о дорожном движении игнорируются во время маршрутизации, влияние исторического трафика на эффективную скорость дорожного движения по-прежнему учитывается.
travelMode	query		TravelMode	Режим перемещения для запрошенного маршрута. Если значение не определено, по умолчанию используется значение "car". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "other". Обратите внимание, что режимы поездки автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные об ограничениях доступны не во всех областях.
uphillEfficiency	query		number double	Указывает эффективность преобразования химической энергии, хранящейся в топливе, в потенциальную энергию, когда транспортное средство получает высоту (т. е. PotentialЯGained/ChemicalИкеконсуме). ChemicalХинергияConsumed получается путем преобразования израсходованного топлива в химическую энергию с использованием топливаХиденситиInMJoulesPerLiter. Должен быть связан с downhillEfficiency. Допустимый диапазон значений : от 0,0 до 1/downhillEfficiency. Разумные значения: для модели горения : 0,27, для электрической модели : 0,74
vehicleAxleWeight	query		integer	Вес на оси транспортного средства в кг. Значение 0 означает, что ограничения веса на оси не учитываются.
vehicleCommercial	query		boolean	Используется ли транспортное средство в коммерческих целях. Коммерческие транспортные средства могут быть запрещены для вождения по некоторым дорогам.
vehicleEngineType	query		VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна соответствовать значению vehicleEngineType.
vehicleHeading	query		integer	Направление движения транспортного средства в градусах, начиная с истинного севера и продолжающегося по часовой стрелке. Север 0 градусов, восток 90 градусов, юг 180 градусов, запад 270 градусов. Возможные значения от 0 до 359
vehicleHeight	query		number double	Высота транспортного средства в метрах. Значение 0 означает, что ограничения по высоте не учитываются.
vehicleLength	query		number double	Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType	query		VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и запрещены с некоторых дорог. Доступные значения vehicleLoadType — это классы 1–9 US Hazmat, а также универсальные классификации для использования в других странах или регионах. Значения, начинающиеся с USHazmat, предназначены для маршрутизации в США, тогда как otherHazmat следует использовать для всех остальных стран и регионов. vehicleLoadType можно указать несколько раз. В настоящее время этот параметр учитывается только для travelMode=truck.
vehicleMaxSpeed	query		integer	Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверка, разрешено ли транспортное средство на автомагистралях. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Ненулевое значение может быть переопределено во время планирования маршрута. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства установлена в 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства составляет 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
vehicleWeight	query		integer	Вес транспортного средства в килограммах. Это обязательно, если задан какой-либо из параметров Efficiency. Он должен быть строго положительным при использовании в контексте модели потребления. Учитываются ограничения веса. Если не указана подробная модель потребления* и значение vehicleWeight не равно нулю, учитываются ограничения по весу. Во всех остальных случаях этот параметр игнорируется. Разумные значения: для модели горения : 1600, для электрической модели : 1900
vehicleWidth	query		number double	Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
windingness	query		WindingnessLevel	Уровень поворотов для захватывающего маршрута. Этот параметр можно использовать только в сочетании с `routeType`параметром =thrilling.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	RouteDirections	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при Create учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Successfully retrieve a route between an origin and a destination

Sample Request

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Определения

Имя	Описание
AlternativeRouteType	Управляет оптимальностью в отношении заданных критериев планирования вычисляемых альтернатив по сравнению с эталонным маршрутом.
ComputeTravelTime	Указывает, следует ли возвращать дополнительное время в пути, используя различные типы сведений о дорожном движении (нет, исторические, динамические), а также оптимальное время поездки по умолчанию.
DelayMagnitude	Величина задержки, вызванной инцидентом. Эти значения соответствуют значениям поля ответа ty API получения сведений об инциденте дорожного движения.
DrivingSide	Указывает на левую и правую сторону вождения в точке маневра.
EffectiveSetting	Действующий параметр или данные, используемые при вызове этого API маршрута.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GuidanceInstructionType	Тип инструкции, например поворот или изменение формы дороги.
GuidanceManeuver	Код, определяющий маневр.
InclineLevel	Степень холмистости для захватывающего маршрута. Этот параметр можно использовать только в сочетании с `routeType`параметром =thrilling.
JunctionType	Тип соединения, на котором выполняется маневр. Для больших круговых переходов создаются две отдельные инструкции для входа и выхода из круговой развязки.
LatLongPair	Расположение, представленное в виде широты и долготы.
Report	Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — effectiveSettings. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию значение по умолчанию будет отражаться там, где параметр не был указан вызывающим объектом.
ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.
ResponseSectionType	Типы разделов ответа сообщаемого маршрута
ResponseTravelMode	Режим перемещения для вычисляемого маршрута. Если запрошенный вид транспорта не поддерживается в этом разделе, будет задано `other` значение .
Route
RouteAvoidType	Указывает то, чего следует избегать при вычислении маршрута при определении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах диапазона маршрутов не следует использовать значение alreadyUsedRoads.
RouteDirections	Этот объект возвращается из успешного вызова маршрутных маршрутов
RouteGuidance	Содержит элементы, связанные с руководством. Это поле присутствует только в том случае, если было запрошено руководство и доступно.
RouteInstruction	Набор атрибутов, описывающих маневр, например "Повернуть вправо", "Сохранить влево", "Возьмите паром", "Возьмите автомагистраль", "Приезжаете".
RouteInstructionGroup	Группы последовательность элементов инструкций, связанных друг с другом. Диапазон последовательностей ограничен значениями firstInstructionIndex и lastInstructionIndex. Если в текстовых сообщениях, доступных для чтения человеком, запрашиваются инструкции (instructionType=text или помечены тегами), то в группе инструкций возвращается сводное сообщение, если доступно.
RouteInstructionsType	Если этот параметр указан, будут возвращены инструкции. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.
RouteLeg	Описание части маршрута, состоящей из списка точек. Каждая дополнительная точка пути, указанная в запросе, приведет к созданию дополнительного этапа в возвращенном маршруте.
RouteLegSummary	Объект Summary для раздела маршрута.
RouteOptimizedWaypoint	Оптимизированный объект точки пути.
RouteReport	Сообщает действующие параметры, используемые в текущем вызове.
RouteRepresentationForBestOrder	Указывает представление набора маршрутов, предоставленных в качестве ответа. Это значение параметра можно использовать только в сочетании с computeBestOrder=true.
RouteSection	Разделы маршрутов содержат дополнительные сведения об частях маршрута. Каждый раздел содержит по крайней мере элементы `startPointIndex`, `endPointIndex`и `sectionType`.
RouteSectionTec	Сведения о событии трафика с использованием определений в стандарте TPEG2-TEC . Может содержать effectCode и вызывает элементы.
RouteSectionTecCause	Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.
RouteSummary	Объект Summary
RouteType	Тип запрошенного маршрута.
SectionType	Указывает, какой из типов разделов указывается в ответе маршрута. Например, если sectionType = пешеход, возвращаются разделы, которые подходят только для пешеходов. Можно использовать несколько типов. Значение по умолчанию sectionType относится к входным данным travelMode. По умолчанию travelMode имеет значение car
SimpleCategory	Тип инцидента. В настоящее время может иметь значение JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе tec.
TravelMode	Режим перемещения для запрошенного маршрута. Если значение не определено, значение по умолчанию — "car". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "other". Обратите внимание, что режимы перемещения автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные об ограничениях доступны не во всех областях.
VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна соответствовать значению vehicleEngineType.
VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены с некоторых дорог. Доступные значения vehicleLoadType — это классы Hazmat для США с 1 по 9, а также универсальные классификации для использования в других странах и регионах. Значения, начинающиеся с USHazmat, предназначены для маршрутизации в США, а для всех остальных стран и регионов следует использовать otherHazmat. vehicleLoadType можно указать несколько раз. В настоящее время этот параметр учитывается только для travelMode=truck.
WindingnessLevel	Уровень поворотов для захватывающего маршрута. Этот параметр можно использовать только в сочетании с `routeType`параметром =thrilling.

AlternativeRouteType

Управляет оптимальностью в отношении заданных критериев планирования вычисляемых альтернатив по сравнению с эталонным маршрутом.

Имя	Тип	Описание
anyRoute	string	Разрешите возврат любого альтернативного маршрута независимо от того, как он сравнивается с эталонным маршрутом с точки зрения оптимальности.
betterRoute	string	Возвращайте альтернативный маршрут, только если он лучше, чем ссылочный маршрут в соответствии с заданными критериями планирования.

ComputeTravelTime

Указывает, следует ли возвращать дополнительное время в пути, используя различные типы сведений о дорожном движении (нет, исторические, динамические), а также оптимальное время поездки по умолчанию.

Имя	Тип	Описание
all	string	Вычисляет время поездки для всех типов сведений о дорожном движении и задает все результаты в полях noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds и liveTrafficIncidentsTravelTimeInSeconds, включенных в сводки в ответе маршрута.
none	string	Не вычисляет дополнительное время в пути.

DelayMagnitude

Величина задержки, вызванной инцидентом. Эти значения соответствуют значениям поля ответа ty API получения сведений об инциденте дорожного движения.

Имя	Тип	Описание
0	string	Неизвестна.
1	string	Незначительное.
2	string	Умеренная.
3	string	Основное.
4	string	Неопределенный, используется для закрытия дорог и других неопределенных задержек.

DrivingSide

Указывает на левую и правую сторону вождения в точке маневра.

Имя	Тип	Описание
LEFT	string	Левая сторона.
RIGHT	string	Справа.

EffectiveSetting

Действующий параметр или данные, используемые при вызове этого API маршрута.

Имя	Тип	Описание
key	string	Имя используемого параметра.
value	string	Значение используемого параметра.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GuidanceInstructionType

Тип инструкции, например поворот или изменение формы дороги.

Имя	Тип	Описание
DIRECTION_INFO	string	Сведения о направлении.
LOCATION_ARRIVAL	string	Место прибытия.
LOCATION_DEPARTURE	string	Место отправления.
LOCATION_WAYPOINT	string	Расположение точки пути.
ROAD_CHANGE	string	Изменение дороги.
TURN	string	Свою очередь.

GuidanceManeuver

Код, определяющий маневр.

Имя	Тип	Описание
ARRIVE	string	Ты приехала.
ARRIVE_LEFT	string	Ты приехала. Место назначения находится слева.
ARRIVE_RIGHT	string	Ты приехала. Ваш пункт назначения находится справа.
BEAR_LEFT	string	Медведь ушел.
BEAR_RIGHT	string	Мишка права.
DEPART	string	Оставить.
ENTER_FREEWAY	string	Поехав на автостраде.
ENTER_HIGHWAY	string	Возьмите шоссе.
ENTER_MOTORWAY	string	Возьмите автомагистраль.
ENTRANCE_RAMP	string	Возьмите пандус.
FOLLOW	string	Следовать.
KEEP_LEFT	string	Держите влево.
KEEP_RIGHT	string	Держите право.
MAKE_UTURN	string	Сделайте разворот.
MOTORWAY_EXIT_LEFT	string	Выберите левый выход.
MOTORWAY_EXIT_RIGHT	string	Возьмите правильный выход.
ROUNDABOUT_BACK	string	Объехав кольцевую развязку.
ROUNDABOUT_CROSS	string	Пересечь кольцевую развязку.
ROUNDABOUT_LEFT	string	На кольцевой развязке выйти слева.
ROUNDABOUT_RIGHT	string	На кольцевой развязке выйдите справа.
SHARP_LEFT	string	Поворот влево.
SHARP_RIGHT	string	Поворот вправо.
STRAIGHT	string	Держите прямо.
SWITCH_MAIN_ROAD	string	Переключитесь на main дорогу.
SWITCH_PARALLEL_ROAD	string	Переключитесь на параллельную дорогу.
TAKE_EXIT	string	Выход.
TAKE_FERRY	string	Возьмите паром.
TRY_MAKE_UTURN	string	Попробуйте сделать разворот.
TURN_LEFT	string	Поверните влево.
TURN_RIGHT	string	Поверните вправо.
WAYPOINT_LEFT	string	Вы достигли точки пути. Это слева.
WAYPOINT_REACHED	string	Вы достигли точки пути.
WAYPOINT_RIGHT	string	Вы достигли точки пути. Это справа.

InclineLevel

Степень холмистости для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeTypeпараметром =thrilling.

Имя	Тип	Описание
high	string	high
low	string	low
normal	string	нормальный

JunctionType

Тип соединения, на котором выполняется маневр. Для больших круговых переходов создаются две отдельные инструкции для входа и выхода из круговой развязки.

Имя	Тип	Описание
BIFURCATION	string	Бифуркации
REGULAR	string	обычный
ROUNDABOUT	string	Круговой перекресток

LatLongPair

Расположение, представленное в виде широты и долготы.

Имя	Тип	Описание
latitude	number	Свойство Latitude
longitude	number	Свойство Долгота

Report

Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — effectiveSettings. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию значение по умолчанию будет отражаться там, где параметр не был указан вызывающим объектом.

Имя	Тип	Описание
effectiveSettings	string	Сообщает действующие параметры или данные, используемые при вызове API.

ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript
xml	string	Язык расширяемой разметки

ResponseSectionType

Типы разделов ответа сообщаемого маршрута

Имя	Тип	Описание
CARPOOL	string	Разделы маршрута, требующие использования карпуля (HOV/High Заполненный автомобиль) полосы движения.
CAR_TRAIN	string	Разделы маршрута, которые являются автомобилями или поездами.
COUNTRY	string	Разделы, указывающие, в каких странах или регионах находится маршрут.
FERRY	string	Разделы маршрута, которые являются паромами.
MOTORWAY	string	Участки маршрута, которые являются автомагистралями.
PEDESTRIAN	string	Участки маршрута, которые подходят только для пешеходов.
TOLL_ROAD	string	Разделы маршрута, требующие оплаты.
TOLL_VIGNETTE	string	Разделы маршрута, требующие наличия платной виньетки.
TRAFFIC	string	Разделы маршрута, содержащие сведения о дорожном движении.
TRAVEL_MODE	string	Разделы по отношению к параметру `travelMode`запроса .
TUNNEL	string	Разделы маршрута, которые являются туннелями.
URBAN	string	Разделы маршрута, расположенные в пределах городских районов.

ResponseTravelMode

Режим перемещения для вычисляемого маршрута. Если запрошенный вид транспорта не поддерживается в этом разделе, будет задано other значение .

Имя	Тип	Описание
bicycle	string	Возвращаемые маршруты оптимизированы для велосипедов, включая использование велосипедных дорожек.
bus	string	Возвращаемые маршруты оптимизированы для автобусов, включая использование только автобусных полос. Функции БЕТА-версии.
car	string	Возвращаемые маршруты оптимизированы для автомобилей.
motorcycle	string	Возвращаемые маршруты оптимизированы для мотоциклов. Функции БЕТА-версии.
other	string	Данный вид транспорта не поддерживается в этом разделе
pedestrian	string	Возвращаемые маршруты оптимизированы для пешеходов, включая использование тротуаров.
taxi	string	Возвращаемые маршруты оптимизированы для такси. Функции БЕТА-версии.
truck	string	Возвращаемые маршруты оптимизированы для коммерческих транспортных средств, например для грузовиков.
van	string	Возвращаемые маршруты оптимизированы для фургонов. Функции БЕТА-версии.

Route

Имя	Тип	Описание
guidance	RouteGuidance	Содержит элементы, связанные с руководством. Это поле присутствует только в том случае, если было запрошено руководство и доступно.
legs	RouteLeg[]	Массив Ног
sections	RouteSection[]	Массив разделов
summary	RouteSummary	Объект Summary

RouteAvoidType

Указывает то, чего следует избегать при вычислении маршрута при определении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах диапазона маршрутов не следует использовать значение alreadyUsedRoads.

Имя	Тип	Описание
alreadyUsedRoads	string	Избегает использования одной и той же дороги несколько раз. Наиболее полезно в сочетании с `routeType`=захватывающим.
borderCrossings	string	Избегает пересечений границ при расчете маршрута.
carpools	string	Избегает маршрутов, требующих использования полос движения карпуля (HOV/High Occupancy Vehicle).
ferries	string	Избегает паромов
motorways	string	Избегает автомагистралей
tollRoads	string	Избегает платных дорог.
unpavedRoads	string	Избегает грунтовой дороги

RouteDirections

Этот объект возвращается из успешного вызова маршрутных маршрутов

Имя	Тип	Описание
formatVersion	string	Свойство Format Version
optimizedWaypoints	RouteOptimizedWaypoint[]	Оптимизированная последовательность путевых точек. Он показывает индекс из предоставленной пользователем последовательности путевых точек для исходного и оптимизированного списка. Например, ответ: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` означает, что исходная последовательность [0, 1, 2], а оптимизированная последовательность — [1, 2, 0]. Так как индекс начинается с 0, оригинал имеет значение "first, second, third", а оптимизированный — "second, third, first".
report	RouteReport	Сообщает действующие параметры, используемые в текущем вызове.
routes	Route[]	Массив маршрутов

RouteGuidance

Содержит элементы, связанные с руководством. Это поле присутствует только в том случае, если было запрошено руководство и доступно.

Имя	Тип	Описание
instructionGroups	RouteInstructionGroup[]	Группы последовательность элементов инструкций, которые связаны друг с другом.
instructions	RouteInstruction[]	Список инструкций, описывающих маневры.

RouteInstruction

Набор атрибутов, описывающих маневр, например "Повернуть вправо", "Сохранить влево", "Возьмите паром", "Возьмите автомагистраль", "Приезжаете".

Имя	Тип	Описание
combinedMessage	string	Понятное сообщение для маневра в сочетании с сообщением из следующей инструкции. Иногда можно объединить две последовательные инструкции в одну инструкцию, что упрощает их выполнение. В этом случае флаг possibleCombineWithNext будет иметь значение true. Пример: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` Флаг possibleCombineWithNext в инструкции 10 имеет значение true. Это указывает клиентам закодированного руководства, что его можно объединить с инструкцией 11. Инструкции будут автоматически объединены для клиентов, запрашивающих удобочитаемые инструкции. Поле combinedMessage содержит объединенное сообщение: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3-символьный код страны ISO 3166-1 alpha-3. Например, США.
drivingSide	DrivingSide	Указывает, что левая и правая сторона вождения в точке маневра.
exitNumber	string	Номера выезда на шоссе, принятые текущим маневром. Если выход имеет несколько номеров выхода, они будут разделены "", и, возможно, агрегированы "-", например, "10, 13-15".
instructionType	GuidanceInstructionType	Тип инструкции, например поворот или изменение дорожной формы.
junctionType	JunctionType	Тип соединения, на котором выполняется маневр. Для больших кругов создаются две отдельные инструкции для входа и выхода из круговой развязки.
maneuver	GuidanceManeuver	Код, определяющий маневр.
message	string	Понятное сообщение для маневра.
point	LatLongPair	Расположение, представленное в виде широты и долготы.
pointIndex	integer	Индекс точки в списке ломаных "точек", соответствующих точке инструкции.
possibleCombineWithNext	boolean	При необходимости можно объединить инструкцию со следующей. Его можно использовать для создания таких сообщений, как "Повернуть налево, а затем повернуть направо".
roadNumbers	string[]	Номера дорог следующего важного сегмента дороги после маневра или дороги, за которыми следует следить. Пример: ["E34", "N205"]
roundaboutExitNumber	string	Это указывает, какой выход следует принять при кольцевой развязке.
routeOffsetInMeters	integer	Расстояние от начала маршрута до точки инструкции.
signpostText	string	Текст на указателе, наиболее релевантный для маневра или направления, за которым следует следовать.
stateCode	string	Подразделение (например, штат) страны, представленное второй частью кода ISO 3166-2 . Эта возможность доступна только для некоторых стран и регионов, таких как США, Канада и Мексика.
street	string	Название улицы следующего значительного сегмента дороги после маневра, или улицы, за которой следует следовать.
travelTimeInSeconds	integer	Предполагаемое время в пути до точки, соответствующей routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Указывает направление инструкции. Если параметр junctionType указывает на инструкцию поворота: 180 = разворот [-179, -1] = левый поворот 0 = прямо в (поворот на 0 градусов) [1, 179] = Поворот вправо Если параметр junctionType указывает на инструкцию бифуркации: <0 — оставить слева >0 — оставить право

RouteInstructionGroup

Группы последовательность элементов инструкций, связанных друг с другом. Диапазон последовательностей ограничен значениями firstInstructionIndex и lastInstructionIndex. Если в текстовых сообщениях, доступных для чтения человеком, запрашиваются инструкции (instructionType=text или помечены тегами), то в группе инструкций возвращается сводное сообщение, если доступно.

Имя	Тип	Описание
firstInstructionIndex	integer	Индекс первой инструкции в инструкциях и принадлежности к этой группе.
groupLengthInMeters	integer	Длина группы.
groupMessage	string	Сводное сообщение, когда текстовые сообщения, доступные для чтения человеком, запрашиваются для указания (instructionType=text или помеченные тегами).
lastInstructionIndex	integer	Индекс последней инструкции в инструкциях и принадлежности к этой группе.

RouteInstructionsType

Если этот параметр указан, будут возвращены инструкции. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.

Имя Тип Описание

coded

Имя	Тип	Описание
coded	string	Возвращает необработанные данные инструкций без сообщений, доступных для чтения человеком.
tagged	string	Возвращает необработанные данные инструкций с тегами сообщения, доступные для чтения человеком, чтобы разрешить форматирование. Удобочитаемое сообщение создается из повторяемых идентифицируемых элементов. Они помечены тегами, чтобы клиентские приложения могли правильно форматировать их. Следующие компоненты сообщения помечены, когда instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Пример сообщения с тегом "Повернуть влево": `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Возвращает необработанные данные инструкций с сообщениями, читаемыми человеком, в виде обычного текста.

string

Возвращает необработанные данные инструкций без сообщений, доступных для чтения человеком.

tagged

string

Возвращает необработанные данные инструкций с тегами сообщения, доступные для чтения человеком, чтобы разрешить форматирование. Удобочитаемое сообщение создается из повторяемых идентифицируемых элементов. Они помечены тегами, чтобы клиентские приложения могли правильно форматировать их. Следующие компоненты сообщения помечены, когда instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Пример сообщения с тегом "Повернуть влево":

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

text

string

Возвращает необработанные данные инструкций с сообщениями, читаемыми человеком, в виде обычного текста.

RouteLeg

Описание части маршрута, состоящей из списка точек. Каждая дополнительная точка пути, указанная в запросе, приведет к созданию дополнительного этапа в возвращенном маршруте.

Имя	Тип	Описание
points	LatLongPair[]	Массив точек
summary	RouteLegSummary	Объект Summary для раздела маршрута.

RouteLegSummary

Объект Summary для раздела маршрута.

Имя	Тип	Описание
arrivalTime	string	Предполагаемое время прибытия для маршрута или этапа. Время указывается в формате UTC.
batteryConsumptionInkWh	number	Оценка потребления электроэнергии в киловатт-часах (кВт/ч) с использованием модели потребления электроэнергии. Включается, если для vehicleEngineType задано значение electric и задано значение constantSpeedConsumptionInkWhPerHundredkm. Значение batteryConsumptionInkWh включает в себя выручаемую электрическую энергию и, следовательно, может быть отрицательной (что указывает на получение энергии). Если указаны значения maxChargeInkWh и currentChargeInkWh, восстановление будет ограничено, чтобы уровень заряда батареи никогда не превышал maxChargeInkWh. Если ни maxChargeInkWh, ни currentChargeInkWh не указаны, при вычислении потребления предполагается неограниченное восстановление.
departureTime	string	Предполагаемое время отправления маршрута или участка. Время указывается в формате UTC.
fuelConsumptionInLiters	number	Предполагаемый расход топлива в литрах с использованием модели потребления горения. Включается, если для vehicleEngineType задано значениести сгорания и задан параметр constantSpeedConsumptionInLitersPerHundredkm. Значение будет не отрицательным.
historicTrafficTravelTimeInSeconds	integer	Предполагаемое время в пути, рассчитанное на основе данных о дорожном движении, зависящих от времени. Включается только в том случае, если в запросе используется параметр computeTravelTimeFor = all.
lengthInMeters	integer	Свойство Length In Meter
liveTrafficIncidentsTravelTimeInSeconds	integer	Предполагаемое время в пути, вычисленное на основе данных о скорости в режиме реального времени. Включается только в том случае, если в запросе используется параметр computeTravelTimeFor = all.
noTrafficTravelTimeInSeconds	integer	Предполагаемое время в пути рассчитывается так, как если бы на маршруте не было задержек из-за условий движения (например, заторов). Включается только в том случае, если в запросе используется параметр computeTravelTimeFor = all.
trafficDelayInSeconds	integer	Предполагаемая задержка в секундах, вызванная инцидентами в режиме реального времени в соответствии с информацией о дорожном движении. Для маршрутов, запланированных со временем отправления в будущем, задержки всегда равно 0. Чтобы вернуть дополнительное время поездки с использованием различных типов сведений о трафике, необходимо добавить параметр computeTravelTimeFor=all.
travelTimeInSeconds	integer	Предполагаемое время в пути в секундах, которое включает задержку из-за трафика в режиме реального времени. Обратите внимание, что даже если traffic=false travelTimeInSeconds по-прежнему включает задержку из-за трафика. Если Значение DepartAt находится в будущем, время в пути вычисляется с помощью данных о дорожном движении, зависящих от времени.

RouteOptimizedWaypoint

Оптимизированный объект точки пути.

Имя	Тип	Описание
optimizedIndex	integer	Оптимизированный индекс точки пути из системы.
providedIndex	integer	Индекс точки пути, предоставленный пользователем.

RouteReport

Сообщает действующие параметры, используемые в текущем вызове.

Имя	Тип	Описание
effectiveSettings	EffectiveSetting[]	Действующие параметры или данные, используемые при вызове этого API маршрута.

RouteRepresentationForBestOrder

Указывает представление набора маршрутов, предоставленных в качестве ответа. Это значение параметра можно использовать только в сочетании с computeBestOrder=true.

Имя	Тип	Описание
none	string	Включает только оптимизированные индексы точек пути, но не включает геометрию маршрута в ответе.
polyline	string	Включает геометрию маршрута в ответ.
summaryOnly	string	Сводка по ломаным линиям, но за исключением элементов геометрии точек для маршрутов в ответе.

RouteSection

Разделы маршрутов содержат дополнительные сведения об частях маршрута. Каждый раздел содержит по крайней мере элементы startPointIndex, endPointIndexи sectionType.

Имя	Тип	Описание
delayInSeconds	integer	Задержка в секундах, вызванная инцидентом.
effectiveSpeedInKmh	integer	Эффективная скорость инцидента в км/ч, усредненная по всей его длине.
endPointIndex	integer	Индекс последней точки (смещение 0) в маршруте, к которому относится этот раздел.
magnitudeOfDelay	DelayMagnitude	Величина задержки, вызванной инцидентом. Эти значения соответствуют значениям поля ответа ty API получения сведений об инциденте дорожного движения.
sectionType	ResponseSectionType	Типы разделов ответа сообщаемого маршрута
simpleCategory	SimpleCategory	Тип инцидента. В настоящее время может иметь значение JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе tec.
startPointIndex	integer	Индекс первой точки (смещение 0) в маршруте, к которому относится этот раздел.
tec	RouteSectionTec	Сведения о событии трафика с использованием определений в стандарте TPEG2-TEC . Может содержать effectCode и вызывает элементы.
travelMode	ResponseTravelMode	Режим перемещения для вычисляемого маршрута. Если запрошенный вид транспорта не поддерживается в этом разделе, будет задано `other` значение .

RouteSectionTec

Сведения о событии трафика с использованием определений в стандарте TPEG2-TEC . Может содержать effectCode и вызывает элементы.

Имя	Тип	Описание
causes	RouteSectionTecCause[]	Массив причин
effectCode	integer	Влияние на поток трафика. Содержит значение в таблице tec001:EffectCode, как определено в стандарте TPEG2-TEC . Можно использовать для цветового кода событий трафика в соответствии с серьезностью.

RouteSectionTecCause

Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.

Имя	Тип	Описание
mainCauseCode	integer	Main причина события трафика. Содержит значение в таблице tec002:CauseCode, как определено в стандарте TPEG2-TEC .
subCauseCode	integer	Подвыголость события трафика. Содержит значение в таблице подпричин, определенной в mainCauseCode, как определено в стандарте TPEG2-TEC .

RouteSummary

Объект Summary

Имя	Тип	Описание
arrivalTime	string	Предполагаемое время прибытия для маршрута или этапа. Время указывается в формате UTC.
departureTime	string	Предполагаемое время отправления маршрута или участка. Время указывается в формате UTC.
lengthInMeters	integer	Свойство Length In Meter
trafficDelayInSeconds	integer	Предполагаемая задержка в секундах, вызванная инцидентами в режиме реального времени в соответствии с информацией о дорожном движении. Для маршрутов, запланированных со временем отправления в будущем, задержки всегда равно 0. Чтобы вернуть дополнительное время поездки с использованием различных типов сведений о трафике, необходимо добавить параметр computeTravelTimeFor=all.
travelTimeInSeconds	integer	Предполагаемое время в пути в секундах, которое включает задержку из-за трафика в режиме реального времени. Обратите внимание, что даже если traffic=false travelTimeInSeconds по-прежнему включает задержку из-за трафика. Если Значение DepartAt находится в будущем, время в пути вычисляется с помощью данных о дорожном движении, зависящих от времени.

RouteType

Тип запрошенного маршрута.

Имя	Тип	Описание
eco	string	Маршрут, сбалансированный по экономии и скорости.
fastest	string	Самый быстрый маршрут.
shortest	string	Кратчайший маршрут по расстоянию.
thrilling	string	Включает в себя интересные или сложные дороги и использует как можно меньше автомагистралей. Вы можете выбрать уровень включенных поворотов, а также степень холмистости. Сведения о настройке см. в разделе Параметры холмистости и обмотки. Существует ограничение в 900 км на маршрутах, запланированных с `routeType`=захватывающие

SectionType

Указывает, какой из типов разделов указывается в ответе маршрута.

Например, если sectionType = пешеход, возвращаются разделы, которые подходят только для пешеходов. Можно использовать несколько типов. Значение по умолчанию sectionType относится к входным данным travelMode. По умолчанию travelMode имеет значение car

Имя	Тип	Описание
carTrain	string	Участки маршрута, которые являются автомобилями или поездами.
carpool	string	Участки маршрута, требующие использования каруля (HOV/High Occupancy Vehicle) полосы движения.
country	string	Разделы, указывающие, в каких странах или регионах находится маршрут.
ferry	string	Разделы маршрута, которые являются паромами.
motorway	string	Участки маршрута, которые являются автомагистралями.
pedestrian	string	Участки маршрута, которые подходят только для пешеходов.
tollRoad	string	Участки маршрута, требующие оплаты.
tollVignette	string	Разделы маршрута, требующие наличия платной виньетки.
traffic	string	Разделы маршрута, содержащие сведения о дорожном движении.
travelMode	string	Разделы по отношению к параметру `travelMode`запроса .
tunnel	string	Разделы маршрута, которые являются туннелями.
urban	string	Участки маршрута, расположенные в пределах городских районов.

SimpleCategory

Тип инцидента. В настоящее время может иметь значение JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе tec.

Имя	Тип	Описание
JAM	string	Пробке.
OTHER	string	Другое
ROAD_CLOSURE	string	Закрытие дорог.
ROAD_WORK	string	Дорожные работы.

TravelMode

Режим перемещения для запрошенного маршрута. Если значение не определено, значение по умолчанию — "car". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "other". Обратите внимание, что режимы перемещения автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные об ограничениях доступны не во всех областях.

Имя	Тип	Описание
bicycle	string	Возвращаемые маршруты оптимизированы для велосипедов, включая использование велосипедных дорожек.
bus	string	Возвращаемые маршруты оптимизированы для автобусов, включая использование только автобусных полос. Бета-версия.
car	string	Возвращаемые маршруты оптимизированы для автомобилей.
motorcycle	string	Возвращаемые маршруты оптимизированы для мотоциклов. Бета-версия.
pedestrian	string	Возвращаемые маршруты оптимизированы для пешеходов, включая использование тротуаров.
taxi	string	Возвращаемые маршруты оптимизированы для такси. Бета-версия.
truck	string	Возвращаемые маршруты оптимизированы для коммерческих транспортных средств, например для грузовиков.
van	string	Возвращаемые маршруты оптимизированы для фургонов. Бета-версия.

VehicleEngineType

Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна соответствовать значению vehicleEngineType.

Имя	Тип	Описание
combustion	string	Двигатель внутреннего сгорания.
electric	string	Электрический двигатель.

VehicleLoadType

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены с некоторых дорог. Доступные значения vehicleLoadType — это классы Hazmat для США с 1 по 9, а также универсальные классификации для использования в других странах и регионах. Значения, начинающиеся с USHazmat, предназначены для маршрутизации в США, а для всех остальных стран и регионов следует использовать otherHazmat. vehicleLoadType можно указать несколько раз. В настоящее время этот параметр учитывается только для travelMode=truck.

Имя	Тип	Описание
USHazmatClass1	string	Взрывоопасные вещества
USHazmatClass2	string	Сжатый газ
USHazmatClass3	string	Легковоспламеняемые жидкости
USHazmatClass4	string	Легковоспламеняемые твердые вещества
USHazmatClass5	string	Окислители
USHazmatClass6	string	Яды
USHazmatClass7	string	Радиоактивные вещества
USHazmatClass8	string	Коррозионные средства
USHazmatClass9	string	Прочее
otherHazmatExplosive	string	Взрывоопасные вещества
otherHazmatGeneral	string	Прочее
otherHazmatHarmfulToWater	string	Вредно для воды

WindingnessLevel

Уровень поворотов для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeTypeпараметром =thrilling.

Имя	Тип	Описание
high	string	high
low	string	low
normal	string	нормальный

Route - Get Route Directions

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Примечания

Scopes

subscription-key

SAS Token

Примеры

Successfully retrieve a route between an origin and a destination

Sample Request

Sample Response

Определения

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Дополнительные ресурсы