Traffic - Get Traffic Incident Viewport

Referens

Tjänst:: Maps

API-version:: 1.0

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

Traffic Incident Viewport-API:et är en HTTP-GET begäran som returnerar juridisk och teknisk information för det visningsområde som beskrivs i begäran. Det bör anropas av klientprogram när visningsporten ändras (till exempel genom zoomning, panorering, att 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 information om kartversionen, samt aktuellt trafikmodell-ID och upphovsrätts-ID: n. Trafikmodell-ID:t som returneras av Beskrivning av Visningsport 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}

Med valfria parametrar:

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. Den `boundingbox` representeras av två värdepar som beskriver dess hörn (första par för nedre vänstra hörnet och 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 överstiga 4 092 bildpunkter när den återges på den angivna zoomnivån. Obs! Avgränsningslådor som korsar 180° meridian kräver särskild behandling. För sådana rutor blir det östra maxX--värdet negativt och därmed mindre än värdet minX väster om meridianen på 180°. För att åtgärda detta bör värdet 40075016.6855874 läggas till i värdet true maxX innan det skickas i begäran.
boundingzoom	query	True	integer (int32) minimum: 0 maximum: 22	Zoomnivå 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 används samma koordinater som `boundingBox`. 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) minimum: 0 maximum: 22	Zoomnivå 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äkerhetsmodellen. 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 för vägledning.

Svar

Name	Typ	Description
200 OK	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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-resurskonton 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 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.

Noteringar

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-hantering-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella 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	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: query

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 traffic incident information for the selected viewport

Exempelbegäran

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

Exempelsvar

Statuskod:: 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 visningsanrop för trafikincidenter
TrafficState	Information om trafiktillstånd
ViewpResp	Viewport Response-objekt

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ResponseFormat

Uppräkning

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

Värde	Description
json	JavaScript-objekt notationens datautbytesformat
xml	Det utökningsbara markupspråket

TrafficIncidentViewport

Objekt

Det här objektet returneras från ett lyckat visningsanrop för trafikincidenter

Name	Typ	Description
viewpResp	ViewpResp	Viewport Response-objekt

TrafficState

Objekt

Information om trafiktillstånd

Name	Typ	Description
@trafficAge	integer (int32)	Den förflutna tiden (i sekunder) från skapandet av trafikmodell-ID.
@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

Objekt

Viewport Response-objekt

Name	Typ	Description
@maps	string	Anger dataleverantörens 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	Information om trafiktillstånd

Dela via

Traffic - Get Traffic Incident Viewport

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Noteringar

Omfattningar

subscription-key

SAS Token

Exempel

Request traffic incident information for the selected viewport

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResponseFormat

TrafficIncidentViewport

TrafficState

ViewpResp