Route - Get Route Range

  • Ссылка
Service:
Maps
API Version:
1.0

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

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

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

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
With optional parameters: 
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

Указывает эффективность преобразования химической энергии, хранящейся в топливе, в кинетической энергии при ускорении транспортного средства (т. е. KineticХергеяГайн/ChemicalЯКонсуме). ChemicalХинергияConsumed получается путем преобразования израсходованного топлива в химическую энергию с использованием топливаХиденситиInMJoulesPerLiter.

Должен быть связан с замедлениемэффициентности.

Допустимый диапазон значений : от 0,0 до 1/decelerationEfficiency.

Разумные значения : для модели горения : 0,33, для электрической модели : 0,66
auxiliaryPowerInkW
 query

number

double

Указывает объем энергии, потребляемой для поддержки вспомогательных систем, в киловаттах (кВт).

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

Разумные значения: 1.7
auxiliaryPowerInLitersPerHour
 query

number

double

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

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

Разумные значения: 0,2
avoid
 query

RouteAvoidType[]

Указывает то, чего следует избегать при вычислении маршрута при определении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах диапазона маршрутов не следует использовать значение alreadyUsedRoads.
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.
distanceBudgetInMeters
 query

number

double

Бюджет расстояния в метрах, определяющий максимальный диапазон, который можно преодолеть с помощью расстояния. Модель потребления будет влиять на диапазон только в том случае, если параметр routeType имеет значение eco.
Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energyBudgetInkWh, timeBudgetInSec или distanceBudgetInMeters).
downhillEfficiency
 query

number

double

Указывает эффективность преобразования потенциальной энергии в сэкономленное (не потребляемое) топливо, когда транспортное средство теряет высоту (т. е. Chemical EnergySaved/PotentialИнергияLost). Chemical EnergySaved получается путем преобразования сохраненного (не израсходованного) топлива в энергию с использованием топливаХериденситиInMJoulesPerLiter.

Должен быть связан с uphillEfficiency.

Допустимый диапазон значений: от 0,0 до 1/uphillEfficiency.

Разумные значения: для модели горения : 0,51, для электрической модели : 0,73
energyBudgetInkWh
 query

number

double

Бюджет электроэнергии в киловатт-часах (кВт*ч), определяющий максимальный диапазон, который может быть пройден с помощью указанной модели потребления электроэнергии.
При использовании energyBudgetInkWh необходимо указать подробную модель потребления электроэнергии.
Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energyBudgetInkWh, timeBudgetInSec или distanceBudgetInMeters).
fuelBudgetInLiters
 query

number

double

Бюджет топлива в литрах, определяющий максимальный диапазон, который можно передвигать с помощью указанной модели потребления сгорания.
При использовании fuelBudgetInLiters необходимо указать подробную модель потребления горения.
Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energyBudgetInkWh, timeBudgetInSec или distanceBudgetInMeters).
fuelEnergyDensityInMJoulesPerLiter
 query

number

double

Указывает количество химической энергии, хранящейся в одном литре топлива в мегаджоулях (MJ). Он используется в сочетании с параметрами *Эффективности для преобразований между сэкономленной или потребляемой энергией и топливом. Например, плотность энергии составляет 34,2 МДж/л для бензина и 35,8 МДж/л для дизельного топлива.

Этот параметр является обязательным, если задан какой-либо параметр *Efficiency .

Разумные значения: 34.2
hilliness
 query

InclineLevel

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

number

double

Указывает максимальную подачу электроэнергии в киловатт-часах (кВт/ч), которая может храниться в аккумуляторе транспортного средства.

Этот параметр со-существует с параметром currentChargeInkWh .

Минимальное значение должно быть больше или равно currentChargeInkWh.

Разумные значения: 85
routeType
 query

RouteType

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

number

double

Бюджет времени в секундах, определяющий максимальный диапазон, который можно путешествовать с использованием времени вождения. Модель потребления будет влиять на диапазон только в том случае, если параметр routeType имеет значение eco.
Необходимо использовать ровно один бюджет (fuel BudgetInLiters, energyBudgetInkWh, timeBudgetInSec или distanceBudgetInMeters).
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.
vehicleHeight
 query

number

double

Высота транспортного средства в метрах. Значение 0 означает, что ограничения по высоте не учитываются.
vehicleLength
 query

number

double

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType
 query

VehicleLoadType

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены с некоторых дорог. Доступные значения vehicleLoadType — это классы Hazmat для США с 1 по 9, а также универсальные классификации для использования в других странах и регионах. Значения, начинающиеся с 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

RouteRangeResult

ОК
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 set of locations that can be reached from the origin point based on various conditions

Sample Request

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

Sample Response

Status code:
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параметром =thrilling.
LatLongPair

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

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

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

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

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

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

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

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

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

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

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

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

Объект error.

InclineLevel

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

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

string

high
low

string

low
normal

string

нормальный

LatLongPair

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

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

number

Свойство Latitude
longitude

number

Свойство Longitude

ResponseFormat

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

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

string

Формат обмена данными нотации объектов JavaScript
xml

string

Язык расширяемой разметки

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

Избегает грунтовой дороги

RouteRange

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

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

LatLongPair[]

Граница многоугольников достижимого диапазона, представленного в виде списка точек.
center

LatLongPair

Центральная точка доступного диапазона

RouteRangeResult

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

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

string

Свойство Format Version
reachableRange

RouteRange

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

RouteReport

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

RouteReport

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

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

EffectiveSetting[]

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

RouteType

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

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

string

Маршрут, сбалансированный по экономии и скорости.
fastest

string

Самый быстрый маршрут.
shortest

string

Кратчайший маршрут по расстоянию.
thrilling

string

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

TravelMode

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

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

string

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

string

Возвращаемые маршруты оптимизированы для автомобилей.
motorcycle

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

нормальный