Traffic - Get Traffic Incident Viewport

Referenz

Service:: Maps

API Version:: 1.0

Verwenden Sie , um rechtliche und technische Informationen für einen Viewport abzurufen.

Die Traffic Incident Viewport API ist eine HTTP-Anforderung GET , die rechtliche und technische Informationen für den in der Anforderung beschriebenen Viewport zurückgibt. Es sollte von Clientanwendungen aufgerufen werden, wenn sich der Viewport ändert (für instance, durch Zoomen, Schwenken, Wechseln zu einem Ort oder Anzeigen einer Route). Die Anforderung sollte das Begrenzungsfeld und den Zoomfaktor des Viewports enthalten, dessen Informationen benötigt werden. Die Rückgabe enthält Kartenversionsinformationen sowie die aktuelle Verkehrsmodell-ID und Copyright-IDs. Die von der Viewport-Beschreibung zurückgegebene Datenverkehrsmodell-ID wird von anderen APIs verwendet, um letzte Datenverkehrsinformationen zur weiteren Verarbeitung abzurufen.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
api-version	query	True	string	Versionsnummer der Azure Maps API.
boundingbox	query	True	number[]	Begrenzungsrahmen des Karten-Viewports in EPSG900913 Projektion. Wird `boundingbox` durch zwei Wertpaare dargestellt, die ihre Ecken beschreiben (erstes Paar für die linke untere Ecke und das zweite für die obere rechte Ecke). Wenn dieser Endpunkt direkt aufgerufen wird, sollten alle Werte durch Kommas getrennt werden (z. B. minY, minX, maxY, maxX). Die maximale Größe des Begrenzungsrahmens, der übergeben werden kann, hängt vom angeforderten Zoomfaktor ab. Die Breite und Höhe darf 4.092 Pixel nicht überschreiten, wenn sie mit dem angegebenen Zoomfaktor gerendert werden. HINWEIS: Begrenzungsfelder, die den 180°-Meridian überqueren, erfordern eine spezielle Behandlung. Bei solchen Boxen ist der östliche maxX-Wert negativ und somit kleiner als der minX-Wert westlich des 180°-Meridians. Um dies zu beheben, sollte der Wert 40075016.6855874 dem wahren maxX-Wert hinzugefügt werden, bevor er in der Anforderung übergeben wird.
boundingzoom	query	True	integer int32	Zoomfaktor des Karten-Viewports. Wird verwendet, um zu bestimmen, ob die Ansicht vergrößert werden kann.
overviewbox	query	True	number[]	Begrenzungsrahmen der Übersichtskarte in EPSG900913 Projektion. Wird für den Fall verwendet, dass das Übersichtsfeld/die Minikarte andere Copyrightdaten enthält als die Standard Karte. Wenn keine Minikarte vorhanden ist, werden die gleichen Koordinaten wie `boundingBox` verwendet. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als eine einzelne Zeichenfolge übergeben, die vier Koordinaten enthält, getrennt durch Kommas.
overviewzoom	query	True	integer int32	Zoomfaktor der Übersichtskarte. Wenn keine Minikarte vorhanden ist, verwenden Sie den gleichen Zoomfaktor wie boundingZoom.
copyright	query		boolean	Bestimmt, welche Copyrightinformationen zurückgegeben werden sollen. Wenn true, wird der Copyrighttext zurückgegeben; wenn false nur der Copyrightindex zurückgegeben wird.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Request traffic incident information for the selected viewport

Sample Request

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

Sample Response

Status code:: 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"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
TrafficIncidentViewport	Dieses Objekt wird von einem erfolgreichen Traffic Incident Viewport-Aufruf zurückgegeben.
TrafficState	Informationen zum Datenverkehrsstatus
ViewpResp	Viewport-Antwortobjekt

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ResponseFormat

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation
xml	string	Die erweiterbare Markupsprache

TrafficIncidentViewport

Dieses Objekt wird von einem erfolgreichen Traffic Incident Viewport-Aufruf zurückgegeben.

Name	Typ	Beschreibung
viewpResp	ViewpResp	Viewport-Antwortobjekt

TrafficState

Informationen zum Datenverkehrsstatus

Name	Typ	Beschreibung
@trafficAge	integer	Die verstrichene Zeit (in Sekunden) nach der Erstellung der Datenverkehrsmodell-ID.
@trafficModelId	string	Die eindeutige ID namens Traffic Model ID wird bei Aufrufen von Traffic Incident-Diensten verwendet. Sie ermöglicht das Abrufen von Informationen aus bestimmten Datenverkehrsupdates. Die Datenverkehrsmodell-ID wird minütlich aktualisiert und ist zwei Minuten lang gültig, bevor das Timeout auftritt.

ViewpResp

Viewport-Antwortobjekt

Name	Typ	Beschreibung
@maps	string	Gibt die internen Namen des Datenanbieters für die im Viewport verwendeten Kartendaten an. Zur Verwendung mit Supportabfragen.
@version	string	Gibt die Softwareversion an, die zum Generieren der Informationen verwendet wird. Zur Verwendung mit Supportabfragen.
copyrightIds	string	Wenn der Wert des Copyrightparameters true ist, enthält dieser den vollständigen Text der Copyrightinformationen, der mit den Kacheln im Viewport angezeigt werden muss.
trafficState	TrafficState	Informationen zum Datenverkehrsstatus