Route - Post Route Matrix

Ссылка

Служба:: Maps

Версия API:: 1.0

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

API Post Route Matrix — это запрос HTTP POST, который позволяет вычислять матрицу сводок маршрутов для набора маршрутов, определенных источниками и целевыми расположениями, с помощью асинхронного (асинхронного) запроса. Сведения о выполнении синхронного (синхронного) запроса см. в разделе синхронизации матрицы маршрутов. Для каждого заданного источника служба вычисляет стоимость маршрутизации из этого источника в каждое заданное место назначения. Набор источников и набор назначений можно рассматривать как заголовки столбцов и строк таблицы, а каждая ячейка в таблице содержит затраты на маршрутизацию от источника к месту назначения для этой ячейки. Например, предположим, что у компании доставки продуктов питания есть 20 водителей, и им нужно найти ближайшего водителя, чтобы забрать доставку из ресторана. Чтобы решить этот вариант использования, они могут вызывать API матрицы маршрутов.

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

Максимальный размер матрицы для асинхронного запроса составляет 700 и для запроса синхронизации 100 (число источников, умноженное на число назначений).

Заметка

Все источники и назначения должны содержаться в ограничивающем поле с выравниванием по оси 400 км x 400 км. В противном случае некоторые ячейки матрицы будут разрешены как OUT_OF_REGION.

Отправка синхронного запроса матрицы маршрутов

Если для сценария требуются синхронные запросы, а максимальный размер матрицы меньше или равен 100, может потребоваться выполнить синхронный запрос. Максимальный размер матрицы для этого API составляет 100 (число источников, умноженное на число назначений). Учитывая это ограничение, примеры возможных измерений матрицы: 10x10, 6x8, 9x8 (не требуется квадрат).

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

Отправка асинхронного запроса матрицы маршрутов

Асинхронный API подходит для обработки больших объемов относительно сложных запросов маршрутизации. При выполнении запроса с помощью асинхронного запроса служба возвращает код ответа 202 по URL-адресу перенаправления в поле "Расположение" заголовка ответа. Этот URL-адрес следует периодически проверять до тех пор, пока не будут доступны данные ответа или сведения об ошибках. Если параметр waitForResults в запросе имеет значение true, пользователь получит ответ 200, если запрос завершен в течение 120 секунд.

Максимальный размер матрицы для этого API составляет 700 (число источников, умноженное на число назначений). Учитывая это ограничение, примеры возможных измерений матрицы: 50x10, 10x10, 28x25. 10x70 (он не должен быть квадратным).

Асинхронные ответы хранятся в течение 24 часов. URL-адрес перенаправления возвращает ответ 404, если используется после истечения срока действия.

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

Ниже приведена типичная последовательность асинхронных операций:

Клиент отправляет запрос Route Matrix POST в Azure Maps
Сервер ответит на одно из следующих действий:

HTTP 202 Accepted — запрос матрицы маршрутов был принят.

HTTP Error . Произошла ошибка при обработке запроса "Матрица маршрутов". Это может быть либо 400 недопустимый запрос, либо любой другой код состояния ошибки.
Если запрос matrix Route был принят успешно, заголовок location в ответе содержит URL-адрес для скачивания результатов запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

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

При выполнении запроса POST для API синхронизации матрицы маршрутизации служба возвращает код ответа 200 для успешного запроса и массива ответов. Текст ответа будет содержать данные и не будет возможности получить результаты позже.

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

Когда запрос выдает ответ 202 Accepted, запрос обрабатывается с помощью асинхронного конвейера. Вы получите URL-адрес для проверки хода выполнения асинхронного запроса в заголовке расположения ответа. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL-адрес, предоставленный заголовком расположения, возвращает следующие ответы при выдаче запроса GET.

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

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

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

