Поделиться через

Route - Post Route Directions Batch

  • Ссылка
Служба:
Maps
Версия API:
2025-01-01

Используется для отправки пакета запросов в API маршрутов маршрутов в одном синхронном запросе.

API — это http-запрос , который отправляет пакеты до 100 запросов в одном вызове API направления маршрута .

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

Текст POST для пакетного запроса

Для отправки направлений будет использоваться запрос POST, в котором текст запроса будет содержать массив batchItems в формате json, а заголовок Content-Type будет иметь значение application/json. Ниже приведен пример текста запроса, содержащего 2 направления запросов:

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

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

Пакет должен содержать по крайней мере 1 запроса.

Модель пакетного ответа

Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • DirectionsResponse. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

Параметры URI

Имя В Обязательно Тип Описание
api-version
 query True

string

Номер версии API Azure Maps.

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

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .
Accept-Language

string

Язык, в котором должны быть возвращены результаты маршрутизации.

Дополнительные сведения см. в поддержке локализации вAzure Maps.

Текст запроса

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

DirectionsBatchRequestItem[]

Список запросов для обработки.

Ответы

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

DirectionsBatchResponse

Пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.
Other Status Codes

MapsErrorResponse

Произошла непредвиденная ошибка.

Заголовки

x-ms-error-code: string

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

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 с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

A Route Directions Batch request containing 2 queries

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

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    }
  ]
}

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

Код состояния:
200 
{
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    }
  ]
}

Определения

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

Административный район и регион страны для точек пути и точек маневра на маршруте грузовика. Примечание. Поддерживается только для грузовика travelMode.
AdminDistrict

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

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

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.
AvoidEnum

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

Пример: "избегайте": ["limitedAccessHighways", "tollRoads"]
CountryRegion

Представляет страну или регион, содержащую связанные сведения.
DirectionsBatchRequestBody

Список направлений запросов и запросов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
DirectionsBatchRequestItem

Объект Batch Query
DirectionsBatchResponse

Этот объект возвращается из успешного вызова пакетной службы "Маршруты".
DirectionsBatchResponseItem

Элемент ответа пакетной службы
DrivingSideEnum

Указывает левую руку против правой стороны вождения в точке маневра. Note: поддерживается только для грузовика travelMode.
ErrorAdditionalInfo

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

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

GeoJSON FeatureCollection объект, содержащий список компонентов. Дополнительные сведения см. в разделе RFC 7946, раздел 3.3.
FeaturesItem

Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута.
FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.
FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.
GeoJsonPoint

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
Hint

Дополнительные сведения, которые могут быть полезны в следующем маршруте. В дополнение к тексту подсказки этот элемент имеет атрибут hintType, который указывает, к чему относится указание, например NextIntersection. Указание является необязательным элементом. Note: поддерживается только для вождения travelMode.
InputWaypointFeaturesItem

Задает входную точку пути и объект компонента viaWaypoint GeoJSON и дополнительные свойства. Дополнительные сведения см. в RFC 7946.
InputWaypointProperties

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

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

Описание маневра в наборе направлений.
Leg

Сведения о разделе маршрута между двумя точками пути. Дополнительные сведения о полях, содержащихся в маршруте Leg:
ManeuverPointProperties

Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.
ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
MapsErrorDetail

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

Распространенный ответ об ошибке для API Azure Maps для возврата сведений об ошибке для неудачных операций.
MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
MultiLineStringGeometry

Указывает объект GeoJSON MultiLineString Geometry. Дополнительные сведения см. в RFC 7946.
OptimizedWaypoint

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

Последовательность для посещения точек пути и viaWaypoints.
PointGeometry

Точка источника, передаваемая в качестве допустимого объекта GeoJSON Geometry, из которого должен вычисляться многоугольник диапазона. Дополнительные сведения см. в RFC 7946.

