Traffic - Get Traffic Incident Viewport

Ссылка

Служба:: Maps

Версия API:: 1.0

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

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

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}

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

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
api-version	query	True	string	Номер версии API Azure Maps.
boundingbox	query	True	number[]	Ограничивающий прямоугольник окна представления карты в проекции EPSG900913. `boundingbox` представлена двумя парами значений, описывающими его угла (первая пара для нижнего левого угла и второй для верхнего правого). При вызове этой конечной точки все значения должны быть разделены запятыми (например, minX,minX,maxY,maxX). Максимальный размер ограничивающего поля, который можно передать, зависит от запрошенного уровня масштабирования. Ширина и высота не могут превышать 4092 пикселей при отображении на заданном уровне масштабирования. ПРИМЕЧАНИЕ. Ограничивающие коробки, пересекающие меридиан 180 градусов, требуют специального лечения. Для таких ящиков восточное maxX значение будет отрицательным, и таким образом меньше, чем minX значение к западу от меридиана 180°. Чтобы устранить это, необходимо добавить значение 40075016.6855874 в значение true maxX перед передачей в запросе.
boundingzoom	query	True	integer (int32) minimum: 0 maximum: 22	Масштаб окна просмотра карты. Используется для определения возможности масштабирования представления.
overviewbox	query	True	number[]	Ограничивающий прямоугольник карты обзора в проекции EPSG900913. Используется в случае, если в поле обзора или мини-карте имеются данные авторских прав, отличные от основной карты. Если мини-карта отсутствует, используются те же координаты, что и `boundingBox`. При вызове этой конечной точки координаты передаются в виде одной строки, содержащей четыре координаты, разделенные запятыми.
overviewzoom	query	True	integer (int32) minimum: 0 maximum: 22	Уровень масштабирования карты обзора. Если мини-карта отсутствует, используйте тот же уровень масштабирования, что и ограничивающийZoom.
copyright	query		boolean	Определяет, какие сведения об авторских правах следует возвращать. Когда возвращается текст авторских прав; Значение false, если возвращается только индекс авторских прав.

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

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

Ответы

Имя	Тип	Описание
200 OK	TrafficIncidentViewport	ХОРОШО
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

Примеры

Request traffic incident information for the selected viewport

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

HTTP

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

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

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

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
TrafficIncidentViewport	Этот объект возвращается из успешного вызова view traffic Incident Viewport
TrafficState	Сведения о состоянии трафика
ViewpResp	Объект Viewport Response

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

ResponseFormat

Перечисление

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

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

TrafficIncidentViewport

Object

Этот объект возвращается из успешного вызова view traffic Incident Viewport

Имя	Тип	Описание
viewpResp	ViewpResp	Объект Viewport Response

TrafficState

Object

Сведения о состоянии трафика

Имя	Тип	Описание
@trafficAge	integer (int32)	Истекшее время (в секундах) из создания идентификатора модели трафика.
@trafficModelId	string	Уникальный идентификатор, называемый идентификатором модели трафика, используется в вызовах служб дорожно-транспортных происшествий. Он позволяет получать сведения из определенных обновлений трафика. Идентификатор модели трафика обновляется каждую минуту и действителен в течение двух минут до истечения времени ожидания.

ViewpResp

Object

Объект Viewport Response

Имя	Тип	Описание
@maps	string	Указывает внутренние имена поставщика данных для данных карты, используемых в представлении. Для использования с запросами поддержки.
@version	string	Указывает версию программного обеспечения, используемую для создания сведений. Для использования с запросами поддержки.
copyrightIds	string	Если значение параметра авторских прав имеет значение true, это содержит полный текст сведений об авторских правах, которые должны отображаться с плитками в режиме просмотра.
trafficState	TrafficState	Сведения о состоянии трафика

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

Traffic - Get Traffic Incident Viewport

Параметры URI

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

Ответы

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

AADToken

Примечания.

Области

subscription-key

SAS Token

Примеры

Request traffic incident information for the selected viewport

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

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

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResponseFormat

TrafficIncidentViewport

TrafficState

ViewpResp

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