Route - Get Route Range

參考

服務:: Maps

API 版本:: 1.0

使用來建立地圖，根據時間、距離或燃料容量，描述在特定閾值內從指定點存取的區域。

備註

Azure 地圖服務路線 v1 服務淘汰

Azure 地圖服務路線 v1 服務現已淘汰，將於 3/31/28 淘汰。為了避免服務中斷，路由 v1 服務的所有呼叫都必須更新為使用路由 v2025-01-01 服務， 3/31/28。如需詳細資訊，請參閱移轉 Azure 地圖服務路線 1.0 API。

Get Route Range （Isochrone） API 是 HTTP GET 要求，會根據指定的燃料、能源、時間或距離預算，計算一組可從源點到達的位置。多邊形界限（或 Isochrone）會以逆時針方向傳回，以及原點結果的精確多邊形中心。

傳回的多邊形可用於進一步處理，例如在幾何內部搜尋，以搜尋所提供時程內的 PO。

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}

含選擇性參數:

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	回應所需的格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	number[]	範圍計算應從中開始的座標。
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	指定當車輛加速時，將儲存在燃料中的化學能量轉換為動能的效率（即 KineticEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。必須與減速效率配對。允許的值範圍是 0.0 到 1/減速效率。合理的值：適用於燃燒模型：0.33，適用於電動模型： 0.66
auxiliaryPowerInkW	query		number (double)	指定以千瓦為單位維持輔助系統所使用的電力量。它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。合理的值：1.7
auxiliaryPowerInLitersPerHour	query		number (double)	指定以每小時升為單位，用於維持車輛輔助系統的燃料量。它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。明智的值：0.2
avoid	query		RouteAvoidType[]	指定路由計算在判斷路由時應嘗試避免的事項。可以在一個要求中指定多次，例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。在 [路由範圍] 要求中，不得使用已經使用的值UsedRoads。
constantSpeedConsumptionInkWhPerHundredkm	query		string	指定耗用量的速度相依元件。以未排序的速度/耗用量率組清單的形式提供。此清單會定義耗用量曲線上的點。找到不在清單中之速度的耗用量率，如下所示：如果指定的速度位於清單中的兩個速度之間，則為線性插補依線性外推，否則假設由清單中最接近兩個點所決定的常數（1Consumption/OcSpeed）清單必須包含介於 1 到 25 點之間（含），且不能包含相同速度的重複點。如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。這可確保外推不會導致負耗用量率。同樣地，針對清單中兩個最小速度指定的耗用量值，無法導致任何較小速度的負耗用量率。耗用量值的有效範圍（以 kWh/100 公里表示）介於 0.01 到 100000.0 之間。合理的值：50,8.2：130,21.3 電耗模型需要此參數，。
constantSpeedConsumptionInLitersPerHundredkm	query		string	指定耗用量的速度相依元件。提供為非排序的冒號分隔速度清單，& 耗用量率組。此清單會定義耗用量曲線上的點。找到不在清單中之速度的耗用量率，如下所示：如果指定的速度位於清單中的兩個速度之間，則為線性插補依線性外推，否則假設由清單中最接近兩個點所決定的常數（1Consumption/OcSpeed）清單必須包含介於 1 到 25 點之間（含），且不能包含相同速度的重複點。如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。這可確保外推不會導致負耗用量率。同樣地，針對清單中兩個最小速度指定的耗用量值，無法導致任何較小速度的負耗用量率。耗用量值的有效範圍（以 l/100 公里表示）介於 0.01 到 100000.0 之間。合理的值：50,6.3：130,11.5 附注：燃燒耗用量模型需要此參數。
currentChargeInkWh	query		number (double)	指定目前千瓦時（kWh）的電力供應。此參數與 maxChargeInkWh 參數並存。允許的值範圍是 0.0 到 maxChargeInkWh。明智的值：43
currentFuelInLiters	query		number (double)	指定目前以升為單位的燃料供應。明智的值：55
decelerationEfficiency	query		number (double) minimum: 0 maximum: 1	指定當車輛減速（即 ChemicalEnergySaved/KineticEnergyLost）時，將動能轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。必須與 accelerationEfficiency配對。允許的值範圍是 0.0 到 1/accelerationEfficiency。合理值：適用於燃燒模型：0.83，適用於電動模型： 0.91
departAt	query		string (date-time)	從原始點出發的日期和時間，格式為 `dateTime` 值，如 RFC 3339 第 5.6 節所定義，並具有選擇性時區位移。未指定時區位移時，會假設其為源點的位移。預設值：現在其他值：`dateTime` 範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 `departAt` 參數不能與 `arriveAt`搭配使用。
distanceBudgetInMeters	query		number (double)	以公尺為單位的距離預算，決定可使用駕駛距離來行駛的最大範圍。取用模型只會在 routeType 為 eco 時影響範圍。必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	指定當車輛失去海拔（即 ChemicalEnergySaved/PotentialEnergyLost）時，將潛在能源轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。必須與 uphillEfficiency配對。允許的值範圍是 0.0 到 1/uphillEfficiency。合理的值：適用於燃燒模型：0.51，適用於電動模型：0.73
energyBudgetInkWh	query		number (double)	千瓦時（kWh）的電力能源預算，決定可使用指定的用電量模型來行駛的最大範圍。使用 energyBudgetInkWh 時，必須指定詳細的用電量模型。必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
fuelBudgetInLiters	query		number (double)	以升為單位的燃料預算，決定可使用指定的燃燒耗用量模型來行駛的最大範圍。使用 fuelBudgetInLiters 時，必須指定詳細的燃燒耗用量模型。必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
fuelEnergyDensityInMJoulesPerLiter	query		number (double)	指定以兆焦耳（MJ）儲存在一升燃料中的化學能量量。它與效率參數搭配使用，用於節省或耗用的能源和燃料之間的轉換。例如，汽油的能源密度為 34.2 MJ/l，柴油為 35.8 MJ/l。如果已設定任何 Efficiency 參數，則需要此參數。明智的值：34.2
hilliness	query		InclineLevel	驚心動魄路線的丘陵程度。此參數只能與 `routeType`=thrilling 搭配使用。
maxChargeInkWh	query		number (double)	指定可能儲存在車輛電池中的千瓦時（kWh）最大電力供應量。此參數與 currentChargeInkWh 參數並存。最小值必須大於或等於 currentChargeInkWh。明智的值：85
routeType	query		RouteType	要求的路由類型。
timeBudgetInSec	query		number (double)	以秒為單位的時間預算，決定可使用駕駛時間行駛的最大範圍。取用模型只會在 routeType 為 eco 時影響範圍。必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
traffic	query		boolean	可能的值： true - 在路由期間考慮所有可用的流量資訊 false - 在路由期間忽略目前的流量數據。請注意，雖然在路由期間忽略目前的交通數據，但歷史交通對有效道路速度的影響仍會納入其中。
travelMode	query		TravelMode	所要求路線的移動模式。如果未定義，預設值為『car』。請注意，要求的 travelMode 可能無法用於整個路線。當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。請注意，旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。所有區域都無法使用完整限制數據。
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	指定當車輛提高高度時，將儲存在燃料中的化學能量轉換為潛在能源的效率（即 PotentialEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。必須與 downhillEfficiency配對。允許的值範圍是 0.0 到 1/downhillEfficiency。合理的值：適用於燃燒模型：0.27，適用於電動模型： 0.74
vehicleAxleWeight	query		integer	每軸車輛重量以公斤為單位。值為 0 表示不會考慮每個軸的重量限制。
vehicleCommercial	query		boolean	車輛是否用於商業用途。可能不允許商用車輛在一些道路上行駛。
vehicleEngineType	query		VehicleEngineType	車輛的引擎類型。指定詳細的取用模型時，它必須與 vehicleEngineType的值一致。
vehicleHeight	query		number (double)	車輛的高度以公尺為單位。值為 0 表示不會考慮高度限制。
vehicleLength	query		number (double)	車輛的長度以公尺為單位。值為 0 表示不會考慮長度限制。
vehicleLoadType	query		VehicleLoadType	可能分類為危險物質的貨物類型，並受限於某些道路。可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。此參數目前只考慮 travelMode=truck。
vehicleMaxSpeed	query		integer	車輛的最大速度，以公里/小時為單位。車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。值為 0 表示將在路線規劃期間決定並套用車輛的適當值。在路線規劃期間，可能會覆寫非零的值。例如，目前的流量為 60 公里/小時。如果車輛最大速度設定為每小時 50 公里，路由引擎會考慮 60 公里/小時，因為這是目前的情況。如果車輛的最大速度提供為80公里/小時，但目前的交通流量為60公里/小時，則路由引擎將再次使用60公里/小時。
vehicleWeight	query		integer	車輛重量以公斤為單位。如果已設定任何效率參數，則這是強制性的。在取用模型的內容中使用時，它必須嚴格為正數。考慮權數限制。如果未指定詳細的耗用量模型，且車輛重量* 的值為非零，則會考慮重量限制。在其他所有情況下，會忽略此參數。合理的值：適用於燃燒模型：1600，適用於電動模型：1900
vehicleWidth	query		number (double)	車輛寬度以公尺為單位。值為 0 表示不會考慮寬度限制。
windingness	query		WindingnessLevel	驚心動魄路線的轉彎水準。此參數只能與 `routeType`=thrilling 搭配使用。