Note: API привязывает запрошенную точку источника к ближайшей дорожной сети и будет использовать ее для вычисления диапазона. Он будет возвращен в качестве center точки в ответе.
RegionTravelSummary

Сводка по расстоянию, времени и платной дороге двумя типами сущностей: страна (например, США, Канада) и административное деление или административное деление (например, "штат" в США и "провинция" в Канаде).
RoadTypeEnum

Тип дороги. Note: поддерживается только для вождения travelMode.
RouteDirectionOptimizeRouteEnum

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec

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

ISNote: поддерживается только для грузовика travelMode.
RouteOutputOptionEnum

Добавьте нужные сведения о маршруте из ответа. По умолчанию маршрут включается в ответ.

Поддерживает несколько значений, таких как routeOutputOptions: ["routePath", "regionTravelSummary"]
RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
RoutePathProperties

Указывает свойства, описывающие путь маршрута в ответе.
RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.
RoutePathTravelModeEnum

Режим перемещения для пути маршрута в ответе.
SideOfStreetEnum

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

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

Сведения о сегментах маршрута, определенных точками пути маршрута и любыми промежуточными точками путем. Например, если в маршруте есть две точки маршрута в дополнение к точкам начала и окончания пути, будет три (3) подножки маршрута.
Summary

Сводка для пакетного запроса
TrafficCongestionEnum

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode
TrafficDataUsedEnum

Тип данных трафика в режиме реального времени, используемых для создания маршрута.
TravelModeEnum

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

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"
VehicleLoadTypeEnum

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

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

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

Address

Object

Административный район и регион страны для точек пути и точек маневра на маршруте грузовика. Примечание. Поддерживается только для грузовика travelMode.

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

AdminDistrictTruck[]

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

CountryRegion

Представляет страну или регион, содержащую связанные сведения.

AdminDistrict

Object

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

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

number

Общее расстояние, пройденное в метрах в административном районе.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
longName

string

Длинное имя адреса, например Вашингтон.
tollDistanceInMeters

number

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

AdminDistrictTruck

Object

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

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

string

Короткое имя соответствующего поля adminDistrict для adminDistrict[0], это может быть короткое имя состояния, например WA. Это доступно только для США, Канады и Мексики.

AdrTunnelRestrictionCodeEnum

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

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.

Значение Описание
B

Транспортные средства с кодом B ограничены дорогами с категориями B, C, D и E.
C

Транспортные средства с кодом C ограничены дорогами с категориями ADR туннеля C, D и E
D

Транспортные средства с кодом D ограничены дорогами с категориями D и E.
E

Транспортные средства с кодом E ограничены дорогами с категорией E туннеля ADR.

AvoidEnum

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

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

Пример: "избегайте": ["limitedAccessHighways", "tollRoads"]

Значение Описание
borderCrossings

Избегает пересечения границ страны в маршруте.
ferries

Избегает использования паромов в маршруте.
limitedAccessHighways

Избегает использования ограниченных шоссе доступа в маршруте.
lowEmissionZones

Избегает зон с низким уровнем выбросов в маршруте. Note: поддерживается только для грузовика travelMode.
tollRoads

Избегает использования платных дорог в маршруте.
tunnels

Избегает использования туннелей в маршруте. Note: поддерживается только для грузовика travelMode.
unpavedRoads

Избегает неотложных дорог в маршруте. Note: поддерживается только для грузовика travelMode.

CountryRegion

Object

Представляет страну или регион, содержащую связанные сведения.

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

string

ISO страны или региона представляет код региона или региона ISO 3166-1 Alpha-2
name

string

имя страны или региона

DirectionsBatchRequestBody

Object

Список направлений запросов и запросов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.

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

DirectionsBatchRequestItem[]

Список запросов для обработки.

DirectionsBatchRequestItem

Object

Объект Batch Query

Имя Тип Default value Описание
arriveAt

string (date-time)

Дата и время прибытия в точку назначения, отформатированная как значение dateTime, определенное RFC 3339, раздел 5.6. Если смещение часового пояса не указано, предполагается, что в формате UTC.

