Route - Post Route Matrix

參考

Service:: Maps

API Version:: 1.0

使用取得路線矩陣，以異步要求顯示來源和目的地清單中所有可能配對的行進時間和距離。

Post Route Matrix API 是 HTTP POST 要求，允許使用異步 (異步) 要求，計算來源和目的地位置所定義之一組路由的路由摘要矩陣。若要進行同步 (同步處理) 要求，請參閱 Post Route Matrix Sync。針對每個指定的來源，服務會計算從該來源路由到每個指定目的地的成本。原點集合和目的地集合可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從來源路由到該儲存格目的地的成本。例如，假設一家食物遞送公司有 20 個驅動程式，他們需要尋找最接近的驅動程式，才能從餐廳挑選遞送。若要解決此使用案例，他們可以呼叫矩陣路由API。

針對每個路線，會傳回行進時間和距離。您可以使用計算成本來判斷要使用路線方向 API 計算哪些詳細路線。

異步要求的矩陣大小上限為 700 ，而同步處理要求的大小上限為 100 (來源數目乘以目的地數目) 。

提交同步路由矩陣要求

如果您的案例需要同步要求，且矩陣的大小上限小於或等於 100，您可能想要提出同步要求。此 API 矩陣的大小上限為 100 (來源數目乘以目的地數目) 。考慮到該條件約束，可能的矩陣維度範例包括：10x10、6x8、9x8 (不需要是平方) 。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

提交異步路由矩陣要求

異步 API 適用於處理大量相對複雜的路由要求。當您使用異步要求提出要求時，服務預設會沿著響應標頭的 [位置] 欄位中的重新導向 URL 傳回 202 回應碼。您應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。如果 waitForResults 要求中的參數設定為 true，則如果要求在 120 秒內完成，則使用者會收到 200 回應。

此 API 矩陣的大小上限為 700 (原點數目乘以目的地數目) 。考慮到該條件約束，可能的矩陣維度範例包括：50x10、10x10、28x25。 10x70 (不需要正方形) 。

異步回應會儲存 14 天。如果到期期間之後使用，重新導向 URL 會傳回 404 回應。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

以下是一般異步操作序列：

用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務
伺服器會以下欄其中一項回應：

HTTP 202 Accepted - 已接受路由矩陣要求。

HTTP Error - 處理路由矩陣要求時發生錯誤。這可能是 400 不正確的要求或任何其他錯誤狀態代碼。
如果成功接受矩陣路由要求，回應中的Location標頭會包含要下載要求結果的URL。此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

用戶端會在步驟 3 取得的下載 URL 上發出 GET 要求，以下載結果

下載同步處理結果

當您提出路由矩陣同步 API 的 POST 要求時，服務會傳回 200 個回應碼，以取得成功的要求和響應數位。回應本文將包含數據，而且稍後將無法擷取結果。

下載異步結果

當要求發出 202 Accepted 回應時，會使用我們的異步管線來處理要求。系統會提供 URL，以檢查回應位置標頭中異步要求的進度。此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

位置標頭提供的 URL 會在發出要求時 GET 傳回下列回應。

HTTP 202 Accepted - 已接受矩陣要求，但仍正在處理。請稍後再試一次。

HTTP 200 OK - 已成功處理矩陣要求。回應本文包含所有結果。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0

