Traffic - Get Traffic Incident Viewport

參考

Service:: Maps

API Version:: 1.0

使用取得檢視區的法律和技術資訊。

Traffic Incident Viewport API 是 HTTP GET 要求，會傳回要求中所述檢視區的法律和技術資訊。用戶端應用程式應該會在檢視區變更 (時呼叫，例如透過縮放、移動流覽、移至位置或顯示路線) 。要求應該包含需要其資訊的檢視區周框方塊和縮放層級。傳回會包含地圖版本資訊，以及目前的流量模型標識碼和著作權標識碼。檢視區描述所傳回的流量模型標識符會由其他 API 用來擷取最後的流量資訊，以便進一步處理。

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	所需的回應格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
boundingbox	query	True	number[]	EPSG900913投影中地圖檢視檢視區的周框方塊。 `boundingbox`會以兩個值組表示，描述其角 (左下角的第一對，第二個值組則為右上方) 。直接呼叫此端點時，所有值都應該以逗號分隔 (例如 minY、minX、maxY、maxX) 。可以傳遞的周框方塊大小上限取決於要求的縮放層級。在指定的縮放層級上呈現時，寬度和高度不能超過 4092 圖元。注意：跨越 180° 經線的周框方塊需要特殊處理。對於這類方塊，東部 maxX 值將會是負數，因此小於 180° 經線的 minX 值西部。若要解決此問題，在傳入要求之前，值 40075016.6855874 應該新增至 true maxX 值。
boundingzoom	query	True	integer int32	地圖檢視檢視區的縮放層級。用來判斷是否可以放大檢視。
overviewbox	query	True	number[]	EPSG900913投影中概觀地圖的周框方塊。用於概觀方塊/迷你地圖與主地圖不同的著作權數據時使用。如果沒有迷你地圖，則會使用與相同的座標 `boundingBox` 。直接呼叫此端點時，座標會以包含四個座標的單一字串傳入，並以逗號分隔。
overviewzoom	query	True	integer int32	概觀地圖的縮放層級。如果沒有迷你地圖，請使用與 boundingZoom 相同的縮放層級。
copyright	query		boolean	決定要傳回的著作權資訊。如果為 true，則會傳回著作權文字;若為 false，則只會傳回著作權索引。

要求標頭

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

回應

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

安全性

AADToken

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

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

備註

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

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。 * Azure 角色型訪問控制是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 從 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 traffic incident information for the selected viewport

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

Sample Response

Status code:: 200

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ResponseFormat	所需的回應格式。值可以是 json 或 xml。
TrafficIncidentViewport	此物件會從成功的流量事件檢視區呼叫傳回
TrafficState	流量狀態資訊
ViewpResp	Viewport Response 物件

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

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

ResponseFormat

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

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

TrafficIncidentViewport

此物件會從成功的流量事件檢視區呼叫傳回

名稱	類型	Description
viewpResp	ViewpResp	Viewport Response 物件

TrafficState

流量狀態資訊

名稱	類型	Description
@trafficAge	integer	從流量模型標識碼建立) ，經過的時間 (以秒為單位。
@trafficModelId	string	呼叫流量事件服務時，會使用稱為「流量模型標識符」的唯一標識符。它允許從特定流量更新取得資訊。流量模型標識碼會每分鐘更新一次，而且會在逾時前 2 分鐘有效。

ViewpResp

Viewport Response 物件

名稱	類型	Description
@maps	string	指出檢視區中使用的地圖數據的數據提供者內部名稱。用於支持查詢。
@version	string	指出用來產生資訊的軟體版本。用於支持查詢。
copyrightIds	string	當 copyright 參數值為 true 時，這會包含必須以檢視區中磚顯示的著作權資訊全文檢索
trafficState	TrafficState	流量狀態資訊