Traffic - Get Traffic Incident Detail

參考

Service:: Maps

API Version:: 1.0

使用來取得指定周框方塊內流量事件的相關信息。

Traffic Incident Detail API 是 HTTP GET 要求，根據目前的流量模型標識符，提供指定周框方塊內流量事件的相關信息。流量模型標識碼可用來授與呼叫與 API 之間的數據同步處理。流量模型標識碼是決定流量事件貨幣的索引鍵值。它會每分鐘更新一次，且在逾時前有效 2 分鐘。它用於轉譯事件磚。它可以從檢視區 API 取得。

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}&language={language}&projection={projection}&geometries={geometries}&expandCluster={expandCluster}&originalPosition={originalPosition}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	所需的回應格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
boundingbox	query	True	number[]	`boundingbox`由兩個值組表示，描述其角落 (左下角的第一組，第二個值組代表右上方) 。您可以使用下列任何 `projection`指定的 (來指定配對，例如 minY、minX、maxX) 或兩個緯度經度組 (，例如 minLat、minLon、maxLat、maxLon) 。注意：如果使用緯度/經度組，則必須將 `projection` 參數設定為 “EPSG4326”。
boundingZoom	query	True	integer int32	所需磚的縮放層級。點陣圖格的 0 到 22，向量磚則為 0 到 22
style	query	True	IncidentDetailStyle	將用來在流量事件磚 API 中呈現磚的樣式。這會影響回復中流量事件的座標。
trafficmodelid	query	True	string	參考流量模型的數目。這可以從 Viewport API 取得。它會每分鐘更新一次，且在逾時前有效 2 分鐘。如果指定了錯誤的流量模型標識碼，介面會傳回正確的標識符。 -1 的值一律會叫用最新的流量模型
expandCluster	query		boolean	布爾值，指出是否要個別列出叢集中的所有流量事件
geometries	query		IncidentGeometryType	新增至事件中的向量幾何類型， (回應) 的元素中傳回。
language	query		string	輸出語言的 ISO 639-1 程式代碼。支持的語言包括 ar、ca、cs、da、de、el、en、en-GB、en-US、es、et、fi、fr、he、hu、id、in*、it、lt、lv、nb、nl、no、pl、pt、ro、ru、sk、sv、th、tr、zh。如需詳細資訊，請參閱支援的語言。當提供無效的語言代碼時，會以英文傳回回應。當事件原因或描述沒有翻譯時，會傳回英文描述。
originalPosition	query		boolean	布爾值，指出是否要傳回事件的原始位置 () ，以及移至交通管 () 的開頭
projection	query		ProjectionStandard	用來在要求和回應中指定座標的投影。 EPSG900913 (預設) 或 EPSG4326

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。它代表 Azure 地圖服務帳戶的唯一標識符，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	TrafficIncidentDetail	確定
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 #D0680077044CB441395AFE0F5FA2B73DB REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是在 Azure 入口網站或使用PowerShell、CLI、Azure SDK 或 REST API Create Azure 地圖服務帳戶時所佈建的共用金鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

Type: apiKey
In: query

SAS Token

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的列出 SAS 作業建立的共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

Type: apiKey
In: header

範例

Request information about a traffic incident

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/incident/detail/json?api-version=1.0&style=s3&boundingbox=6841263.950712,511972.674418,6886056.049288,582676.925582&boundingZoom=11&trafficmodelid=1335294634919

Sample Response

Status code:: 200

