RouteRequestRouteDirectionsBatchSync200Response interface

參考

套件:: @azure-rest/maps-route

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."
                }
            }
        }
    ]
}

Extends: HttpResponse

屬性

body
status

繼承的屬性

headers	HTTP 回應標頭。
request	產生此回應的要求。

屬性詳細資料

body

body: RouteDirectionsBatchResultOutput

屬性值

RouteDirectionsBatchResultOutput

status

status: "200"

屬性值

"200"

繼承的屬性詳細資料

headers

HTTP 回應標頭。

headers: RawHttpHeaders

屬性值

RawHttpHeaders

繼承自 HttpResponse.headers

request

產生此回應的要求。

request: PipelineRequest

屬性值

PipelineRequest

繼承自 HttpResponse.request

共用方式為