Traffic - Get Traffic Flow Segment

Referens

Service:: 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ödesskiktet i renderningstjä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 dem för användaren.

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

With optional 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-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 över fyra koordinater som innehåller två koordinatpar (lat, long, lat, long) och 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 absoluta uppmätta hastigheten, relativ som 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	Zoomningsnivå för önskad panel. Zoomvärdet måste ligga i intervallet: 0–22 (inklusive). Mer information finns i Zoomnivåer och Panelrutnät .
openLr	query		boolean	Booleskt värde om svaret ska innehålla OpenLR-kod
thickness	query		integer int32	Värdet för bredden på linjen 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äkerhetsmodell. Det 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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto 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 för att Azure Maps REST-API:er.

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 ha å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 som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.

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

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

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

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps konto i Azure Portal eller med hjälp av 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 huvudnyckel i det konto som de har utfärdats i.

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

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Request traffic flow segment information

Sample Request

HTTP

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

Sample Response

Status code:: 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 högkvalitativ visualisering i varje skala.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FlowSegmentData	Dataegenskap för flödessegment
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 absoluta uppmätta hastigheten, relativ som 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 högkvalitativ visualisering i varje skala.

Name	Typ	Description
coordinate	LatLongPair[]	Koordinatmatris

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

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

Dataegenskap för flödessegment

Name	Typ	Description
@version	string	Detta anger vilken programvaruversion som genererade svaret.
confidence	number	Konfidensen är ett mått på kvaliteten på den angivna restiden och hastigheten. Värdet 1 innebär full 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 högkvalitativ visualisering i varje skala.
currentSpeed	integer	Den aktuella genomsnittliga hastigheten vid den valda punkten, i de enheter som begärs. 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, som skulle 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 Öppna 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	Dataegenskap för flödessegment

TrafficFlowSegmentStyle

Det format som ska användas för att återge panelen. Giltiga värden är absoluta som returnerar färger som återspeglar den absoluta uppmätta hastigheten, relativ som 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