Параметр arriveAt нельзя использовать в сочетании с departAt.

Пример: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid

AvoidEnum[]

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

Пример: "избегайте": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

Дата и время выхода из точки источника, отформатированная как значение dateTime, определенное RFC 3339, раздел 5.6. Если смещение часового пояса не указано, предполагается, что в формате UTC.

Если departAt не задано, значение по умолчанию — текущее время.

Пример:

"departAt": "2023-06-01T09:30:00.000-07:00"
features

InputWaypointFeaturesItem[]

Маршруты для вождения и ходьбы определяются набором точек пути (останавливается) и viaWaypoints (промежуточные расположения, через которые должен пройти маршрут). Между каждым набором точек пути можно использовать не более 25 точек пути и не более 10 в viaWaypoints. Маршрут грузовика поддерживает до 150 точек пути и viaWaypoints не поддерживаются.

Маршрут должен иметь не менее 2 точек пути, а начальные и конечные точки маршрута не могут быть черезWaypoints.

Как точка пути, так и расположения viaWaypoint должны быть указаны в качестве допустимого объекта функции GeoJSON Point вместе с pointIndex, который указывает порядок расположений. Дополнительные сведения о формате GeoJSON см. в RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

Начальное направление транспортного средства в градусах, начиная с истинного Севера и продолжающегося в часовой стрелке. Север составляет 0 градусов, восток составляет 90 градусов, юг составляет 180 градусов, запад — 270 градусов. Возможные значения 0-359
maxRouteCount

integer (int64)

minimum: 1
maximum: 3

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

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

По умолчанию: maxRouteCount:1

Минимальное значение: maxRouteCount:1

Максимальное значение: maxRouteCount:3
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Повторно упорядочение точек пути маршрута с помощью быстрого эвристического алгоритма, чтобы сократить затраты на маршрут, указанные параметром оптимизации. Источник и назначение исключены из оптимизированной точки пути, и их положение считается фиксированным. Допустимые значения : true или false.

Note: поддерживается только для грузовика travelMode.
optionalId

string

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

RouteOutputOptionEnum[]

[ "itinerary" ]

Добавьте нужные сведения о маршруте из ответа. По умолчанию маршрут включается в ответ.

Поддерживает несколько значений, таких как routeOutputOptions: ["routePath", "regionTravelSummary"]
travelMode

TravelModeEnum

driving

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

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"
type

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

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

Note: поддерживается только для грузовика travelMode

DirectionsBatchResponse

Object

Этот объект возвращается из успешного вызова пакетной службы "Маршруты".

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

DirectionsBatchResponseItem[]

Массив, содержащий результаты пакетной службы.
summary

Summary

Сводка для пакетного запроса

DirectionsBatchResponseItem

Object

Элемент ответа пакетной службы

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

FeatureCollection[]

Альтернативный маршрут.
error

ErrorDetail

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

FeaturesItem[]

GeoJSON объект компонента, содержащий объект Geometry и дополнительные свойства. Дополнительные сведения см. в разделе RFC 7946, раздел 3.2.
optionalId

string

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

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

DrivingSideEnum

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

Указывает левую руку против правой стороны вождения в точке маневра. Note: поддерживается только для грузовика travelMode.

Значение Описание
Left

Слева на стороне вождения.
Right

Правой стороной вождения.

ErrorAdditionalInfo

Object

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

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

Целевой объект ошибки.

FeatureCollection

Object

GeoJSON FeatureCollection объект, содержащий список компонентов. Дополнительные сведения см. в разделе RFC 7946, раздел 3.3.

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

FeaturesItem[]

GeoJSON объект компонента, содержащий объект Geometry и дополнительные свойства. Дополнительные сведения см. в разделе RFC 7946, раздел 3.2.
type

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

FeaturesItem

Object

Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута.

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

number[] (double)

Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольников определяются значениями широты и долготы. Дополнительные сведения см. в разделе RFC 7946, раздел 5.

Пример: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Допустимый объект GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.
properties FeatureProperties:

Задает свойства признаков маршрута, такие как маршрут, маршрут ноги и геометрия, сводка по путешествиям.
type

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

FeaturesItemTypeEnum

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

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

Значение Описание
Feature

Указывает тип объекта компонента GeoJSON.

FeatureTypeEnum

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

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

Значение Описание
FeatureCollection

Указывает тип объекта GeoJSONFeatureCollection.

GeoJsonPoint

Object

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.

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

number[] (double)

Position — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type string:

Point

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Hint

Object

Дополнительные сведения, которые могут быть полезны в следующем маршруте. В дополнение к тексту подсказки этот элемент имеет атрибут hintType, который указывает, к чему относится указание, например NextIntersection. Указание является необязательным элементом. Note: поддерживается только для вождения travelMode.

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

string

Тип подсказки.
text

string

текст подсказки.

InputWaypointFeaturesItem

Object

Задает входную точку пути и объект компонента viaWaypoint GeoJSON и дополнительные свойства. Дополнительные сведения см. в RFC 7946.

Имя Тип Описание
geometry GeoJsonPoint:

PointGeometry

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
properties

InputWaypointProperties

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

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

InputWaypointProperties

Object

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

Имя Тип Default value Описание
pointIndex

integer (int64)

Определите и упорядочение последовательности точек пути в маршруте. Значением по умолчанию является index value массива функций.
pointType

InputWaypointTypeEnum

waypoint

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

InputWaypointTypeEnum

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

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

Значение Описание
viaWaypoint

ViaWaypoint — это конкретная точка пути, которую необходимо пройти через или посетить вдоль маршрута или поездки. Note: поддерживается только для вождения travelMode.
waypoint

Точка пути — это определенное расположение или точка вдоль маршрута или поездки, которая служит эталонной или остановочной точкой.

Instruction

Object

Описание маневра в наборе направлений.

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

DrivingSideEnum

Указывает левую руку против правой стороны вождения в точке маневра. Note: поддерживается только для грузовика travelMode.
formattedText

string

Форматирование текстового описания инструкции.
hints

Hint[]

Дополнительные сведения, которые могут быть полезны в следующем маршруте. В дополнение к тексту подсказки этот элемент имеет атрибут hintType, который указывает, к чему относится указание, например NextIntersection. Указание — это необязательный элемент, а шаг маршрута может содержать несколько подсказок. Note: поддерживается только для вождения travelMode
maneuverType

ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
text

string

Описание инструкции в виде обычного текста.

Leg

Object

Сведения о разделе маршрута между двумя точками пути. Дополнительные сведения о полях, содержащихся в маршруте Leg:

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

string (date-time)

Предполагаемое время прибытия для ноги, которое учитывает условия движения, форматируется как значение dateTime, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
departureAt

string (date-time)

Предполагаемое время отъезда для ноги, которое учитывает условия движения, форматируется как значение dateTime, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
description

string

Краткое описание маршрута.
distanceInMeters

number

Физическое расстояние в метрах, охваченное маршрутом Нога.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
regionTravelSummary

RegionTravelSummary

Включите сводку по расстоянию, времени и платной дороге двумя типами сущностей: страна (например, США, Канада) и административное деление или административное деление (например, "штат" в США и "провинция" в Канаде).
routePathRange

RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.
subLegs

SubLeg[]

Сведения о сегментах маршрута, определенных точками пути маршрута и любыми промежуточными точками путем. Например, если в маршруте есть две точки маршрута в дополнение к точкам начала и окончания пути, будет три (3) подножки маршрута.

ManeuverPointProperties

Object

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

Имя Тип Default value Описание
address

Address

Административный район и регион страны для точек пути и точек маневра на маршруте грузовика. Примечание. Поддерживается только для грузовика travelMode.
compassDirection

