Traffic - Get Traffic Flow Segment

Service:: Maps

API-versie:: 1.0

Gebruik dit diagram om informatie te krijgen over de snelheden en reistijden van het opgegeven gedeelte van de weg.

Opmerking

Buiten gebruik stellen van de Azure Maps Traffic v1-service

De Azure Maps Traffic v1-service is nu afgeschaft en wordt op 31-3-28 buiten gebruik gesteld. Om serviceonderbrekingen te voorkomen, moeten alle aanroepen naar de Traffic v1-service vóór 31-3-28 zijn bijgewerkt. Zie Azure Maps Traffic 1.0-API's migreren voor meer informatie.

De Traffic Flow Segment-API is een HTTP-GET-aanvraag die informatie biedt over de snelheden en reistijden van het wegfragment dat het dichtst bij de opgegeven coördinaten ligt. Het is ontworpen om naast de stroomlaag van de Render Service te werken om klikbare stroomgegevensvisualisaties te ondersteunen. 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}

Met optionele 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ördinaatparen (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 snelheid weerspiegelen, relatief die de snelheid ten opzichte van 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. Zoomwaarde moet binnen het bereik liggen: 0-22 (inclusief). Zie zoomniveaus en tegelraster voor meer informatie.
openLr	query		boolean	Booleaanse waarde die aangeeft of het antwoord OpenLR-code moet bevatten
thickness	query		integer (int32) minimum: 1 maximum: 20	De waarde van de breedte van de lijn die verkeer vertegenwoordigt. Deze waarde is een vermenigvuldiger en de geaccepteerde waarden variëren van 1 tot 20. De standaardwaarde is 10.
unit	query		SpeedUnit	Snelheidseenheid in KMPH of MPH

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke id voor het Azure Maps-account kan worden verkregen uit de account-API van het Azure Maps-beheervlak. Zie Verificatie beheren in Azure Maps voor meer informatie over het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

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 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 flow segment information

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Coordinates	Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden van de weg verschoven, afhankelijk van het zoomniveau ter ondersteuning van visualisatie van hoge kwaliteit in elke schaal.
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 door een geslaagde aanroep Traffic Flow Segment
TrafficFlowSegmentStyle	De stijl die moet worden gebruikt om de tegel weer te geven. Geldige waarden zijn absoluut die kleuren retourneren die de absolute snelheid weerspiegelen, relatief die de snelheid ten opzichte van vrije stroom retourneert, relatieve vertraging die alleen relatieve snelheden weergeeft wanneer ze verschillen van de vrije stroomsnelheden

Coordinates

Object

Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden van de weg verschoven, afhankelijk van het zoomniveau ter ondersteuning van visualisatie van hoge kwaliteit in elke schaal.

Name	Type	Description
coordinate	LatLongPair[]	Matrix coördineren

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.

FlowSegmentData

Object

Gegevenseigenschap Stroomsegment

Name	Type	Description
@version	string	Dit geeft de softwareversie aan die het antwoord heeft gegenereerd.
confidence	number	Het vertrouwen is een meting van de kwaliteit van de opgegeven reistijd en snelheid. Een waarde van 1 betekent volledig vertrouwen dat het antwoord de gegevens van de hoogste kwaliteit bevat. Lagere waarden geven de mate aan dat het antwoord kan variëren 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 livesnelheden.
coordinates	Coordinates	Bevat de coördinaten die de vorm van het segment beschrijven. Coördinaten worden van de weg verschoven, afhankelijk van het zoomniveau ter ondersteuning van visualisatie van hoge kwaliteit in elke schaal.
currentSpeed	integer (int32)	De huidige gemiddelde snelheid op het geselecteerde punt, in de aangevraagde eenheden. Dit wordt berekend op basis van de currentTravelTime en de lengte van het geselecteerde segment.
currentTravelTime	integer (int32)	Huidige reistijd in seconden, in dit verkeerssegment, op basis van gefuseerde realtimemetingen 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: Belangrijke weg, minder belangrijk dan een snelweg. 2: Andere belangrijke weg. 3: Secundaire weg. 4: Lokale verbindingsweg. 5: Lokale weg van hoog belang. 6: Lokale weg.
freeFlowSpeed	integer (int32)	De verwachte vrije stroomsnelheid onder ideale omstandigheden, uitgedrukt in de aangevraagde eenheden. Dit is gerelateerd aan de freeFlowTravelTime.
freeFlowTravelTime	integer (int32)	De reistijd in seconden, in dit verkeerssegment, wat onder ideale vrije stroomomstandigheden zou worden verwacht.
openlr	string	OpenLR-code voor segment. Zie OpenLR- voor meer informatie over het gebruik van Open LR-codes.

LatLongPair

Object

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number (double)	De eigenschap Breedtegraad
longitude	number (double)	Eigenschap Lengtegraad

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

SpeedUnit

Inventarisatie

Snelheidseenheid in KMPH of MPH

Waarde	Description
KMPH	Kilometer per uur
MPH	Mijl per uur

TrafficFlowSegmentData

Object

Dit object wordt geretourneerd door een geslaagde aanroep Traffic Flow Segment

Name	Type	Description
flowSegmentData	FlowSegmentData	Gegevenseigenschap Stroomsegment

TrafficFlowSegmentStyle

Inventarisatie

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

Waarde	Description
absolute
relative
relative-delay

Delen via

Traffic - Get Traffic Flow Segment

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Opmerkingen

Bereiken

subscription-key

SAS Token

Voorbeelden

Request traffic flow segment information

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle