Route - Post Route Directions

Ссылка

Служба:: Maps

Версия API:: 1.0

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

API Post Route Directions — это запрос HTTP POST, который возвращает маршрут между источником и назначением, передавая точки пути, если они указаны. Маршрут учитывает такие факторы, как текущий трафик и типичные скорости дорожного движения в запрошенный день недели и времени дня.

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

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

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

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

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
api-version	query	True	string	Номер версии API Azure Maps.
query	query	True	string	Координаты, с помощью которых вычисляется маршрут, разделенные двоеточием. Требуется не менее двух координат. Первое — источник, а последний — назначение маршрута. Необязательные координаты между ними выполняют роль WayPoints в маршруте. Можно передать до 150 WayPoints.
accelerationEfficiency	query		number double	Указывает эффективность преобразования химической энергии, хранящейся в кинетической энергии, когда автомобиль ускоряет (т. е. KineticFxGained/ChemicalDbConsumed). Химическое, полученное путем преобразования потребляемого топлива в химическую энергию с помощью топливаErDensityInMJoulesPerLiter. Необходимо связать с замедлением. Диапазон значений, допустимых, составляет от 0,0 до 1/замедление. Разумные значения: для модели сжигания : 0,33, для электрической модели : 0,66
alternativeType	query		AlternativeRouteType	Управляет оптимальностью в отношении заданных критериев планирования вычисляемых альтернатив по сравнению с эталонным маршрутом.
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`.
auxiliaryPowerInkW	query		number double	Указывает объем энергии, потребляемой для поддержания вспомогательных систем, в киловаттах (kW). Его можно использовать для указания потребления из-за устройств и систем, таких как системы AC, радио, нагревание и т. д. Разумные значения: 1.7
auxiliaryPowerInLitersPerHour	query		number double	Указывает объем топлива, потребляемого для поддержания вспомогательных систем транспортного средства, в литрах в час. Его можно использовать для указания потребления из-за устройств и систем, таких как системы AC, радио, нагревание и т. д. Разумные значения: 0.2
avoid	query		RouteAvoidType[]	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
computeBestOrder	query		boolean	Повторно упорядочение точек пути маршрута с помощью быстрого эвристического алгоритма для уменьшения длины маршрута. Обеспечивает наилучшие результаты при использовании в сочетании с routeType самым коротким. Обратите внимание, что источник и назначение исключены из оптимизированных индексов точек пути. Чтобы включить источник и назначение в ответ, увеличьте все индексы на 1, чтобы учесть источник, а затем добавьте назначение в качестве окончательного индекса. Возможные значения : true или false. Значение True вычисляет лучший порядок, если это возможно, но не допускается использовать в сочетании со значением maxAlternatives больше 0 или в сочетании с точками пути круга. False будет использовать расположения в указанном порядке и не допускается использовать в сочетании с маршрутомRepresentation ни.
computeTravelTimeFor	query		ComputeTravelTime	Указывает, следует ли возвращать дополнительные время поездки с использованием различных типов информации о дорожном движении (нет, исторические, живые), а также оптимальной оценки времени путешествия по умолчанию.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Указывает компонент, зависящий от скорости потребления. Предоставляется как неупорядоченный список пар скорости и потребления. Список определяет точки на кривой потребления. Показатели потребления скоростей, не входящих в список, находятся следующим образом: линейная интерполяция, если заданная скорость находится между двумя скоростями в списке по линейной экстраполяции в противном случае при условии константы (TMConsumption/ΔSpeed), определяемой ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для той же скорости. Если он содержит только одну точку, то скорость потребления этой точки используется без дополнительной обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно значению предпоследней максимальной скорости. Это гарантирует, что экстраполяция не приводит к отрицательным ставкам потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в kWh/100km) составляет от 0,01 до 1000000.0. Разумные значения: 50,8.2:130,21.3 Этот параметр необходим для модели потребления электроэнергии.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Указывает компонент, зависящий от скорости потребления. Предоставляется как неупорядоченный список пар скорости с разделителями двоеточием & пар скорости потребления. Список определяет точки на кривой потребления. Показатели потребления скоростей, не входящих в список, находятся следующим образом: линейная интерполяция, если заданная скорость находится между двумя скоростями в списке по линейной экстраполяции в противном случае при условии константы (TMConsumption/ΔSpeed), определяемой ближайшими двумя точками в списке Список должен содержать от 1 до 25 точек (включительно) и не может содержать повторяющиеся точки для той же скорости. Если он содержит только одну точку, то скорость потребления этой точки используется без дополнительной обработки. Потребление, указанное для наибольшей скорости, должно быть больше или равно значению предпоследней максимальной скорости. Это гарантирует, что экстраполяция не приводит к отрицательным ставкам потребления. Аналогичным образом значения потребления, указанные для двух наименьших скоростей в списке, не могут привести к отрицательной скорости потребления для любой меньшей скорости. Допустимый диапазон значений потребления (выраженный в l/100km) составляет от 0,01 до 1000000.0. Разумные значения: 50,6.3:130,11.5 Примечание. Этот параметр необходим для модели потребления топлива.
currentChargeInkWh	query		number double	Указывает текущую электрическую энергию в киловатт-часах (kWh). Этот параметр совместно существует с параметром maxChargeInkWh. Диапазон значений, допустимых в диапазоне от 0,0 до maxChargeInkWh. Разумные значения: 43
currentFuelInLiters	query		number double	Указывает текущий запас топлива в литрах. Разумные значения: 55
decelerationEfficiency	query		number double	Указывает эффективность преобразования кинетической энергии в сохраненный (не потребляемый) топливо, когда автомобиль уменьшает (т. е. ChemicalLost). Химические ВеществаSaved получены путем преобразования сохраненного (не потребляемого) топлива в энергию с помощью топливаJoulesInMJoulesPerLiter. Необходимо связать с ускорениемEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/ускоренияEfficiency. Разумные значения: для модели сжигания : 0,83, для электрической модели : 0,91
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`.
downhillEfficiency	query		number double	Указывает эффективность преобразования потенциальной энергии в сохраненный (не потребляемый) топливо, когда автомобиль теряет высоту (т. е. ChemicalDbSaved/Потенциальные Экземпляры). Химические ВеществаSaved получены путем преобразования сохраненного (не потребляемого) топлива в энергию с помощью топливаJoulesInMJoulesPerLiter. Необходимо связать с uphillEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/uphillEfficiency. Разумные значения: для модели сжигания : 0,51, для электрической модели : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Указывает объем химической энергии, хранящейся в одном литре топлива в мегаджулях (MJ). Он используется в сочетании с параметрами эффективностиэффективности для преобразования между сохраненными или потребляемыми энергией и топливом. Например, плотность энергии составляет 34,2 MJ/l для бензина и 35,8 MJ/l для дизельного топлива. Этот параметр необходим, если задан параметр эффективности *. Разумные значения: 34.2
hilliness	query		InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
instructionsType	query		RouteInstructionsType	При указании инструкции будут возвращены. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.
language	query		string	Параметр языка определяет язык сообщений руководства. Это не влияет на правильные существительные (имена улиц, площадей и т. д.) Он не действует, когда инструкцияType=закодирована. Допустимые значения : (подмножество) описанных тегов языка IETF
maxAlternatives	query		integer	Количество требуемых альтернативных маршрутов, которые необходимо вычислить. По умолчанию: 0, минимум: 0 и максимум: 5
maxChargeInkWh	query		number double	Указывает максимальный объем электроэнергии в киловатт-часах (kWh), которые могут храниться в батарее транспортного средства. Этот параметр совместно существует с параметром currentChargeInkWh. Минимальное значение должно быть больше или равно currentChargeInkWh. Разумные значения: 85
minDeviationDistance	query		integer	Все альтернативные маршруты, возвращаемые, будут соответствовать эталонной маршруту (см. раздел POST Request) из точки источника запроса calculateRoute по крайней мере для этого количества метров. Можно использовать только при восстановлении маршрута. Параметр minDeviationDistance нельзя использовать в сочетании с arriveAt
minDeviationTime	query		integer	Все альтернативные маршруты, возвращаемые, будут соответствовать эталонной маршруту (см. раздел POST Request) из точки источника запроса calculateRoute по крайней мере на это количество секунд. Можно использовать только при восстановлении маршрута. Параметр minDeviationTime нельзя использовать в сочетании с arriveAt. Значение по умолчанию — 0. Установка параметра )minDeviationTime_ значением больше нуля имеет следующие последствия: В исходной точке вычисляется запрос должен быть включен (или очень близок) входной эталонный маршрут. Если это не так, возвращается ошибка. Однако точка источника не должна находиться в начале входного эталонного маршрута (его можно считать текущей позицией транспортного средства на эталонном маршруте). Эталонный маршрут, возвращаемый в качестве первого маршрута в calculateRoute Response, будет начинаться с точки источника, указанной в вычислении запроса. Начальная часть входного маршрута ссылки вплоть до точки источника будет исключена из ответа. Значения minDeviationDistance и minDeviationTime определяют, насколько далеко альтернативные маршруты будут гарантированно соответствовать эталонной маршруте из точки источника. Маршрут должен использовать вылете. транспортных средств игнорируется.
report	query		Report	Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — действующие наборы. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию по умолчанию будет отражено, где параметр не указан вызывающим.
routeRepresentation	query		RouteRepresentationForBestOrder	Указывает представление набора маршрутов, предоставленных в качестве ответа.
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 ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
uphillEfficiency	query		number double	Указывает эффективность преобразования химической энергии, хранящейся в топливо, в потенциальную энергию, когда автомобиль получает повышение высоты (т. е. Потенциальные ТипыГайн/Химические ВеществаКонсумеда). Химическое, полученное путем преобразования потребляемого топлива в химическую энергию с помощью топливаErDensityInMJoulesPerLiter. Необходимо связать с внизхиллEfficiency. Диапазон значений, допустимых, составляет от 0,0 до 1/внизхиллEfficiency. Разумные значения: для модели сжигания : 0,27, для электрической модели : 0,74
vehicleAxleWeight	query		integer	Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
vehicleCommercial	query		boolean	Используется ли автомобиль для коммерческих целей. Коммерческие транспортные средства могут быть запрещены ездить на некоторых дорогах.
vehicleEngineType	query		VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна быть согласована со значением vehicleEngineType.
vehicleHeading	query		integer	Направление движения транспортного средства в градусах, начиная с истинного Севера и продолжающегося в часовом направлении. Север составляет 0 градусов, восток составляет 90 градусов, юг составляет 180 градусов, запад — 270 градусов. Возможные значения 0-359
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	Вес транспортного средства в килограммах. Обязательно, если заданы какие-либо из параметров эффективности. Он должен быть строго положительным при использовании в контексте модели потребления. Ограничения веса считаются. Если нет подробного модели потребления, а значение транспортного веса не равно нулю, то учитываются ограничения веса. Во всех остальных случаях этот параметр игнорируется. Разумные значения: для модели сжигания : 1600, для электрической модели : 1900
vehicleWidth	query		number double	Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
windingness	query		WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

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

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

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

