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

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Ссылка
Пакет:
@azure-rest/maps-route

Свойства

arriveAt

Дата и время прибытия в точку назначения, отформатированная как значение dateTime, как определено в RFC 3339, раздел 5.6, с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка назначения.

Примеры:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Параметр arriveAt нельзя использовать в сочетании с departAt, minDeviationDistance или minDeviationTime.
avoid

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

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

Дата и время отъезда из точки источника, отформатированная как значение dateTime, как определено в RFC 3339, раздел 5.6с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка источника.

  • Значение по умолчанию: теперь
  • Другое значение: dateTime

Примеры:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Параметр departAt нельзя использовать в сочетании с arriveAt.
hilliness

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

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

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

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

Возможные значения:

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

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

Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
vehicleHeight

Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются.
vehicleLength

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType

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

Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях.

  • Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута.

  • Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
vehicleWeight

Вес транспортного средства в килограммах.
vehicleWidth

Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
waitForResults

Логическое значение, указывающее, следует ли выполнять запрос синхронно. Если задано значение true, пользователь получит ответ 200, если запрос завершится до 120 секунд. В противном случае пользователь сразу получит ответ 202. Дополнительные сведения об ответе 202 см. в описании API. поддерживается только для асинхронного запроса.
windingness

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

Сведения о свойстве

arriveAt

Дата и время прибытия в точку назначения, отформатированная как значение dateTime, как определено в RFC 3339, раздел 5.6, с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка назначения.

Примеры:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Параметр arriveAt нельзя использовать в сочетании с departAt, minDeviationDistance или minDeviationTime.

arriveAt?: string | Date

Значение свойства

string | Date

avoid

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

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Значение свойства

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

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

computeTravelTimeFor?: "none" | "all"

Значение свойства

"none" | "all"

departAt

Дата и время отъезда из точки источника, отформатированная как значение dateTime, как определено в RFC 3339, раздел 5.6с необязательным смещением часового пояса. Если смещение часового пояса не указано, предполагается, что это точка источника.

  • Значение по умолчанию: теперь
  • Другое значение: dateTime

Примеры:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Параметр departAt нельзя использовать в сочетании с arriveAt.

departAt?: string | Date

Значение свойства

string | Date

hilliness

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

hilliness?: "low" | "normal" | "high"

Значение свойства

"low" | "normal" | "high"

routeType

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

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Значение свойства

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

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

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

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Значение свойства

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

Возможные значения:

  • True. Рассмотрите все доступные сведения о трафике во время маршрутизации
  • false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные дорожного движения игнорируются во время маршрутизации, влияние исторического движения на эффективные скорости дорожного движения по-прежнему включается.
traffic?: boolean

Значение свойства

boolean

travelMode

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

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Значение свойства

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.

vehicleAxleWeight?: number

Значение свойства

number

vehicleHeight

Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются.

vehicleHeight?: number

Значение свойства

number

vehicleLength

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.

vehicleLength?: number

Значение свойства

number

vehicleLoadType

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

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Значение свойства

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях.

  • Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута.

  • Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.

vehicleMaxSpeed?: number

Значение свойства

number

vehicleWeight

Вес транспортного средства в килограммах.

vehicleWeight?: number

Значение свойства

number

vehicleWidth

Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.

vehicleWidth?: number

Значение свойства

number

waitForResults

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

waitForResults?: boolean

Значение свойства

boolean

windingness

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

windingness?: "low" | "normal" | "high"

Значение свойства

"low" | "normal" | "high"