Traffic - Get Traffic Incident Detail
Använd för att hämta information om trafikincidenter i en viss avgränsningsruta.
API:et Traffic Incident Detail
är en HTTP-begäran GET
som innehåller information om trafikincidenter i en viss avgränsningsruta, baserat på aktuellt trafikmodell-ID. Trafikmodell-ID:t är tillgängligt för att bevilja synkronisering av data mellan anrop och API:er. Trafikmodell-ID är ett nyckelvärde för att fastställa valutan för trafikincidenter. Den uppdateras varje minut och är giltig i två minuter innan tidsgränsen uppnås. Den används i rendering av incidentpaneler. Det kan hämtas från Viewport-API :et.
GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}
GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}&language={language}&projection={projection}&geometries={geometries}&expandCluster={expandCluster}&originalPosition={originalPosition}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Önskat format för svaret. Värdet kan vara antingen json eller xml. |
|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
boundingbox
|
query | True |
number[] |
|
bounding
|
query | True |
integer int32 |
Zoomnivå för önskad panel. 0 till 22 för rasterpaneler, 0 till 22 för vektorpaneler |
style
|
query | True |
Det format som ska användas för att återge panelen i API:et för trafikincidentpanel . Detta påverkar koordinaterna för trafikincidenter i svaret. |
|
trafficmodelid
|
query | True |
string |
Nummer som refererar till trafikmodellen. Detta kan hämtas från Viewport-API :et. Den uppdateras varje minut och är giltig i två minuter innan tidsgränsen uppnås. Om fel trafikmodell-ID anges returneras rätt av gränssnittet. Värdet -1 anropar alltid den senaste trafikmodellen |
expand
|
query |
boolean |
Booleskt värde som anger om alla trafikincidenter i ett kluster ska listas separat |
|
geometries
|
query |
Typ av vektorgeometri som lagts till i incidenter (returneras i -elementet i svaret). |
||
language
|
query |
string |
ISO 639-1-kod för utdataspråket. Språk som stöds är ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh. Mer information finns i Språk som stöds . När ogiltig språkkod anges returneras svaret på engelska. När incidentorsaken eller beskrivningen inte har översättning returneras en engelsk beskrivning. |
|
original
|
query |
boolean |
Booleskt värde om huruvida incidentens ursprungliga position ska returneras () samt den som flyttades till början av trafikröret () |
|
projection
|
query |
Projektionen som används för att ange koordinaterna i begäran och svaret. EPSG900913 (standard) eller EPSG4326 |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. 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 för att 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.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
* Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, 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 Microsofts identitetsplattform översikt.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | 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 Portal 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:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.
För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Type:
apiKey
In:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 av 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 återgivningsmissbruk och regelbundet förnya SAS-token.
Type:
apiKey
In:
header
Exempel
Request information about a traffic incident
Sample Request
GET https://atlas.microsoft.com/traffic/incident/detail/json?api-version=1.0&style=s3&boundingbox=6841263.950712,511972.674418,6886056.049288,582676.925582&boundingZoom=11&trafficmodelid=1335294634919
Sample Response
{
"tm": {
"@id": "1521671948910",
"poi": [
{
"id": "europe_HD_NL_TTR116377227776064",
"p": {
"x": 538636.9,
"y": 6842004.5
},
"ic": 9,
"ty": 1,
"cs": 0,
"d": "roadworks",
"c": "new roadworks layout",
"f": "Amstelveen/Vinkeveen - N201 (N196)",
"t": "Uithoorn-Centrum (N196)",
"l": 220,
"dl": 14,
"r": "N196"
},
{
"id": "europe_CLUSTER_11_-34959639",
"p": {
"x": 528668.6,
"y": 6848897.9
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 528622.5,
"y": 6848661.2
},
"ctr": {
"x": 528714.7,
"y": 6849134.6
},
"cs": 2,
"l": 190
},
{
"id": "europe_CLUSTER_11_-1540737434",
"p": {
"x": 518277,
"y": 6852206.8
},
"ic": 9,
"ty": 1,
"cbl": {
"x": 517421.3,
"y": 6851776.4
},
"ctr": {
"x": 519132.8,
"y": 6852637.2
},
"cs": 2,
"l": 1620
},
{
"id": "europe_CLUSTER_11_-26712906",
"p": {
"x": 529902.2,
"y": 6855622.4
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 529524.6,
"y": 6855377.2
},
"ctr": {
"x": 530279.9,
"y": 6855867.7
},
"cs": 4,
"l": 660
},
{
"id": "europe_HD_NL_TTR116367997504816",
"p": {
"x": 568216,
"y": 6851287.6
},
"ic": 9,
"ty": 1,
"cs": 0,
"d": "roadworks",
"c": "new roadworks layout",
"f": "Ankeveen (N236)",
"t": "Weesp (N236)",
"l": 2760,
"dl": 73,
"r": "N236"
},
{
"id": "europe_HD_NL_TTR116367997261488",
"p": {
"x": 561973.7,
"y": 6854259.4
},
"ic": 9,
"ty": 3,
"cs": 0,
"d": "roadworks",
"c": "new roadworks layout",
"f": "Weesp (N236)",
"t": "Ankeveen (N236)",
"l": 2650,
"r": "N236"
},
{
"id": "europe_HD_NL_TTR116331064819392",
"p": {
"x": 571268.5,
"y": 6858435.4
},
"ic": 8,
"ty": 4,
"cs": 0,
"d": "closed",
"f": "IJsselmeerweg",
"t": "A6",
"l": 370
},
{
"id": "europe_CLUSTER_11_-1442937814",
"p": {
"x": 563934,
"y": 6859271.3
},
"ic": 9,
"ty": 1,
"cbl": {
"x": 563726.1,
"y": 6859250.4
},
"ctr": {
"x": 564141.9,
"y": 6859292.2
},
"cs": 2,
"l": 460
},
{
"id": "europe_CLUSTER_11_258400781",
"p": {
"x": 558055.6,
"y": 6861147.1
},
"ic": 13,
"ty": 1,
"cbl": {
"x": 557493.3,
"y": 6860514.8
},
"ctr": {
"x": 558618,
"y": 6861779.4
},
"cs": 3,
"l": 1030
},
{
"id": "europe_HD_NL_TTR116100227865681",
"p": {
"x": 542665,
"y": 6861959.7
},
"ic": 8,
"ty": 4,
"cs": 0,
"d": "closed",
"f": "Strawinskylaan",
"t": "Matthijs Vermeulenpad",
"l": 110
},
{
"id": "europe_CLUSTER_11_1438243625",
"p": {
"x": 545058.7,
"y": 6864571.6
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 543779.5,
"y": 6864070.7
},
"ctr": {
"x": 546337.8,
"y": 6865072.6
},
"cs": 5,
"l": 1590
},
{
"id": "europe_HD_NL_TTR116081762316976",
"p": {
"x": 547507.8,
"y": 6866259.3
},
"ic": 8,
"ty": 4,
"cs": 0,
"d": "closed",
"f": "Alexanderplein (s113)",
"t": "Stadhouderskade",
"l": 390,
"r": "S100"
},
{
"id": "europe_CLUSTER_11_691732516",
"p": {
"x": 541448.7,
"y": 6867162.1
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 541160.1,
"y": 6866710.7
},
"ctr": {
"x": 541737.2,
"y": 6867613.5
},
"cs": 4,
"l": 430
},
{
"id": "europe_CLUSTER_11_1582351486",
"p": {
"x": 534709.6,
"y": 6865174.7
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 534562.2,
"y": 6865025.3
},
"ctr": {
"x": 534856.9,
"y": 6865324.2
},
"cs": 2,
"l": 380
},
{
"id": "europe_CLUSTER_11_-2070222267",
"p": {
"x": 536813.1,
"y": 6868188.3
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 536191.1,
"y": 6867699.7
},
"ctr": {
"x": 537435.1,
"y": 6868677
},
"cs": 7,
"l": 1380
},
{
"id": "europe_CLUSTER_11_-496866890",
"p": {
"x": 516025.5,
"y": 6871606.3
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 514115.1,
"y": 6870216.9
},
"ctr": {
"x": 517935.9,
"y": 6872995.7
},
"cs": 7,
"l": 1510
},
{
"id": "europe_HD_NL_TTR115675492352160",
"p": {
"x": 517835.3,
"y": 6883216.3
},
"ic": 8,
"ty": 4,
"cs": 0,
"d": "closed",
"f": "Amsterdamseweg",
"t": "A22",
"l": 710
},
{
"id": "europe_CLUSTER_11_834920993",
"p": {
"x": 543803.8,
"y": 6875659.8
},
"ic": 8,
"ty": 0,
"cbl": {
"x": 543474.7,
"y": 6875602.7
},
"ctr": {
"x": 544133,
"y": 6875716.9
},
"cs": 2,
"l": 760
}
]
}
}
Definitioner
Name | Description |
---|---|
Delay |
Omfattningen av fördröjningen i samband med incidenten. Dessa värden motsvarar incidentfärger i trafikpanelerna |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Icon |
Ikonkategorin som är associerad med den här incidenten. Värdena är tal i intervallet 0-13, med följande betydelser -- 0: Okänt, 1: Olycka, 2: Dimma, 3: Farliga förhållanden, 4: Regn, 5: Is, 6: Sylt, 7: Körfält stängt, 8: Avstängd väg, 9: Vägarbeten, 10: Vind, 11: Översvämning, 12: Detour, 13: Kluster |
Incident |
Det format som ska användas för att återge panelen i API:et för trafikincidentpanel . Detta påverkar koordinaterna för trafikincidenter i svaret. |
Incident |
Typ av vektorgeometri som lagts till i incidenter (returneras i -elementet i svaret). |
Point |
Allmän representation av en punkt med koordinater (x, y) i det kartesiska planet. |
Projection |
Projektionen som används för att ange koordinaterna i begäran och svaret. EPSG900913 (standard) eller EPSG4326 |
Response |
Önskat format för svaret. Värdet kan vara antingen json eller xml. |
Tm |
Huvudsvarselement |
Traffic |
Det här objektet returneras från ett lyckat detaljanrop för trafikincident |
Traffic |
DelayMagnitude
Omfattningen av fördröjningen i samband med incidenten. Dessa värden motsvarar incidentfärger i trafikpanelerna
Name | Typ | Description |
---|---|---|
0 |
Integer |
Okänt |
1 |
Integer |
Mindre |
2 |
Integer |
Medel |
3 |
Integer |
Större |
4 |
Integer |
Obestämd (används för vägavstängningar och andra obestämda förseningar) |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
IconCategory
Ikonkategorin som är associerad med den här incidenten. Värdena är tal i intervallet 0-13, med följande betydelser -- 0: Okänt, 1: Olycka, 2: Dimma, 3: Farliga förhållanden, 4: Regn, 5: Is, 6: Sylt, 7: Körfält stängt, 8: Avstängd väg, 9: Vägarbeten, 10: Vind, 11: Översvämning, 12: Detour, 13: Kluster
Name | Typ | Description |
---|---|---|
0 |
Integer |
Okänt |
1 |
Integer |
Olycka |
10 |
Integer |
Vind |
11 |
Integer |
Översvämningar |
12 |
Integer |
Omväg |
13 |
Integer |
Kluster: Returneras om ett kluster innehåller incidenter med olika ikonkategorier. |
14 |
Integer |
Trasigt fordon |
2 |
Integer |
Dimma |
3 |
Integer |
Farliga förhållanden |
4 |
Integer |
Regn |
5 |
Integer |
Ice |
6 |
Integer |
Sylt |
7 |
Integer |
Körfält stängt |
8 |
Integer |
Väg stängd |
9 |
Integer |
Vägarbeten |
IncidentDetailStyle
Det format som ska användas för att återge panelen i API:et för trafikincidentpanel . Detta påverkar koordinaterna för trafikincidenter i svaret.
Name | Typ | Description |
---|---|---|
night |
string |
Nattstil. |
s1 |
string |
Skapar trafiklinjer med färgade sparrar som anger allvarlighetsgrad. |
s2 |
string |
Skapar enkla linjer med viss grad av glöd. |
s3 |
string |
Skapar enkla linjer med viss grad av ljussken, som skiljer sig från s2-stilen. |
IncidentGeometryType
Typ av vektorgeometri som lagts till i incidenter (returneras i -elementet i svaret).
Name | Typ | Description |
---|---|---|
original |
string |
Places incidenter exakt på vägen. |
shifted |
string |
Flyttar incidenten något (beroende på zoomnivå) för att indikera specifika vägbanor. |
Point
Allmän representation av en punkt med koordinater (x, y) i det kartesiska planet.
Name | Typ | Description |
---|---|---|
x |
number |
x koordinat |
y |
number |
y-koordinat |
ProjectionStandard
Projektionen som används för att ange koordinaterna i begäran och svaret. EPSG900913 (standard) eller EPSG4326
Name | Typ | Description |
---|---|---|
EPSG4326 |
string |
|
EPSG900913 |
string |
ResponseFormat
Önskat format för svaret. Värdet kan vara antingen json eller xml.
Name | Typ | Description |
---|---|---|
json |
string |
|
xml |
string |
Tm
Huvudsvarselement
Name | Typ | Description |
---|---|---|
@id |
string |
ID för trafikmodellen för den här incidenten |
poi |
En enskild trafikincident eller ett kluster med trafikincidenter |
TrafficIncidentDetail
Det här objektet returneras från ett lyckat detaljanrop för trafikincident
Name | Typ | Description |
---|---|---|
tm |
Huvudsvarselement |
TrafficIncidentPointOfInterest
Name | Typ | Description |
---|---|---|
c |
string |
Orsaken till incidenten, där det är tillgängligt, på det begärda språket |
cbl |
Nedre vänstra koordinaten för klustret i projektionen av begäran |
|
cs |
integer |
Klusterstorlek: antalet incidenter i klustret |
ctr |
Övre högra koordinaten för klustret i projektionen av begäran |
|
d |
string |
Beskrivning av incidenten på det begärda språket |
dl |
integer |
Fördröjning orsakad av incidenten i sekunder (förutom vid vägavstängningar) |
ed |
string |
Uppskattat slutdatum för incidenten, om det är tillgängligt. Datumet beskrivs i ISO8601 format. |
f |
string |
Från: namnet på skärningspunkten eller platsen där trafiken på grund av incidenten startar |
ic |
Ikonkategorin som är associerad med den här incidenten. Värdena är tal i intervallet 0-13, med följande betydelser -- 0: Okänt, 1: Olycka, 2: Dimma, 3: Farliga förhållanden, 4: Regn, 5: Is, 6: Sylt, 7: Körfält stängt, 8: Avstängd väg, 9: Vägarbeten, 10: Vind, 11: Översvämning, 12: Detour, 13: Kluster |
|
id |
string |
ID för trafikincidenten |
l |
integer |
Incidentens längd i meter |
p |
Den punkt där en ikon för klustret eller råincidenten ska ritas, uttryckt i den begärda projektionen. Detta påverkas av trafikstil, zoomnivå och vägtyp |
|
r |
string |
Vägnummer som påverkas av incidenten. Flera vägnummer avgränsas med snedstreck |
sd |
string |
Startdatum för incidenten, om det är tillgängligt. Datumet beskrivs i ISO8601 format. |
t |
string |
Till: namnet på skärningspunkten eller platsen där trafiken på grund av incidenten slutar |
ty |
Omfattningen av fördröjningen i samband med incidenten. Dessa värden motsvarar incidentfärger i trafikpanelerna |