Traffic - Get Traffic Flow Segment

Referens

Tjänst:: Maps

API-version:: 1.0

Använd för att få information om hastigheter och restider för den angivna vägsträckan.

API:et Traffic Flow Segment är en HTTP-begäran GET som innehåller information om hastigheterna och restiderna för vägfragmentet närmast de angivna koordinaterna. Den är utformad för att fungera tillsammans med flödeslagret i renderingstjänsten för att stödja klickbara flödesdatavisualiseringar. Med API:et Traffic Flow Segment kan klientsidan ansluta valfri plats på kartan med flödesdata på närmaste väg och presentera den för användaren.

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

Med valfria parametrar:

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

Name	I	Obligatorisk	Typ	Description
format	path	True	ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
api-version	query	True	string	Versionsnummer för Azure Maps API.
query	query	True	number[]	Koordinater för punkten nära vägsegmentet. Den här parametern är en lista med fyra koordinater som innehåller två koordinatpar (lat, long, lat, long) och som beräknas med hjälp av EPSG4326 projektion. När den här slutpunkten anropas direkt skickas koordinaterna in som en enda sträng som innehåller fyra koordinater, avgränsade med kommatecken.
style	query	True	TrafficFlowSegmentStyle	Det format som ska användas för att återge panelen. Giltiga värden är absoluta som returnerar färger som återspeglar den uppmätta absoluta hastigheten, relativt vilken returnerar hastigheten i förhållande till fritt flöde, Relativ fördröjning som endast visar relativa hastigheter där de skiljer sig från friflödeshastigheterna
zoom	query	True	integer int32	Zoomnivå för önskad panel. Zoomvärdet måste ligga i intervallet: 0–22 (inklusive). Mer information finns i Zoomnivåer och Rutnät för paneler .
openLr	query		boolean	Booleskt värde för om svaret ska innehålla OpenLR-kod
thickness	query		integer int32	Värdet för bredden på den rad som representerar trafik. Det här värdet är en multiplikator och de godkända värdena sträcker sig från 1 till 20. Standardvärdet är 10.
unit	query		SpeedUnit	Hastighetsenhet i KMPH eller MPH

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Svar

Name	Typ	Description
200 OK	TrafficFlowSegmentData	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Webb-SDK för Azure Maps möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure-portalen eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att få åtkomst till REST-API:er för Azure Maps så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Request traffic flow segment information

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Coordinates	Innehåller koordinaterna som beskriver segmentets form. Koordinater flyttas från vägen beroende på zoomningsnivån för att stödja visualisering av hög kvalitet i varje skala.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FlowSegmentData	Flödessegmentdataegenskap
LatLongPair	En plats som representeras som latitud och longitud.
ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
SpeedUnit	Hastighetsenhet i KMPH eller MPH
TrafficFlowSegmentData	Det här objektet returneras från ett lyckat trafikflödessegmentanrop
TrafficFlowSegmentStyle	Det format som ska användas för att återge panelen. Giltiga värden är absoluta som returnerar färger som återspeglar den uppmätta absoluta hastigheten, relativt vilken returnerar hastigheten i förhållande till fritt flöde, Relativ fördröjning som endast visar relativa hastigheter där de skiljer sig från friflödeshastigheterna

Coordinates

Innehåller koordinaterna som beskriver segmentets form. Koordinater flyttas från vägen beroende på zoomningsnivån för att stödja visualisering av hög kvalitet i varje skala.

Name	Typ	Description
coordinate	LatLongPair[]	Koordinatmatris

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FlowSegmentData

Flödessegmentdataegenskap

Name	Typ	Description
@version	string	Detta anger vilken programvaruversion som genererade svaret.
confidence	number	Förtroendet är ett mått på kvaliteten på den tillhandahållna restiden och hastigheten. Värdet 1 innebär fullständig konfidens, att svaret innehåller data av högsta kvalitet. Lägre värden anger i vilken grad svaret kan variera från de faktiska förhållandena på vägen. Alla värden som är större än 0,6 innebär att informationen baserades på indata från realtidsavsökningen. Värdet 0,5 innebär att den rapporterade hastigheten baseras på historisk information. Ett värde mellan 0,5 och 0,6 har ett beräknat viktat genomsnitt mellan historiska och aktiva hastigheter.
coordinates	Coordinates	Innehåller koordinaterna som beskriver segmentets form. Koordinater flyttas från vägen beroende på zoomningsnivån för att stödja visualisering av hög kvalitet i varje skala.
currentSpeed	integer	Den aktuella genomsnittliga hastigheten vid den valda punkten i de begärda enheterna. Detta beräknas utifrån currentTravelTime och längden på det valda segmentet.
currentTravelTime	integer	Aktuell restid i sekunder, i det här trafiksegmentet, baserat på sammansvetsade realtidsmätningar mellan de definierade platserna i den angivna riktningen.
frc	string	Funktionell vägklass. Detta anger vägtypen: 0: Motorväg, motorväg eller annan större väg. 1: Större väg, mindre viktig än en motorväg. 2: Annan större väg. 3: Sekundär väg. 4: Lokal anslutningsväg. 5: Lokal väg av hög betydelse. 6: Lokal väg.
freeFlowSpeed	integer	Den fria flödeshastighet som förväntas under idealiska förhållanden, uttryckt i de enheter som begärs. Detta är relaterat till freeFlowTravelTime.
freeFlowTravelTime	integer	Restiden i sekunder, i det här trafiksegmentet, vilket kan förväntas under idealiska förhållanden för fritt flöde.
openlr	string	OpenLR-kod för segment. Mer information om hur du använder Open LR-koder finns i OpenLR .

LatLongPair

En plats som representeras som latitud och longitud.

Name	Typ	Description
latitude	number	Latitude-egenskap
longitude	number	Longitudegenskap

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation
xml	string	Utökningsbart markeringsspråk

SpeedUnit

Hastighetsenhet i KMPH eller MPH

Name	Typ	Description
KMPH	string	Kilometer per timme
MPH	string	Miles per timme

TrafficFlowSegmentData

Det här objektet returneras från ett lyckat trafikflödessegmentanrop

Name	Typ	Description
flowSegmentData	FlowSegmentData	Flödessegmentdataegenskap

TrafficFlowSegmentStyle

Det format som ska användas för att återge panelen. Giltiga värden är absoluta som returnerar färger som återspeglar den uppmätta absoluta hastigheten, relativt vilken returnerar hastigheten i förhållande till fritt flöde, Relativ fördröjning som endast visar relativa hastigheter där de skiljer sig från friflödeshastigheterna

Name	Typ	Description
absolute	string
relative	string
relative-delay	string

Dela via