string

Направление путешествия, связанное с маневром на маршруте, например на юге или юго-западе. Note: поддерживается только для вождения travelMode.
distanceInMeters

number

Физическое расстояние в метрах, охватываемого этим шагом маршрута.
durationInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance.
exitIdentifier

string

Имя или номер выхода, связанного с этим шагом маршрута.
instruction

Instruction

Описание маневра в наборе направлений.
order

Order

Последовательность для посещения точек пути и viaWaypoints.
routePathPoint

RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
sideOfStreet

SideOfStreetEnum

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

string[]

Текст подписи для маршрута. Может быть несколько значений знака.
steps

Step[]

Шаги между двумя последовательными точками маневра.
towardsRoadName

string

Имя улицы, к которому идет маршрут в первом ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Режим перемещения для пути маршрута в ответе.
type string:

ManeuverPoint

Тип вывода.

ManeuverTypeEnum

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

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.

Значение Описание
ArriveFinish

Прибыть в конечное место назначения.
ArriveIntermediate

Прибыть в промежуточную точку пути.
BearLeft

Медведь слева.
BearLeftThenBearLeft

Медведь слева, а затем медведь оставил снова.
BearLeftThenBearRight

Медведь слева, а затем медведь справа.
BearLeftThenTurnLeft

Медведь слева, а затем вернитесь влево.
BearLeftThenTurnRight

Медведь влево, а затем вернитесь вправо.
BearRight

Медведь право.
BearRightThenBearLeft

Медведь справа, а затем медведь слева.
BearRightThenBearRight

Медведь право, а затем медведь снова.
BearRightThenTurnLeft

Медведь справа, а затем вернитесь влево.
BearRightThenTurnRight

Медведь справа, а затем повернуть вправо.
BearThenKeep

Инструкции медведя, а затем оставить инструкцию
BearThenMerge

Инструкция носителя, а затем инструкция слияния.
Continue

Продолжайте на текущей дороге.
DepartIntermediateStop

Оставьте промежуточную точку пути в другом направлении и дороге, чем вы прибыли.
DepartIntermediateStopReturning

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

Оставьте начальную точку.
EnterRoundabout

Введите округление.
EnterThenExitRoundabout

Введите и закройте круглое движение.
ExitRoundabout

Выход из круглого цикла.
ExitRoundaboutLeft

На круглой кольцевой части выйдите слева.
ExitRoundaboutRight

В круглой кольцевой области выйдите справа.
Follow

Следовать.
GoAroundRoundabout

Идти по кругу.
KeepLeft

Держите слева на другой дороге.
KeepOnRampLeft

Держите слева и продолжайте на пандус.
KeepOnRampRight

Держите право и продолжайте на пандус.
KeepOnRampStraight

Держите прямо и продолжайте на пандус.
KeepRight

Держите прямо на другой дороге.
KeepStraight

Держите прямо на другой дороге.
KeepToStayLeft

Оставайтесь влево, чтобы остаться на той же дороге.
KeepToStayRight

Будьте правы, чтобы остаться на той же дороге.
KeepToStayStraight

Будьте прямо, чтобы остаться на той же дороге.
MergeFreeway

Слияние на автостраде.
MergeHighway

Слияние на шоссе.
MergeMotorway

Слияние на автомагистраль.
MotorwayExitLeft

Возьмите левый выход.
MotorwayExitRight

Возьмите правый выход.
None

Нет инструкций.
RampThenHighwayLeft

Возьмите левый пандус на шоссе. Это часть объединенной инструкции.
RampThenHighwayRight

Возьмите правой рампы на шоссе. Это часть объединенной инструкции.
RampThenHighwayStraight

Оставайтесь прямо, чтобы взять пандус на шоссе. Это часть объединенной инструкции.
RoadNameChange

Изменение имени дороги.
SwitchToMainRoad