С использованием необязательных параметров:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.
arriveAt	query		string date-time	Дата и время прибытия в точку назначения, отформатированная как значение `dateTime`, как определено в RFC 3339, раздел 5.6, с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка назначения. Примеры: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Параметр `arriveAt` нельзя использовать в сочетании с `departAt`, `minDeviationDistance` или `minDeviationTime`.
avoid	query		RouteAvoidType[]	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
computeTravelTimeFor	query		ComputeTravelTime	Указывает, следует ли возвращать дополнительные время поездки с использованием различных типов информации о дорожном движении (нет, исторические, живые), а также оптимальной оценки времени путешествия по умолчанию.
departAt	query		string date-time	Дата и время отъезда из точки источника, отформатированная как значение `dateTime`, как определено в RFC 3339, раздел 5.6с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка источника. Значение по умолчанию: теперь Другое значение: `dateTime` Примеры: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Параметр `departAt` нельзя использовать в сочетании с `arriveAt`.
hilliness	query		InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
routeType	query		RouteType	Тип запрошенного маршрута.
sectionType	query		SectionType[]	Указывает, какие типы разделов сообщаются в ответе маршрута. Например, если sectionType = пешеходы, которые подходят только для пешеходов, возвращаются. Можно указать несколько раз в одном запросе, например '§ionType=carTrain§ionType=пешеходная§ionType=автомагистраль". Тип раздела по умолчанию относится к входным данным travelMode. По умолчанию travelMode имеет значение car
traffic	query		boolean	Возможные значения: True. Рассмотрите все доступные сведения о трафике во время маршрутизации false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные дорожного движения игнорируются во время маршрутизации, влияние исторического движения на эффективные скорости дорожного движения по-прежнему включается.
travelMode	query		TravelMode	Режим поездки для запрошенного маршрута. Если не определено, значение по умолчанию — "автомобиль". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
vehicleAxleWeight	query		integer	Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
vehicleHeight	query		number double	Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются.
vehicleLength	query		number double	Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType	query		VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах или регионах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие страны или регионы должны использоваться для других стран и регионов. vehicleLoadType можно указать несколько раз. Этот параметр в настоящее время считается только для travelMode=truck.
vehicleMaxSpeed	query		integer	Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
vehicleWeight	query		integer	Вес транспортного средства в килограммах.
vehicleWidth	query		number double	Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
waitForResults	query		boolean	Логическое значение, указывающее, следует ли выполнять запрос синхронно. Если задано значение true, пользователь получит ответ 200, если запрос завершится до 120 секунд. В противном случае пользователь сразу получит ответ 202. Дополнительные сведения об ответе 202 см. в описании API. поддерживается только для асинхронного запроса.
windingness	query		WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

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

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

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

Имя	Тип	Описание
destinations	GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
origins	GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.

Ответы

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

Имя

Тип

Описание

200 OK

RouteMatrixResult

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

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-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

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

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

Тип: apiKey
В: header

Примеры

Successfully submit a route matrix request

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

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

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

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

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

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

operation-Location: New URL to check the status of the long-running operation.

Определения

Имя	Описание
ComputeTravelTime	Указывает, следует ли возвращать дополнительные время поездки с использованием различных типов информации о дорожном движении (нет, исторические, живые), а также оптимальной оценки времени путешествия по умолчанию.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
RouteAvoidType	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
RouteLegSummary	Сводный объект для раздела маршрута.
RouteMatrix	Объект результата матрицы
RouteMatrixQuery	Объект с матрицей координат.
RouteMatrixResult	Этот объект возвращается из успешного вызова Route Matrix. Например, если предоставляются 2 источника и 3 назначения, в каждом из них будет 2 массива с 3 элементами. Содержимое каждого элемента зависит от параметров, предоставленных в запросе.
RouteMatrixResultResponse	Объект ответа текущей ячейки в входной матрице.
RouteMatrixSummary	Объект Summary
RouteType	Тип запрошенного маршрута.
SectionType	Указывает, какие типы разделов сообщаются в ответе маршрута. Например, если sectionType = пешеходы, которые подходят только для пешеходов, возвращаются. Можно указать несколько раз в одном запросе, например '§ionType=carTrain§ionType=пешеходная§ionType=автомагистраль". Тип раздела по умолчанию относится к входным данным travelMode. По умолчанию travelMode имеет значение car
TravelMode	Режим поездки для запрошенного маршрута. Если не определено, значение по умолчанию — "автомобиль". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах или регионах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие страны или регионы должны использоваться для других стран и регионов. vehicleLoadType можно указать несколько раз. Этот параметр в настоящее время считается только для travelMode=truck.
WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

ComputeTravelTime

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

Имя	Тип	Описание
all	string	Вычисляет время перемещения для всех типов информации о трафике и указывает все результаты полей noTrafficTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds и liveTrafficIncidentsTravelTimeInSeconds, включенных в сводки в ответе маршрута.
none	string	Не вычисляет дополнительное время перемещения.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

GeoJsonMultiPoint

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

Имя	Тип	Описание
coordinates	number[]	Координаты геометрии `GeoJson MultiPoint`.
type	string: MultiPoint	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

InclineLevel

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

Имя	Тип	Описание
high	string	высокий
low	string	низкий
normal	string	нормальный

JsonFormat

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

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

RouteAvoidType

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

Имя	Тип	Описание
alreadyUsedRoads	string	Избегает использования одной и той же дороги несколько раз. Наиболее полезно в сочетании с `routeType`=захватывающим.
borderCrossings	string	Избегает пересечения границ в расчете маршрутов.
carpools	string	Избегает маршрутов, требующих использования полос carpool (HOV/High Occupancy Vehicle) полос.
ferries	string	Избегает паромов
motorways	string	Избегайте автомагистралей
tollRoads	string	Избегает платных дорог.
unpavedRoads	string	Избегает неотложных дорог