{
  "tm": {
    "@id": "1521671948910",
    "poi": [
      {
        "id": "europe_HD_NL_TTR116377227776064",
        "p": {
          "x": 538636.9,
          "y": 6842004.5
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Amstelveen/Vinkeveen - N201 (N196)",
        "t": "Uithoorn-Centrum (N196)",
        "l": 220,
        "dl": 14,
        "r": "N196"
      },
      {
        "id": "europe_CLUSTER_11_-34959639",
        "p": {
          "x": 528668.6,
          "y": 6848897.9
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 528622.5,
          "y": 6848661.2
        },
        "ctr": {
          "x": 528714.7,
          "y": 6849134.6
        },
        "cs": 2,
        "l": 190
      },
      {
        "id": "europe_CLUSTER_11_-1540737434",
        "p": {
          "x": 518277,
          "y": 6852206.8
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 517421.3,
          "y": 6851776.4
        },
        "ctr": {
          "x": 519132.8,
          "y": 6852637.2
        },
        "cs": 2,
        "l": 1620
      },
      {
        "id": "europe_CLUSTER_11_-26712906",
        "p": {
          "x": 529902.2,
          "y": 6855622.4
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 529524.6,
          "y": 6855377.2
        },
        "ctr": {
          "x": 530279.9,
          "y": 6855867.7
        },
        "cs": 4,
        "l": 660
      },
      {
        "id": "europe_HD_NL_TTR116367997504816",
        "p": {
          "x": 568216,
          "y": 6851287.6
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Ankeveen (N236)",
        "t": "Weesp (N236)",
        "l": 2760,
        "dl": 73,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116367997261488",
        "p": {
          "x": 561973.7,
          "y": 6854259.4
        },
        "ic": 9,
        "ty": 3,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Weesp (N236)",
        "t": "Ankeveen (N236)",
        "l": 2650,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116331064819392",
        "p": {
          "x": 571268.5,
          "y": 6858435.4
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "IJsselmeerweg",
        "t": "A6",
        "l": 370
      },
      {
        "id": "europe_CLUSTER_11_-1442937814",
        "p": {
          "x": 563934,
          "y": 6859271.3
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 563726.1,
          "y": 6859250.4
        },
        "ctr": {
          "x": 564141.9,
          "y": 6859292.2
        },
        "cs": 2,
        "l": 460
      },
      {
        "id": "europe_CLUSTER_11_258400781",
        "p": {
          "x": 558055.6,
          "y": 6861147.1
        },
        "ic": 13,
        "ty": 1,
        "cbl": {
          "x": 557493.3,
          "y": 6860514.8
        },
        "ctr": {
          "x": 558618,
          "y": 6861779.4
        },
        "cs": 3,
        "l": 1030
      },
      {
        "id": "europe_HD_NL_TTR116100227865681",
        "p": {
          "x": 542665,
          "y": 6861959.7
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Strawinskylaan",
        "t": "Matthijs Vermeulenpad",
        "l": 110
      },
      {
        "id": "europe_CLUSTER_11_1438243625",
        "p": {
          "x": 545058.7,
          "y": 6864571.6
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543779.5,
          "y": 6864070.7
        },
        "ctr": {
          "x": 546337.8,
          "y": 6865072.6
        },
        "cs": 5,
        "l": 1590
      },
      {
        "id": "europe_HD_NL_TTR116081762316976",
        "p": {
          "x": 547507.8,
          "y": 6866259.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Alexanderplein (s113)",
        "t": "Stadhouderskade",
        "l": 390,
        "r": "S100"
      },
      {
        "id": "europe_CLUSTER_11_691732516",
        "p": {
          "x": 541448.7,
          "y": 6867162.1
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 541160.1,
          "y": 6866710.7
        },
        "ctr": {
          "x": 541737.2,
          "y": 6867613.5
        },
        "cs": 4,
        "l": 430
      },
      {
        "id": "europe_CLUSTER_11_1582351486",
        "p": {
          "x": 534709.6,
          "y": 6865174.7
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 534562.2,
          "y": 6865025.3
        },
        "ctr": {
          "x": 534856.9,
          "y": 6865324.2
        },
        "cs": 2,
        "l": 380
      },
      {
        "id": "europe_CLUSTER_11_-2070222267",
        "p": {
          "x": 536813.1,
          "y": 6868188.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 536191.1,
          "y": 6867699.7
        },
        "ctr": {
          "x": 537435.1,
          "y": 6868677
        },
        "cs": 7,
        "l": 1380
      },
      {
        "id": "europe_CLUSTER_11_-496866890",
        "p": {
          "x": 516025.5,
          "y": 6871606.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 514115.1,
          "y": 6870216.9
        },
        "ctr": {
          "x": 517935.9,
          "y": 6872995.7
        },
        "cs": 7,
        "l": 1510
      },
      {
        "id": "europe_HD_NL_TTR115675492352160",
        "p": {
          "x": 517835.3,
          "y": 6883216.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Amsterdamseweg",
        "t": "A22",
        "l": 710
      },
      {
        "id": "europe_CLUSTER_11_834920993",
        "p": {
          "x": 543803.8,
          "y": 6875659.8
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543474.7,
          "y": 6875602.7
        },
        "ctr": {
          "x": 544133,
          "y": 6875716.9
        },
        "cs": 2,
        "l": 760
      }
    ]
  }
}

定義

名稱	Description
DelayMagnitude	與事件相關聯的延遲程度。這些值會對應至交通圖格中的事件色彩
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IconCategory	與此事件相關聯的圖示類別目錄。值是範圍 0-13 中的數位，其意義如下：- 0：未知、1：意外、2：交通、3：危險狀況、4：雨、5：Ice、6：Jam、7： Lane Closed、8：Road Closed、9： Road Works、10： Wind、11： Flooding、12： Detour、13： Cluster
IncidentDetailStyle	將用來呈現流量事件磚 API 中磚的樣式。這會影響回復中交通事件的座標。
IncidentGeometryType	新增至事件 (回應) 項目中傳回的向量幾何類型。
Point	在笛卡兒平面中，座標 (為 x、y) 之點的泛型表示法。
ProjectionStandard	用來在要求和回應中指定座標的投影。 EPSG900913 (預設) 或 EPSG4326
ResponseFormat	所需的回應格式。值可以是 json 或 xml。
Tm	主要回應專案
TrafficIncidentDetail	此物件會從成功的流量事件詳細數據呼叫傳回
TrafficIncidentPointOfInterest

DelayMagnitude

與事件相關聯的延遲程度。這些值會對應至交通圖格中的事件色彩

名稱	類型	Description
0	Integer	Unknown
1	Integer	Minor
2	Integer	中
3	Integer	主要
4	Integer	用於道路關閉和其他無限期延遲的無限期 ()

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

IconCategory

與此事件相關聯的圖示類別目錄。值是範圍 0-13 中的數位，其意義如下：- 0：未知、1：意外、2：交通、3：危險狀況、4：雨、5：Ice、6：Jam、7： Lane Closed、8：Road Closed、9： Road Works、10： Wind、11： Flooding、12： Detour、13： Cluster

名稱	類型	Description
0	Integer	Unknown
1	Integer	Accident
10	Integer	Wind
11	Integer	洪水
12	Integer	彎路
13	Integer	叢集：如果叢集包含具有不同圖示類別的事件，則會傳回。
14	Integer	細分車輛
2	Integer	起霧
3	Integer	危險狀況
4	Integer	下雨
5	Integer	Ice
6	Integer	果醬
7	Integer	Lane Closed
8	Integer	道路封閉
9	Integer	道路工時

IncidentDetailStyle

將用來呈現流量事件磚 API 中磚的樣式。這會影響回復中交通事件的座標。

名稱	類型	Description
night	string	夜間樣式。
s1	string	建立具有彩色形箭號的交通線路，指出嚴重性。
s2	string	建立具有特定光暈程度的純線。
s3	string	使用與 s2 樣式不同的特定光暈來建立純線。

IncidentGeometryType

新增至事件 (回應) 項目中傳回的向量幾何類型。

名稱	類型	Description
original	string	Places道路上的事件。
shifted	string	根據縮放層級) ，將事件稍微 (移動，以指出特定的道路路道。

Point

在笛卡兒平面中，座標 (為 x、y) 之點的泛型表示法。

名稱	類型	Description
x	number	x 座標
y	number	y 座標

ProjectionStandard

用來在要求和回應中指定座標的投影。 EPSG900913 (預設) 或 EPSG4326

名稱	類型	Description
EPSG4326	string	EPSG4326
EPSG900913	string	EPSG900913

ResponseFormat

所需的回應格式。值可以是 json 或 xml。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式
xml	string	可延伸標記語言

Tm

主要回應專案

名稱	類型	Description
@id	string	此事件的流量模型標識碼
poi	TrafficIncidentPointOfInterest[]	單一交通事件或流量事件的叢集

TrafficIncidentDetail

此物件會從成功的流量事件詳細數據呼叫傳回

名稱	類型	Description
tm	Tm	主要回應專案

TrafficIncidentPointOfInterest

名稱	類型	Description
c	string	事件的原因，如果有，請以所要求的語言顯示
cbl	Point	要求投影中叢集的左下座標
cs	integer	叢集大小：叢集中的事件數目
ctr	Point	要求投影中叢集的右上方座標
d	string	以所要求的語言描述事件
dl	integer	除了道路關閉) 以外， (秒內由事件所造成的延遲 (
ed	string	事件的估計結束日期，如果有的話。日期會以ISO8601格式描述。
f	string	寄件者：因事件而啟動流量的交集或位置名稱
ic	IconCategory	與此事件相關聯的圖示類別目錄。值是範圍 0-13 中的數位，其意義如下：- 0：未知、1：意外、2：交通、3：危險狀況、4：雨、5：Ice、6：Jam、7： Lane Closed、8：Road Closed、9： Road Works、10： Wind、11： Flooding、12： Detour、13： Cluster
id	string	交通事件的標識碼
l	integer	以公尺為單位的事件長度
p	Point	應該繪製叢集或原始事件的圖示，以要求投影表示的點。這受到交通樣式、縮放層級和道路類型的影響
r	string	道路號碼 (受事件影響) 。多個道路號碼會以斜線分隔
sd	string	事件的開始日期，如果有的話。日期會以ISO8601格式描述。
t	string	To：因事件結束而造成流量的交集或位置名稱
ty	DelayMagnitude	與事件相關聯的延遲程度。這些值會對應至交通圖格中的事件色彩