Имя	Тип	Описание
allowVignette	string[]	Это список 3-символов, ISO 3166-1, альфа-3 коды стран и регионов, в которых разрешены платные дороги с виньетками, например "AUS,CHE". Указание allowVignette с некоторыми странами или регионами X эквивалентно указанию избегайте Vignette со всеми странами и регионами, но X. Указание allowVignette с пустым списком совпадает с тем, что избежать всех платных дорог с vignettes. Примечание. Это ошибка при указании обоих избежать Vignette и allowVignette.
avoidAreas	GeoJsonMultiPolygon	GeoJSON MultiPolygon, представляющий список областей, которые следует избегать. Поддерживаются только прямоугольники многоугольников. Максимальный размер прямоугольника составляет около 160x160 км. Максимальное количество избегаемых областей — 10. Он не может пересекать 180-й меридиан. Он должен находиться в диапазоне от -80 до +80 градусов широты.
avoidVignette	string[]	Это список 3-символов, ISO 3166-1, альфа-3 коды стран и регионов, в которых все платные дороги с вигнетами должны быть избеганы, например "AUS,CHE". Платные дороги с vignettes в странах или регионах, не входящих в список, не затронуты. Примечание. Это ошибка при указании обоих избежать Vignette и allowVignette.
supportingPoints	GeoJsonGeometryCollection	Коллекция GeoJSON Geometry, представляющая последовательность координат, используемых в качестве входных данных для реконструкции маршрута, и для вычисления нуля или более альтернативных маршрутов для этого эталонного маршрута. Указанная последовательность вспомогательных точек используется в качестве входных данных для восстановления маршрута. Альтернативные маршруты вычисляются между точками источника и назначения, указанными в расположениях параметров базового пути. Если для обоих minDeviationDistance и minDeviationTime задано нулевое значение, то эти точки источника и точки назначения должны находиться в начале и конце эталонного маршрута соответственно (или очень близко). Промежуточные расположения (точек пути) не поддерживаются при использовании <вспомогательных точек>. Эталонный маршрут может содержать инциденты дорожного движения типа ROAD_CLOSURE, которые игнорируются для вычисления времени поездки эталонного маршрута и задержки трафика. Дополнительные сведения см. в вспомогательных точек.

Ответы

Имя	Тип	Описание
200 OK	RouteDirections	ХОРОШО
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 a route between an origin and a destination with additional parameters in the body

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

HTTP

POST https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

{
  "supportingPoints": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Point",
        "coordinates": [
          13.42936,
          52.5093
        ]
      },
      {
        "type": "Point",
        "coordinates": [
          13.42859,
          52.50844
        ]
      }
    ]
  },
  "avoidVignette": [
    "AUS",
    "CHE"
  ],
  "avoidAreas": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [
            -122.39456176757811,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.489368981370724
          ]
        ]
      ],
      [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    ]
  }
}

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

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

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Определения

Имя	Описание
AlternativeRouteType	Управляет оптимальностью в отношении заданных критериев планирования вычисляемых альтернатив по сравнению с эталонным маршрутом.
ComputeTravelTime	Указывает, следует ли возвращать дополнительные время поездки с использованием различных типов информации о дорожном движении (нет, исторические, живые), а также оптимальной оценки времени путешествия по умолчанию.
DelayMagnitude	Величина задержки, вызванная инцидентом. Эти значения соответствуют значениям поля ответа API получения сведений об инциденте трафика.
DrivingSide	Указывает левую руку против правой стороны вождения в точке маневра.
EffectiveSetting	Действующий параметр или данные, используемые при вызове ЭТОГО API маршрута.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoJsonGeometry	Допустимый объект `GeoJSON` геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
GeoJsonGeometryCollection	Допустимый тип объекта `GeoJSON GeometryCollection`. Дополнительные сведения см. в RFC 7946.
GeoJsonLineString	Допустимый тип геометрии `GeoJSON LineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiLineString	Допустимый тип геометрии `GeoJSON MultiLineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPolygon	Допустимый тип объекта `GeoJSON MultiPolygon`. Дополнительные сведения см. в RFC 7946.
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
GeoJsonPolygon	Допустимый тип геометрии `GeoJSON Polygon`. Дополнительные сведения см. в RFC 7946.
GuidanceInstructionType	Тип инструкции, например поворот или изменение формы дороги.
GuidanceManeuver	Код, определяющий маневр.
InclineLevel	Степень холмистости для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.
JunctionType	Тип соединения, где проходит маневр. Для более крупных округлений создаются две отдельные инструкции для ввода и выхода из круговой области.
LatLongPair	Расположение, представленное в виде широты и долготы.
Report	Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — действующие наборы. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию по умолчанию будет отражено, где параметр не указан вызывающим.
ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
ResponseSectionType	Типы разделов ответа на указанный маршрут
ResponseTravelMode	Режим перемещения для вычисляемого маршрута. Значение будет иметь значение `other`, если запрошенный режим транспорта невозможен в этом разделе.
Route
RouteAvoidType	Указывает, что вычисление маршрута должно пытаться избежать при определении маршрута. Можно указать несколько раз в одном запросе, например "&избегайте=автомагистралей&избегайте=tollRoads&избегайте паромов". В запросах диапазона маршрутов значение уже не должно использоваться.
RouteDirectionParameters	Параметры основного текста для направлений маршрута.
RouteDirections	Этот объект возвращается из успешного вызова Route Directions
RouteGuidance	Содержит рекомендации, связанные с элементами. Это поле присутствует только в том случае, если было запрошено руководство и доступно.
RouteInstruction	Набор атрибутов, описывающих маневр, например "Повернуть вправо", "Сохранить слева", "Взять паром", "Взять автомагистраль", "Прибыть".
RouteInstructionGroup	Группируют последовательность элементов инструкций, связанных друг с другом. Диапазон последовательности ограничен первой структуройInstructionIndex и lastInstructionInstructionIndex. Если текстовые сообщения, доступные для чтения человека, запрашиваются для указания (инструкцияType=text или tagged), группа инструкций возвращает сводное сообщение, возвращаемое при наличии.
RouteInstructionsType	При указании инструкции будут возвращены. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.
RouteLeg	Описание части маршрута, состоящей из списка точек. Каждая дополнительная точка пути, указанная в запросе, приведет к дополнительной ноге в возвращаемом маршруте.
RouteLegSummary	Сводный объект для раздела маршрута.
RouteOptimizedWaypoint	Оптимизированный объект точки пути.
RouteReport	Сообщает об эффективных параметрах, используемых в текущем вызове.
RouteRepresentationForBestOrder	Указывает представление набора маршрутов, предоставленных в качестве ответа.
RouteSection	Разделы маршрута содержат дополнительные сведения о частях маршрута. Каждый раздел содержит по крайней мере элементы `startPointIndex`, `endPointIndex`и `sectionType`.
RouteSectionTec	Сведения о событии трафика, используя определения в стандарте TPEG2- TEC. Может содержать код эффектов и вызывает элементы.
RouteSectionTecCause	Причина события трафика. Может содержать элементы mainCauseCode и subCauseCode. Можно использовать для определения значков и описаний.
RouteSummary	Объект Summary
RouteType	Тип запрошенного маршрута.
SectionType	Указывает, какие типы разделов сообщаются в ответе маршрута. Например, если sectionType = пешеходы, которые подходят только для пешеходов, возвращаются. Можно указать несколько раз в одном запросе, например '§ionType=carTrain§ionType=пешеходная§ionType=автомагистраль". Тип раздела по умолчанию относится к входным данным travelMode. По умолчанию travelMode имеет значение car
SimpleCategory	Тип инцидента. В настоящее время может быть JAM, ROAD_WORK, ROAD_CLOSURE или OTHER. Подробные сведения см. в разделе "tec".
TravelMode	Режим поездки для запрошенного маршрута. Если не определено, значение по умолчанию — "автомобиль". Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим". Обратите внимание, что режимы путешествий автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные ограничений недоступны во всех областях.
VehicleEngineType	Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна быть согласована со значением vehicleEngineType.
VehicleLoadType	Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах или регионах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие страны или регионы должны использоваться для других стран и регионов. vehicleLoadType можно указать несколько раз. Этот параметр в настоящее время считается только для travelMode=truck.
WindingnessLevel	Уровень поворотов для захватывающих маршрутов. Этот параметр можно использовать только в сочетании с `routeType`=захватывающим.

