Traffic - Get Traffic Incident
API:et för trafikincidenter tillhandahåller trafikincidenter som konstruktion, trafikstockningar och olyckor osv. i en avgränsningsruta. Den innehåller även trafikmetadata för detaljerad information om varje incident.
API:et tillhandahåller en GeoJSON-funktionssamling med trafikincidenter. Varje incident innehåller två punktfunktioner: platsen där du stöter på incidenten och slutplatsen för en trafikincident, till exempel slutet av en byggzon. Information om trafikincidenters täckning per land/region finns i trafiktäckning.
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-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Maps-tjänstens värdnamn. Använd |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
|
bbox
|
query | True |
number[] |
Definierar ett rektangulärt område av intresse på jordens yta. Rektangelns sidor anges med longitud- och latitudvärden och måste följa GeoJSON-formatet: [minLon, minLat, maxLon, maxLat]. Mer information finns i RFC 7946, avsnitt 5.
|
|
incident
|
query |
Anger vilken typ av trafikincident som ska returneras. Flera incidenttyper i en enda begäran stöds. Om det inte anges innehåller resultaten alla incidenttyper i den angivna avgränsningsrutan. Exempel: "&incidentType=Accident" eller "&incidentType=Accident,Construction". |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Specificerar vilket konto som är avsett för användning i kombination med Azure AD:s säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps management plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps. |
|
| Accept-Language |
string |
Språk där trafikincidentens resultat ska returneras. Mer information finns i Språk som stöds som referens. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. |
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
AadToken
Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Note
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et. -
Authorization URLär specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. - Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
- Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Request information about a traffic incident
Exempelbegäran
GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61
Exempelsvar
{
"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"
}
}
]
}
Definitioner
| Name | Description |
|---|---|
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Detaljerna om felet. |
|
Error |
Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.). |
|
Features |
Anger |
|
Feature |
Anger |
|
Geo |
Anger |
|
Geo |
En giltig |
|
Incident |
Anger typen av trafikincident. Detta kan användas för att begära och skilja mellan olika typer av incidenter. |
|
Traffic |
Anger detaljerad information om trafikincidenterna. |
|
Traffic |
GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för trafikincidenter. |
|
Traffic |
Ett GeoJSON-funktionssamlingsobjekt som innehåller en lista över funktioner för trafikincidenter. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
ErrorDetail
Detaljerna om felet.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorResponse
Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
FeaturesItemTypeEnum
Anger GeoJSON typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| Feature |
Anger objekttypen |
FeatureTypeEnum
Anger GeoJSON typ. Den enda objekttypen som stöds är FeatureCollection. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| FeatureCollection |
Anger |
GeoJsonObjectType
Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
| Värde | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
En |
| type |
string:
Point |
Anger |
IncidentType
Anger typen av trafikincident. Detta kan användas för att begära och skilja mellan olika typer av incidenter.
| Värde | Description |
|---|---|
| Accident |
Olycka |
| Congestion |
Trafikstockning |
| DisabledVehicle |
DisabledVehicle |
| Miscellaneous |
Miscellaneous |
| RoadHazard |
RoadHazard |
| Construction |
Byggnation |
| Weather |
Vädret |
TrafficIncidentFeatureProperties
Anger detaljerad information om trafikincidenterna.
| Name | Typ | Description |
|---|---|---|
| delay |
number (double) |
Fördröjningen som orsakas av incidenten i sekunder. Om ingen fördröjning eller inte är tillämplig returnerar den noll. |
| description |
string |
En beskrivning av incidenten som innehåller vägnamnet och händelsen som påverkar trafikflödet. Exempel: • W 95th St mellan Switzer Rd och Bluejacket Dr - konstruktion • WB Johnson Dr på I-435 - bro reparation |
| endPoint |
Ett GeoJson Point-objekt som angav slutplatsen för en trafikincident, till exempel slutet av en byggzon. Den här platsen är en del av objektet för incidentegenskaper och kan som standard inte tolkas av parsare för visning på kartan. |
|
| endTime |
string |
Datum och tid i UTC när trafikincidenten avslutas, formaterat som ett dateTime-värde enligt definitionen i RFC 3339, avsnitt 5.6. |
| incidentType |
Anger typen av trafikincident. Detta kan användas för att begära och skilja mellan olika typer av incidenter. |
|
| isRoadClosed |
boolean |
Värdet |
| isTrafficJam |
boolean |
Värdet |
| lastModifiedTime |
string |
Datum och tid i UTC när incidentinformationen senast uppdaterades, formaterat som ett dateTime-värde enligt definitionen i RFC 3339, avsnitt 5.6. |
| severity |
integer (int32) |
Anger hur viktig incidenten är.
|
| startTime |
string |
Datum och tid i UTC när incidenten inträffade, formaterat som ett dateTime-värde enligt definitionen i RFC 3339, avsnitt 5.6. |
| title |
string |
Anger vägnamn och riktning för berörda vägar. |
TrafficIncidentFeaturesItem
GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för trafikincidenter.
| Name | Typ | Description |
|---|---|---|
| geometry |
En giltig |
|
| id |
integer (int64) |
Ett unikt ID för incidenten. |
| properties |
Anger detaljerad information om trafikincidenterna. |
|
| type |
Anger |
TrafficIncidentResponse
Ett GeoJSON-funktionssamlingsobjekt som innehåller en lista över funktioner för trafikincidenter.
| Name | Typ | Description |
|---|---|---|
| features |
|
|
| type |
Anger |