Route - Post Route Directions Batch

Ссылка

Service:: Maps

API Version:: 1.0

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

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

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

Асинхронный API подходит для обработки больших объемов относительно сложных запросов маршрутов.

Он позволяет получить результаты в отдельном вызове (возможно несколько скачиваний).
Асинхронный API оптимизирован для обеспечения надежности и не ожидается, что время ожидания истекло.
Количество пакетных элементов для этого API ограничено 700 .

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 вместе с URL-адресом перенаправления в поле Расположение заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если он используется после истечения срока действия.

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

Клиент отправляет пакетный POST запрос направления маршрута Azure Maps.

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

Сервер ответит одним из следующих ответов:

HTTP 202 Accepted — пакетный запрос принят.

HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть либо код состояния, либо любой 400 Bad Request другой Error код состояния.
Если пакетный запрос был успешно принят, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот URI состояния выглядит следующим образом:

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

Клиент отправляет GET запрос по URL-адресу скачивания , полученному на шаге 3, чтобы скачать результаты пакета.

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

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

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Запрос направления маршрута в пакете — это лишь частичный URL-адрес без протокола, базового URL-адреса, пути, версии API и ключа подписки. Он может принимать любые поддерживаемые параметры URIнаправлений маршрута. Строковые значения в запросе маршрутов должны быть правильно экранированы (например, символ "должен быть экранирован с \ ), а также правильно закодирован URL-адрес.

Асинхронный API позволяет вызывающей службе пакетировать до 700 запросов и синхронизировать API до 100 запросов. Пакет должен содержать не менее 1 запроса.

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

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

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

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

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

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

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

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

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. Если при скачивании результатов асинхронного пакетного запроса обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит компонент , указывающий summarytotalRequests , который был частью исходного пакетного запроса, и 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."
                }
            }
        }
    ]
}

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
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 см. в следующих статьях.

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

Имя	Тип	Описание
batchItems	BatchRequestItem[]	Список обрабатываемых запросов.

Ответы

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

Имя

Тип

Описание

200 OK

RouteDirectionsBatchResult

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

202 Accepted

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

Headers

Location: string

Other Status Codes

ErrorResponse

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

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

AADToken

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

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

Примечания

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

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

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

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

Successfully submit a route direction batch request

Sample Request

HTTP

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

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Sample Response

Status code:: 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
  }
}

Status code:: 202

operation-Location: URL to download the results of the long-running batch request.

Определения

Имя	Описание
BatchRequest	Этот тип представляет текст запроса для пакетной службы.
BatchRequestItem	Объект пакетного запроса
DelayMagnitude	Величина задержки, вызванной инцидентом. Эти значения соответствуют значениям поля ответа ty API получения сведений об инциденте дорожного движения.
DrivingSide	Указывает на левую и правую сторону вождения в точке маневра.
EffectiveSetting	Действующий параметр или данные, используемые при вызове этого API маршрута.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GuidanceInstructionType	Тип инструкции, например поворот или изменение формы дороги.
GuidanceManeuver	Код, определяющий маневр.
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
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 и вызывает элементы.
RouteSectionTecCause	Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.
RouteSummary	Объект Summary
SimpleCategory	Тип инцидента. В настоящее время может иметь значение JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе tec.
Summary	Сводка результатов пакетного запроса

BatchRequest

Этот тип представляет текст запроса для пакетной службы.

Имя	Тип	Описание
batchItems	BatchRequestItem[]	Список обрабатываемых запросов.

BatchRequestItem

Объект пакетного запроса

Имя	Тип	Описание
query	string	Этот параметр содержит строку запроса, используемую для выполнения операции неструктурированного геокодирования. Строка запроса будет передана в API поиска для обработки дословно.

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	Переключитесь на main дорогу.
SWITCH_PARALLEL_ROAD	string	Переключитесь на параллельную дорогу.
TAKE_EXIT	string	Выход.
TAKE_FERRY	string	Возьмите паром.
TRY_MAKE_UTURN	string	Попробуйте сделать разворот.
TURN_LEFT	string	Поверните влево.
TURN_RIGHT	string	Поверните вправо.
WAYPOINT_LEFT	string	Вы достигли точки пути. Это слева.
WAYPOINT_REACHED	string	Вы достигли точки пути.
WAYPOINT_RIGHT	string	Вы достигли точки пути. Это справа.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

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

JunctionType

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

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

LatLongPair

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

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

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 Заполненный автомобиль) полосы движения.
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	string	Это указывает, какой выход следует принять при кольцевой развязке.
routeOffsetInMeters	integer	Расстояние от начала маршрута до точки инструкции.
signpostText	string	Текст на указателе, наиболее релевантный для маневра или направления, за которым следует следовать.
stateCode	string	Подразделение (например, штат) страны, представленное второй частью кода ISO 3166-2 . Эта возможность доступна только для некоторых стран и регионов, таких как США, Канада и Мексика.
street	string	Название улицы следующего значительного сегмента дороги после маневра, или улицы, за которой следует следовать.
travelTimeInSeconds	integer	Предполагаемое время в пути до точки, соответствующей routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Указывает направление инструкции. Если параметр junctionType указывает на инструкцию поворота: 180 = разворот [-179, -1] = левый поворот 0 = прямо в (поворот на 0 градусов) [1, 179] = Поворот вправо Если параметр junctionType указывает на инструкцию бифуркации: <0 — оставить слева >0 — оставить право

RouteInstructionGroup

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

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

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	RouteSectionTecCause[]	Массив причин
effectCode	integer	Влияние на поток трафика. Содержит значение в таблице tec001:EffectCode, как определено в стандарте TPEG2-TEC . Можно использовать для цветового кода событий трафика в соответствии с серьезностью.

RouteSectionTecCause

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

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

RouteSummary

Объект Summary

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

SimpleCategory

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

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

Summary

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

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

Route - Post Route Directions Batch

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

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

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

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

Параметры URI

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

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

Ответы

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

AADToken

Примечания

Scopes

subscription-key

SAS Token

Примеры

Successfully submit a route direction batch request

Sample Request

Sample Response

Определения

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

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