Traffic - Get Traffic Incident Detail

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

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

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}
GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}&language={language}&projection={projection}&geometries={geometries}&expandCluster={expandCluster}&originalPosition={originalPosition}

Параметры URI

Имя В Обязательно Тип Описание
format
path True

ResponseFormat

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

api-version
query True

string

Номер версии API Azure Maps

boundingbox
query True

number[]

Представляется boundingbox двумя парами значений, описывающими его углы (первая пара для левого нижнего угла и вторая — для правого верхнего угла). Пары можно указать с помощью любой из указанных projectionниже (например, minY,minX,maxY,maxX) или двумя парами широты и долготы (например, minLat,minLon,maxLat,maxLon).

ПРИМЕЧАНИЕ. Если используются пары широты и долготы, параметру projection необходимо задать значение "EPSG4326".

boundingZoom
query True

integer

int32

Уровень масштабирования для нужной плитки. От 0 до 22 для растровых плиток, от 0 до 22 для векторных плиток

style
query True

IncidentDetailStyle

Стиль, который будет использоваться для отрисовки плитки в API плитки дорожно-транспортных происшествий . Это повлияет на координаты дорожно-транспортных происшествий в ответе.

trafficmodelid
query True

string

Число, ссылающееся на модель трафика. Это можно получить из API Viewport . Он обновляется каждую минуту и действителен в течение двух минут до истечения времени ожидания. Если указан неправильный идентификатор модели трафика, интерфейс вернет правильный. Значение -1 всегда вызывает самую последнюю модель трафика.

expandCluster
query

boolean

Логическое значение, указывающее, следует ли выводить список всех дорожно-транспортных происшествий в кластере отдельно

geometries
query

IncidentGeometryType

Тип векторной геометрии, добавляемой в инциденты (возвращается в элементе ответа).

language
query

string

Код ISO 639-1 для языка вывода. Поддерживаемые языки: ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.

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

originalPosition
query

boolean

Логическое значение о том, следует ли возвращать исходную позицию инцидента (), а также смещенную в начало пробки ()

projection
query

ProjectionStandard

Проекция, используемая для указания координат в запросе и ответе. EPSG900913 (по умолчанию) или EPSG4326

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

Имя Обязательно Тип Описание
x-ms-client-id

string

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

Ответы

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

TrafficIncidentDetail

ОК

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 information about a traffic incident

Sample Request

GET https://atlas.microsoft.com/traffic/incident/detail/json?api-version=1.0&style=s3&boundingbox=6841263.950712,511972.674418,6886056.049288,582676.925582&boundingZoom=11&trafficmodelid=1335294634919

Sample Response

