Route - Post Route Directions Batch Sync

Служба:: Maps

Версия API:: 1.0

Используется для отправки пакета запросов в api Get Route Directions в одном синхронном запросе.

Примечание.

azure Maps Route версии 1

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

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

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

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

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

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

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

POST https://atlas.microsoft.com/route/directions/batch/sync/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 см. в статье Управление проверкой подлинности в Azure Maps.

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

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

Ответы

Имя	Тип	Описание
200 OK	RouteDirectionsBatchResult	ХОРОШО
Other Status Codes	ErrorResponse	Время ожидания: запрос занимает больше времени, чем максимальное время, определенное в API.
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечания.

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

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

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

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

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successfully retrieve the route direction batch result synchronously

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

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/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"
    }
  ]
}

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

Код состояния:: 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
  }
}

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

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Определения

Имя	Описание
BatchRequest	Этот тип представляет текст запроса для пакетной службы.
BatchRequestItem	Объект пакетного запроса
DelayMagnitude	Величина задержки, вызванная инцидентом. Эти значения соответствуют значениям поля ответа 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	Группируют последовательность элементов инструкций, связанных друг с другом. Диапазон последовательности ограничен первой структуройInstructionIndex и lastInstructionInstructionIndex. Если текстовые сообщения, доступные для чтения человека, запрашиваются для указания (инструкцияType=text или tagged), группа инструкций возвращает сводное сообщение, возвращаемое при наличии.
RouteLeg	Описание части маршрута, состоящей из списка точек. Каждая дополнительная точка пути, указанная в запросе, приведет к дополнительной ноге в возвращаемом маршруте.
RouteLegSummary	Сводный объект для раздела маршрута.
RouteOptimizedWaypoint	Оптимизированный объект точки пути.
RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.
RouteSection	Разделы маршрута содержат дополнительные сведения о частях маршрута. Каждый раздел содержит по крайней мере элементы `startPointIndex`, `endPointIndex`и `sectionType`.
RouteSectionTec	Сведения о событии трафика, используя определения в стандарте TPEG2- TEC. Может содержать код эффектов и вызывает элементы.
RouteSectionTecCause	Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.
RouteSummary	Объект Summary
SimpleCategory	Тип инцидента. В настоящее время может быть JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе "tec".
Summary	Сводка результатов для пакетного запроса

BatchRequest

Object

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

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

BatchRequestItem

Object

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

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

DelayMagnitude

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

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

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

DrivingSide

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

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

Значение	Описание
LEFT	Левая сторона.
RIGHT	Правая сторона.

EffectiveSetting

Object

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

GuidanceInstructionType

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

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

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

GuidanceManeuver

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

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

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

JsonFormat

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

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

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

JunctionType

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

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

Значение	Описание
REGULAR	регулярный
ROUNDABOUT	окольный
BIFURCATION	раздвоение

LatLongPair

Object

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

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

Response

Object

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.
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, исходный — "первый, второй, третий", а оптимизированный — "второй, третий, первый".
report	RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.
routes	Route[]	Массив маршрутов

ResponseSectionType

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

Типы разделов ответа на указанный маршрут

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

ResponseTravelMode

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

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

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

Route

Object

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

RouteDirectionsBatchItem

Object

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

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

RouteDirectionsBatchResult

Object

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

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

RouteGuidance

Object

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

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

RouteInstruction

Object

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

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

RouteInstructionGroup

Object

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

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

RouteLeg

Object

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

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

RouteLegSummary

Object

Сводный объект для раздела маршрута.

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

RouteOptimizedWaypoint

Object

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

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

RouteReport

Object

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

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

RouteSection

Object

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

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

RouteSectionTec

Object

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

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

RouteSectionTecCause

Object

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

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

RouteSummary

Object

Объект Summary

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

SimpleCategory

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

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

Значение	Описание
JAM	Затор.
ROAD_WORK	Дорожные работы.
ROAD_CLOSURE	Закрытие дороги.
OTHER	Другой.

Summary

Object

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

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

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

Route - Post Route Directions Batch Sync

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

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

Параметры URI

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

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

Ответы

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

AADToken

Примечания.

Области

subscription-key

SAS Token

Примеры

Successfully retrieve the route direction batch result synchronously

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

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

Определения

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