RouteGetRouteDirectionsBatch200Response interface

Get Route Directions Batch API は、1 つの要求を使用して Get Route Directions API にクエリのバッチを送信する HTTP GET 要求です。 Get Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

非同期バッチ結果のダウンロード

非同期バッチ結果をダウンロードするには、バッチ ダウンロード エンドポイントに GET 要求を発行します。 この ダウンロード URL は、成功した POST バッチ要求の Location ヘッダーから取得でき、次のようになります。

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

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

1. クライアントは、ダウンロード URLを使用して GET 要求を送信します。

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - バッチ要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

   HTTP 200 OK - バッチ要求が正常に処理されました。 応答本文には、すべてのバッチ結果が含まれています。

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 batchItems の各項目には、statusCode フィールドと response フィールドが含まれています。 batchItems の各 response は、次のいずれかの種類です。

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