Traffic - Get Traffic Flow Segment

Ссылка

Service:: Maps

API Version:: 1.0

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

API Traffic Flow Segment — это HTTP-запрос GET , который предоставляет сведения о скорости и времени перемещения фрагмента дороги, ближайшего к заданным координатам. Он предназначен для работы наряду с уровнем потока службы подготовки для поддержки визуализации данных потока с возможностью щелчка. Traffic Flow Segment С помощью API клиентская сторона может подключить любое место на карте с данными потока на ближайшей дороге и представить их пользователю.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

With optional parameters:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.
api-version	query	True	string	Номер версии API Azure Maps
query	query	True	number[]	Координаты точки, близкой к сегменту дороги. Этот параметр представляет собой список из четырех координат, содержащий две пары координат (lat, long, lat, long), и вычисляется с помощью EPSG4326 проекции. Когда эта конечная точка вызывается напрямую, координаты передаются в виде одной строки, содержащей четыре координаты, разделенные запятыми.
style	query	True	TrafficFlowSegmentStyle	Стиль, используемый для отрисовки плитки. Допустимые значения являются абсолютными, которые возвращают цвета, отражающие абсолютную измеряемую скорость, относительная, которая возвращает скорость относительно свободного потока, относительная задержка, которая отображает относительные скорости только там, где они отличаются от скоростей свободного потока
zoom	query	True	integer int32	Уровень масштабирования для нужной плитки. Значение масштаба должно находиться в диапазоне от 0 до 22 (включительно). Дополнительные сведения см. в разделах Уровни масштабирования и Сетка плиток .
openLr	query		boolean	Логическое значение о том, должен ли ответ включать код OpenLR
thickness	query		integer int32	Значение ширины линии, представляющей трафик. Это значение является множителем, и допустимые значения варьируются от 1 до 20. Значение по умолчанию — 10.
unit	query		SpeedUnit	Единица скорости в KMPH или MPH

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

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

Ответы

Имя	Тип	Описание
200 OK	TrafficFlowSegmentData	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечания

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

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

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

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

Request traffic flow segment information

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Sample Response

Status code:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

Определения

Имя	Описание
Coordinates	Включает координаты, описывающие форму сегмента. Координаты смещаются с дороги в зависимости от уровня масштаба для поддержки высококачественной визуализации в каждом масштабе.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FlowSegmentData	Свойство "Данные сегмента потока"
LatLongPair	Расположение, представленное в виде широты и долготы.
ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.
SpeedUnit	Единица скорости в KMPH или MPH
TrafficFlowSegmentData	Этот объект возвращается из успешного вызова сегмента потока трафика
TrafficFlowSegmentStyle	Стиль, используемый для отрисовки плитки. Допустимые значения являются абсолютными, которые возвращают цвета, отражающие абсолютную измеряемую скорость, относительная, которая возвращает скорость относительно свободного потока, относительная задержка, которая отображает относительные скорости только там, где они отличаются от скоростей свободного потока

Coordinates

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

Имя	Тип	Описание
coordinate	LatLongPair[]	Массив координат

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Сообщение об ошибке

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

FlowSegmentData

Свойство "Данные сегмента потока"

Имя	Тип	Описание
@version	string	Это указывает версию программного обеспечения, создающую ответ.
confidence	number	Достоверность является мерой качества предоставленного времени и скорости поездки. Значение 1 означает полную уверенность в том, что ответ содержит данные самого высокого качества. Более низкие значения указывают на то, что ответ может отличаться от фактических условий на дороге. Любое значение больше 0,6 означает, что информация была основана на входных данных пробы в режиме реального времени. Значение 0,5 означает, что сообщаемая скорость основана на исторических данных. Значение от 0,5 до 0,6 имеет вычисляемое взвешенный средний показатель между исторической и динамической скоростью.
coordinates	Coordinates	Включает координаты, описывающие форму сегмента. Координаты смещаются с дороги в зависимости от уровня масштаба для поддержки высококачественной визуализации в каждом масштабе.
currentSpeed	integer	Текущая средняя скорость в выбранной точке в запрошенных единицах. Это вычисляется на основе currentTravelTime и длины выбранного сегмента.
currentTravelTime	integer	Текущее время в пути в секундах в этом сегменте трафика на основе плавленных измерений в режиме реального времени между определенными расположениями в указанном направлении.
frc	string	Класс Functional Road. Это указывает тип дороги: 0: автомагистраль, автострада или другая основная дорога. 1: Главная дорога, менее важная, чем автомагистраль. 2: Другая главная дорога. 3: Вторичная дорога. 4: Локальная соединительная дорога. 5: Местные дороги большого значения. 6: Местные дороги.
freeFlowSpeed	integer	Ожидаемая скорость свободного потока в идеальных условиях, выраженная в запрошенных единицах. Это связано с freeFlowTravelTime.
freeFlowTravelTime	integer	Время в пути в секундах в этом сегменте трафика, которое можно было бы ожидать в идеальных условиях свободного потока.
openlr	string	Код OpenLR для сегмента. Дополнительные сведения об использовании кодов Open LR см. в статье OpenLR .

LatLongPair

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

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

ResponseFormat

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

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

SpeedUnit

Единица скорости в KMPH или MPH

Имя	Тип	Описание
KMPH	string	Километров в час
MPH	string	Мили в час

TrafficFlowSegmentData

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

Имя	Тип	Описание
flowSegmentData	FlowSegmentData	Свойство "Данные сегмента потока"

TrafficFlowSegmentStyle

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

Имя	Тип	Описание
absolute	string
relative	string
relative-delay	string