Traffic - Get Traffic Flow Segment

Datenverkehr Flow Segment

Gilt für: Siehe Tarife.

Dieser Dienst stellt Informationen zu den Geschwindigkeiten und Reisezeiten des Straßenfragments bereit, das den angegebenen Koordinaten am nächsten liegt. Sie ist so konzipiert, dass sie zusammen mit der Flow Ebene des Renderdiensts funktioniert, um visualisierungen von klickbaren Datenflüssen zu unterstützen. Mit dieser API kann die Clientseite jede Stelle in der Karte mit Datenflussdaten in 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}
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 Required Type Description
format
path True

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

api-version
query True
  • string

Versionsnummer der Azure Karten-API.

query
query True
  • array

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) enthalten und mithilfe der EPSG4326-Projektion berechnet werden. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als einzelne Zeichenfolge übergeben, die vier durch Kommas getrennte Koordinaten enthält.

style
query True

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

zoom
query True
  • integer
int32

Zoomfaktor für die gewünschte Kachel. Der Zoomwert muss im Bereich von 0 bis 22 (einschließlich) liegen. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster .

openLr
query
  • boolean

Boolescher Wert für die Angabe, ob die Antwort OpenLR-Code enthalten soll

thickness
query
  • integer
int32

Der Wert der Breite der Linie, die den Datenverkehr darstellt. Dieser Wert ist ein Multiplikator, und die akzeptierten Werte liegen zwischen 1 und 20. Der Standardwert ist 10.

unit
query

Geschwindigkeitseinheit in KMPH oder MPH

Anforderungsheader

Name Required Type Description
x-ms-client-id
  • string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Karten-Konto dar und kann von der Konto-API der Azure Karten-Verwaltungsebene abgerufen werden. Informationen zur Verwendung Azure AD Sicherheit in Azure Karten finden Sie in den folgenden Artikeln.

Antworten

Name Type Description
200 OK

OK

Other Status Codes

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Karten REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf mindestens ein Azure Karten-Ressourcenkonto oder untergeordnete Ressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus mindestens einer Berechtigung für Azure Karten REST-APIs besteht.

Um Szenarien zu implementieren, wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die zugriffssteuerungsfä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 Karten Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-API erworben werden.

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

  • Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeits-, Schul- und Gastkonten, aber keine persönlichen Konten.

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

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Anders ausgedrückt: Diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Karten REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist ein SAS-Token für den gemeinsamen Zugriff, das aus dem Vorgang SAS auflisten für die Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer differenzierten Steuerung des Ablaufs, der Rate und der Regionen autorisiert, die für das jeweilige Token verwendet werden. Mit anderen Worten: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sichere Weise zu ermöglichen, als mit dem gemeinsam verwendeten Schlüssel.

Bei öffentlich verfügbar gemachten Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge für die Map-Kontoressource zu konfigurieren, um den Rendering-Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Request traffic flow segment information

Sample Request

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

Sample Response

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

Coordinates

Schließt die Koordinaten ein, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skala zu unterstützen.

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

FlowSegmentData

Flow Segmentdateneigenschaft

LatLongPair

Eine Position, die 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 Aufruf von Traffic Flow Segment zurückgegeben.

TrafficFlowSegmentStyle

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

Coordinates

Schließt die Koordinaten ein, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skala zu unterstützen.

Name Type Description
coordinate

Koordinatenarray

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

Name Type Description
info
  • object

Die zusätzlichen Informationen.

type
  • string

Der zusätzliche Infotyp.

ErrorDetail

Die Fehlerdetails.

Name Type Description
additionalInfo

Die zusätzlichen Informationen zum Fehler.

code
  • string

Der Fehlercode.

details

Die Fehlerdetails.

message
  • string

Die Fehlermeldung.

target
  • string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Type Description
error

Das Fehlerobjekt.

FlowSegmentData

Flow Segmentdateneigenschaft

Name Type Description
@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. Der Wert 1 bedeutet volle Zuverlässigkeit, 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 einer Testeingabe in Echtzeit basierten. Der Wert 0,5 bedeutet, dass die gemeldete Geschwindigkeit auf Verlaufsinformationen basiert. Ein Wert zwischen 0,5 und 0,6 weist einen berechneten gewichteten Durchschnitt zwischen Verlaufs- und Livegeschwindigkeit auf.

coordinates

Schließt die Koordinaten ein, die die Form des Segments beschreiben. Koordinaten werden je nach Zoomfaktor von der Straße verschoben, um eine qualitativ hochwertige Visualisierung in jeder Skala zu unterstützen.

currentSpeed
  • integer

Die aktuelle Durchschnittsgeschwindigkeit 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 über dieses Verkehrssegment, basierend auf fused Real-Time-Messungen zwischen den definierten Standorten in der angegebenen Richtung.

frc
  • string

Functional Road-Klasse. Dies gibt den Straßentyp an: 0: Fahrten, Freiweg oder andere Hauptverkehrsstrecke. 1: Hauptverkehrsstrecke, weniger wichtig als ein 1:1. 2: Andere wichtige Straße. 3: Sekundäre Straße. 4: Lokale Verbindungsstraße. 5: Lokale Straße von hoher Wichtigkeit. 6: Lokale Straße.

freeFlowSpeed
  • integer

Die unter idealen Bedingungen erwartete Geschwindigkeit des freien Datenflusses, ausgedrückt in den angeforderten Einheiten. Dies bezieht sich auf freeFlowTravelTime.

freeFlowTravelTime
  • integer

Die Reisezeit in Sekunden für dieses Verkehrssegment, die unter idealen Bedingungen für den freien Fluss zu erwarten wäre.

openlr
  • string

OpenLR-Code für Segment. Weitere Informationen zur Verwendung von Open LR-Codes finden Sie unter OpenLR .

LatLongPair

Eine Position, die als Breiten- und Längengrad dargestellt wird.

Name Type Description
latitude
  • number

Latitude-Eigenschaft

longitude
  • number

Längengradeigenschaft

ResponseFormat

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

Name Type Description
json
  • string

Das JavaScript Object Notation-Datenaustauschformat

xml
  • string

Die Extensible Markup Language

SpeedUnit

Geschwindigkeitseinheit in KMPH oder MPH

Name Type Description
KMPH
  • string

Kilometer pro Stunde

MPH
  • string

Meilen pro Stunde

TrafficFlowSegmentData

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

Name Type Description
flowSegmentData

Flow Segmentdateneigenschaft

TrafficFlowSegmentStyle

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

Name Type Description
absolute
  • string
relative
  • string
relative-delay
  • string