Route - Get Route Directions Batch

Ссылка

Служба:: Maps

Версия API:: 1.0

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

API Get Route Directions Batch — это HTTP-запрос GET , который отправляет пакеты запросов в API получения маршрутов с помощью одного запроса. Вы можете вызывать Get Route Directions Batch API для выполнения асинхронно (асинхронно) или синхронно (синхронизация). Асинхронный API позволяет вызывающей службе пакетировать до 700 запросов и синхронизировать API до 100 запросов.

Скачивание результатов асинхронной пакетной обработки

Чтобы скачать результаты асинхронного пакета, отправьте запрос к конечной GET точке пакетной загрузки. Этот URL-адрес для скачивания можно получить из заголовка Location успешного POST пакетного запроса и выглядеть следующим образом:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Ниже приведена типичная последовательность операций для скачивания результатов пакета.

Клиент отправляет запрос по GETURL-адресу для скачивания.
Сервер ответит одним из следующих вариантов:

HTTP 202 Accepted — пакетный запрос был принят, но все еще обрабатывается. Повторите попытку через некоторое время.

HTTP 200 OK — пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

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

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

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

Ниже приведен пример пакетного ответа с результатом 1 успешный и 1 сбой :

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	string	Идентификатор пакетной службы для запроса операции.
api-version	query	True	string	Номер версии API Azure Maps

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

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

Ответы

Имя	Тип	Описание
200 OK	RouteDirectionsBatchResult	Пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.
202 Accepted		Поддерживается только для асинхронного запроса. Запрос принят: запрос принят для обработки. Используйте URL-адрес в заголовке расположения, чтобы повторить попытку или получить доступ к результатам. Заголовки Location: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Имя

Тип

Описание

200 OK

RouteDirectionsBatchResult

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

202 Accepted

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

Заголовки

Location: string

Other Status Codes

ErrorResponse

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

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

AADToken

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

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

Примечания

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

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

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

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

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successfully retrieve the status for the route direction batch request

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

HTTP

GET https://atlas.microsoft.com/route/directions/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

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

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

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

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

Определения

Имя	Описание
DelayMagnitude	Величина задержки, вызванной инцидентом. Эти значения соответствуют значениям поля ответа ty API получения сведений об инциденте дорожного движения.
DrivingSide	Указывает, что левая и правая сторона вождения в точке маневра.
EffectiveSetting	Действующий параметр или данные, используемые при вызове этого API маршрута.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GuidanceInstructionType	Тип инструкции, например поворот или изменение дорожной формы.
GuidanceManeuver	Код, определяющий маневр.
JunctionType	Тип соединения, на котором выполняется маневр. Для больших кругов создаются две отдельные инструкции для входа и выхода из круговой развязки.
LatLongPair	Расположение, представленное в виде широты и долготы.
Response	Результат запроса. RouteDirections, если запрос выполнен успешно, ErrorResponse — в противном случае.
ResponseSectionType	Типы разделов сообщаемого ответа маршрута
ResponseTravelMode	Режим перемещения для вычисляемого маршрута. Если запрошенный режим транспорта не поддерживается в этом разделе, будет задано `other` значение .
Route
RouteDirectionsBatchItem	Элемент, возвращенный вызовом пакетной службы маршрутных маршрутов.
RouteDirectionsBatchResult	Этот объект возвращается из успешного вызова пакетной службы маршрутных маршрутов.
RouteGuidance	Содержит элементы, связанные с руководством. Это поле присутствует только в том случае, если было запрошено руководство и доступно.
RouteInstruction	Набор атрибутов, описывающих маневр, например "Повернуть вправо", "Оставить влево", "Возьмите паром", "Возьмите автомагистраль", "Приехать".
RouteInstructionGroup	Группировать последовательность элементов инструкций, которые связаны друг с другом. Диапазон последовательностей ограничен значениями firstInstructionIndex и lastInstructionIndex. Если в текстовых сообщениях, доступных для чтения, запрашиваются рекомендации (instructionType=text или помечены тегами), то в группе инструкций возвращается сводное сообщение, если доступно.
RouteLeg	Описание части маршрута, состоящее из списка точек. Каждая дополнительная точка пути, указанная в запросе, приведет к дополнительному этапу в возвращаемом маршруте.
RouteLegSummary	Объект Summary для раздела маршрута.
RouteOptimizedWaypoint	Оптимизированный объект точки пути.
RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.
RouteSection	Разделы маршрута содержат дополнительные сведения об частях маршрута. Каждый раздел содержит по крайней мере элементы `startPointIndex`, `endPointIndex`и `sectionType`.
RouteSectionTec	Сведения о событии трафика с использованием определений в стандарте TPEG2-TEC . Может содержать элементы effectCode и causes.
RouteSectionTecCause	Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.
RouteSummary	Объект Summary
SimpleCategory	Тип инцидента. В настоящее время может быть JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе "tec".
Summary	Сводка результатов пакетного запроса

DelayMagnitude

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

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

DrivingSide

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

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

EffectiveSetting

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

GuidanceInstructionType

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

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

GuidanceManeuver

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

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

JunctionType

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

Имя	Тип	Описание
BIFURCATION	string	раздвоение
REGULAR	string	обычный
ROUNDABOUT	string	окольный

LatLongPair

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

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

Response

Результат запроса. RouteDirections, если запрос выполнен успешно, ErrorResponse — в противном случае.

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

ResponseSectionType

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

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

ResponseTravelMode

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

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

Route

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

RouteDirectionsBatchItem

Элемент, возвращенный вызовом пакетной службы маршрутных маршрутов.

Имя	Тип	Описание
response	Response	Результат запроса. RouteDirections, если запрос выполнен успешно, ErrorResponse — в противном случае.
statusCode	integer	Код состояния HTTP-запроса.

RouteDirectionsBatchResult

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

Имя	Тип	Описание
batchItems	RouteDirectionsBatchItem[]	Массив, содержащий пакетные результаты.
summary	Summary	Сводка результатов пакетного запроса

RouteGuidance

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

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

RouteInstruction

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

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

RouteInstructionGroup

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

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

RouteLeg

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

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

RouteLegSummary

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

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

RouteOptimizedWaypoint

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

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

RouteReport

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

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

RouteSection

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

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

RouteSectionTec

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

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

RouteSectionTecCause

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

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

RouteSummary

Объект Summary

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

SimpleCategory

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

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

Summary

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

Имя	Тип	Описание
successfulRequests	integer	Количество успешных запросов в пакете
totalRequests	integer	Общее количество запросов в пакете

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

Route - Get Route Directions Batch

Скачивание результатов асинхронной пакетной обработки

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

Параметры URI

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

Ответы

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

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Successfully retrieve the status for the route direction batch request

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

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

Определения

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

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