Freigeben über


Traffic - Get Traffic Incident

Die Datenverkehrsvorfall-API bietet Verkehrsvorfälle wie Bau, Staus und Unfälle usw. innerhalb einer Begrenzungsbox. Außerdem werden Datenverkehrsmetadaten für detaillierte Informationen zu den einzelnen Vorfällen bereitgestellt.

Die API stellt eine GeoJSON-Featuresammlung von Datenverkehrsvorfällen bereit. Jeder Vorfall umfasst zwei Punktefunktionen: den Ort, an dem Sie auf den Vorfall stoßen, und die Endposition eines Verkehrsvorfalls wie das Ende einer Bauzone. Informationen zur Abdeckung von Verkehrsunfällen nach Land/Region finden Sie unter Verkehrsabdeckung.

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
query True

string

Versionsnummer der Azure Maps-API.

bbox
query True

number[]

Definiert einen rechteckigen Interessenbereich auf der Erdoberfläche. Die Seiten des Rechtecks werden durch Längen- und Breitengradwerte angegeben und müssen dem GeoJSON-Format entsprechen: [minLon, minLat, maxLon, maxLat]. Weitere Informationen finden Sie unter RFC 7946, Abschnitt 5.

  • Mindestabmessungen: Die Höhe oder Breite des Begrenzungsrahmens muss mindestens 12 Meter betragen.
  • Maximale Fläche: Der Begrenzungsrahmen kann eine Fläche von bis zu 10.000 Quadratkilometern abdecken.
  • Einbeziehung von Vorfällen: Verkehrsstörungen werden in die Antwort einbezogen, wenn sie sich mit dem Begrenzungsrahmen überlappen oder wenn ihr Anfang, ihr Ende oder ein Teil des Vorfalls den Begrenzungsrahmen durchläuft. Die Start- und Endpositionen des Vorfalls können außerhalb des Begrenzungsrahmens liegen.
Beispiel: bbox=-105,37,-94,45

incidentType
query

IncidentType

Gibt den Typ des Datenverkehrsvorfalls an, der zurückgegeben werden soll. Es werden mehrere Vorfalltypen innerhalb einer einzelnen Anforderung unterstützt. Wenn nicht angegeben, enthalten die Ergebnisse alle Vorfalltypen innerhalb des bereitgestellten Begrenzungsfelds.

Beispiel: '&incidentType=Accident' oder '&incidentType=Accident,Construction'.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto in Verbindung mit dem Azure AD-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps.

Accept-Language

string

Sprache, in der Ergebnisse von Datenverkehrsvorfällen zurückgegeben werden sollen.

Weitere Informationen finden Sie unter Unterstützte Sprachen als Referenz.

Antworten

Name Typ Beschreibung
200 OK

TrafficIncidentResponse

OK

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Notes

  • 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 Kartenverwaltung API erworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das 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.

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 Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

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

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

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

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

Typ: apiKey
In: header

Beispiele

Request information about a traffic incident

Beispielanforderung

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61

Beispiel für eine Antwort

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 125193835200120000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20148,
          47.609058
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T20:50:41.3340000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Stationary traffic on Bellevue Way SE from SE 3rd St to Bellevue Way NE / Main St.",
        "severity": 1,
        "isRoadClosed": false,
        "title": "Bellevue Way SE",
        "isTrafficJam": true,
        "delay": 125,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.202707,
            47.610156
          ]
        }
      }
    },
    {
      "type": "Feature",
      "id": 125453508966320000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.195563,
          47.499877
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T19:19:00.0000000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Slow traffic on I-405 N from Sunset Blvd NE exit [5] to exit [7].",
        "severity": 1,
        "isRoadClosed": false,
        "title": "I-405 N",
        "isTrafficJam": true,
        "delay": 141,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.196893,
            47.531893
          ]
        }
      }
    }
  ]
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.

IncidentType

Gibt den Typ des Datenverkehrsvorfalls an. Dies kann verwendet werden, um verschiedene Arten von Vorfällen anzufordern und zu unterscheiden.

TrafficIncidentFeatureProperties

Gibt detaillierte Informationen zu den Verkehrsvorfällen an.

TrafficIncidentFeaturesItem

Gibt das GeoJSON-Featureobjekt des Datenverkehrs an, einschließlich der Geometrie und zusätzlicher Eigenschaften.

TrafficIncidentResponse

Ein GeoJSON-Featureauflistungsobjekt, das eine Liste der Features für Datenverkehrsvorfälle enthält.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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.

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