With optional parameters:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	JsonFormat	所需的回應格式。僅支援 `json` 格式。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
arriveAt	query		string date-time	抵達目的地點的日期和時間，格式為 `dateTime`RFC 3339 第 5339 節中定義的值，並具有選擇性時區位移。未指定時區位移時，會假設為目的地點的位移。範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 參數 `arriveAt` 不能與 `departAt`或 `minDeviationDistanceminDeviationTime`搭配使用。
avoid	query		RouteAvoidType[]	指定路由計算在判斷路由時應該嘗試避免的事項。可以在一個要求中多次指定，例如『&avoid=ins&avoid=tollRoads&avoid=tollRoads』。在 [路由範圍] 要求中，不得使用已經使用值UsedRoads。
computeTravelTimeFor	query		ComputeTravelTime	指定是否使用不同類型的交通資訊來傳回額外的交通時間， (無、歷史、即時) ，以及預設的最佳預估旅遊時間。
departAt	query		string date-time	從原點開始的日期和時間，格式為 `dateTime`RFC 3339 第 5339 節中定義的值，並具有選擇性時區位移。未指定時區位移時，會假設為原點的位移。默認值：現在其他值： `dateTime` 範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 參數 `departAt` 不能與 `arriveAt`一起使用。
hilliness	query		InclineLevel	令人興奮路線的峰度。此參數只能與 `routeType`=refreshing 搭配使用。
routeType	query		RouteType	要求的路由類型。
sectionType	query		SectionType	指定路由回應中報告哪些區段類型。例如，如果 sectionType = 讓區段只傳回適合使用中樞的區段。可以使用多個類型。默認 sectionType 是指 travelMode 輸入。根據預設，travelMode 會設定為汽車
traffic	query		boolean	可能的值： true - 在路由期間考慮所有可用的流量資訊 false - 在路由期間忽略目前的流量數據。請注意，雖然在路由期間會忽略目前的交通數據，但有效道路速度上的歷史交通影響仍會併入。
travelMode	query		TravelMode	所要求路由的移動模式。如果未定義，預設值為『car』。請注意，要求的 travelMode 可能無法用於整個路線。當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。請注意，旅遊模式總線、車車、計程車和貨車都是 BETA 功能。所有區域都無法使用完整限制數據。
vehicleAxleWeight	query		integer	每一車輛的重量，以磅為單位。值為 0 表示不會考慮每個擷取的加權限制。
vehicleHeight	query		number double	以公尺為單位的車輛高度。值為 0 表示不會考慮高度限制。
vehicleLength	query		number double	以公尺為單位的車輛長度。值為 0 表示不會考慮長度限制。
vehicleLoadType	query		VehicleLoadType	可能分類為危險材料且受限於某些道路的貨物類型。可用的 vehicleLoadType 值是美國 Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。從 USHazmat 開始的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。此參數目前只考慮用於 travelMode=truck。
vehicleMaxSpeed	query		integer	以 km/小時為單位的車輛最大速度。車輛配置檔中的最大速度是用來檢查車輛是否允許在汽車上。值為 0 表示將在路線規劃期間決定並套用車輛的適當值。在路由規劃期間，可能會覆寫非零值。例如，目前的流量為 60 公里/小時。如果車輛最大速度設定為50公里/小時，則路由引擎會考慮60公里/小時，因為這是目前的情況。如果車輛的最大速度是以 80 公里 /小時提供，但目前的交通流量為 60 公里/小時，則路由引擎會再次使用 60 公里/小時。
vehicleWeight	query		integer	車輛重量，以壓克為單位。
vehicleWidth	query		number double	以公尺為單位的車輛寬度。值為 0 表示不會考慮寬度限制。
waitForResults	query		boolean	布爾值，指出是否要同步執行要求。如果設定為 true，則如果要求在 120 秒內完成，則使用者會收到 200 回應。否則，使用者會立即收到 202 回應。如需 202 回應的詳細資訊，請參閱 API 描述。僅支援異步要求。
windingness	query		WindingnessLevel	令人興奮路線的回合層級。此參數只能與 `routeType`=refreshing 搭配使用。

要求標頭

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

要求本文

名稱	類型	Description
destinations	GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
origins	GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

回應

名稱	類型	Description
200 OK	RouteMatrixResult	已成功處理矩陣要求。回應本文包含所有結果。
202 Accepted		僅支援異步要求。已接受要求：要求已接受進行處理。請使用位置標頭中的 URL 來重試或存取結果。 Headers Location: string
Other Status Codes	ErrorResponse	發生意外錯誤。

名稱

類型

Description

200 OK

RouteMatrixResult

已成功處理矩陣要求。回應本文包含所有結果。

202 Accepted

僅支援異步要求。 已接受要求：要求已接受進行處理。請使用位置標頭中的 URL 來重試或存取結果。

Headers

Location: string

Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 Azure 地圖服務 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

範例

Successfully submit a route matrix request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

Status code:: 202

operation-Location: New URL to check the status of the long-running operation.

定義

名稱	Description
ComputeTravelTime	指定是否使用不同類型的交通資訊傳回額外的行進時間， (無、歷史、即時) ，以及預設的最佳估計行進時間。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
InclineLevel	令人驚豔的路線程度。此參數只能與 =ining 搭配 `routeType`使用。
JsonFormat	所需的回應格式。僅支援 `json` 格式。
RouteAvoidType	指定在判斷路由時，路由計算應該嘗試避免的事項。可以在一個要求中多次指定，例如『&avoid=&avoid=tollRoads&avoid=feries』。在路由範圍要求中，不得使用已經使用值UsedRoads。
RouteLegSummary	route 區段的 Summary 物件。
RouteMatrix	矩陣結果物件
RouteMatrixQuery	具有座標矩陣的物件。
RouteMatrixResult	此物件是從成功的路由矩陣呼叫傳回。例如，如果提供2個來源和3個目的地，則每個都有3個元素的陣列。每個元素的內容取決於查詢中提供的選項。
RouteMatrixResultResponse	輸入矩陣中目前儲存格的回應物件。
RouteMatrixSummary	Summary 物件
RouteType	要求的路由類型。
SectionType	指定路由回應中報告哪些區段類型。例如，如果 sectionType = 允許只傳回適合耙耙的區段。可以使用多個類型。默認 sectionType 是指 travelMode 輸入。根據預設，travelMode 會設定為 car
TravelMode	所要求路線的行進模式。如果未定義，預設值為『car』。請注意，要求的 travelMode 可能無法用於整個路線。如果要求之 travelMode 不適用於特定區段，該區段之回應的 travelMode 元素將會是 “other”。請注意，旅遊模式總線、車車、計程車和貨車都是 BETA 功能。所有區域都無法使用完整限制數據。
VehicleLoadType	可能分類為危險材料且受限於某些道路的貨物類型。可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的一般分類。從 USHazmat 開始的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。此參數目前只考慮 travelMode=truck。
WindingnessLevel	令人興奮路線的回合層級。此參數只能與 =ining 搭配 `routeType`使用。

ComputeTravelTime

指定是否使用不同類型的交通資訊傳回額外的行進時間， (無、歷史、即時) ，以及預設的最佳估計行進時間。

名稱	類型	Description
all	string	計算所有類型的流量資訊的行進時間，並指定路由響應摘要中包含的欄位 noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds 和 liveTrafficIncidentsTravelTimeInSeconds 字段中的所有結果。
none	string	不會計算額外的移動時間。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

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

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	幾何的 `GeoJson MultiPoint` 座標。
type	string: MultiPoint	指定 `GeoJSON` 類型。必須是九個有效 GeoJSON 物件類型的其中一種： Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

InclineLevel

令人驚豔的路線程度。此參數只能與 =ining 搭配 routeType使用。

名稱	類型	Description
high	string	high
low	string	low
normal	string	正常

JsonFormat

所需的回應格式。僅支援 json 格式。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式

RouteAvoidType

指定在判斷路由時，路由計算應該嘗試避免的事項。可以在一個要求中多次指定，例如『&avoid=&avoid=tollRoads&avoid=feries』。在路由範圍要求中，不得使用已經使用值UsedRoads。

名稱	類型	Description
alreadyUsedRoads	string	避免多次使用相同的道路。最適合與 =refreshing 搭配 `routeType`使用。
borderCrossings	string	避免在路線計算中跨越框線。
carpools	string	避免需要使用汽車緩衝 (HOV/高佔用車輛) 通道的路線。
ferries	string	避免水器
motorways	string	避免擷取
tollRoads	string	避免收費道路。
unpavedRoads	string	避免未修補道路

RouteLegSummary

route 區段的 Summary 物件。

名稱	類型	Description
arrivalTime	string	路線或回合的預估抵達時間。時間以UTC為單位。
batteryConsumptionInkWh	number	使用電力耗用量模型 (kWh) 的估計電力耗用量。如果 vehicleEngineType 設定為電力，且已指定 constantSpeedConsumptionInkWhPerHundredkm，則包含此專案。 batteryConsumptionInkWh 的值包含可回收的電力，因此可以是負 (，這表示取得能源) 。如果同時指定 maxChargeInkWh 和 currentChargeInkWh，則會限制回收，以確保電池電量永遠不會超過 maxChargeInkWh。如果未指定 maxChargeInkWh 或 currentChargeInkWh，則會在耗用量計算中假設未受限制的回收。
departureTime	string	路線或回合的預估出發時間。時間以UTC為單位。
fuelConsumptionInLiters	number	使用[油耗模型] 的估計燃料耗用量。如果 vehicleEngineType 設定為，且已指定 constantSpeedConsumptionInLitersPerHundredkm，則包含此專案。此值將是非負值。
historicTrafficTravelTimeInSeconds	integer	使用時間相依歷史交通數據計算的估計行進時間。只有在 computeTravelTimeFor = 全部用於查詢時，才會包含。
lengthInMeters	integer	Length In Meters 屬性
liveTrafficIncidentsTravelTimeInSeconds	integer	使用即時速度數據計算的估計行進時間。只有在 computeTravelTimeFor = 全部用於查詢時，才會包含。
noTrafficTravelTimeInSeconds	integer	由於交通狀況 (例如擷塞) ，預估的行進時間會計算為路線沒有延遲。只有在 computeTravelTimeFor = 全部用於查詢時，才會包含。
trafficDelayInSeconds	integer	根據交通資訊，即時事件 () 所造成的預估延遲秒數。對於未來規劃的出發時間的路線，延遲一律為 0。若要使用不同類型的交通資訊傳回其他行進時間，必須新增parameter computeTravelTimeFor=all。
travelTimeInSeconds	integer	估計的行進時間，以秒為單位屬性，其中包含因為即時流量而造成的延遲。請注意，即使 traffic=false travelTimeInSeconds 仍包含因為流量而造成的延遲。如果 FutureAt 是未來，則會使用時間相依的歷史流量數據來計算行進時間。

RouteMatrix

矩陣結果物件

名稱	類型	Description
response	RouteMatrixResultResponse	輸入矩陣中目前儲存格的回應物件。
statusCode	integer	輸入矩陣中目前儲存格的 StatusCode 屬性。

RouteMatrixQuery

具有座標矩陣的物件。

名稱	類型	Description
destinations	GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
origins	GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

RouteMatrixResult

此物件是從成功的路由矩陣呼叫傳回。例如，如果提供2個來源和3個目的地，則每個都有3個元素的陣列。每個元素的內容取決於查詢中提供的選項。

名稱	類型	Description
formatVersion	string	Format Version 屬性
matrix	RouteMatrix[]	結果為路由摘要的 2 維陣列。
summary	RouteMatrixSummary	Summary 物件

RouteMatrixResultResponse

輸入矩陣中目前儲存格的回應物件。

名稱	類型	Description
routeSummary	RouteLegSummary	route 區段的 Summary 物件。

RouteMatrixSummary

Summary 物件

名稱	類型	Description
successfulRoutes	integer	回應中成功的路由數目。
totalRoutes	integer	要求的路由總數。輸入矩陣中的儲存格數目。

RouteType

要求的路由類型。

