Traffic - Get Traffic Incident Viewport

Referens

Service:: Maps

API Version:: 1.0

Använd för att hämta juridisk och teknisk information för en vyport.

API:et Traffic Incident Viewport är en HTTP-begäran GET som returnerar juridisk och teknisk information för det visningsområde som beskrivs i begäran. Det bör anropas av klientprogram när viewporten ändras (till exempel genom zoomning, panorering, gå till en plats eller visa en väg). Begäran ska innehålla avgränsningsrutan och zoomnivån för det visningsområde vars information behövs. Returen innehåller kartversionsinformation samt aktuellt trafikmodell-ID och upphovsrätts-ID:n. Trafikmodell-ID:t som returneras av Viewport-beskrivningen används av andra API:er för att hämta den senaste trafikinformationen för vidare bearbetning.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	ResponseFormat	Ö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[]	Avgränsningsruta för kartvyporten i EPSG900913 projektion. `boundingbox` representeras av två värdepar som beskriver dess hörn (första paret för det nedre vänstra hörnet och det andra för övre högra hörnet). När den här slutpunkten anropas direkt ska alla värden avgränsas med kommatecken (t.ex. minY,minX,maxY,maxX). Den maximala storleken på avgränsningsrutan som kan skickas beror på den begärda zoomnivån. Bredden och höjden får inte överskrida 4 092 bildpunkter när de återges på den angivna zoomnivån. Obs! Avgränsningslådor som korsar 180° meridianen kräver särskild behandling. För sådana rutor blir det östra maxX-värdet negativt och därmed mindre än minX-värdet väster om meridianen på 180°. För att åtgärda detta bör värdet 40075016.6855874 läggas till i det sanna maxX-värdet innan det skickas i begäran.
boundingzoom	query	True	integer int32	Zoomningsnivå för kartvyporten. Används för att avgöra om vyn kan zoomas in.
overviewbox	query	True	number[]	Avgränsningsruta för översiktskartan i EPSG900913 projektion. Används om översiktsrutan/minikartan har andra upphovsrättsdata än huvudkartan. Om det inte finns någon minikarta, samma koordinater som `boundingBox` används. När den här slutpunkten anropas direkt skickas koordinaterna in som en enda sträng som innehåller fyra koordinater, avgränsade med kommatecken.
overviewzoom	query	True	integer int32	Zoomningsnivå för översiktskartan. Om det inte finns någon minikarta använder du samma zoomnivå som boundingZoom.
copyright	query		boolean	Avgör vilken upphovsrättsinformation som ska returneras. När det är sant returneras upphovsrättstexten; när falskt returneras endast upphovsrättsindexet.

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. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. 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	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	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 ett 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 ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkrä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-hanterings-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure 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 huvudnyckel i det konto som de har utfärdats 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 säkrare 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.

Type: apiKey
In: header

Exempel

Request traffic incident information for the selected viewport

Sample Request

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

Sample Response

Status code:: 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"
  }
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
TrafficIncidentViewport	Det här objektet returneras från ett lyckat Viewport-anrop för trafikincidenter
TrafficState	Trafiktillståndsinformation
ViewpResp	Viewport Response-objekt

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation
xml	string	Utökningsbart markeringsspråk

TrafficIncidentViewport

Det här objektet returneras från ett lyckat Viewport-anrop för trafikincidenter

Name	Typ	Description
viewpResp	ViewpResp	Viewport Response-objekt

TrafficState

Trafiktillståndsinformation

Name	Typ	Description
@trafficAge	integer	Den förflutna tiden (i sekunder) från skapandet av trafikmodell-ID: t.
@trafficModelId	string	Det unika ID:t som kallas Trafikmodell-ID används i anrop till trafikincidenttjänster. Det gör det möjligt att hämta information från vissa trafikuppdateringar. Trafikmodell-ID uppdateras varje minut och är giltigt i två minuter innan tidsgränsen uppnås.

ViewpResp

Viewport Response-objekt

Name	Typ	Description
@maps	string	Anger dataproviderns interna namn för kartdata som används i visningsporten. För användning med supportfrågor.
@version	string	Anger vilken programvaruversion som används för att generera informationen. För användning med supportfrågor.
copyrightIds	string	När värdet för copyrightparametern är sant innehåller detta den fullständiga texten i den upphovsrättsinformation som måste visas med panelerna i visningsplatsen
trafficState	TrafficState	Trafiktillståndsinformation