Traffic - Get Traffic Flow Segment

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

Slouží k získání informací o rychlostech a dobách jízdy zadané části silnice.

Rozhraní API Traffic Flow Segment je požadavek HTTP GET, který poskytuje informace o rychlosti a době jízdy fragmentu cesty nejblíže danému souřadnici. Je navržená tak, aby fungovala společně s vrstvou Flow Render Service, která podporuje vizualizace dat toku, na které lze kliknout. S rozhraním API Traffic Flow Segment může strana klienta připojit jakékoli místo na 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}

S volitelnými parametry:

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 obsahující dva páry souřadnic (lat, long, lat, long) a počítané pomocí EPSG4326 projekce. Když je tento koncový bod volán přímo, souřadnice se předávají 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 relativní vzhledem k volným tokům, relativní zpoždění, které zobrazuje relativní rychlosti pouze v případě, že se liší od rychlosti volného toku.
zoom	query	True	integer (int32)	Úroveň přiblížení požadované dlaždice Hodnota lupy musí být v rozsahu: 0–22 (včetně). Podrobnosti najdete v tématu úrovně přiblížení a mřížky dlaždic.
openLr	query		boolean	Logická hodnota, zda má odpověď obsahovat kód OpenLR
thickness	query		integer (int32) minimum: 1 maximum: 20	Hodnota šířky čáry představující provoz. Tato hodnota je násobitel a přijímané 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 pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích s pokyny.

Odpovědi

Name	Typ	Description
200 OK	TrafficFlowSegmentData	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více úč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 složené 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 koncepty ověřování . Stručně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a rozsahy.

Poznámky

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

Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID. * Řízení přístupu na základě role 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í.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

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.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč 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 Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure 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 Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze 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ů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Request traffic flow segment information

Ukázkový požadavek

HTTP

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ěď

Stavový kód:: 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"
  }
}

Definice

Name	Description
Coordinates	Zahrnuje souřadnice popisující tvar segmentu. Souřadnice se posunou od cesty v závislosti na úrovni přiblížení, aby podporovaly vizualizaci vysoké kvality v každém měřítku.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FlowSegmentData	Vlastnost Flow Segment Data
LatLongPair	Umístění reprezentované jako zeměpisná šířka a zeměpisná 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 relativní vzhledem k volným tokům, relativní zpoždění, které zobrazuje relativní rychlosti pouze v případě, že se liší od rychlosti volného toku.

Coordinates

Objekt

Zahrnuje souřadnice popisující tvar segmentu. Souřadnice se posunou od cesty v závislosti na úrovni přiblížení, aby podporovaly vizualizaci vysoké kvality v každém měřítku.

Name	Typ	Description
coordinate	LatLongPair[]	Souřadnicové pole

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FlowSegmentData

Objekt

Vlastnost Flow Segment Data

Name	Typ	Description
@version	string	To označuje verzi softwaru, která vygenerovala odpověď.
confidence	number	Spolehlivost je míra kvality poskytnuté doby jízdy a rychlosti. Hodnota 1 znamená plnou jistotu, že odpověď obsahuje data nejvyšší kvality. Nižší hodnoty označují stupeň, kdy 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žená 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 se posunou od cesty v závislosti na úrovni přiblížení, aby podporovaly vizualizaci vysoké kvality v každém měřítku.
currentSpeed	integer (int32)	Aktuální průměrná rychlost ve vybraném bodě v požadovaných jednotkách. Vypočítá se z currentTravelTime a délky vybraného segmentu.
currentTravelTime	integer (int32)	Aktuální doba cesty v sekundách napříč tímto segmentem provozu na základě tavených měření v reálném čase mezi definovanými umístěními v zadaném směru.
frc	string	Třída funkční cesty. To označuje typ silnice: 0: Dálnice, volná cesta nebo jiná hlavní silnice. 1: Hlavní silnice, méně důležitá než dálnice. 2: Další hlavní silnice. 3: Sekundární silnice. 4: Místní spojovací cesta. 5: Místní cesta s vysokou důležitostí. 6: Místní cesta.
freeFlowSpeed	integer (int32)	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 (int32)	Doba trvání cesty 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 OpenLR.

LatLongPair

Objekt

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

Name	Typ	Description
latitude	number (double)	Vlastnost Zeměpisná šířka
longitude	number (double)	Zeměpisná délka – vlastnost

ResponseFormat

Výčet

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

Hodnota	Description
json	formát výměny dat javascriptového objektu
xml	rozšiřitelného jazyka značek

SpeedUnit

Výčet

Jednotka rychlosti v KMPH nebo MPH

Hodnota	Description
KMPH	Kilometry za hodinu
MPH	Míle za hodinu

TrafficFlowSegmentData

Objekt

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

Name	Typ	Description
flowSegmentData	FlowSegmentData	Vlastnost Flow Segment Data

TrafficFlowSegmentStyle

Výčet

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 relativní vzhledem k volným tokům, relativní zpoždění, které zobrazuje relativní rychlosti pouze v případě, že se liší od rychlosti volného toku.

Hodnota	Description
absolute
relative
relative-delay

Sdílet prostřednictvím

Traffic - Get Traffic Flow Segment

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

subscription-key

SAS Token

Příklady

Request traffic flow segment information

Ukázkový požadavek

Ukázková odpověď

Definice

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle