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 {endpoint}/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET {endpoint}/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

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.

  • **Mindestmaße**: Die Höhe oder Breite der Begrenzungsbox muss mindestens 12 Meter betragen.
  • **Maximale Fläche**: Die Begrenzungsbox kann eine Fläche von bis zu 10.000 Quadratkilometern abdecken.
  • **Incident Inclusion**: Verkehrsvorfälle werden in die Reaktion einbezogen, wenn sie sich mit der Begrenzungsbox überschneiden oder wenn ihr Anfang, Ende oder ein Teil des Vorfalls durch die Begrenzungsbox verlä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

Spezifiziert, welches Konto für die Nutzung in Verbindung mit dem Azure-AD-Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebene-Account API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten 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

Die Anforderung ist erfolgreich.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

AadToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jeder Benutzer, jede Gruppe oder jeder Service-Principal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle erhalten, die aus einer oder mehreren Berechtigungen besteht, REST-APIs zu Azure Maps.\n\nUm Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepte anzusehen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zur Modellierung von Anwendungen über Objekte, die Zugriff auf spezifische APIs und Scopes ermöglichen.\n\n#### Anmerkungen\n* Diese Sicherheitsdefinition re die Verwendung des x-ms-client-id Headers, um anzuzeigen, auf welche Azure Maps Ressource die Anwendung Zugriff bittet. Dies kann über die Maps Management API erworben werden.\n* \nDas Authorization URL ist spezifisch für die Azure Public Cloud-Instanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. \n* \nDie Azure rollenbasierte Zugriffskontrolle wird von der Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.\n* \nNutzung der Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.\n* Für weitere Informationen zu Microsoft Identity Platform siehe Microsoft Identity Platform Übersicht.

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

Bereiche

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

subscription-key

Dies ist ein gemeinsamer Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps Konto im Azure Portal oder mit PowerShell, CLI, Azure SDKs oder REST API erstellen.\n\n Mit diesem Schlüssel kann jede Anwendung auf alle REST-APIs zugreifen. Mit anderen Worten: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgegeben werden.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, den Ansatz confidential Client Applications zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared-Access-Signaturtoken, das aus der List SAS-Operation auf der Azure Maps Ressource über die Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.\n\n Mit diesem Token ist jede Anwendung autorisiert, mit Azure rollenbasierte Zugriffskontrollen und feine Kontrolle über Ablauf, Rate und Nutzungsregion des jeweiligen Tokens. Mit anderen Worten: Der SAS-Token kann verwendet werden, um Anwendungen die Zugriffskontrolle auf sicherere Weise als der gemeinsame Schlüssel zu ermöglichen.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, eine spezielle Liste erlaubter Ursprünge auf der Map-Konto-Ressource zu konfigurieren, um Rendering-Missbrauch zu begrenzen, und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Request information about a traffic incident

Beispielanforderung

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

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

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.

GeoJsonObjectType

Gibt den GeoJSON Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

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

GeoJSON-Feature-Objekt, das das Geometrie-Objekt und zusätzliche Eigenschaften von Verkehrsvorfällen enthält.

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

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

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.

GeoJsonObjectType

Gibt den GeoJSON Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

Wert Beschreibung
Point

GeoJSON Point Geometrie.

MultiPoint

GeoJSON MultiPoint Geometrie.

LineString

GeoJSON LineString Geometrie.

MultiLineString

GeoJSON MultiLineString Geometrie.

Polygon

GeoJSON Polygon Geometrie.

MultiPolygon

GeoJSON MultiPolygon Geometrie.

GeometryCollection

GeoJSON GeometryCollection Geometrie.

Feature

GeoJSON Feature-Objekt

FeatureCollection

GeoJSON FeatureCollection-Objekt

GeoJsonPoint

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

Name Typ Beschreibung
bbox

number[] (double)

Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-.

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:

Point

Gibt den GeoJSON Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

IncidentType

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

Wert Beschreibung
Accident

Unfall

Congestion

Congestion

DisabledVehicle

DisabledVehicle

Miscellaneous

Miscellaneous

RoadHazard

RoadHazard

Construction

Bauwesen

Weather

Wetter

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.

Beispiele

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

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

endPoint

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: Bedeutend

  • 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

GeoJSON-Feature-Objekt, das das Geometrie-Objekt und zusätzliche Eigenschaften von Verkehrsvorfällen enthält.

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.