AlternativeRouteType

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

Имя	Тип	Описание
anyRoute	string	Разрешить возвращать любой альтернативный маршрут независимо от того, как он сравнивается с эталонным маршрутом с точки зрения оптимальности.
betterRoute	string	Возвращает альтернативный маршрут, только если он лучше эталонного маршрута в соответствии с заданными критериями планирования.

ComputeTravelTime

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

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

DelayMagnitude

Величина задержки, вызванная инцидентом. Эти значения соответствуют значениям поля ответа 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	Объект ошибки.

GeoJsonGeometry

Допустимый объект GeoJSON геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.

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

GeoJsonGeometryCollection

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

Имя	Тип	Описание
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Содержит список допустимых `GeoJSON` геометрических объектов. примечание координат в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: GeometryCollection	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

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

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

GeoJsonMultiLineString

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

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

GeoJsonMultiPoint

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

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

GeoJsonMultiPolygon

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

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

GeoJsonPoint

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

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

GeoJsonPolygon

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

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

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	Сделайте U-turn.
MOTORWAY_EXIT_LEFT	string	Возьмите левый выход.
MOTORWAY_EXIT_RIGHT	string	Возьмите правый выход.
ROUNDABOUT_BACK	string	Идти по кругу.
ROUNDABOUT_CROSS	string	Перекрестная круглая.
ROUNDABOUT_LEFT	string	На круглой кольцевой части выйдите слева.
ROUNDABOUT_RIGHT	string	В круглой кольцевой области выйдите справа.
SHARP_LEFT	string	Поворот резкого влево.
SHARP_RIGHT	string	Поворот резкого вправо.
STRAIGHT	string	Продолжайте прямо.
SWITCH_MAIN_ROAD	string	Переключитесь на главную дорогу.
SWITCH_PARALLEL_ROAD	string	Переключитесь на параллельную дорогу.
TAKE_EXIT	string	Возьмите выход.
TAKE_FERRY	string	Возьмите паром.
TRY_MAKE_UTURN	string	Попробуйте сделать U-turn.
TURN_LEFT	string	Вернитесь влево.
TURN_RIGHT	string	Поворот вправо.
WAYPOINT_LEFT	string	Вы достигли точки пути. Он находится слева.
WAYPOINT_REACHED	string	Вы достигли точки пути.
WAYPOINT_RIGHT	string	Вы достигли точки пути. Это справа.

