Traffic - Get Traffic Flow Segment

Referentie

Service:: Maps

API Version:: 1.0

Gebruik om informatie op te halen over de snelheden en reistijden van het opgegeven weggedeelte.

De Traffic Flow Segment API is een HTTP-aanvraag GET die informatie biedt over de snelheden en reistijden van het wegfragment dat het dichtst bij de opgegeven coördinaten ligt. Het is ontworpen om samen te werken met de stroomlaag van de Render-service ter ondersteuning van visualisaties van klikbare stroomgegevens. Met de Traffic Flow Segment API kan de clientzijde elke plaats in de kaart verbinden met stroomgegevens op de dichtstbijzijnde weg en deze aan de gebruiker presenteren.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

With optional parameters:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

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.
query	query	True	number[]	Coördinaten van het punt dicht bij het wegsegment. Deze parameter is een lijst met vier coördinaten, met twee coördinatenparen (lat, long, lat, long) en berekend met behulp van EPSG4326 projectie. Wanneer dit eindpunt rechtstreeks wordt aangeroepen, worden coördinaten doorgegeven als één tekenreeks met vier coördinaten, gescheiden door komma's.
style	query	True	TrafficFlowSegmentStyle	De stijl die moet worden gebruikt om de tegel weer te geven. Geldige waarden zijn absoluut die kleuren retourneren die de absolute gemeten snelheid weerspiegelen, relatief die de snelheid ten opzichte van de vrije stroom retourneert, relatieve vertraging die alleen relatieve snelheden weergeeft wanneer ze verschillen van de vrije stroomsnelheden
zoom	query	True	integer int32	Zoomniveau voor de gewenste tegel. De zoomwaarde moet zich in het bereik 0-22 (inclusief) bevindt. Zie Zoomniveaus en Tegelraster voor meer informatie.
openLr	query		boolean	Booleaanse waarde voor de vraag of het antwoord OpenLR-code moet bevatten
thickness	query		integer int32	De waarde van de breedte van de lijn die verkeer vertegenwoordigt. Deze waarde is een vermenigvuldiger en de geaccepteerde waarden liggen tussen 1 en 20. De standaardwaarde is 10.
unit	query		SpeedUnit	Snelheidseenheid in KMPH of MPH

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 in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

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

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met 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.

Als u scenario's wilt implementeren, raden we u aan om 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

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 Beheer-API van Maps .

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 gebruiksscenario's.

Zie Microsoft identity platform overzicht 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 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 wordt 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 over het verloop, de snelheid en de 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 oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Request traffic flow segment information

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Sample Response

Status code:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

Definities

Name	Description
Coordinates	Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden verschoven van de weg, afhankelijk van het zoomniveau om visualisaties van hoge kwaliteit in elke schaal te ondersteunen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FlowSegmentData	Gegevenseigenschap stroomsegment
LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json of xml zijn.
SpeedUnit	Snelheidseenheid in KMPH of MPH
TrafficFlowSegmentData	Dit object wordt geretourneerd na een geslaagde aanroep van het verkeersstroomsegment
TrafficFlowSegmentStyle	De stijl die moet worden gebruikt om de tegel weer te geven. Geldige waarden zijn absoluut die kleuren retourneren die de absolute gemeten snelheid weerspiegelen, relatief die de snelheid ten opzichte van de vrije stroom retourneert, relatieve vertraging die alleen relatieve snelheden weergeeft wanneer ze verschillen van de vrije stroomsnelheden

Coordinates

Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden verschoven van de weg, afhankelijk van het zoomniveau om visualisaties van hoge kwaliteit in elke schaal te ondersteunen.

Name	Type	Description
coordinate	LatLongPair[]	Coördinaatmatrix

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[]	De fout aanvullende informatie.
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.

FlowSegmentData

Gegevenseigenschap stroomsegment

Name	Type	Description
@version	string	Dit geeft de softwareversie aan die het antwoord heeft gegenereerd.
confidence	number	Het vertrouwen is een maat voor de kwaliteit van de geleverde reistijd en snelheid. Een waarde van 1 betekent volledig vertrouwen, dat het antwoord de gegevens van de hoogste kwaliteit bevat. Lagere waarden geven aan in hoeverre de reactie kan afwijken van de werkelijke omstandigheden op de weg. Elke waarde groter dan 0,6 betekent dat de informatie is gebaseerd op realtime testinvoer. Een waarde van 0,5 betekent dat de gerapporteerde snelheid is gebaseerd op historische informatie. Een waarde tussen 0,5 en 0,6 heeft een berekend gewogen gemiddelde tussen historische en actieve snelheden.
coordinates	Coordinates	Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden verschoven van de weg, afhankelijk van het zoomniveau om visualisaties van hoge kwaliteit in elke schaal te ondersteunen.
currentSpeed	integer	De huidige gemiddelde snelheid op het geselecteerde punt, in de gevraagde eenheden. Dit wordt berekend op basis van de huidigeTravelTime en de lengte van het geselecteerde segment.
currentTravelTime	integer	Huidige reistijd in seconden, in dit verkeerssegment, op basis van gefuseerde realtime metingen tussen de gedefinieerde locaties in de opgegeven richting.
frc	string	Functionele wegklasse. Dit geeft het wegtype aan: 0: Snelweg, snelweg of andere belangrijke weg. 1: Hoofdweg, minder belangrijk dan een snelweg. 2: Andere grote weg. 3: Secundaire weg. 4: Lokale verbindingsweg. 5: Lokale weg van hoog belang. 6: Lokale weg.
freeFlowSpeed	integer	De verwachte vrije stroomsnelheid onder ideale omstandigheden, uitgedrukt in de gevraagde eenheden. Dit is gerelateerd aan de freeFlowTravelTime.
freeFlowTravelTime	integer	De reistijd in seconden, over dit verkeerssegment, wat te verwachten is onder ideale vrije doorstromingsomstandigheden.
openlr	string	OpenLR-code voor segment. Zie OpenLR voor meer informatie over het gebruik van Open LR-codes.

LatLongPair

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number	De eigenschap Breedtegraad
longitude	number	De eigenschap Lengtegraad

ResponseFormat

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

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

SpeedUnit

Snelheidseenheid in KMPH of MPH

Name	Type	Description
KMPH	string	Kilometers per uur
MPH	string	Mijlen per uur

TrafficFlowSegmentData

Dit object wordt geretourneerd na een geslaagde aanroep van het verkeersstroomsegment

Name	Type	Description
flowSegmentData	FlowSegmentData	Gegevenseigenschap stroomsegment

TrafficFlowSegmentStyle

De stijl die moet worden gebruikt om de tegel weer te geven. Geldige waarden zijn absoluut die kleuren retourneren die de absolute gemeten snelheid weerspiegelen, relatief die de snelheid ten opzichte van de vrije stroom retourneert, relatieve vertraging die alleen relatieve snelheden weergeeft wanneer ze verschillen van de vrije stroomsnelheden

Name	Type	Description
absolute	string
relative	string
relative-delay	string