共用方式為

@azure-rest/maps-route package

  • 參考

介面

BatchRequest

此類型代表 Batch 服務的要求本文。
BatchRequestItem

Batch 要求物件
BatchResultItemOutput

從 Batch API 傳回的專案。 使用 『response』 屬性擴充。
BatchResultOutput

此物件會從成功的 Batch 服務呼叫傳回。 使用 『batchItems』 屬性擴充。
BatchResultSummaryOutput

批次要求結果的摘要
EffectiveSettingOutput

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

錯誤詳細數據。
ErrorResponseOutput

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
GeoJsonFeature

有效的 GeoJSON Feature 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonFeatureCollection

有效的 GeoJSON FeatureCollection 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

有效的 GeoJSON geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonLineString

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

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

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

GeoJson MultiPoint所包含的數據。
GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiPolygonData
GeoJsonObjectParent

有效的 GeoJSON 物件。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonPoint

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

GeoJson Point所包含的數據。
GeoJsonPolygon

有效的 GeoJSON Polygon 幾何類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

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

用戶端的選擇性參數
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Post body parameters for Route directions.
RouteDirectionsBatchItemOutput

從路由方向 Batch 服務呼叫傳回的專案。
RouteDirectionsBatchItemResponseOutput

查詢的結果。 如果查詢成功完成，則 RouteDirectionss 為 ErrorResponse，否則為 ErrorResponse。
RouteDirectionsBatchResultOutput

此物件會從成功的路由方向 Batch 服務呼叫傳回。
RouteDirectionsOutput

此物件會從成功的路由方向呼叫傳回
RouteGetRouteDirections200Response

Get Route Directions API 是 HTTP GET 要求，會傳回來源與目的地之間的路由，並在指定時通過路徑點。 路線會考慮目前交通和一般道路速度等因素，如一周中要求的一天和一天中的時間。

傳回的資訊包括距離、預估的行進時間，以及路線幾何的表示。 視選取的選項而定，也會提供其他路由資訊，例如優化的導航點順序或回合指示。

路由服務提供一組參數，以取得車輛特定耗用量模型的詳細描述。 如需詳細資訊，請參閱 取用模型。
RouteGetRouteDirectionsBatch200Response

Get Route Directions Batch API 是 HTTP GET 要求，會使用單一要求將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Get Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。

下載異步批次結果

若要下載異步批次結果，您將向批次下載端點發出 GET 要求。 此 下載 URL 可以從成功 Location 批次要求的 POST 標頭取得，如下所示：

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

以下是下載批次結果的一般作業順序：

  1. 用戶端會使用 GET傳送 要求。

  2. 伺服器會以下欄其中一項回應：

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

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Get Route Directions Batch API 是 HTTP GET 要求，會使用單一要求將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Get Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。

下載異步批次結果

若要下載異步批次結果，您將向批次下載端點發出 GET 要求。 此 下載 URL 可以從成功 Location 批次要求的 POST 標頭取得，如下所示：

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

以下是下載批次結果的一般作業順序：

  1. 用戶端會使用 GET傳送 要求。

  2. 伺服器會以下欄其中一項回應：

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

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

Get Route Directions API 是 HTTP GET 要求，會傳回來源與目的地之間的路由，並在指定時通過路徑點。 路線會考慮目前交通和一般道路速度等因素，如一周中要求的一天和一天中的時間。

傳回的資訊包括距離、預估的行進時間，以及路線幾何的表示。 視選取的選項而定，也會提供其他路由資訊，例如優化的導航點順序或回合指示。

路由服務提供一組參數，以取得車輛特定耗用量模型的詳細描述。 如需詳細資訊，請參閱 取用模型。
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Post Route Directions API 是 HTTP POST 要求，會傳回來源與目的地之間的路由，並在指定時通過路點。 路線將考慮目前交通和一般道路速度等因素，在一周的要求當天和一天的時間。

傳回的資訊包括距離、預估的行進時間，以及路線幾何的表示。 視選取的選項而定，也會提供其他路由資訊，例如優化的導航點順序或回合指示。

路由服務提供一組參數，以取得車輛特定耗用量模型的詳細描述。 如需相關概念和參數的詳細說明，請參閱 取用模型。
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Post Route Directions API 是 HTTP POST 要求，會傳回來源與目的地之間的路由，並在指定時通過路點。 路線將考慮目前交通和一般道路速度等因素，在一周的要求當天和一天的時間。

傳回的資訊包括距離、預估的行進時間，以及路線幾何的表示。 視選取的選項而定，也會提供其他路由資訊，例如優化的導航點順序或回合指示。

路由服務提供一組參數，以取得車輛特定耗用量模型的詳細描述。 如需相關概念和參數的詳細說明，請參閱 取用模型。
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Get Route Matrix API 是 HTTP GET 要求，可計算來源和目的地清單中所有可能配對的行進時間和距離。 不同於 取得路線指示 API，其提供詳細的路線指示，此 API 著重於效率，方法是提供從每個來源到每個目的地的路由成本（行程時間和距離）。 如需詳細資訊，請參閱 Azure 地圖服務路線服務的最佳做法。

針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有20名司機，他們需要找到最接近的司機，才能從餐廳接貨。 若要解決此使用案例，他們可以呼叫矩陣路由API。

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

異步要求矩陣的大小上限為 700，而同步處理要求的大小上限為 100 （原點數目乘以目的地數目）。

提交同步路由矩陣要求

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

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

提交異步路由矩陣要求

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

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

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

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

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

  1. 用戶端會將路由矩陣 GET 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 3 取得的下載 URL 上發出 GET 要求，以下載結果

下載同步處理結果

當您對路由矩陣同步 API 提出 GET 要求時，服務會傳回 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Get Route Matrix API 是 HTTP GET 要求，可計算來源和目的地清單中所有可能配對的行進時間和距離。 不同於 取得路線指示 API，其提供詳細的路線指示，此 API 著重於效率，方法是提供從每個來源到每個目的地的路由成本（行程時間和距離）。 如需詳細資訊，請參閱 Azure 地圖服務路線服務的最佳做法。

針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有20名司機，他們需要找到最接近的司機，才能從餐廳接貨。 若要解決此使用案例，他們可以呼叫矩陣路由API。

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

異步要求矩陣的大小上限為 700，而同步處理要求的大小上限為 100 （原點數目乘以目的地數目）。

提交同步路由矩陣要求

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

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

提交異步路由矩陣要求

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

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

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

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

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

  1. 用戶端會將路由矩陣 GET 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 3 取得的下載 URL 上發出 GET 要求，以下載結果

下載同步處理結果

當您對路由矩陣同步 API 提出 GET 要求時，服務會傳回 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteGetRouteRange200Response

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

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

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

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

包含指引相關元素。 只有在要求指導方針且可供使用時，才會顯示此欄位。
RouteInstructionGroupOutput

將彼此相關的指令元素序列分組。 序列範圍受限於 firstInstructionIndex 和 lastInstructionIndex。 當要求人類可讀取的文字訊息以取得指引時（instructionType=text 或標記），則 instructionGroup 會在可用時傳回摘要訊息。
RouteInstructionOutput

一組描述機動的屬性，例如「向右轉」、「保持左轉」、「乘坐渡輪」、「乘坐高速公路」、「到達」。
RouteLegOutput

由點清單所組成的路線部分描述。 要求中提供的每個額外導航點，都會在傳回的路線中再增加一條腿。
RouteMatrixOutput

矩陣結果物件
RouteMatrixQuery

具有座標矩陣的物件。
RouteMatrixResultOutput

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

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

Summary 物件
RouteOptimizedWaypointOutput

優化的方式點物件。
RouteOutput
RouteRangeOutput

可觸達的範圍
RouteRangeResultOutput

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

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

Post Route Directions Batch API 是 HTTP POST 要求，會使用單一異步要求，將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。 若要在同步要求中呼叫 Post Route Directions Batch API，請參閱 後路由指示批次同步處理。

提交異步批次要求

異步 API 適用於處理大量相對複雜的路由要求

  • 它允許在不同的呼叫中擷取結果（可能有多個下載專案）。
  • 異步 API 已針對可靠性進行優化，預計不會遇到逾時。
  • 此 API 的批次項目數目限制為 700。

當您使用異步要求提出要求時，服務預設會在響應標頭的 [位置] 字段中傳回 202 回應碼以及重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 異步回應會儲存 24 小時。 如果到期期間之後使用，重新導向 URL 會傳回 404 回應。

請注意，異步批次要求是長時間執行的作業。 以下是一般作業順序：

  1. 用戶端會將路線指示批次 POST 要求傳送至 Azure 地圖服務。
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. 伺服器會以下欄其中一項回應：

    HTTP 202 Accepted - 已接受 Batch 要求。

    HTTP Error - 處理 Batch 要求時發生錯誤。 這可能是 400 Bad Request 或任何其他 Error 狀態代碼。

  2. 如果成功接受批次要求，回應中的 Location 標頭會包含下載批次要求結果的 URL。 此狀態 URI 如下所示：

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 用戶端會在步驟 3 中取得 GET 發出 要求，以下載批次結果。

批次要求的 POST 本文

若要在查詢 傳送 路由指示，您將使用 要求，其中要求本文會以 格式包含 陣列，且 標頭會設定為 。 以下是包含 3 個 路由指示 查詢的範例要求本文：

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

批次中 查詢 路由指示只是部分 URL ，而不需要 通訊協定、基底 URL、路徑、api-version 和 subscription-key。 它可以接受任何支援的 路由指示，URI 參數。 路由方向中的字串值 查詢必須正確逸出（例如，“字元應該使用 \ 逸出），而且也應該正確編碼 URL。

異步 API 可讓呼叫者將最多 700 個 查詢批處理，並將 API 同步處理至最多 100 100 個 查詢，批次至少應包含 1 個 查詢。

下載異步批次結果

若要下載異步批次結果，您將向批次下載端點發出 GET 要求。 此 下載 URL 可以從成功 Location 批次要求的 POST 標頭取得，如下所示：

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

以下是下載批次結果的一般作業順序：

  1. 用戶端會使用 GET傳送 要求。

  2. 伺服器會以下欄其中一項回應：

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

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

Post Route Directions Batch API 是 HTTP POST 要求，會使用單一異步要求，將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。 若要在同步要求中呼叫 Post Route Directions Batch API，請參閱 後路由指示批次同步處理。

提交異步批次要求

異步 API 適用於處理大量相對複雜的路由要求

  • 它允許在不同的呼叫中擷取結果（可能有多個下載專案）。
  • 異步 API 已針對可靠性進行優化，預計不會遇到逾時。
  • 此 API 的批次項目數目限制為 700。

當您使用異步要求提出要求時，服務預設會在響應標頭的 [位置] 字段中傳回 202 回應碼以及重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 異步回應會儲存 24 小時。 如果到期期間之後使用，重新導向 URL 會傳回 404 回應。

請注意，異步批次要求是長時間執行的作業。 以下是一般作業順序：

  1. 用戶端會將路線指示批次 POST 要求傳送至 Azure 地圖服務。
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. 伺服器會以下欄其中一項回應：

    HTTP 202 Accepted - 已接受 Batch 要求。

    HTTP Error - 處理 Batch 要求時發生錯誤。 這可能是 400 Bad Request 或任何其他 Error 狀態代碼。

  2. 如果成功接受批次要求，回應中的 Location 標頭會包含下載批次要求結果的 URL。 此狀態 URI 如下所示：

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 用戶端會在步驟 3 中取得 GET 發出 要求，以下載批次結果。

批次要求的 POST 本文

若要在查詢 傳送 路由指示，您將使用 要求，其中要求本文會以 格式包含 陣列，且 標頭會設定為 。 以下是包含 3 個 路由指示 查詢的範例要求本文：

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

批次中 查詢 路由指示只是部分 URL ，而不需要 通訊協定、基底 URL、路徑、api-version 和 subscription-key。 它可以接受任何支援的 路由指示，URI 參數。 路由方向中的字串值 查詢必須正確逸出（例如，“字元應該使用 \ 逸出），而且也應該正確編碼 URL。

異步 API 可讓呼叫者將最多 700 個 查詢批處理，並將 API 同步處理至最多 100 100 個 查詢，批次至少應包含 1 個 查詢。

下載異步批次結果

若要下載異步批次結果，您將向批次下載端點發出 GET 要求。 此 下載 URL 可以從成功 Location 批次要求的 POST 標頭取得，如下所示：

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

以下是下載批次結果的一般作業順序：

  1. 用戶端會使用 GET傳送 要求。

  2. 伺服器會以下欄其中一項回應：

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

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Post Route Directions Batch Sync API 是 HTTP POST 要求，會使用單一同步要求，將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。 若要在異步要求中呼叫 Post Route Directions Batch API，請參閱 Post Route Directions Batch。

提交同步批次要求

針對輕量型批次要求，建議使用同步 API。 當服務收到要求時，它會在計算批次專案后立即回應，且稍後將不可能擷取結果。 如果要求超過 60 秒，同步 API 會傳回逾時錯誤 （408 回應）。 批次項目的數目限制為此 API 100。

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Post Route Directions Batch Sync API 是 HTTP POST 要求，會使用單一同步要求，將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。 若要在異步要求中呼叫 Post Route Directions Batch API，請參閱 Post Route Directions Batch。

提交同步批次要求

