次の方法で共有

RouteRequestRouteDirectionsBatchSyncDefaultResponse interface

  • リファレンス
パッケージ:
@azure-rest/maps-route

Post Route Directions Batch Sync API は、1 つの同期要求を使用して Get Route Directions API にクエリのバッチを送信する HTTP POST 要求です。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。 非同期要求で API を呼び出すには、「ルートのルート案内のバッチを参照してください。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、元のバッチ要求の一部であった 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."
                }
            }
        }
    ]
}
Extends
HttpResponse

プロパティ

body
status

継承されたプロパティ

headers

HTTP 応答ヘッダー。
request

この応答を生成した要求。

プロパティの詳細

body 

body: ErrorResponseOutput

プロパティ値

ErrorResponseOutput

status 

status: string

プロパティ値

string

継承されたプロパティの詳細

headers

HTTP 応答ヘッダー。

headers: RawHttpHeaders

プロパティ値

RawHttpHeaders

httpResponse.headers から継承

request

この応答を生成した要求。

request: PipelineRequest

プロパティ値

PipelineRequest

httpResponse.request から継承