RouteRequestRouteDirectionsBatchSync200Response interface

路由方向批处理 API

适用于：请参阅定价 层。

路由方向批处理 API 仅使用单个 API 调用将一批查询发送到 路由方向 API。 可以调用路由方向 Batch API 以异步（异步）或同步运行（同步）。 异步 API 允许调用方对多达 700 个 查询进行批处理，并将 API 同步到 100 个 查询。

提交同步批处理请求

建议对轻型批处理请求使用同步 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 字段。 batchItems 中的每个 response 都是以下类型之一：

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

• Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。

下面是一个示例 Batch 响应，其中 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."
                }
            }
        }
    ]
}