Переключитесь на главную дорогу.
SwitchToParallelRoad

Переключитесь на параллельную дорогу.
Take

Поймите дорогу. Эта инструкция используется при входе или выходе из парома.
TakeExit

Возьмите выход.
TakeFerry

Возьмите паром.
TakeRamp

Возьмите пандус.
TakeRampLeft

Возьмите пандус слева.
TakeRampRight

Возьмите пандус справа.
TakeRampStraight

Оставайтесь прямо, чтобы взять пандус.
TurnBack

Вернитесь резко.
TurnLeft

Вернитесь влево.
TurnLeftSharp

Возьмите резкий левый поворот.
TurnLeftThenBearLeft

Вернитесь влево, а затем слева медведь.
TurnLeftThenBearRight

Вернитесь влево, а затем вернитесь вправо.
TurnLeftThenTurnLeft

Вернитесь влево и снова вернитесь влево.
TurnLeftThenTurnRight

Вернитесь влево, а затем вернитесь вправо.
TurnRight

Поворот вправо.
TurnRightSharp

Возьмите резкий правый поворот.
TurnRightThenBearLeft

Вернитесь вправо, а затем слева.
TurnRightThenBearRight

Повернуть вправо, а затем нести вправо.
TurnRightThenTurnLeft

Вернитесь вправо и верните влево.
TurnRightThenTurnRight

Повернуть вправо, а затем снова повернуть вправо
TurnThenMerge

Включите инструкцию, за которой следует инструкция слияния.
TurnToStayLeft

Вернитесь влево, чтобы остаться на той же дороге.
TurnToStayRight

Вернитесь вправо, чтобы остаться на той же дороге.
UTurn

Сделайте u-поворот, чтобы пойти в противоположном направлении.
Unknown

Инструкция неизвестна.
Wait

Ждать
Walk

Ходить

MapsErrorDetail

Object

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

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

string

Один из определяемых сервером кодов ошибок.
details

