Traffic - Get Traffic Flow Segment

Referenz

Dienst:: Maps

API-Version:: 1.0

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

Die Traffic Flow Segment-API ist eine HTTP-GET-Anforderung, die Informationen zu den Geschwindigkeiten und Fahrzeiten des Straßenfragments bereitstellt, die den angegebenen Koordinaten am nächsten kommt. Es wurde entwickelt, um zusammen mit der Flow-Ebene des Render Service zu arbeiten, um klickbare Flussdatenvisualisierungen zu unterstützen. Mit der Traffic Flow Segment-API kann die Clientseite einen beliebigen Ort in 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	Gewünschtes 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 mit vier Koordinaten, die zwei Koordinatenpaare (lat, long, lat, long), und mit EPSG4326 Projektion berechnet werden. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als einzelne Zeichenfolge übergeben, die vier Koordinaten enthält, getrennt durch Kommas.
style	query	True	TrafficFlowSegmentStyle	Die Formatvorlage, die zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, was Farben zurückgibt, die die gemessene absolute Geschwindigkeit widerspiegeln, relativ, was die Geschwindigkeit relativ zum Freifluss zurückgibt, relative Verzögerung, die nur relative Geschwindigkeiten anzeigt, bei denen sie sich von den Freilaufgeschwindigkeiten unterscheiden.
zoom	query	True	integer (int32)	Zoomfaktor für die gewünschte Kachel. Der Zoomwert muss sich im Bereich befinden: 0-22 (einschließlich). Weitere Informationen finden Sie unter Zoomstufen und kachelraster-.
openLr	query		boolean	Boolescher Wert, ob die Antwort OpenLR-Code enthalten soll
thickness	query		integer (int32) minimum: 1 maximum: 20	Der Wert der Breite der Linie, die Datenverkehr darstellt. Dieser Wert ist ein Multiplizierer und der zulässige Wertebereich 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 in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Antworten

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

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Kartenverwaltung API erworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, 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 zur Microsoft Identity Platform finden Sie unter Übersicht über die 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz 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 Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch 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 das Shape des Abschnitts beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skalierung zu unterstützen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FlowSegmentData	Flow Segment Data-Eigenschaft
LatLongPair	Ein Ort, der als Breiten- und Längengrad dargestellt wird.
ResponseFormat	Gewünschtes 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	Die Formatvorlage, die zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, was Farben zurückgibt, die die gemessene absolute Geschwindigkeit widerspiegeln, relativ, was die Geschwindigkeit relativ zum Freifluss zurückgibt, relative Verzögerung, die nur relative Geschwindigkeiten anzeigt, bei denen sie sich von den Freilaufgeschwindigkeiten unterscheiden.

Coordinates

Objekt

Enthält die Koordinaten, die das Shape des Abschnitts 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

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FlowSegmentData

Objekt

Flow Segment Data-Eigenschaft

Name	Typ	Beschreibung
@version	string	Dies gibt die Softwareversion an, die die Antwort generiert hat.
confidence	number	Das Vertrauen ist ein Maß für die Qualität der bereitgestellten Reisezeit und Geschwindigkeit. Ein Wert von 1 bedeutet volles Vertrauen, dass die Antwort die höchsten Qualitätsdaten 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, der größer als 0,6 ist, bedeutet, dass die Informationen auf Echtzeitsondeneingaben 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 Mittelwert zwischen historischen und Livegeschwindigkeiten auf.
coordinates	Coordinates	Enthält die Koordinaten, die das Shape des Abschnitts beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skalierung zu unterstützen.
currentSpeed	integer (int32)	Die aktuelle Durchschnittliche Geschwindigkeit am ausgewählten Punkt in den angeforderten Einheiten. Dies wird aus der currentTravelTime und der Länge des ausgewählten Segments berechnet.
currentTravelTime	integer (int32)	Aktuelle Fahrzeit in Sekunden, basierend auf verschmolzenen Echtzeitmessungen zwischen den definierten Standorten in der angegebenen Richtung.
frc	string	Funktionale Straßenklasse. Dies gibt den Straßentyp an: 0: Autobahn, Autobahn, Autobahn oder andere Hauptstraße. 1: Hauptstraße, weniger wichtig als eine Autobahn. 2: Andere große Straße. 3: Nebenstraße. 4: Ortsverbindungsstraße. 5: Ortsstraße von hoher Bedeutung. 6: Ortsstraße.
freeFlowSpeed	integer (int32)	Die unter idealen Bedingungen erwartete freie Strömungsgeschwindigkeit, ausgedrückt in den angeforderten Einheiten. Dies bezieht sich auf die freeFlowTravelTime.
freeFlowTravelTime	integer (int32)	Die Fahrzeit in Sekunden, in diesem Verkehrssegment, die unter idealen Freien Flussbedingungen erwartet würde.
openlr	string	OpenLR-Code für Segment. Weitere Informationen zur Verwendung von Open LR-Codes finden Sie unter OpenLR-.

LatLongPair

Objekt

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

Name	Typ	Beschreibung
latitude	number (double)	Latitude-Eigenschaft
longitude	number (double)	Longitude-Eigenschaft

ResponseFormat

Enumeration

Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format
xml	Extensible Markup Language

SpeedUnit

Enumeration

Geschwindigkeitseinheit in KMPH oder MPH

Wert	Beschreibung
KMPH	Kilometer pro Stunde
MPH	Meilen pro Stunde

TrafficFlowSegmentData

Objekt

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

Name	Typ	Beschreibung
flowSegmentData	FlowSegmentData	Flow Segment Data-Eigenschaft

TrafficFlowSegmentStyle

Enumeration

Die Formatvorlage, die zum Rendern der Kachel verwendet werden soll. Gültige Werte sind absolut, was Farben zurückgibt, die die gemessene absolute Geschwindigkeit widerspiegeln, relativ, was die Geschwindigkeit relativ zum Freifluss zurückgibt, relative Verzögerung, die nur relative Geschwindigkeiten anzeigt, bei denen sie sich von den Freilaufgeschwindigkeiten unterscheiden.

Wert	Beschreibung
absolute
relative
relative-delay

Freigeben über

Traffic - Get Traffic Flow Segment

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Request traffic flow segment information

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle

Zusätzliche Ressourcen