InclineLevel

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

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

JunctionType

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

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

LatLongPair

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

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

Report

Указывает, какие данные следует сообщать в целях диагностики. Единственное возможное значение — действующие наборы. Сообщает действующие параметры или данные, используемые при вызове API. В случае параметров по умолчанию по умолчанию будет отражено, где параметр не указан вызывающим.

Имя	Тип	Описание
effectiveSettings	string	Сообщает действующие параметры или данные, используемые при вызове API.

ResponseFormat

Требуемый формат ответа. Значение может быть либо json, либо xml.

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

ResponseSectionType

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

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

ResponseTravelMode

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

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

Route

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

RouteAvoidType

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

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

RouteDirectionParameters

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

Имя	Тип	Описание
allowVignette	string[]	Это список 3-символов, ISO 3166-1, альфа-3 коды стран и регионов, в которых разрешены платные дороги с виньетками, например "AUS,CHE". Указание allowVignette с некоторыми странами или регионами X эквивалентно указанию избегайте Vignette со всеми странами и регионами, но X. Указание allowVignette с пустым списком совпадает с тем, что избежать всех платных дорог с vignettes. Примечание. Это ошибка при указании обоих избежать Vignette и allowVignette.
avoidAreas	GeoJsonMultiPolygon	GeoJSON MultiPolygon, представляющий список областей, которые следует избегать. Поддерживаются только прямоугольники многоугольников. Максимальный размер прямоугольника составляет около 160x160 км. Максимальное количество избегаемых областей — 10. Он не может пересекать 180-й меридиан. Он должен находиться в диапазоне от -80 до +80 градусов широты.
avoidVignette	string[]	Это список 3-символов, ISO 3166-1, альфа-3 коды стран и регионов, в которых все платные дороги с вигнетами должны быть избеганы, например "AUS,CHE". Платные дороги с vignettes в странах или регионах, не входящих в список, не затронуты. Примечание. Это ошибка при указании обоих избежать Vignette и allowVignette.
supportingPoints	GeoJsonGeometryCollection	Коллекция GeoJSON Geometry, представляющая последовательность координат, используемых в качестве входных данных для реконструкции маршрута, и для вычисления нуля или более альтернативных маршрутов для этого эталонного маршрута. Указанная последовательность вспомогательных точек используется в качестве входных данных для восстановления маршрута. Альтернативные маршруты вычисляются между точками источника и назначения, указанными в расположениях параметров базового пути. Если для обоих minDeviationDistance и minDeviationTime задано нулевое значение, то эти точки источника и точки назначения должны находиться в начале и конце эталонного маршрута соответственно (или очень близко). Промежуточные расположения (точек пути) не поддерживаются при использовании <вспомогательных точек>. Эталонный маршрут может содержать инциденты дорожного движения типа ROAD_CLOSURE, которые игнорируются для вычисления времени поездки эталонного маршрута и задержки трафика. Дополнительные сведения см. в вспомогательных точек.

