Route - Get Route Range

Служба:: Maps

Версия API:: 1.0

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

Примечание.

azure Maps Route версии 1

Служба маршрута Azure Maps версии 1 теперь устарела и будет прекращена 3.31.28. Чтобы избежать сбоев в работе служб, все вызовы службы Route версии 1 необходимо обновить для использования службы Route версии 2025-01-01 к 3/31/28. Дополнительные сведения см. в разделе Миграция API-интерфейсов Azure Maps 1.0.

API Get Route Range (Isochrone) — это http-запрос GET, который вычисляет набор расположений, которые можно достичь из точки источника на основе топлива, энергии, времени или расстояния, указанного бюджета. Граница многоугольника (или Isochrone) возвращается в ориентации по счетчику, а также в точном центре многоугольников, который был результатом точки источника.

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

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

С использованием необязательных параметров:

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&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	number[]	Координата, из которой должен начинаться вычисление диапазона.
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Указывает эффективность преобразования химической энергии, хранящейся в кинетической энергии, когда автомобиль ускоряет (т. е. KineticFxGained/ChemicalDbConsumed). Химическое, полученное путем преобразования потребляемого топлива в химическую энергию с помощью топливаErDensityInMJoulesPerLiter. Необходимо связать с замедлением. Диапазон значений, допустимых, составляет от 0,0 до 1/замедление. Разумные значения: для модели сжигания : 0,33, для электрической модели : 0,66
auxiliaryPowerInkW	query		number (double)	Указывает объем энергии, потребляемой для поддержания вспомогательных систем, в киловаттах (kW). Его можно использовать для указания потребления из-за устройств и систем, таких как системы AC, радио, нагревание и т. д. Разумные значения: 1.7
auxiliaryPowerInLitersPerHour	query		number (double)	Указывает объем топлива, потребляемого для поддержания вспомогательных систем транспортного средства, в литрах в час. Его можно использовать для указания потребления из-за устройств и систем, таких как системы AC, радио, нагревание и т. д. Разумные значения: 0.2
avoid	query		RouteAvoidType[]	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Указывает компонент, зависящий от скорости потребления. Предоставляется как неупорядоченный список пар скорости и потребления. Список определяет точки на кривой потребления. Показатели потребления скоростей, не входящих в список, находятся следующим образом: линейная интерполяция, если заданная скорость находится между двумя скоростями в списке по линейной экстраполяции в противном случае при условии константы (TMConsumption/ΔSpeed), определяемой ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для той же скорости. Если он содержит только одну точку, то скорость потребления этой точки используется без дополнительной обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно значению предпоследней максимальной скорости. Это гарантирует, что экстраполяция не приводит к отрицательным ставкам потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в kWh/100km) составляет от 0,01 до 1000000.0. Разумные значения: 50,8.2:130,21.3 Этот параметр необходим для модели потребления электроэнергии.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Указывает компонент, зависящий от скорости потребления. Предоставляется как неупорядоченный список пар скорости с разделителями двоеточием & пар скорости потребления. Список определяет точки на кривой потребления. Показатели потребления скоростей, не входящих в список, находятся следующим образом: линейная интерполяция, если заданная скорость находится между двумя скоростями в списке по линейной экстраполяции в противном случае при условии константы (TMConsumption/ΔSpeed), определяемой ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для той же скорости. Если он содержит только одну точку, то скорость потребления этой точки используется без дополнительной обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно значению предпоследней максимальной скорости. Это гарантирует, что экстраполяция не приводит к отрицательным ставкам потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в l/100km) составляет от 0,01 до 1000000.0. Разумные значения: 50,6.3:130,11.5 Примечание. Этот параметр необходим для модели потребления топлива.
currentChargeInkWh	query		number (double)	Указывает текущую электрическую энергию в киловатт-часах (kWh). Этот параметр совместно существует с параметром maxChargeInkWh. Диапазон значений, допустимых в диапазоне от 0,0 до maxChargeInkWh. Разумные значения: 43
currentFuelInLiters	query		number (double)	Указывает текущий запас топлива в литрах. Разумные значения: 55
decelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Указывает эффективность преобразования кинетической энергии в сохраненный (не потребляемый) топливо, когда автомобиль уменьшает (т. е. ChemicalLost). Химические ВеществаSaved получены путем преобразования сохраненного (не потребляемого) топлива в энергию с помощью топливаJoulesInMJoulesPerLiter. Необходимо связать с ускорениемEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/ускоренияEfficiency. Разумные значения: для модели сжигания : 0,83, для электрической модели : 0,91
departAt	query		string (date-time)	Дата и время отъезда из точки источника, отформатированная как значение `dateTime`, как определено в RFC 3339, раздел 5.6с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка источника. Значение по умолчанию: теперь Другое значение: `dateTime` Примеры: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Параметр `departAt` нельзя использовать в сочетании с `arriveAt`.
distanceBudgetInMeters	query		number (double)	Бюджет расстояния в метрах, определяющий максимальный диапазон, который можно путешествовать с помощью расстояния вождения. Модель потребления будет влиять только на диапазон, если тип маршрута является эко. Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energy BudgetInkWh, time BudgetInSec или distance BudgetInMeters).
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	Указывает эффективность преобразования потенциальной энергии в сохраненный (не потребляемый) топливо, когда автомобиль теряет высоту (т. е. ChemicalDbSaved/Потенциальные Экземпляры). Химические ВеществаSaved получены путем преобразования сохраненного (не потребляемого) топлива в энергию с помощью топливаJoulesInMJoulesPerLiter. Необходимо связать с uphillEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/uphillEfficiency. Разумные значения: для модели сжигания : 0,51, для электрической модели : 0,73
energyBudgetInkWh	query		number (double)	Бюджет электроэнергии в киловатт-часах (kWh), определяющий максимальный диапазон, который можно путешествовать с помощью указанной модели потребления электроэнергии. При использовании energyBudgetInkWh необходимо указать подробную модель потребления электроэнергии. Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energy BudgetInkWh, time BudgetInSec или distance BudgetInMeters).
fuelBudgetInLiters	query		number (double)	Бюджет топлива в литрах, определяющий максимальный диапазон, который можно путешествовать с помощью указанной модели потребления топлива. При использовании fuelBudgetInLiters необходимо указать подробную модель потребления сжигания. Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energy BudgetInkWh, time BudgetInSec или distance BudgetInMeters).
fuelEnergyDensityInMJoulesPerLiter	query		number (double)	Указывает объем химической энергии, хранящейся в одном литре топлива в мегаджулях (MJ). Он используется в сочетании с параметрами эффективностиэффективности для преобразования между сохраненными или потребляемыми энергией и топливом. Например, плотность энергии составляет 34,2 MJ/l для бензина и 35,8 MJ/l для дизельного топлива. Этот параметр необходим, если задан параметр эффективности *. Разумные значения: 34.2
hilliness	query		InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
maxChargeInkWh	query		number (double)	Указывает максимальный объем электроэнергии в киловатт-часах (kWh), которые могут храниться в батарее транспортного средства. Этот параметр совместно существует с параметром currentChargeInkWh. Минимальное значение должно быть больше или равно currentChargeInkWh. Разумные значения: 85
routeType	query		RouteType	Тип запрошенного маршрута.
timeBudgetInSec	query		number (double)	Бюджет времени в секундах, определяющий максимальный диапазон, который можно путешествовать с помощью времени вождения. Модель потребления будет влиять только на диапазон, если тип маршрута является эко. Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energy BudgetInkWh, time BudgetInSec или distance BudgetInMeters).
traffic	query		boolean	Возможные значения: True. Рассмотрите все доступные сведения о трафике во время маршрутизации false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные дорожного движения игнорируются во время маршрутизации, влияние исторического движения на эффективные скорости дорожного движения по-прежнему включается.
travelMode	query		TravelMode	Режим поездки для запрошенного маршрута. Если не определено, значение по умолчанию — "автомобиль". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	Указывает эффективность преобразования химической энергии, хранящейся в топливо, в потенциальную энергию, когда автомобиль получает повышение высоты (т. е. Потенциальные ТипыГайн/Химические ВеществаКонсумеда). Химическое, полученное путем преобразования потребляемого топлива в химическую энергию с помощью топливаErDensityInMJoulesPerLiter. Необходимо связать с внизхиллEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/внизхиллEfficiency. Разумные значения: для модели сжигания : 0,27, для электрической модели : 0,74
vehicleAxleWeight	query		integer	Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
vehicleCommercial	query		boolean	Используется ли автомобиль для коммерческих целей. Коммерческие транспортные средства могут быть запрещены ездить на некоторых дорогах.
vehicleEngineType	query		VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна быть согласована со значением vehicleEngineType.
vehicleHeight	query		number (double)	Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются.
vehicleLength	query		number (double)	Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType	query		VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах или регионах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие страны или регионы должны использоваться для других стран и регионов. vehicleLoadType можно указать несколько раз. Этот параметр в настоящее время считается только для travelMode=truck.
vehicleMaxSpeed	query		integer	Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
vehicleWeight	query		integer	Вес транспортного средства в килограммах. Обязательно, если заданы какие-либо из параметров эффективности. Он должен быть строго положительным при использовании в контексте модели потребления. Ограничения веса считаются. Если нет подробного модели потребления, а значение транспортного веса не равно нулю, то учитываются ограничения веса. Во всех остальных случаях этот параметр игнорируется. Разумные значения: для модели сжигания : 1600, для электрической модели : 1900
vehicleWidth	query		number (double)	Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
windingness	query		WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

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

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

