Traffic - Get Traffic Incident Viewport

Referentie

Service:: Maps

API-versie:: 1.0

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

De Traffic Incident Viewport-API is een HTTP-GET-aanvraag 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 het zoomniveau van de viewport bevatten waarvan de informatie nodig is. De retour bevat informatie over kaartversies, evenals de huidige verkeersmodel-id en copyright-id's. De verkeersmodel-id die wordt geretourneerd door de Viewport Description, wordt door andere API's gebruikt om 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}

Met optionele 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. De waarde kan json- of xml-zijn.
api-version	query	True	string	Versienummer van Azure Maps-API.
boundingbox	query	True	number[]	Begrenzingsvak van de kaart viewport in EPSG900913 projectie. De `boundingbox` wordt vertegenwoordigd door twee waardeparen die de hoeken beschrijven (eerste paar voor linkerbenedenhoek en tweede 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°dian oversteken, vereisen speciale behandeling. Voor dergelijke vakken zal de oostelijke maxX waarde negatief zijn, en dus kleiner dan de minX waarde ten westen van de 180°diane. Om dit te verhelpen, moet de waarde 40075016.6855874 worden toegevoegd aan de true maxX waarde voordat deze wordt doorgegeven in de aanvraag.
boundingzoom	query	True	integer (int32) minimum: 0 maximum: 22	Zoomniveau van de kaart viewport. Wordt gebruikt om te bepalen of de weergave kan worden ingezoomd.
overviewbox	query	True	number[]	Begrenzingsvak van de overzichtskaart in EPSG900913 projectie. Wordt gebruikt als het overzichtsvak/minikaart andere copyrightgegevens heeft dan de hoofdkaart. Als er geen minikaart is, worden dezelfde coördinaten gebruikt als `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) minimum: 0 maximum: 22	Zoomniveau van de overzichtskaart. Als er geen minikaart is, gebruikt u hetzelfde zoomniveau als begrenzingszoom.
copyright	query		boolean	Bepaalt welke copyrightinformatie moet worden geretourneerd. Wanneer waar is, wordt de copyrighttekst geretourneerd; als alleen de copyrightindex onwaar 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 Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

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 Flows. Wanneer deze 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 aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. 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 om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Opmerkingen

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

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Het op rollen gebaseerde 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 configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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 maken in 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 worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering 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 wordt gemaakt op basis van de bewerking List SAS 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 voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Request traffic incident information for the selected viewport

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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. De waarde kan json- of xml-zijn.
TrafficIncidentViewport	Dit object wordt geretourneerd door een geslaagde Viewport-aanroep voor verkeersincidenten
TrafficState	Informatie over verkeersstatus
ViewpResp	Viewport Response-object

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

Object

De foutdetails.

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

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ResponseFormat

Inventarisatie

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten
xml	De uitbreidbare opmaaktaal

TrafficIncidentViewport

Object

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

Name	Type	Description
viewpResp	ViewpResp	Viewport Response-object

TrafficState

Object

Informatie over verkeersstatus

Name	Type	Description
@trafficAge	integer (int32)	De verstreken tijd (in seconden) van 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 verkrijgen van bepaalde verkeersupdates. De verkeersmodel-id wordt elke minuut bijgewerkt en is twee minuten geldig voordat er een time-out optreedt.

ViewpResp

Object

Viewport Response-object

Name	Type	Description
@maps	string	Geeft de interne namen van de gegevensprovider aan voor de kaartgegevens die in de viewport worden gebruikt. 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 copyrightparameter waar is, bevat dit de volledige tekst van de copyrightinformatie die moet worden weergegeven met de tegels in de viewport
trafficState	TrafficState	Informatie over verkeersstatus

Delen via

Traffic - Get Traffic Incident Viewport

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Opmerkingen

Bereiken

subscription-key

SAS Token

Voorbeelden

Request traffic incident information for the selected viewport

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResponseFormat

TrafficIncidentViewport

TrafficState

ViewpResp

Aanvullende resources