Traffic - Get Traffic Flow Segment

Slouží k získání informací o rychlostech a časech jízdy v zadaném úseku silnice.

Rozhraní Traffic Flow Segment API je požadavek HTTP GET , který poskytuje informace o rychlostech a časech jízdy fragmentu cesty, který je nejblíže k danému souřadnici. Je navržená tak, aby spolupracovala s vrstvou Flow služby Render Service a podporovala vizualizace dat toku s možností kliknutí. Traffic Flow Segment Pomocí rozhraní API může klientská strana připojit libovolné místo v mapě s daty toku na nejbližší cestě a prezentovat je uživateli.

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}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
path True

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.

api-version
query True

string

Číslo verze rozhraní API služby Azure Maps

query
query True

number[]

Souřadnice bodu blízko segmentu cesty. Tento parametr je seznam čtyř souřadnic, které obsahují dvě dvojice souřadnic (lat, long, lat, long) a počítané pomocí EPSG4326 projekce. Při přímém zavolání tohoto koncového bodu jsou souřadnice předány jako jeden řetězec obsahující čtyři souřadnice oddělené čárkami.

style
query True

TrafficFlowSegmentStyle

Styl, který se má použít k vykreslení dlaždice. Platné hodnoty jsou absolutní, které vrací barvy odrážející absolutní naměřenou rychlost, relativní, která vrací rychlost vzhledem k volnému toku, relativní zpoždění, které zobrazuje relativní rychlosti pouze tam, kde se liší od rychlosti volného toku.

zoom
query True

integer

int32

Úroveň přiblížení požadované dlaždice Hodnota přiblížení musí být v rozsahu 0–22 (včetně). Podrobnosti najdete v tématu Úrovně přiblížení a Mřížka dlaždic .

openLr
query

boolean

Logická hodnota určující, jestli má odpověď obsahovat kód OpenLR

thickness
query

integer

int32

Hodnota šířky čáry představující provoz. Tato hodnota je násobitelem a akceptované hodnoty jsou v rozsahu od 1 do 20. Výchozí hodnota je 10.

unit
query

SpeedUnit

Jednotka rychlosti v KMPH nebo MPH

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps najdete v následujících článcích .

Odpovědi

Name Typ Description
200 OK

TrafficFlowSegmentData

OK

Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map .

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme použít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Request traffic flow segment information

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
Coordinates

Zahrnuje souřadnice popisující tvar segmentu. Souřadnice jsou posunuty od cesty v závislosti na úrovni přiblížení, aby bylo možné v každém měřítku podporovat vysoce kvalitní vizualizaci.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Odpověď na chybu

FlowSegmentData

Vlastnost Data segmentu toku

LatLongPair

Umístění reprezentované jako zeměpisná šířka a délka.

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.

SpeedUnit

Jednotka rychlosti v KMPH nebo MPH

TrafficFlowSegmentData

Tento objekt se vrátí z úspěšného volání segmentu toku provozu.

TrafficFlowSegmentStyle

Styl, který se má použít k vykreslení dlaždice. Platné hodnoty jsou absolutní, které vrací barvy odrážející absolutní naměřenou rychlost, relativní, která vrací rychlost vzhledem k volnému toku, relativní zpoždění, které zobrazuje relativní rychlosti pouze tam, kde se liší od rychlosti volného toku.

Coordinates

Zahrnuje souřadnice popisující tvar segmentu. Souřadnice jsou posunuty od cesty v závislosti na úrovni přiblížení, aby bylo možné v každém měřítku podporovat vysoce kvalitní vizualizaci.

Name Typ Description
coordinate

LatLongPair[]

Souřadnicové pole

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

FlowSegmentData

Vlastnost Data segmentu toku

Name Typ Description
@version

string

To označuje verzi softwaru, která vygenerovala odpověď.

confidence

number

Spolehlivost je měřítkem kvality poskytnuté doby jízdy a rychlosti. Hodnota 1 znamená plnou jistotu, že odpověď obsahuje data nejvyšší kvality. Nižší hodnoty označují míru, do které se odpověď může lišit od skutečných podmínek na silnici. Jakákoli hodnota větší než 0,6 znamená, že informace byly založeny na vstupu sondy v reálném čase. Hodnota 0,5 znamená, že hlášená rychlost je založena na historických informacích. Hodnota mezi 0,5 a 0,6 má vypočítaný vážený průměr mezi historickými a živými rychlostmi.

coordinates

Coordinates

Zahrnuje souřadnice popisující tvar segmentu. Souřadnice jsou posunuty od cesty v závislosti na úrovni přiblížení, aby bylo možné v každém měřítku podporovat vysoce kvalitní vizualizaci.

currentSpeed

integer

Aktuální průměrná rychlost ve vybraném bodě v požadovaných jednotkách. Vypočítá se z hodnoty currentTravelTime a délky vybraného segmentu.

currentTravelTime

integer

Aktuální doba jízdy v sekundách napříč tímto segmentem provozu na základě sloučených měření v reálném čase mezi definovanými místy v zadaném směru.

frc

string

Funkční silniční třída. To označuje typ silnice: 0: Dálnice, dálnice nebo jiná hlavní silnice. 1: Hlavní silnice, méně důležitá než dálnice. 2: Další hlavní silnice. 3: Vedlejší silnice. 4: Místní spojovací cesta. 5: Místní silnice s vysokým významem. 6: Místní silnice.

freeFlowSpeed

integer

Rychlost volného toku očekávaná za ideálních podmínek vyjádřená v požadovaných jednotkách. To souvisí s freeFlowTravelTime.

freeFlowTravelTime

integer

Doba jízdy v sekundách napříč tímto segmentem provozu, která by se očekávala za ideálních podmínek volného toku.

openlr

string

Kód OpenLR pro segment. Další informace o použití kódů Open LR najdete v tématu OpenLR .

LatLongPair

Umístění reprezentované jako zeměpisná šířka a délka.

Name Typ Description
latitude

number

Vlastnost Zeměpisná šířka

longitude

number

Zeměpisná délka – vlastnost

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.

Name Typ Description
json

string

Formát výměny dat v zápisu objektů JavaScriptu

xml

string

Rozšiřitelný jazyk značek

SpeedUnit

Jednotka rychlosti v KMPH nebo MPH

Name Typ Description
KMPH

string

Počet kilometrů za hodinu

MPH

string

Míle za hodinu

TrafficFlowSegmentData

Tento objekt se vrátí z úspěšného volání segmentu toku provozu.

Name Typ Description
flowSegmentData

FlowSegmentData

Vlastnost Data segmentu toku

TrafficFlowSegmentStyle

Styl, který se má použít k vykreslení dlaždice. Platné hodnoty jsou absolutní, které vrací barvy odrážející absolutní naměřenou rychlost, relativní, která vrací rychlost vzhledem k volnému toku, relativní zpoždění, které zobrazuje relativní rychlosti pouze tam, kde se liší od rychlosti volného toku.

Name Typ Description
absolute

string

relative

string

relative-delay

string