要求標頭

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

回應

名稱	類型	Description
200 OK	RouteRangeResult	還行
Other Status Codes	ErrorResponse	發生未預期的錯誤。

安全性

AADToken

這些是 Entra OAuth 2.0 流程 Microsoft。與 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 身分識別平臺概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

subscription-key

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

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

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

類型: apiKey
位於: query

SAS Token

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

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

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

類型: apiKey
位於: header

範例

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

範例要求

HTTP

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

範例回覆

狀態碼:: 200

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

定義

名稱	Description
EffectiveSetting	呼叫此路由 API 時所使用的有效參數或數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
InclineLevel	驚心動魄路線的丘陵程度。此參數只能與 `routeType`=thrilling 搭配使用。
LatLongPair	以緯度和經度表示的位置。
ResponseFormat	回應所需的格式。值可以是 json 或 xml。
RouteAvoidType	指定路由計算在判斷路由時應嘗試避免的事項。可以在一個要求中指定多次，例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。在 [路由範圍] 要求中，不得使用已經使用的值UsedRoads。
RouteRange	可觸達的範圍
RouteRangeResult	此物件是從成功的 Route Reachable Range 呼叫傳回
RouteReport	報告目前呼叫中使用的有效設定。
RouteType	要求的路由類型。
TravelMode	所要求路線的移動模式。如果未定義，預設值為『car』。請注意，要求的 travelMode 可能無法用於整個路線。當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。請注意，旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。所有區域都無法使用完整限制數據。
VehicleEngineType	車輛的引擎類型。指定詳細的取用模型時，它必須與 vehicleEngineType的值一致。
VehicleLoadType	可能分類為危險物質的貨物類型，並受限於某些道路。可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。此參數目前只考慮 travelMode=truck。
WindingnessLevel	驚心動魄路線的轉彎水準。此參數只能與 `routeType`=thrilling 搭配使用。