RouteDirections

Этот объект возвращается из успешного вызова Route Directions

Имя	Тип	Описание
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[]	Массив маршрутов

RouteGuidance

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

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

RouteInstruction

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

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

RouteInstructionGroup

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

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

RouteInstructionsType

При указании инструкции будут возвращены. Обратите внимание, что параметр instructionsType нельзя использовать в сочетании с routeRepresentation=none.

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

coded

Имя	Тип	Описание
coded	string	Возвращает необработанные данные инструкций без сообщений, доступных для чтения человеком.
tagged	string	Возвращает необработанные данные инструкции с тегами сообщений, доступных для чтения, чтобы разрешить форматирование. Сообщение, доступное для чтения, создается из повторяющихся идентифицируемых элементов. Они помечены так, чтобы клиентские приложения могли правильно отформатировать их. Следующие компоненты сообщения помечаются при указанииType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Пример сообщения с тегом "Поворот влево": `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Возвращает необработанные данные инструкций с пользовательскими сообщениями в виде обычного текста.

string

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

tagged

string

Возвращает необработанные данные инструкции с тегами сообщений, доступных для чтения, чтобы разрешить форматирование. Сообщение, доступное для чтения, создается из повторяющихся идентифицируемых элементов. Они помечены так, чтобы клиентские приложения могли правильно отформатировать их. Следующие компоненты сообщения помечаются при указанииType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Пример сообщения с тегом "Поворот влево":

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

text

string

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

RouteLeg

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

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

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 по-прежнему включает задержку из-за трафика. Если в будущем Значение "Отступ" находится в будущем, время поездки вычисляется с использованием данных о времени, зависящих от времени, с учетом исторических данных трафика.

RouteOptimizedWaypoint

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

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

RouteReport

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

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

RouteRepresentationForBestOrder

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

Имя	Тип	Описание
none	string	Включает только оптимизированные индексы точек пути, но не включает геометрию маршрута в ответ. Это значение параметра можно использовать только в сочетании с computeBestOrder=true.
polyline	string	Включает геометрию маршрута в ответе.
summaryOnly	string	Сводка по полилайну, но за исключением элементов геометрии точки для маршрутов в ответе.

RouteSection

Разделы маршрута содержат дополнительные сведения о частях маршрута. Каждый раздел содержит по крайней мере элементы 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

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

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

RouteSectionTecCause

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

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

RouteSummary

Объект Summary

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

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	Разделы маршрута, расположенные в городских районах.

SimpleCategory

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

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

TravelMode

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

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

VehicleEngineType

Тип двигателя транспортного средства. Если указана подробная модель потребления, она должна быть согласована со значением vehicleEngineType.

Имя	Тип	Описание
combustion	string	Внутренний двигатель внутреннего сгорания.
electric	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 Directions

Параметры URI

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

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

Ответы

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

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Successfully retrieve a route between an origin and a destination with additional parameters in the body

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

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

Определения

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirectionParameters

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

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