MapsErrorDetail[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

MapsErrorResponse

Object

Распространенный ответ об ошибке для API Azure Maps для возврата сведений об ошибке для неудачных операций.

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

MapsErrorDetail

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

MapsInnerError

Object

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

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

string

Код ошибки.
innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

MultiLineStringGeometry

Object

Указывает объект GeoJSON MultiLineString Geometry. Дополнительные сведения см. в RFC 7946.

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

number[] (double)

Координаты геометрии GeoJson MultiLineString.
type string:

MultiLineString

Задает тип геометрии для объекта GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.

OptimizedWaypoint

Object

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

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

integer (int64)

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

integer (int64)

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

Order

Object

Последовательность для посещения точек пути и viaWaypoints.

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

integer (int64)

Предоставленный пользователем индекс для точек пути и входных данных viaWaypoint.
optimizedIndex

integer (int64)

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

PointGeometry

Object

Точка источника, передаваемая в качестве допустимого объекта GeoJSON Geometry, из которого должен вычисляться многоугольник диапазона. Дополнительные сведения см. в RFC 7946.

Note: API привязывает запрошенную точку источника к ближайшей дорожной сети и будет использовать ее для вычисления диапазона. Он будет возвращен в качестве center точки в ответе.

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

number[] (double)

Position — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type string:

Point

Задает тип геометрии для объекта GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.

RegionTravelSummary

Object

Сводка по расстоянию, времени и платной дороге двумя типами сущностей: страна (например, США, Канада) и административное деление или административное деление (например, "штат" в США и "провинция" в Канаде).

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

AdminDistrict[]

массив adminDistrict.
countryRegion

CountryRegion

Представляет страну или регион, содержащую связанные сведения.
distanceInMeters

number

Свойство Length In Meters
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
tollDistanceInMeters

number

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

RoadTypeEnum

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

Тип дороги. Note: поддерживается только для вождения travelMode.

Значение Описание
Arterial

Артериальный.
Ferry

Паром.
Highway

Шоссе.
LimitedAccessHighway

LimitedAccessHighway.
MajorRoad

МайорРоад.
NotApplicable

NotApplicable.
Ramp

Рампа.
Street

Улица.
WalkingPath

Ходячий путь.

RouteDirectionOptimizeRouteEnum

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

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"

Значение Описание
fastestAvoidClosureWithoutTraffic

Маршрут вычисляется, чтобы свести к минимуму время и избежать закрытия дорог. В расчете не используется информация о дорожном движении, за исключением закрытия дорог. Note: поддерживается только для вождения travelMode.
fastestWithTraffic

Маршрут вычисляется, чтобы свести к минимуму время с использованием текущей информации о трафике. Note: поддерживается только для вождения и грузовика travelMode.
fastestWithoutTraffic

Находит самый быстрый маршрут, не учитывая сведения о трафике.
shortest

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

RouteDirectionVehicleSpec

Object

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

ISNote: поддерживается только для грузовика travelMode.

Имя Тип Default value Описание
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.
axleCount

integer (int64)

Количество осей на транспортном средстве.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
height

number (double)

minimum: 0
maximum: 1000000 		0

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

boolean

False

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

number (double)

minimum: 0
maximum: 1000000 		0

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

VehicleLoadTypeEnum[]

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

integer (int64)

minimum: 0
maximum: 250 		0

Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях.

Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута.

Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
weight

integer (int64)

minimum: 0
maximum: 1000000 		0

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

number (double)

minimum: 0
maximum: 1000000 		0

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

RouteOutputOptionEnum

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

Добавьте нужные сведения о маршруте из ответа. По умолчанию маршрут включается в ответ.

Поддерживает несколько значений, таких как routeOutputOptions: ["routePath", "regionTravelSummary"]

Значение Описание
itinerary

Включите подробные инструкции в ответ. Подробные инструкции предоставляются как "Маневры" и содержат такие сведения, как повернутые инструкции.
regionTravelSummary

Включите сводку по расстоянию, времени и платной дороге двумя типами сущностей: страна (например, США, Канада) и административное деление или административное подразделение (например, "штат" в США и "провинция" в Канаде). Note: поддерживается только для вождения и прогулки travelMode
routePath

Включите geoJSON MultiLineString RFC 7946, раздел 3.1.5, описывающий путь маршрута в ответе.
routeSummary

Включите только время путешествия и расстояние для маршрута и не предоставляют другие сведения.

RoutePathPoint

Object

Ссылается на индекс точки в определенной части маршрута.

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

integer (int64)

Индекс маршрута — это последовательный номер маршрута, назначенный каждому логу маршрута, который помогает определить и различать различные сегменты маршрута.
pointIndex

integer (int64)

Индекс точки в определенной ноге.

RoutePathProperties

Object

Указывает свойства, описывающие путь маршрута в ответе.

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

string (date-time)

Предполагаемое время прибытия для ноги, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
departureAt

string (date-time)

Предполагаемое время отъезда для ноги, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
distanceInMeters

number

Физическое расстояние в метрах, охватываемого всем маршрутом.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
legs

Leg[]

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

OptimizedWaypoint[]

Оптимизированная последовательность точек пути. Он показывает индекс от пользователя, предоставленную последовательность точек пути для исходных и оптимизированных списков.
resourceId

string

Уникальный идентификатор ресурса.
trafficCongestion

TrafficCongestionEnum

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode
trafficDataUsed

TrafficDataUsedEnum

Тип данных трафика в режиме реального времени, используемых для создания маршрута.
type string:

RoutePath

Тип вывода.

RoutePathRange

Object

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

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

integer (int64)

Индекс маршрута — это последовательный номер маршрута, назначенный каждому логу маршрута, который помогает определить и различать различные сегменты маршрута.
range

integer[] (int64)

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

RoutePathTravelModeEnum

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

Режим перемещения для пути маршрута в ответе.

Значение Описание
driving

Маршруты, оптимизированные для автомобилей.
other

RouteTravelMode возвращается как "другой" для грузовика travelMode, если маршрут грузовика недоступен для определенного раздела маршрута.
truck

Маршруты, оптимизированные для больших размеров грузовиков на основе спецификации транспортного средства.
walking

Маршруты, оптимизированные для пешеходов.

SideOfStreetEnum

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

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

Значение Описание
Left

Налево.
Right

Правильно.
Unknown

Неизвестный.

Step

Object

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

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

number

Направление в градусах. Note: поддерживается только для вождения travelMode.
maneuverType

ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
names

string[]

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

RoadTypeEnum

Тип дороги. Note: поддерживается только для вождения travelMode.
routePathRange

RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

SubLeg

Object

Сведения о сегментах маршрута, определенных точками пути маршрута и любыми промежуточными точками путем. Например, если в маршруте есть две точки маршрута в дополнение к точкам начала и окончания пути, будет три (3) подножки маршрута.

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

number

Физическое расстояние в метрах, охваченное подножеством.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
routePathRange

RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

Summary

Object

Сводка для пакетного запроса

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

integer (int32)

Количество успешных запросов в пакете
totalRequests

integer (int32)

Общее количество запросов в пакете

TrafficCongestionEnum

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

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode

Значение Описание
Heavy

Тяжелый.
Medium

Терпимая.
Mild

Легкая.
None

Нет.
Unknown

Неизвестный.

TrafficDataUsedEnum

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

Тип данных трафика в режиме реального времени, используемых для создания маршрута.

Значение Описание
Closure

Используемые данные закрытия в режиме реального времени, если это применимо.
Flow

Скорости трафика в режиме реального времени, используемые для вычисления времени движения.
FlowAndClosure

Поток и закрытие.
None

Нет.

TravelModeEnum

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

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

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"

Значение Описание
driving

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

Возвращаемые маршруты оптимизированы для больших размеров грузовиков на основе спецификации транспортного средства.
walking

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

VehicleLoadTypeEnum

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

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

Значение Описание
USHazmatClass1

Взрывчатка
USHazmatClass2

Сжатый газ
USHazmatClass3

Воспламеняемые жидкости
USHazmatClass4

Воспламеняемые твердые вещества
USHazmatClass5

Окислители
USHazmatClass6

Противоядия
USHazmatClass7

Радиоактивный
USHazmatClass8

Корросивы
USHazmatClass9

Разное
otherHazmatExplosive

Взрывчатка
otherHazmatGeneral

Разное
otherHazmatHarmfulToWater

Вредно для воды

ViaWaypointProperties

Object

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

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

string[]

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

Order

Последовательность для посещения точек пути и viaWaypoints.
routePathPoint

RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
type string:

ViaWaypoint

Тип вывода.

WaypointProperties

Object

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

Имя Тип Default value Описание
address

Address

Административный район и регион страны для точек пути и точек маневра на маршруте грузовика. Примечание. Поддерживается только для грузовика travelMode.
compassDirection

string

Направление путешествия, связанное с маневром на маршруте, например на юге или юго-западе. Note: поддерживается только для вождения travelMode.
distanceInMeters

number

Физическое расстояние в метрах, охватываемого этим шагом маршрута.
durationInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance.
exitIdentifier

string

Имя или номер выхода, связанного с этим шагом маршрута.
instruction

Instruction

Описание маневра в наборе направлений.
order

Order

Последовательность для посещения точек пути и viaWaypoints.
routePathPoint

RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
sideOfStreet

SideOfStreetEnum

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

string[]

Текст подписи для маршрута. Может быть несколько значений знака.
steps

Step[]

Шаги между двумя последовательными точками маневра.
towardsRoadName

string

Имя улицы, к которому идет маршрут в первом ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Режим перемещения для пути маршрута в ответе.
type string:

Waypoint

Тип вывода.