Traffic - Get Traffic Incident Viewport

Referentie

Service:: Maps

API Version:: 1.0

Gebruik om juridische en technische informatie voor een viewport op te halen.

De Traffic Incident Viewport API is een HTTP-aanvraag GET die juridische en technische informatie retourneert voor de viewport die in de aanvraag wordt beschreven. Deze moet worden aangeroepen door clienttoepassingen wanneer de viewport verandert (bijvoorbeeld door te zoomen, pannen, naar een locatie te gaan of een route weer te geven). De aanvraag moet het begrenzingsvak en zoomniveau bevatten van de viewport waarvan de informatie nodig is. De retour bevat informatie over de kaartversie, evenals de huidige verkeersmodel-id en copyright-id's. De verkeersmodel-id die door de Viewport-beschrijving wordt geretourneerd, wordt door andere API's gebruikt om de laatste verkeersinformatie op te halen voor verdere verwerking.

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-parameters

Name	In	Vereist	Type	Description
format	path	True	ResponseFormat	Gewenste indeling van het antwoord. Waarde kan json of xml zijn.
api-version	query	True	string	Versienummer van Azure Maps API.
boundingbox	query	True	number[]	Begrenzingsvak van de kaartweergavepoort in EPSG900913 projectie. De `boundingbox` wordt vertegenwoordigd door twee waardeparen die de hoeken beschrijven (het eerste paar voor de linkerbenedenhoek en het tweede paar voor rechtsboven). Wanneer dit eindpunt rechtstreeks wordt aangeroepen, moeten alle waarden worden gescheiden door komma's (bijvoorbeeld minY,minX,maxY,maxX). De maximale grootte van het begrenzingsvak dat kan worden doorgegeven, is afhankelijk van het aangevraagde zoomniveau. De breedte en hoogte mogen niet groter zijn dan 4092 pixels wanneer ze worden weergegeven op het opgegeven zoomniveau. OPMERKING: Begrenzingsvakken die de 180°idiaan overschrijden, vereisen een speciale behandeling. Voor dergelijke vakken zal de oostelijke maxX-waarde negatief zijn, en dus kleiner dan de minX-waarde ten westen van de 180° meridian. Hiervoor moet de waarde 40075016.6855874 worden toegevoegd aan de waarde true maxX voordat deze in de aanvraag wordt doorgegeven.
boundingzoom	query	True	integer int32	Zoomniveau van de kaartweergavepoort. Wordt gebruikt om te bepalen of de weergave kan worden ingezoomd.
overviewbox	query	True	number[]	Begrenzingsvak van de overzichtskaart in EPSG900913 projectie. Wordt gebruikt voor het geval de overzichtsbox/minikaart andere copyrightgegevens heeft dan de hoofdkaart. Als er geen minikaart is, worden dezelfde coördinaten gebruikt.`boundingBox` Wanneer dit eindpunt rechtstreeks wordt aangeroepen, worden coördinaten doorgegeven als één tekenreeks met vier coördinaten, gescheiden door komma's.
overviewzoom	query	True	integer int32	Zoomniveau van de overzichtskaart. Als er geen minikaart is, gebruikt u hetzelfde zoomniveau als boundingZoom.
copyright	query		boolean	Bepaalt welke copyrightinformatie moet worden geretourneerd. Indien waar wordt de copyrighttekst geretourneerd; wanneer onwaar alleen de copyrightindex wordt geretourneerd.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

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

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account Creatie in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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"
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ResponseFormat	Gewenste indeling van het antwoord. Waarde kan json of xml zijn.
TrafficIncidentViewport	Dit object wordt geretourneerd na een geslaagde Viewport-aanroep voor verkeersincidenten
TrafficState	Informatie over de verkeersstatus
ViewpResp	Viewport-antwoordobject

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ResponseFormat

Gewenste indeling van het antwoord. Waarde kan json of xml zijn.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling
xml	string	De uitbreidbare opmaaktaal

TrafficIncidentViewport

Dit object wordt geretourneerd na een geslaagde Viewport-aanroep voor verkeersincidenten

Name	Type	Description
viewpResp	ViewpResp	Viewport-antwoordobject

TrafficState

Informatie over de verkeersstatus

Name	Type	Description
@trafficAge	integer	De verstreken tijd (in seconden) na het maken van de verkeersmodel-id.
@trafficModelId	string	De unieke id met de naam Traffic Model ID wordt gebruikt in aanroepen naar Traffic Incident Services. Hiermee kunt u informatie ophalen van bepaalde verkeersupdates. De verkeersmodel-id wordt elke minuut bijgewerkt en is twee minuten geldig voordat er een time-out optreedt.

ViewpResp

Viewport-antwoordobject

Name	Type	Description
@maps	string	Geeft de interne namen van de gegevensprovider aan voor de kaartgegevens die worden gebruikt in de viewport. Voor gebruik met ondersteuningsquery's.
@version	string	Geeft de softwareversie aan die wordt gebruikt om de informatie te genereren. Voor gebruik met ondersteuningsquery's.
copyrightIds	string	Wanneer de waarde van de parameter copyright waar is, bevat deze de volledige tekst van de copyrightinformatie die moet worden weergegeven met de tegels in de viewport
trafficState	TrafficState	Informatie over de verkeersstatus