Wert Beschreibung
Feature

Gibt den GeoJSON Featureobjekttyp an.

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.

Wert Beschreibung
FeatureCollection

Gibt den GeoJSONFeatureCollection Objekttyp an.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.

Name Typ Beschreibung
coordinates

number[] (double)

Ein Position ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längengrad und Breitengradgenau in dieser Reihenfolge. Altitude/Elevation ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946-.

type

string

Gibt den GeoJSON-Typ als Punkt an.

IncidentType

Gibt den Typ des Datenverkehrsvorfalls an. Dies kann verwendet werden, um verschiedene Arten von Vorfällen anzufordern und zu unterscheiden.

Wert Beschreibung
Accident

Accident

Congestion

Congestion

DisabledVehicle

DisabledVehicle

Miscellaneous

Miscellaneous

RoadHazard

RoadHazard

Construction

Construction

Weather

Weather

TrafficIncidentFeatureProperties

Gibt detaillierte Informationen zu den Verkehrsvorfällen an.

Name Typ Beschreibung
delay

number (double)

Die Verzögerung, die durch den Vorfall in Sekunden verursacht wurde. Wenn keine Verzögerung oder nicht zutreffend ist, wird null zurückgegeben.

description

string

Eine Beschreibung des Vorfalls, der den Straßennamen und das Ereignis enthält, das sich auf den Verkehrsfluss auswirkt.

Examples:

• W 95th St zwischen Switzer Rd und Bluejacket Dr - Bau

• WB Johnson Dr bei I-435 - Brückenreparatur

endPoint

object

Ein GeoJson Point -Objekt, das die Endposition eines Verkehrsvorfalls wie das Ende einer Bauzone angegeben hat.

Diese Position ist Teil des Vorfalleigenschaftenobjekts und kann standardmäßig nicht von Parsern für die Anzeige auf der Karte interpretiert werden.

endTime

string

Das Datum und die Uhrzeit in UTC, wenn der Datenverkehrsvorfall endet, formatiert als dateTime-Wert, wie in RFC 3339, Abschnitt 5.6definiert.

incidentType

IncidentType

Gibt den Typ des Datenverkehrsvorfalls an. Dies kann verwendet werden, um verschiedene Arten von Vorfällen anzufordern und zu unterscheiden.

isRoadClosed

boolean

Ein Wert von true gibt an, dass es eine Straßenschließung gibt.

isTrafficJam

boolean

Ein Wert von true gibt an, dass der von diesem Vorfall abgedeckte Straßenbereich ungewöhnliche Verkehrsbedingungen aufweist, was zu nicht typischen Verzögerungen führt.

lastModifiedTime

string

Datum und Uhrzeit in UTC, als die Vorfallinformationen zuletzt aktualisiert wurden, formatiert als dateTime-Wert gemäß definition in RFC 3339, Abschnitt 5.6.

severity

integer (int32)

Gibt die Wichtigkeitsstufe des Vorfalls an.

  • 0: Unbekannt

  • 1: Geringfügig

  • 2: Moderat

  • 3: Major

  • 4: Undefiniert (wird für Straßensperrungen und andere unbestimmte Verspätungen verwendet)

startTime

string

Datum und Uhrzeit in UTC, wenn der Vorfall aufgetreten ist, formatiert als dateTime-Wert gemäß definition in RFC 3339, Abschnitt 5.6.

title

string

Gibt die Straßennamen und die Richtung betroffener Straßen an.

TrafficIncidentFeaturesItem

Gibt das GeoJSON-Featureobjekt des Datenverkehrs an, einschließlich der Geometrie und zusätzlicher Eigenschaften.

Name Typ Beschreibung
geometry

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.

id

integer (int64)

Eine eindeutige ID für den Vorfall.

properties

TrafficIncidentFeatureProperties

Gibt detaillierte Informationen zu den Verkehrsvorfällen an.

type

FeaturesItemTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.

TrafficIncidentResponse

Ein GeoJSON-Featureauflistungsobjekt, das eine Liste der Features für Datenverkehrsvorfälle enthält.

Name Typ Beschreibung
features

TrafficIncidentFeaturesItem[]

GeoJSON Featureobjekt, das Geometry-Objekt und zusätzliche Eigenschaften enthält. Ausführliche Informationen finden Sie unter RFC 7946, Abschnitt 3.2.

type

FeatureTypeEnum

Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.