RequestRouteDirectionsBatchSync interface

Metódusok

post(RouteRequestRouteDirectionsBatchSyncParameters)

A Post Route Directions Batch Sync API egy HTTP-POST-kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen szinkron kéréssel. Meghívhatja Route Directions Batch API-t aszinkron (aszinkron) vagy szinkron (szinkronizálási) futtatásra. Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 700 lekérdezést kötegeljen, és akár 100 lekérdezést szinkronizáljon az API-val. A Post Route Directions Batch API aszinkron kérésben való meghívásához tekintse meg Post Route Directions Batchcímű témakört.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

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

Kötegelt válasz modell

A visszaadott adattartalom hasonló az aszinkron és szinkronizálási kérelmekhez. Az aszinkron kötegkérelem eredményeinek letöltésekor, ha a köteg feldolgozása befejeződött, a válasz törzse tartalmazza a kötegválaszt. Ez a kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. A batchItems minden eleme statusCode és response mezőket tartalmaz. A response minden batchItems a következő típusok egyikét tartalmazza:

  • RouteDirections – Ha a lekérdezés sikeresen befejeződött.

  • Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:

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

Metódus adatai

post(RouteRequestRouteDirectionsBatchSyncParameters)

A Post Route Directions Batch Sync API egy HTTP-POST-kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen szinkron kéréssel. Meghívhatja Route Directions Batch API-t aszinkron (aszinkron) vagy szinkron (szinkronizálási) futtatásra. Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 700 lekérdezést kötegeljen, és akár 100 lekérdezést szinkronizáljon az API-val. A Post Route Directions Batch API aszinkron kérésben való meghívásához tekintse meg Post Route Directions Batchcímű témakört.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

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

Kötegelt válasz modell

A visszaadott adattartalom hasonló az aszinkron és szinkronizálási kérelmekhez. Az aszinkron kötegkérelem eredményeinek letöltésekor, ha a köteg feldolgozása befejeződött, a válasz törzse tartalmazza a kötegválaszt. Ez a kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. A batchItems minden eleme statusCode és response mezőket tartalmaz. A response minden batchItems a következő típusok egyikét tartalmazza:

  • RouteDirections – Ha a lekérdezés sikeresen befejeződött.

  • Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:

{
    "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."
                }
            }
        }
    ]
}
function post(options: RouteRequestRouteDirectionsBatchSyncParameters): StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>

Paraméterek

Válaszok