RouteLegSummary

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

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

RouteMatrix

Объект результата матрицы

Имя	Тип	Описание
response	RouteMatrixResultResponse	Объект ответа текущей ячейки в входной матрице.
statusCode	integer	Свойство StatusCode для текущей ячейки в входной матрице.

RouteMatrixQuery

Объект с матрицей координат.

Имя	Тип	Описание
destinations	GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
origins	GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.

RouteMatrixResult

Этот объект возвращается из успешного вызова Route Matrix. Например, если предоставляются 2 источника и 3 назначения, в каждом из них будет 2 массива с 3 элементами. Содержимое каждого элемента зависит от параметров, предоставленных в запросе.

Имя	Тип	Описание
formatVersion	string	Свойство Format Version
matrix	RouteMatrix[]	Результаты в виде 2-го массива сводок маршрутов.
summary	RouteMatrixSummary	Объект Summary

RouteMatrixResultResponse

Объект ответа текущей ячейки в входной матрице.

Имя	Тип	Описание
routeSummary	RouteLegSummary	Сводный объект для раздела маршрута.

RouteMatrixSummary

Объект Summary

Имя	Тип	Описание
successfulRoutes	integer	Количество успешных маршрутов в ответе.
totalRoutes	integer	Общее количество запрошенных маршрутов. Число ячеек в входной матрице.

RouteType

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

Имя	Тип	Описание
eco	string	Маршрут, сбалансированный по экономике и скорости.
fastest	string	Самый быстрый маршрут.
shortest	string	Самый короткий маршрут по расстоянию.
thrilling	string	Включает интересные или сложные дороги и использует как можно меньше автомагистралей. Вы можете выбрать уровень поворотов, включенных и степень холмистости. Сведения о настройке этого параметра см. в параметрах холмистости и обветренности. Существует ограничение в 900 км на маршрутах, запланированных с `routeType`=захватывающий

SectionType

Указывает, какие типы разделов сообщаются в ответе маршрута.

Например, если sectionType = пешеходы, которые подходят только для пешеходов, возвращаются. Можно указать несколько раз в одном запросе, например '§ionType=carTrain§ionType=пешеходная§ionType=автомагистраль". Тип раздела по умолчанию относится к входным данным travelMode. По умолчанию travelMode имеет значение car

Имя	Тип	Описание
carTrain	string	Разделы маршрута, которые являются автомобилями или поездами.
carpool	string	Разделы маршрута, требующие использования полос carpool (HOV/High Occupancy Vehicle) полос.
country	string	Разделы, указывающие, в каких странах или регионах находится маршрут.
ferry	string	Разделы маршрута, которые являются паромами.
motorway	string	Разделы маршрута, которые являются автомагистралями.
pedestrian	string	Разделы маршрута, которые подходят только для пешеходов.
tollRoad	string	Разделы маршрута, требующие оплаты платных платежей.
tollVignette	string	Разделы маршрута, для которых требуется наличие виньетки с платным номером.
traffic	string	Разделы маршрута, содержащие сведения о трафике.
travelMode	string	Разделы относительно параметра запроса `travelMode`.
tunnel	string	Разделы маршрута, которые являются туннелями.
urban	string	Разделы маршрута, расположенные в городских районах.

TravelMode

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

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

VehicleLoadType

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

Имя	Тип	Описание
USHazmatClass1	string	Взрывчатка
USHazmatClass2	string	Сжатый газ
USHazmatClass3	string	Воспламеняемые жидкости
USHazmatClass4	string	Воспламеняемые твердые вещества
USHazmatClass5	string	Окислители
USHazmatClass6	string	Противоядия
USHazmatClass7	string	Радиоактивный
USHazmatClass8	string	Корросивы
USHazmatClass9	string	Смешанный
otherHazmatExplosive	string	Взрывчатка
otherHazmatGeneral	string	Смешанный
otherHazmatHarmfulToWater	string	Вредно для воды

WindingnessLevel

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

Имя	Тип	Описание
high	string	высокий
low	string	низкий
normal	string	нормальный

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

Route - Post Route Matrix

Отправка синхронного запроса матрицы маршрутов

Отправка асинхронного запроса матрицы маршрутов

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

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

Параметры URI

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

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

Ответы

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

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Successfully submit a route matrix request

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

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

Определения

ComputeTravelTime

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonMultiPoint

InclineLevel

JsonFormat

RouteAvoidType

RouteLegSummary

RouteMatrix

RouteMatrixQuery

RouteMatrixResult

RouteMatrixResultResponse

RouteMatrixSummary

RouteType

SectionType

TravelMode

VehicleLoadType

WindingnessLevel

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