Traffic - Get Traffic Incident Viewport

Referenz

Dienst:: 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 (z. B. durch Zoomen, Schwenken, Navigieren zu einem Speicherort oder Anzeigen einer Route). Die Anforderung sollte das Begrenzungsfeld und die Zoomstufe 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 Description zurückgegebene Verkehrsmodell-ID wird von anderen APIs verwendet, um letzte Datenverkehrsinformationen für die weitere Verarbeitung abzurufen.

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

Mit optionalen Parametern:

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	Gewünschtes 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[]	Begrenzungsfeld des Kartensichtports in EPSG900913 Projektion. Die `boundingbox` wird durch zwei Wertpaare dargestellt, die ihre Ecken beschreiben (erstes Paar für die linke untere ecke und 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, die übergeben werden kann, hängt von der angeforderten Zoomstufe ab. Die Breite und Höhe darf 4.092 Pixel nicht überschreiten, wenn sie auf der angegebenen Zoomebene gerendert werden. HINWEIS: Begrenzungsfelder, die den 180°-Meridian kreuzen, erfordern eine besondere Behandlung. Für solche Felder ist der östliche maxX-Wert negativ und damit 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	Zoomstufe des Kartenansichtports. Wird verwendet, um zu bestimmen, ob die Ansicht vergrößert werden kann.
overviewbox	query	True	number[]	Begrenzungsfeld der Übersichtskarte in EPSG900913 Projektion. Wird verwendet, wenn die Übersichtsbox/Minikarte andere Urheberrechtsdaten als die Hauptkarte aufweist. Wenn keine Minikarte vorhanden ist, werden dieselben Koordinaten wie `boundingBox` verwendet. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als eine einzelne Zeichenfolge mit vier Koordinaten übergeben, die durch Kommas getrennt sind.
overviewzoom	query	True	integer int32	Zoomstufe der Übersichtskarte. Wenn keine Minikarte vorhanden ist, verwenden Sie die gleiche Zoomstufe wie boundingZoom.
copyright	query		boolean	Bestimmt, welche Urheberrechtsinformationen zurückgegeben werden sollen. Wenn true der Copyrighttext zurückgegeben wird; wenn false nur der Urheberrechtsindex zurückgegeben wird.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der 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. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

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

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

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Request traffic incident information for the selected viewport

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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	Gewünschtes 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	Verkehrszustandsinformationen
ViewpResp	Viewport Response-Objekt

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

Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation
xml	string	The Extensible Markup Language

TrafficIncidentViewport

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

Name	Typ	Beschreibung
viewpResp	ViewpResp	Viewport Response-Objekt

TrafficState

Verkehrszustandsinformationen

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

ViewpResp

Viewport Response-Objekt

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 Urheberrechtsinformationen, die mit den Kacheln im Viewport angezeigt werden müssen.
trafficState	TrafficState	Verkehrszustandsinformationen

Freigeben über