針對輕量型批次要求，建議使用同步 API。 當服務收到要求時，它會在計算批次專案后立即回應，且稍後將不可能擷取結果。 如果要求超過 60 秒，同步 API 會傳回逾時錯誤 （408 回應）。 批次項目的數目限制為此 API 100。

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Post Route Directions Batch Sync API 是 HTTP POST 要求，會使用單一同步要求，將查詢批次傳送至 取得路由指示 API。 您可以呼叫 Route Directions Batch API，以異步方式執行 （async） 或同步執行 （sync）。 異步 API 可讓呼叫者批處理最多 700 700 個 查詢，並將 API 同步處理至 100 個 查詢 。 若要在異步要求中呼叫 Post Route Directions Batch API，請參閱 Post Route Directions Batch。

提交同步批次要求

針對輕量型批次要求，建議使用同步 API。 當服務收到要求時，它會在計算批次專案后立即回應，且稍後將不可能擷取結果。 如果要求超過 60 秒，同步 API 會傳回逾時錯誤 （408 回應）。 批次項目的數目限制為此 API 100。

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

批次回應模型

傳回的數據內容類似於異步和同步處理要求。 下載異步批次要求的結果時，如果批次已完成處理，響應主體就會包含批次回應。 此批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 batchItems 中的每個專案都包含 statusCode 和 response 欄位。 response 中的每個 batchItems 都是下列其中一種類型：

  • RouteDirections - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中，回應會包含 code 和 message。

以下是 1 個成功 和 1 失敗 結果的批次回應範例：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Post Route Matrix API 是 HTTP POST 要求，允許使用異步 （async） 要求，計算一組由來源和目的地位置定義的路由摘要矩陣。 若要提出同步 （sync） 要求，請參閱 Post Route Matrix Sync。針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有20名司機，他們需要找到最接近的司機，才能從餐廳接貨。 若要解決此使用案例，他們可以呼叫矩陣路由API。

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

異步要求矩陣的大小上限為 700，而同步處理要求的大小上限為 100 （原點數目乘以目的地數目）。

注意事項

所有原點和目的地都應該包含在軸對齊的 400 公里 x 400 公里周框方塊中。 否則，某些矩陣單元格會解析為OUT_OF_REGION。

提交同步路由矩陣要求

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

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

提交異步路由矩陣要求

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

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

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

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

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

  1. 用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Post Route Matrix API 是 HTTP POST 要求，允許使用異步 （async） 要求，計算一組由來源和目的地位置定義的路由摘要矩陣。 若要提出同步 （sync） 要求，請參閱 Post Route Matrix Sync。針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有20名司機，他們需要找到最接近的司機，才能從餐廳接貨。 若要解決此使用案例，他們可以呼叫矩陣路由API。

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

異步要求矩陣的大小上限為 700，而同步處理要求的大小上限為 100 （原點數目乘以目的地數目）。

注意事項

所有原點和目的地都應該包含在軸對齊的 400 公里 x 400 公里周框方塊中。 否則，某些矩陣單元格會解析為OUT_OF_REGION。

提交同步路由矩陣要求

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

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

提交異步路由矩陣要求

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

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

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

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

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

  1. 用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Post Route Matrix Sync API 是 HTTP POST 要求，允許使用單一同步 （sync） 要求，計算一組由來源和目的地位置定義的路由摘要矩陣。 若要提出異步 （async） 要求，請參閱 Post Route Matrix。 針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有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 適用於處理大量相對複雜的路由要求。 當您使用異步要求提出要求時，服務預設會在響應標頭的 [位置] 字段中傳回 202 回應碼以及重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 如果要求中的 waitForResults 參數設定為 true，則如果要求在 120 秒內完成，使用者會收到 200 回應。

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

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

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

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

  1. 用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteRequestRouteMatrixSync408Response

Post Route Matrix Sync API 是 HTTP POST 要求，允許使用單一同步 （sync） 要求，計算一組由來源和目的地位置定義的路由摘要矩陣。 若要提出異步 （async） 要求，請參閱 Post Route Matrix。 針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有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 適用於處理大量相對複雜的路由要求。 當您使用異步要求提出要求時，服務預設會在響應標頭的 [位置] 字段中傳回 202 回應碼以及重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 如果要求中的 waitForResults 參數設定為 true，則如果要求在 120 秒內完成，使用者會收到 200 回應。

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

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

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

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

  1. 用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Post Route Matrix Sync API 是 HTTP POST 要求，允許使用單一同步 （sync） 要求，計算一組由來源和目的地位置定義的路由摘要矩陣。 若要提出異步 （async） 要求，請參閱 Post Route Matrix。 針對每個指定的來源，服務會計算從該來源到每個指定目的地的路由成本。 一組原點和一組目的地可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從源數據行到該單元格目的地的路由成本。 例如，假設一家食品送貨公司有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 適用於處理大量相對複雜的路由要求。 當您使用異步要求提出要求時，服務預設會在響應標頭的 [位置] 字段中傳回 202 回應碼以及重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 如果要求中的 waitForResults 參數設定為 true，則如果要求在 120 秒內完成，使用者會收到 200 回應。

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

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

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

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

  1. 用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務

  2. 伺服器會以下欄其中一項回應：

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

    HTTP Error - 處理路由矩陣要求時發生錯誤。 這可能是 400 不正確的要求或任何其他錯誤狀態代碼。

  3. 如果成功接受矩陣路由要求，回應中的Location標頭會包含下載要求結果的URL。 此狀態 URI 如下所示：

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 用戶端在步驟 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 - 矩陣要求已成功處理。 回應本文包含所有結果。
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

路由區段包含路由部分的其他資訊。 每個區段至少包含 startPointIndex、endPointIndex和 sectionType的專案。
RouteSectionTecCauseOutput

流量事件的原因。 可以包含mainCauseCode和subCauseCode元素。 可以用來定義圖示和描述。
RouteSectionTecOutput

流量事件的詳細數據，使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。
RouteSummaryOutput

Summary 物件
Routes
SimplePollerLike

簡單的輪詢器，可用來輪詢長時間執行的作業。

類型別名

GeoJsonGeometry

有效的 GeoJSON geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonObject

有效的 GeoJSON 物件。 如需詳細資訊，請參閱 RFC 7946。
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

函式

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

建立一堆路由方向要求的批次要求本文。
default(AzureKeyCredential, ClientOptions)

從訂用帳戶金鑰建立 MapsRouteClient 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

從 Azure 身分識別 TokenCredential建立 MapsRoute 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

從 Azure 身分識別 AzureSASCredential建立 MapsRoute 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

建置 Poller 物件的 Helper 函式，以協助輪詢長時間執行的作業。
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

將 [Latitude， Longtitute] 陣列轉換成下列格式的字串：「Latitude_1，Longtitute_1：Latitude_2，Longtitute_2：...」

函式詳細資料

buildMultiCollection(string[], string) 

function buildMultiCollection(items: string[], parameterName: string): string

參數

items

string[]

parameterName

string

傳回

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

建立一堆路由方向要求的批次要求本文。

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

參數

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

路由方向要求的查詢參數物件

傳回

BatchRequest

撰寫的批次要求。

default(AzureKeyCredential, ClientOptions)

從訂用帳戶金鑰建立 MapsRouteClient 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

參數

credential
AzureKeyCredential

用來驗證服務要求的 AzureKeyCredential 實例

options
ClientOptions

用來設定路由客戶端的選項

傳回

MapsRouteClient

default(TokenCredential, string, ClientOptions)

從 Azure 身分識別 TokenCredential建立 MapsRoute 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

參數

credential
TokenCredential

用來驗證服務要求的 TokenCredential 實例

mapsAccountClientId

string

特定地圖資源的 Azure 地圖服務用戶端識別碼

options
ClientOptions

用來設定路由客戶端的選項

傳回

MapsRouteClient

default(AzureSASCredential, ClientOptions)

從 Azure 身分識別 AzureSASCredential建立 MapsRoute 的實例。

範例

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

參數

credential
AzureSASCredential

用來驗證服務要求的 AzureSASCredential 實例

options
ClientOptions

用來設定路由客戶端的選項

傳回

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

建置 Poller 物件的 Helper 函式，以協助輪詢長時間執行的作業。

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

參數

client
Client

用來傳送要求以取得其他頁面的用戶端。

initialResponse

TResult

初始回應。

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

設定繼續狀態或自定義輪詢間隔的選項。

傳回

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • 輪詢作業狀態更新的輪詢器對象，最終會取得最終回應。

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

參數

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

傳回

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

參數

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

傳回

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

參數

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

傳回

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

參數

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

傳回

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

參數

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

傳回

response

toColonDelimitedLatLonString(LatLon[])

將 [Latitude， Longtitute] 陣列轉換成下列格式的字串：「Latitude_1，Longtitute_1：Latitude_2，Longtitute_2：...」

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

參數

coordinates

LatLon[]

要轉換的 Latitude/Longtitute 配對陣列。

傳回

string

已轉換的字串。