名稱	類型	Description
eco	string	以經濟和速度平衡的路線。
fastest	string	最快速的路線。
shortest	string	依距離的最短路線。
thrilling	string	包含有趣或具挑戰性的道路，並盡可能使用最少的道路。您可以選擇包含的回合層級，也可以選擇拒絕程度。如需如何設定此動作，請參閱坡度和線圈參數。規劃的 `routeType`路線有900公里的限制，其值為 =要

SectionType

指定路由回應中報告哪些區段類型。

例如，如果 sectionType = 允許只傳回適合耙耙的區段。可以使用多個類型。默認 sectionType 是指 travelMode 輸入。根據預設，travelMode 會設定為 car

名稱	類型	Description
carTrain	string	汽車或訓練路線的區段。
carpool	string	需要使用汽車緩衝 (HOV/高佔用車輛) 行的路線區段。
country	string	區段，指出路由所在的國家/地區。
ferry	string	路線的區段是鐵道。
motorway	string	路線的區段。
pedestrian	string	路線的區段，僅適用於鐺鐺。
tollRoad	string	需要付費的路線區段。
tollVignette	string	需要有付費 vignette 的路線區段。
traffic	string	包含流量資訊的路由區段。
travelMode	string	與要求參數 `travelMode`相關的區段。
tunnel	string	屬於通道之路由的區段。
urban	string	位於城市區域內路線的區段。

TravelMode

所要求路線的行進模式。如果未定義，預設值為『car』。請注意，要求的 travelMode 可能無法用於整個路線。如果要求之 travelMode 不適用於特定區段，該區段之回應的 travelMode 元素將會是 “other”。請注意，旅遊模式總線、車車、計程車和貨車都是 BETA 功能。所有區域都無法使用完整限制數據。

名稱	類型	Description
bicycle	string	傳回的路線已針對自行車優化，包括使用自行車道。
bus	string	傳回的路線已針對公交車優化，包括僅使用公交車道。 BETA 功能。
car	string	傳回的路線已針對汽車進行優化。
motorcycle	string	傳回的路線已針對自行車優化。 BETA 功能。
pedestrian	string	傳回的路由已針對街道優化，包括使用側道。
taxi	string	傳回的路線已針對計程車優化。 BETA 功能。
truck	string	傳回的路線已針對商業車輛進行優化，例如卡車。
van	string	傳回的路由已針對 Vans 優化。 BETA 功能。

VehicleLoadType

可能分類為危險材料且受限於某些道路的貨物類型。可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的一般分類。從 USHazmat 開始的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。此參數目前只考慮 travelMode=truck。

名稱	類型	Description
USHazmatClass1	string	爆炸物
USHazmatClass2	string	壓縮的能源
USHazmatClass3	string	一個水
USHazmatClass4	string	一元實心
USHazmatClass5	string	Oxidizers
USHazmatClass6	string	毒藥
USHazmatClass7	string	放射性
USHazmatClass8	string	新月
USHazmatClass9	string	其他
otherHazmatExplosive	string	爆炸物
otherHazmatGeneral	string	其他
otherHazmatHarmfulToWater	string	有害於水

WindingnessLevel

令人興奮路線的回合層級。此參數只能與 =ining 搭配 routeType使用。

名稱	類型	Description
high	string	high
low	string	low
normal	string	正常

Route - Post Route Matrix

提交同步路由矩陣要求

提交異步路由矩陣要求

下載同步處理結果

下載異步結果

URI 參數

要求標頭

要求本文

回應

安全性

AADToken

備註

Scopes

subscription-key

SAS Token

範例

Successfully submit a route matrix request

Sample Request

Sample Response

定義

ComputeTravelTime

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonMultiPoint

InclineLevel

JsonFormat

RouteAvoidType

RouteLegSummary

RouteMatrix

RouteMatrixQuery

RouteMatrixResult

RouteMatrixResultResponse

RouteMatrixSummary

RouteType

SectionType

TravelMode

VehicleLoadType

WindingnessLevel

其他資源