EffectiveSetting

Object

呼叫此路由 API 時所使用的有效參數或數據。

名稱	類型	Description
key	string	所使用的參數名稱。
value	string	所使用的參數值。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

InclineLevel

列舉型別

驚心動魄路線的丘陵程度。此參數只能與 routeType=thrilling 搭配使用。

值	Description
high	高
low	低
normal	一般

LatLongPair

Object

以緯度和經度表示的位置。

名稱	類型	Description
latitude	number (double)	Latitude 屬性
longitude	number (double)	經度屬性

ResponseFormat

列舉型別

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

值	Description
json	JavaScript 物件表示法數據交換格式
xml	可延伸標記語言

RouteAvoidType

列舉型別

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

值	Description
alreadyUsedRoads	避免多次使用相同的道路。與 `routeType`=thrilling 搭配使用時，最有用。
borderCrossings	避免路由計算中的邊界交叉。
carpools	避免需要使用拼車（HOV/高佔用車輛）車道的路線。
ferries	避免渡輪
motorways	避免高速公路
tollRoads	避免收費道路。
unpavedRoads	避免未修補的道路

RouteRange

Object

可觸達的範圍

名稱	類型	Description
boundary	LatLongPair[]	可觸達範圍的多邊形界限，以點清單表示。
center	LatLongPair	可觸達範圍的中心點

RouteRangeResult

Object

此物件是從成功的 Route Reachable Range 呼叫傳回

名稱	類型	Description
formatVersion	string	Format Version 屬性
reachableRange	RouteRange	可觸達的範圍
report	RouteReport	報告目前呼叫中使用的有效設定。

RouteReport

Object

報告目前呼叫中使用的有效設定。

名稱	類型	Description
effectiveSettings	EffectiveSetting[]	呼叫此路由 API 時所使用的有效參數或數據。

RouteType

列舉型別

要求的路由類型。

值	Description
eco	經濟和速度平衡的路線。
fastest	最快的路線。
shortest	依距離的最短路線。
thrilling	包含有趣或具有挑戰性的道路，並盡可能少地使用高速公路。您可以選擇包含的回合層級，以及丘陵程度。如需如何設定此設定，請參閱丘陵和線圈參數。規劃的路線限制為900公里，`routeType`=驚心動魄

TravelMode

列舉型別

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

值	Description
bus	傳回的路線已針對公交車進行優化，包括只使用公交車車道。 BETA 功能。
car	傳回的路線已針對汽車進行優化。
motorcycle	傳回的路線已針對摩托車進行優化。 BETA 功能。
taxi	傳回的路線已針對計程車進行優化。 BETA 功能。
truck	傳回的路線已針對商用車輛進行優化，例如卡車。
van	傳回的路線已針對麵包車進行優化。 BETA 功能。

VehicleEngineType

列舉型別

車輛的引擎類型。指定詳細的取用模型時，它必須與 vehicleEngineType的值一致。

值	Description
combustion	內燃機。
electric	電動引擎。

VehicleLoadType

列舉型別

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

值	Description
USHazmatClass1	炸藥
USHazmatClass2	壓縮氣體
USHazmatClass3	易燃液體
USHazmatClass4	易燃固體
USHazmatClass5	Oxidizers
USHazmatClass6	毒藥
USHazmatClass7	放射性
USHazmatClass8	腐蝕
USHazmatClass9	其他
otherHazmatExplosive	炸藥
otherHazmatGeneral	其他
otherHazmatHarmfulToWater	對水有害

WindingnessLevel

列舉型別

驚心動魄路線的轉彎水準。此參數只能與 routeType=thrilling 搭配使用。

值	Description
high	高
low	低
normal	一般

共用方式為

Route - Get Route Range

URI 參數

要求標頭

回應

安全性

AADToken

備註

範圍

subscription-key

SAS Token

範例

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

範例要求

範例回覆

定義

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InclineLevel

LatLongPair

ResponseFormat

RouteAvoidType

RouteRange

RouteRangeResult

RouteReport

RouteType

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

其他資源