{
  "tm": {
    "@id": "1521671948910",
    "poi": [
      {
        "id": "europe_HD_NL_TTR116377227776064",
        "p": {
          "x": 538636.9,
          "y": 6842004.5
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Amstelveen/Vinkeveen - N201 (N196)",
        "t": "Uithoorn-Centrum (N196)",
        "l": 220,
        "dl": 14,
        "r": "N196"
      },
      {
        "id": "europe_CLUSTER_11_-34959639",
        "p": {
          "x": 528668.6,
          "y": 6848897.9
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 528622.5,
          "y": 6848661.2
        },
        "ctr": {
          "x": 528714.7,
          "y": 6849134.6
        },
        "cs": 2,
        "l": 190
      },
      {
        "id": "europe_CLUSTER_11_-1540737434",
        "p": {
          "x": 518277,
          "y": 6852206.8
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 517421.3,
          "y": 6851776.4
        },
        "ctr": {
          "x": 519132.8,
          "y": 6852637.2
        },
        "cs": 2,
        "l": 1620
      },
      {
        "id": "europe_CLUSTER_11_-26712906",
        "p": {
          "x": 529902.2,
          "y": 6855622.4
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 529524.6,
          "y": 6855377.2
        },
        "ctr": {
          "x": 530279.9,
          "y": 6855867.7
        },
        "cs": 4,
        "l": 660
      },
      {
        "id": "europe_HD_NL_TTR116367997504816",
        "p": {
          "x": 568216,
          "y": 6851287.6
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Ankeveen (N236)",
        "t": "Weesp (N236)",
        "l": 2760,
        "dl": 73,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116367997261488",
        "p": {
          "x": 561973.7,
          "y": 6854259.4
        },
        "ic": 9,
        "ty": 3,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Weesp (N236)",
        "t": "Ankeveen (N236)",
        "l": 2650,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116331064819392",
        "p": {
          "x": 571268.5,
          "y": 6858435.4
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "IJsselmeerweg",
        "t": "A6",
        "l": 370
      },
      {
        "id": "europe_CLUSTER_11_-1442937814",
        "p": {
          "x": 563934,
          "y": 6859271.3
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 563726.1,
          "y": 6859250.4
        },
        "ctr": {
          "x": 564141.9,
          "y": 6859292.2
        },
        "cs": 2,
        "l": 460
      },
      {
        "id": "europe_CLUSTER_11_258400781",
        "p": {
          "x": 558055.6,
          "y": 6861147.1
        },
        "ic": 13,
        "ty": 1,
        "cbl": {
          "x": 557493.3,
          "y": 6860514.8
        },
        "ctr": {
          "x": 558618,
          "y": 6861779.4
        },
        "cs": 3,
        "l": 1030
      },
      {
        "id": "europe_HD_NL_TTR116100227865681",
        "p": {
          "x": 542665,
          "y": 6861959.7
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Strawinskylaan",
        "t": "Matthijs Vermeulenpad",
        "l": 110
      },
      {
        "id": "europe_CLUSTER_11_1438243625",
        "p": {
          "x": 545058.7,
          "y": 6864571.6
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543779.5,
          "y": 6864070.7
        },
        "ctr": {
          "x": 546337.8,
          "y": 6865072.6
        },
        "cs": 5,
        "l": 1590
      },
      {
        "id": "europe_HD_NL_TTR116081762316976",
        "p": {
          "x": 547507.8,
          "y": 6866259.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Alexanderplein (s113)",
        "t": "Stadhouderskade",
        "l": 390,
        "r": "S100"
      },
      {
        "id": "europe_CLUSTER_11_691732516",
        "p": {
          "x": 541448.7,
          "y": 6867162.1
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 541160.1,
          "y": 6866710.7
        },
        "ctr": {
          "x": 541737.2,
          "y": 6867613.5
        },
        "cs": 4,
        "l": 430
      },
      {
        "id": "europe_CLUSTER_11_1582351486",
        "p": {
          "x": 534709.6,
          "y": 6865174.7
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 534562.2,
          "y": 6865025.3
        },
        "ctr": {
          "x": 534856.9,
          "y": 6865324.2
        },
        "cs": 2,
        "l": 380
      },
      {
        "id": "europe_CLUSTER_11_-2070222267",
        "p": {
          "x": 536813.1,
          "y": 6868188.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 536191.1,
          "y": 6867699.7
        },
        "ctr": {
          "x": 537435.1,
          "y": 6868677
        },
        "cs": 7,
        "l": 1380
      },
      {
        "id": "europe_CLUSTER_11_-496866890",
        "p": {
          "x": 516025.5,
          "y": 6871606.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 514115.1,
          "y": 6870216.9
        },
        "ctr": {
          "x": 517935.9,
          "y": 6872995.7
        },
        "cs": 7,
        "l": 1510
      },
      {
        "id": "europe_HD_NL_TTR115675492352160",
        "p": {
          "x": 517835.3,
          "y": 6883216.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Amsterdamseweg",
        "t": "A22",
        "l": 710
      },
      {
        "id": "europe_CLUSTER_11_834920993",
        "p": {
          "x": 543803.8,
          "y": 6875659.8
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543474.7,
          "y": 6875602.7
        },
        "ctr": {
          "x": 544133,
          "y": 6875716.9
        },
        "cs": 2,
        "l": 760
      }
    ]
  }
}

Определения

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

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

IconCategory

Категория значков, связанная с этим инцидентом. Значения — это числа в диапазоне от 0 до 13 со следующими значениями: 0: Неизвестно, 1: Авария, 2: Туман, 3: Опасные условия, 4: Дождь, 5: Лед, 6: Джем, 7: Переулок закрыт, 8: Дорога закрыта, 9: Дорожные работы, 10: Ветер, 11: Наводнение, 12: Объезд, 13: Кластер

IncidentDetailStyle

Стиль, который будет использоваться для отрисовки плитки в API плитки дорожного происшествия . Это повлияет на координаты дорожно-транспортных происшествий в ответе.

IncidentGeometryType

Тип геометрии вектора, добавляемого к инцидентам (возвращается в элементе ответа).

Point

Универсальное представление точки с координатами (x, y) в декартовой плоскости.

ProjectionStandard

Проекция, используемая для указания координат в запросе и ответе. EPSG900913 (по умолчанию) или EPSG4326

ResponseFormat

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

Tm

Основной элемент ответа

TrafficIncidentDetail

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

TrafficIncidentPointOfInterest

DelayMagnitude

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

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

Integer

Неизвестно

1

Integer

Дополнительный номер

2

Integer

Средняя

3

Integer

Значительно

4

Integer

Неопределенный (используется для закрытия дорог и других неопределенных задержек)

ErrorAdditionalInfo

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

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

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

Целевой объект ошибки.

ErrorResponse

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

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

ErrorDetail

Объект error.

IconCategory

Категория значков, связанная с этим инцидентом. Значения — это числа в диапазоне от 0 до 13 со следующими значениями: 0: Неизвестно, 1: Авария, 2: Туман, 3: Опасные условия, 4: Дождь, 5: Лед, 6: Джем, 7: Переулок закрыт, 8: Дорога закрыта, 9: Дорожные работы, 10: Ветер, 11: Наводнение, 12: Объезд, 13: Кластер

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

Integer

Неизвестно

1

Integer

Accident

10

Integer

Wind

11

Integer

Наводнения

12

Integer

Объезд

13

Integer

Кластер: возвращается, если кластер содержит инциденты с разными категориями значков.

14

Integer

Сломанный автомобиль

2

Integer

Туман

3

Integer

Опасные условия

4

Integer

Дождь

5

Integer

Айс (Ice)

6

Integer

Джем

7

Integer

Лейн закрыт

8

Integer

Дорога закрыта

9

Integer

Дорожные работы

IncidentDetailStyle

Стиль, который будет использоваться для отрисовки плитки в API плитки дорожного происшествия . Это повлияет на координаты дорожно-транспортных происшествий в ответе.

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

string

Ночной стиль.

s1

string

Создает линии трафика с цветными шевронами, указывающими на серьезность.

s2

string

Создает простые линии с определенной степенью свечения.

s3

string

Создает простые линии с определенной степенью свечения, отличающейся от стиля s2.

IncidentGeometryType

Тип геометрии вектора, добавляемого к инцидентам (возвращается в элементе ответа).

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

string

Places инциденты именно на дороге.

shifted

string

Немного перемещает инцидент (в зависимости от масштаба), чтобы указать конкретные полосы движения дороги.

Point

Универсальное представление точки с координатами (x, y) в декартовой плоскости.

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

number

Координата x

y

number

Координата y

ProjectionStandard

Проекция, используемая для указания координат в запросе и ответе. EPSG900913 (по умолчанию) или EPSG4326

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

string

EPSG4326

EPSG900913

string

EPSG900913

ResponseFormat

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

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

string

Формат обмена данными нотации объектов JavaScript

xml

string

Язык расширяемой разметки

Tm

Основной элемент ответа

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

string

Идентификатор модели трафика для этого инцидента

poi

TrafficIncidentPointOfInterest[]

Один дорожный инцидент или кластер дорожно-транспортных происшествий

TrafficIncidentDetail

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

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

Tm

Основной элемент ответа

TrafficIncidentPointOfInterest

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

string

Причина инцидента, если она доступна, на запрашиваемом языке

cbl

Point

Нижняя левая координата кластера в проекции запроса

cs

integer

Размер кластера: количество инцидентов в кластере.

ctr

Point

Верхняя правая координата кластера в проекции запроса

d

string

Описание инцидента на запрашиваемом языке

dl

integer

Задержка, вызванная инцидентом в секундах (за исключением закрытия дорог)

ed

string

Предполагаемая дата окончания инцидента, если она доступна. Дата описывается в формате ISO8601.

f

string

От: имя пересечения или место, где начинается трафик из-за инцидента.

ic

IconCategory

Категория значков, связанная с этим инцидентом. Значения — это числа в диапазоне от 0 до 13 со следующими значениями: 0: Неизвестно, 1: Авария, 2: Туман, 3: Опасные условия, 4: Дождь, 5: Лед, 6: Джем, 7: Переулок закрыт, 8: Дорога закрыта, 9: Дорожные работы, 10: Ветер, 11: Наводнение, 12: Объезд, 13: Кластер

id

string

Идентификатор дорожного происшествия

l

integer

Длина инцидента в метрах

p

Point

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

r

string

Номера дорог, затронутые инцидентом. Несколько номеров дорог будут разделены косыми чертами

sd

string

Дата начала инцидента, если она доступна. Дата описывается в формате ISO8601.

t

string

Для: имя пересечения или расположения, где трафик из-за инцидента заканчивается.

ty

DelayMagnitude

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