Traffic - Get Traffic Flow Segment

Referenz

Dienst:: Maps

API-Version:: 1.0

Verwenden Sie , um Informationen über die Geschwindigkeiten und Fahrzeiten des angegebenen Straßenabschnitts zu erhalten.

Die Traffic Flow Segment API ist eine HTTP-Anforderung GET , die Informationen über die Geschwindigkeiten und Reisezeiten des Straßenfragments bereitstellt, das den angegebenen Koordinaten am nächsten kommt. Es wurde entwickelt, um zusammen mit der Flow-Ebene des Renderdiensts zu arbeiten, um klickbare Flussdatenvisualisierungen zu unterstützen. Mit der Traffic Flow Segment API kann die Clientseite einen beliebigen Ort auf der Karte mit Flussdaten auf der nächstgelegenen Straße verbinden und dem Benutzer präsentieren.

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

Mit optionalen Parametern:

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

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	number[]	Koordinaten des Punkts in der Nähe des Straßensegments. Dieser Parameter ist eine Liste von vier Koordinaten, die zwei Koordinatenpaare (lat, long, lat, long) enthält und mit EPSG4326 Projektion berechnet wird. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als eine einzelne Zeichenfolge übergeben, die vier Koordinaten enthält, getrennt durch Kommas.
style	query	True	TrafficFlowSegmentStyle	Der Stil, der zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, die Farben zurückgibt, die die absolute gemessene Geschwindigkeit widerspiegeln, relativ, die die Geschwindigkeit relativ zum Freien Fluss zurückgibt, Relative Verzögerung, die relative Geschwindigkeiten nur anzeigt, wenn sie sich von den Freeflowgeschwindigkeiten unterscheiden.
zoom	query	True	integer int32	Zoomfaktor für die gewünschte Kachel. Der Zoomwert muss im Bereich zwischen 0 und 22 (einschließlich) liegen. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster .
openLr	query		boolean	Boolescher Wert, ob die Antwort OpenLR-Code enthalten soll
thickness	query		integer int32	Der Wert der Breite der Linie, die Datenverkehr darstellt. Dieser Wert ist ein Multiplikator, und die akzeptierten Werte liegen zwischen 1 und 20. Der Standardwert ist 10.
unit	query		SpeedUnit	Geschwindigkeitseinheit in KMPH oder MPH

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name	Typ	Beschreibung
200 OK	TrafficFlowSegmentData	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Request traffic flow segment information

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Coordinates	Enthält die Koordinaten, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skalierung zu unterstützen.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
FlowSegmentData	FlowSegment Data-Eigenschaft
LatLongPair	Ein Standort, der als Breiten- und Längengrad dargestellt wird.
ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
SpeedUnit	Geschwindigkeitseinheit in KMPH oder MPH
TrafficFlowSegmentData	Dieses Objekt wird von einem erfolgreichen Traffic Flow Segment-Aufruf zurückgegeben.
TrafficFlowSegmentStyle	Der Stil, der zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, die Farben zurückgibt, die die absolute gemessene Geschwindigkeit widerspiegeln, relativ, die die Geschwindigkeit relativ zum Freien Fluss zurückgibt, Relative Verzögerung, die relative Geschwindigkeiten nur anzeigt, wenn sie sich von den Freeflowgeschwindigkeiten unterscheiden.

Coordinates

Enthält die Koordinaten, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skalierung zu unterstützen.

Name	Typ	Beschreibung
coordinate	LatLongPair[]	Koordinatenarray

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FlowSegmentData

FlowSegment Data-Eigenschaft

Name	Typ	Beschreibung
@version	string	Dies gibt die Softwareversion an, die die Antwort generiert hat.
confidence	number	Die Zuverlässigkeit ist ein Maß für die Qualität der bereitgestellten Reisezeit und Geschwindigkeit. Ein Wert von 1 bedeutet volle Gewissheit, dass die Antwort die Daten mit der höchsten Qualität enthält. Niedrigere Werte geben den Grad an, in dem die Antwort von den tatsächlichen Bedingungen auf der Straße abweichen kann. Jeder Wert größer als 0,6 bedeutet, dass die Informationen auf echtzeitbasierten Testeingaben basieren. Der Wert 0,5 bedeutet, dass die gemeldete Geschwindigkeit auf historischen Informationen basiert. Ein Wert zwischen 0,5 und 0,6 weist einen berechneten gewichteten Durchschnitt zwischen historischen und Live-Geschwindigkeiten auf.
coordinates	Coordinates	Enthält die Koordinaten, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skalierung zu unterstützen.
currentSpeed	integer	Die aktuelle durchschnittliche Geschwindigkeit am ausgewählten Punkt in den angeforderten Einheiten. Dies wird aus currentTravelTime und der Länge des ausgewählten Segments berechnet.
currentTravelTime	integer	Aktuelle Reisezeit in Sekunden in diesem Verkehrssegment basierend auf fusionierten Echtzeitmessungen zwischen den definierten Orten in der angegebenen Richtung.
frc	string	Functional Road-Klasse. Dies gibt den Straßentyp an: 0: Autobahn, Autobahn oder andere Hauptstraße. 1: Hauptstrasse, weniger wichtig als eine Autobahn. 2: Andere Hauptverkehrsstraße. 3: Nebenstraße. 4: Ortsverbindungsstraße. 5: Ortsstraße von hoher Bedeutung. 6: Ortsstraße.
freeFlowSpeed	integer	Die unter idealen Bedingungen erwartete freie Strömungsgeschwindigkeit, ausgedrückt in den angeforderten Einheiten. Dies bezieht sich auf freeFlowTravelTime.
freeFlowTravelTime	integer	Die Reisezeit in Sekunden in diesem Verkehrssegment, die unter idealen Freien Flussbedingungen erwartet wird.
openlr	string	OpenLR-Code für Segment. Weitere Informationen zur Verwendung von Open LR-Codes finden Sie unter OpenLR .

LatLongPair

Ein Standort, der als Breiten- und Längengrad dargestellt wird.

Name	Typ	Beschreibung
latitude	number	Latitude-Eigenschaft
longitude	number	Longitude-Eigenschaft

ResponseFormat

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation
xml	string	Die erweiterbare Markupsprache

SpeedUnit

Geschwindigkeitseinheit in KMPH oder MPH

Name	Typ	Beschreibung
KMPH	string	Kilometer pro Stunde
MPH	string	Meilen pro Stunde

TrafficFlowSegmentData

Dieses Objekt wird von einem erfolgreichen Traffic Flow Segment-Aufruf zurückgegeben.

Name	Typ	Beschreibung
flowSegmentData	FlowSegmentData	FlowSegment Data-Eigenschaft

TrafficFlowSegmentStyle

Der Stil, der zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, die Farben zurückgibt, die die absolute gemessene Geschwindigkeit widerspiegeln, relativ, die die Geschwindigkeit relativ zum Freien Fluss zurückgibt, Relative Verzögerung, die relative Geschwindigkeiten nur anzeigt, wenn sie sich von den Freeflowgeschwindigkeiten unterscheiden.

Name	Typ	Beschreibung
absolute	string
relative	string
relative-delay	string

Freigeben über