Ответы

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

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

AADToken

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

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

Примечания.

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

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

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Образец запроса

HTTP

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Пример ответа

Код состояния:: 200

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

Определения

Имя	Описание
EffectiveSetting	Действующий параметр или данные, используемые при вызове ЭТОГО API маршрута.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
LatLongPair	Расположение, представленное в виде широты и долготы.
ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
RouteAvoidType	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
RouteRange	Доступный диапазон
RouteRangeResult	Этот объект возвращается из успешного вызова Range Reachable Route
RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.
RouteType	Тип запрошенного маршрута.
TravelMode	Режим поездки для запрошенного маршрута. Если не определено, значение по умолчанию — "автомобиль". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна быть согласована со значением vehicleEngineType.
VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах или регионах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие страны или регионы должны использоваться для других стран и регионов. vehicleLoadType можно указать несколько раз. Этот параметр в настоящее время считается только для travelMode=truck.
WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

EffectiveSetting

Object

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

InclineLevel

Перечисление

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

Значение	Описание
low	низкий
normal	Обычная
high	высокий

LatLongPair

Object

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

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

ResponseFormat

Перечисление

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

Значение	Описание
json	формат обмена данными для объектов JavaScript
xml	расширяемый язык разметки

RouteAvoidType

Перечисление

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

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

RouteRange

Object

Доступный диапазон

Имя	Тип	Описание
boundary	LatLongPair[]	Граница многоугольника доступного диапазона представлена в виде списка точек.
center	LatLongPair	Центральная точка доступного диапазона

RouteRangeResult

Object

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

Имя	Тип	Описание
formatVersion	string	Свойство Format Version
reachableRange	RouteRange	Доступный диапазон
report	RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.

RouteReport

Object

Сообщает об эффективных параметрах, используемых в текущем вызове.

Имя	Тип	Описание
effectiveSettings	EffectiveSetting[]	Эффективные параметры или данные, используемые при вызове ЭТОГО API маршрута.

RouteType

Перечисление

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

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

TravelMode

Перечисление

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

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

VehicleEngineType

Перечисление

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

Значение	Описание
combustion	Внутренний двигатель внутреннего сгорания.
electric	Электродвигатель.

VehicleLoadType

Перечисление

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

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

WindingnessLevel

Перечисление

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

Значение	Описание
low	низкий
normal	Обычная
high	высокий