Megosztás a következőn keresztül:


@azure-rest/maps-route package

Interfészek

BatchRequest

Ez a típus a Batch szolgáltatás kéréstörzsét jelöli.

BatchRequestItem

Batch-kérelem objektuma

BatchResultItemOutput

A Batch API-ból visszaadott elem. Kiterjeszthető a "response" tulajdonsággal.

BatchResultOutput

Ezt az objektumot egy sikeres Batch-szolgáltatáshívás adja vissza. Kiterjesztheti a "batchItems" tulajdonsággal.

BatchResultSummaryOutput

A kötegelt kérelem eredményeinek összegzése

EffectiveSettingOutput

A Route API meghívásakor használt érvényes paraméter vagy adatok.

ErrorDetailOutput

A hiba részletei.

ErrorResponseOutput

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

GeoJsonFeature

Érvényes GeoJSON Feature objektumtípus. Részletekért tekintse meg RFC 7946.

GeoJsonFeatureCollection

Érvényes GeoJSON FeatureCollection objektumtípus. Részletekért tekintse meg RFC 7946.

GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Érvényes GeoJSON GeometryCollection objektumtípus. Részletekért tekintse meg RFC 7946.

GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.

GeoJsonLineString

Érvényes GeoJSON LineString geometriatípus. Részletekért tekintse meg RFC 7946.

GeoJsonLineStringData
GeoJsonMultiLineString

Érvényes GeoJSON MultiLineString geometriatípus. Részletekért tekintse meg RFC 7946.

GeoJsonMultiLineStringData
GeoJsonMultiPoint

Érvényes GeoJSON MultiPoint geometriatípus. Részletekért tekintse meg RFC 7946.

GeoJsonMultiPointData

Egy GeoJson MultiPointáltal tárolt adatok.

GeoJsonMultiPolygon

Érvényes GeoJSON MultiPolygon objektumtípus. Részletekért tekintse meg RFC 7946.

GeoJsonMultiPolygonData
GeoJsonObjectParent

Érvényes GeoJSON objektum. Részletekért tekintse meg RFC 7946.

GeoJsonPoint

Érvényes GeoJSON Point geometriatípus. Részletekért tekintse meg RFC 7946.

GeoJsonPointData

Egy GeoJson Pointáltal tárolt adatok.

GeoJsonPolygon

Érvényes GeoJSON Polygon geometriatípus. Részletekért tekintse meg RFC 7946.

GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Földrajzi szélességként és hosszúságként ábrázolt hely.

MapsRouteClientOptions

Az ügyfél opcionális paraméterei

RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Az útvonalirányok törzsparamétereinek közzététele.

RouteDirectionsBatchItemOutput

A Route Directions Batch szolgáltatáshívásából visszaadott elem.

RouteDirectionsBatchItemResponseOutput

A lekérdezés eredménye. RouteDirections, ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyébként.

RouteDirectionsBatchResultOutput

Ez az objektum egy sikeres Route Directions Batch-szolgáltatáshívásból származik.

RouteDirectionsOutput

Ezt az objektumot egy sikeres útvonalirány-hívás adja vissza

RouteGetRouteDirections200Response

A Get Route Directions API egy HTTP-GET kérés, amely egy forrás és egy cél közötti útvonalat ad vissza, ha meg van adva. Az útvonal figyelembe veszi az olyan tényezőket, mint a jelenlegi forgalom és a hét kért napján és a nap idejének átlagos közúti sebessége.

A visszaadott információk közé tartozik a távolság, a becsült utazási idő és az útvonalgeometria ábrázolása. A kiválasztott beállításoktól függően további útválasztási információk is elérhetők, például az optimalizált útválasztási sorrend vagy a turn by turn utasítások.

Az útválasztási szolgáltatás paraméterkészletet biztosít egy járműspecifikus fogyasztási modell részletes leírásához. További információ: Használati modell.

RouteGetRouteDirectionsBatch200Response

A Get Route Directions Batch API egy HTTP-GET kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen kéréssel. Meghívhatja Get 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.

Aszinkron Batch-eredmények letöltése

Az aszinkron köteg eredményeinek letöltéséhez GET kérést küld a köteg letöltési végpontjának. Ez a letöltési URL- egy sikeres Location kötegelt kérelem POST fejlécéből szerezhető be, és a következőképpen néz ki:

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

Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:

  1. Az ügyfél GET kérelmet küld a letöltési URL-címhasználatával.

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérelmet elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.

    HTTP 200 OK – A Batch-kérelem feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes kötegelt eredményt.

Batch Response Model

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

A Get Route Directions Batch API egy HTTP-GET kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen kéréssel. Meghívhatja Get 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.

Aszinkron Batch-eredmények letöltése

Az aszinkron köteg eredményeinek letöltéséhez GET kérést küld a köteg letöltési végpontjának. Ez a letöltési URL- egy sikeres Location kötegelt kérelem POST fejlécéből szerezhető be, és a következőképpen néz ki:

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

Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:

  1. Az ügyfél GET kérelmet küld a letöltési URL-címhasználatával.

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérelmet elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.

    HTTP 200 OK – A Batch-kérelem feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes kötegelt eredményt.

Batch Response Model

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

A Get Route Directions API egy HTTP-GET kérés, amely egy forrás és egy cél közötti útvonalat ad vissza, ha meg van adva. Az útvonal figyelembe veszi az olyan tényezőket, mint a jelenlegi forgalom és a hét kért napján és a nap idejének átlagos közúti sebessége.

A visszaadott információk közé tartozik a távolság, a becsült utazási idő és az útvonalgeometria ábrázolása. A kiválasztott beállításoktól függően további útválasztási információk is elérhetők, például az optimalizált útválasztási sorrend vagy a turn by turn utasítások.

Az útválasztási szolgáltatás paraméterkészletet biztosít egy járműspecifikus fogyasztási modell részletes leírásához. További információ: Használati modell.

RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

A Post Route Directions API egy HTTP-POST-kérés, amely egy forrás és egy cél közötti útvonalat ad vissza, és ha meg van adva, áthalad az útpontokon. Az útvonal figyelembe veszi az olyan tényezőket, mint a jelenlegi forgalom, valamint a hét kért napján és a nap folyamán mért átlagos útsebességek.

A visszaadott információk közé tartozik a távolság, a becsült utazási idő és az útvonalgeometria ábrázolása. A kiválasztott beállításoktól függően további útválasztási információk is elérhetők, például az optimalizált útválasztási sorrend vagy a turn by turn utasítások.

Az útválasztási szolgáltatás paraméterkészletet biztosít egy járműspecifikus használati modell részletes leírásához. Az érintett fogalmak és paraméterek részletes magyarázatáért tekintse meg használati modell.

RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

A Post Route Directions API egy HTTP-POST-kérés, amely egy forrás és egy cél közötti útvonalat ad vissza, és ha meg van adva, áthalad az útpontokon. Az útvonal figyelembe veszi az olyan tényezőket, mint a jelenlegi forgalom, valamint a hét kért napján és a nap folyamán mért átlagos útsebességek.

A visszaadott információk közé tartozik a távolság, a becsült utazási idő és az útvonalgeometria ábrázolása. A kiválasztott beállításoktól függően további útválasztási információk is elérhetők, például az optimalizált útválasztási sorrend vagy a turn by turn utasítások.

Az útválasztási szolgáltatás paraméterkészletet biztosít egy járműspecifikus használati modell részletes leírásához. Az érintett fogalmak és paraméterek részletes magyarázatáért tekintse meg használati modell.

RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

A Get Route Matrix API egy HTTP-GET-kérés, amely kiszámítja az összes lehetséges pár utazási idejét és távolságát a forrás- és úti célok listájában. A Útvonaltervek lekérése API-val ellentétben, amely részletes útvonalutasításokat biztosít, ez az API a hatékonyságra összpontosít azáltal, hogy az útválasztás költségeit (utazási idejét és távolságát) az egyes forrásoktól minden célig biztosítja. További információ: Ajánlott eljárások az Azure Maps Route szolgáltatáshoz.

A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix GET kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor GET kérést küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

A Get Route Matrix API egy HTTP-GET-kérés, amely kiszámítja az összes lehetséges pár utazási idejét és távolságát a forrás- és úti célok listájában. A Útvonaltervek lekérése API-val ellentétben, amely részletes útvonalutasításokat biztosít, ez az API a hatékonyságra összpontosít azáltal, hogy az útválasztás költségeit (utazási idejét és távolságát) az egyes forrásoktól minden célig biztosítja. További információ: Ajánlott eljárások az Azure Maps Route szolgáltatáshoz.

A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix GET kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor GET kérést küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteGetRouteRange200Response

A Get Route Range (Isochrone) API egy HTTP-GET kérés, amely kiszámítja a forrásponttól elérhető helyek készletét a megadott üzemanyag- energia-, idő- vagy távolságkeret alapján. A sokszöghatár (vagy Isochrone) az óramutató járásával ellentétes irányban, valamint a pontos sokszög középen jelenik meg, amely a forráspont eredménye volt.

A visszaadott sokszög további feldolgozásra használható, például Keresés a geometrián belül a megadott isochrone-beli POI-k kereséséhez.

RouteGetRouteRangeDefaultResponse

A Get Route Range (Isochrone) API egy HTTP-GET kérés, amely kiszámítja a forrásponttól elérhető helyek készletét a megadott üzemanyag- energia-, idő- vagy távolságkeret alapján. A sokszöghatár (vagy Isochrone) az óramutató járásával ellentétes irányban, valamint a pontos sokszög középen jelenik meg, amely a forráspont eredménye volt.

A visszaadott sokszög további feldolgozásra használható, például Keresés a geometrián belül a megadott isochrone-beli POI-k kereséséhez.

RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.

RouteInstructionGroupOutput

Egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja. A sorozattartományt az firstInstructionIndex és a lastInstructionIndex korlátozza. Ha emberi olvasásra alkalmas szöveges üzeneteket kérnek útmutatásért (instructionType=text vagy tagged), akkor az utasításcsoport egy összefoglaló üzenetet ad vissza, ha elérhető.

RouteInstructionOutput

A manővert leíró attribútumok készlete, pl. "Jobbra fordulás", "Balra marad", "Szálljon a kompra", "Autópályára", "Érkezés".

RouteLegOutput

Az útvonal egy részének leírása, amely a pontok listájából áll. A kérésben megadott további útpontok további lábat eredményeznek a visszaadott útvonalon.

RouteMatrixOutput

Mátrix eredményobjektuma

RouteMatrixQuery

Egy koordináta-mátrixot tartalmazó objektum.

RouteMatrixResultOutput

Ezt az objektumot egy sikeres útvonalmátrix-hívás adja vissza. Ha például 2 forrást és 3 célhelyet adnak meg, akkor 2 tömb lesz, amelyekben 3 elem található. Az egyes elemek tartalma a lekérdezésben megadott beállításoktól függ.

RouteMatrixResultResponseOutput

Az aktuális cella válaszobjektuma a bemeneti mátrixban.

RouteMatrixSummaryOutput

Összegző objektum

RouteOptimizedWaypointOutput

Optimalizált útpont objektum.

RouteOutput
RouteRangeOutput

Elérhető tartomány

RouteRangeResultOutput

Ezt az objektumot egy sikeres útvonalelérési tartomány hívása adja vissza

RouteReportOutput

Az aktuális hívásban használt érvényes beállításokat jelenti.

RouteRequestRouteDirectionsBatch200Response

A Post Route Directions Batch API egy HTTP-POST kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen aszinkron 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 szinkron kérésben való meghívásához lásd Útvonaltervek utáni Batch Synccímű témakört.

Aszinkron batch-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útvonalkérések nagy mennyiségének feldolgozására

  • Lehetővé teszi az eredmények lekérését egy külön hívásban (több letöltés is lehetséges).
  • Az aszinkron API megbízhatóságra van optimalizálva, és nem várható, hogy időtúllépésbe ütközik.
  • A kötegelemek száma az API-hoz 700.

Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

Vegye figyelembe, hogy az aszinkron kötegkérelem hosszú ideig futó művelet. Íme egy tipikus műveletsor:

  1. Az ügyfél egy útvonalterv-kötegelt POST kérelmet küld az Azure Mapsnek.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérés elfogadva.

    HTTP Error – Hiba történt a Batch-kérelem feldolgozása során. Ez lehet egy 400 Bad Request vagy bármely más Error állapotkód.

  2. Ha a kötegkérelmet sikeresen elfogadták, a válasz Location fejléce tartalmazza a kötegelt kérelem eredményeinek letöltéséhez tartozó URL-címet. Az állapot URI-ja a következőképpen néz ki:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Az ügyfél GET kérést küld a 3. lépésben beszerzett letöltési URL-címre, a köteg eredményeinek letöltéséhez.

POST törzs a Batch-kérelemhez

A útvonalirányok lekérdezések küldéséhez egy POST kérést kell használnia, amelyben a kérelemtörzs batchItems tömböt fog tartalmazni json formátumban, és a Content-Type fejléc application/jsonlesz beállítva. Íme egy mintakérés törzse, amely 3 útvonalirányt lekérdezéseket tartalmaz:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

A kötegben lévő útvonalirányok lekérdezések csak részleges URL-a protokoll, az alap URL-cím, az elérési út, az api-verzió és az előfizetési kulcs nélkül. Az URI-paraméterekbármelyik támogatott útvonalirányt elfogadhatja. A útvonalirányok sztringértékeit lekérdezésnek megfelelően kell megmenekülnie (például a " karaktert meg kell szökni \ karakterrel), és megfelelően URL-kódolásúnak kell lennie.

Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 700 lekérdezést kötegeljen, és akár 100 lekérdezésig szinkronizálja az API-t, és a kötegnek legalább 1 lekérdezést kell tartalmaznia.

Aszinkron Batch-eredmények letöltése

Az aszinkron köteg eredményeinek letöltéséhez GET kérést küld a köteg letöltési végpontjának. Ez a letöltési URL- egy sikeres Location kötegelt kérelem POST fejlécéből szerezhető be, és a következőképpen néz ki:

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

Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:

  1. Az ügyfél GET kérelmet küld a letöltési URL-címhasználatával.

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérelmet elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.

    HTTP 200 OK – A Batch-kérelem feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes kötegelt eredményt.

Batch Response Model

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

A Post Route Directions Batch API egy HTTP-POST kérés, amely több lekérdezést küld a Útvonaltervek lekérése API-nak egyetlen aszinkron 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 szinkron kérésben való meghívásához lásd Útvonaltervek utáni Batch Synccímű témakört.

Aszinkron batch-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útvonalkérések nagy mennyiségének feldolgozására

  • Lehetővé teszi az eredmények lekérését egy külön hívásban (több letöltés is lehetséges).
  • Az aszinkron API megbízhatóságra van optimalizálva, és nem várható, hogy időtúllépésbe ütközik.
  • A kötegelemek száma az API-hoz 700.

Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

Vegye figyelembe, hogy az aszinkron kötegkérelem hosszú ideig futó művelet. Íme egy tipikus műveletsor:

  1. Az ügyfél egy útvonalterv-kötegelt POST kérelmet küld az Azure Mapsnek.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérés elfogadva.

    HTTP Error – Hiba történt a Batch-kérelem feldolgozása során. Ez lehet egy 400 Bad Request vagy bármely más Error állapotkód.

  2. Ha a kötegkérelmet sikeresen elfogadták, a válasz Location fejléce tartalmazza a kötegelt kérelem eredményeinek letöltéséhez tartozó URL-címet. Az állapot URI-ja a következőképpen néz ki:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Az ügyfél GET kérést küld a 3. lépésben beszerzett letöltési URL-címre, a köteg eredményeinek letöltéséhez.

POST törzs a Batch-kérelemhez

A útvonalirányok lekérdezések küldéséhez egy POST kérést kell használnia, amelyben a kérelemtörzs batchItems tömböt fog tartalmazni json formátumban, és a Content-Type fejléc application/jsonlesz beállítva. Íme egy mintakérés törzse, amely 3 útvonalirányt lekérdezéseket tartalmaz:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

A kötegben lévő útvonalirányok lekérdezések csak részleges URL-a protokoll, az alap URL-cím, az elérési út, az api-verzió és az előfizetési kulcs nélkül. Az URI-paraméterekbármelyik támogatott útvonalirányt elfogadhatja. A útvonalirányok sztringértékeit lekérdezésnek megfelelően kell megmenekülnie (például a " karaktert meg kell szökni \ karakterrel), és megfelelően URL-kódolásúnak kell lennie.

Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 700 lekérdezést kötegeljen, és akár 100 lekérdezésig szinkronizálja az API-t, és a kötegnek legalább 1 lekérdezést kell tartalmaznia.

Aszinkron Batch-eredmények letöltése

Az aszinkron köteg eredményeinek letöltéséhez GET kérést küld a köteg letöltési végpontjának. Ez a letöltési URL- egy sikeres Location kötegelt kérelem POST fejlécéből szerezhető be, és a következőképpen néz ki:

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

Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:

  1. Az ügyfél GET kérelmet küld a letöltési URL-címhasználatával.

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – A Batch-kérelmet elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.

    HTTP 200 OK – A Batch-kérelem feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes kötegelt eredményt.

Batch Response Model

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

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}

Batch Response Model

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

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}

Batch Response Model

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

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}

Batch Response Model

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

A Post Route Matrix API egy HTTP-POST-kérés, amely lehetővé teszi a forrás- és célhelyek által meghatározott útvonalak mátrixának kiszámítását egy aszinkron (aszinkron) kéréssel. Szinkron (szinkronizálási) kérést Post Route Matrix Synccímű témakörben talál. A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Megjegyzés:

Minden forrást és célhelyet egy tengelyhez igazított 400 km x 400 km határolókeretben kell tárolni. Ellenkező esetben egyes mátrixcellák OUT_OF_REGION lesznek feloldva.

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

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

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix POST-kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor POST kérelmet küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

A Post Route Matrix API egy HTTP-POST-kérés, amely lehetővé teszi a forrás- és célhelyek által meghatározott útvonalak mátrixának kiszámítását egy aszinkron (aszinkron) kéréssel. Szinkron (szinkronizálási) kérést Post Route Matrix Synccímű témakörben talál. A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Megjegyzés:

Minden forrást és célhelyet egy tengelyhez igazított 400 km x 400 km határolókeretben kell tárolni. Ellenkező esetben egyes mátrixcellák OUT_OF_REGION lesznek feloldva.

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

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

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix POST-kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor POST kérelmet küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

A Post Route Matrix Sync API egy HTTP-POST-kérés, amely lehetővé teszi a forrás- és célhelyek által meghatározott útvonalak mátrixának kiszámítását egyetlen szinkron (szinkronizálási) kérelem használatával. Ha aszinkron (aszinkron) kérést szeretne készíteni, tekintse meg útvonal utáni mátrix. A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

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

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix POST-kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor POST kérelmet küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteRequestRouteMatrixSync408Response

A Post Route Matrix Sync API egy HTTP-POST-kérés, amely lehetővé teszi a forrás- és célhelyek által meghatározott útvonalak mátrixának kiszámítását egyetlen szinkron (szinkronizálási) kérelem használatával. Ha aszinkron (aszinkron) kérést szeretne készíteni, tekintse meg útvonal utáni mátrix. A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

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

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix POST-kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor POST kérelmet küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

A Post Route Matrix Sync API egy HTTP-POST-kérés, amely lehetővé teszi a forrás- és célhelyek által meghatározott útvonalak mátrixának kiszámítását egyetlen szinkron (szinkronizálási) kérelem használatával. Ha aszinkron (aszinkron) kérést szeretne készíteni, tekintse meg útvonal utáni mátrix. A szolgáltatás minden adott forrás esetében kiszámítja az adott forrástól az adott célhelyig történő útválasztás költségét. A forráskészletet és a célhelykészletet úgy lehet elképzelni, mint egy tábla oszlop- és sorfejléceit, és a táblázat minden cellái tartalmazzák az adott cella forrásától a célhelyig történő útválasztás költségeit. Tegyük fel például, hogy egy ételkézbesítési vállalatnak 20 sofőrje van, és meg kell találniuk a legközelebbi sofőrt, aki felveszi a szállítást az étteremből. A használati eset megoldásához meghívhatják a Matrix Route API-t.

Minden útvonal esetében a rendszer visszaadja az utazási időket és a távolságokat. A kiszámított költségek alapján meghatározhatja, hogy mely részletes útvonalakat számítsa ki a Route Directions API használatával.

Az aszinkron kérelmek mátrixának maximális mérete 700, szinkronizálási kérelem esetén pedig 100 (a források száma és a célhelyek száma).

Szinkron útvonalmátrix-kérelem elküldése

Ha a forgatókönyv szinkron kéréseket igényel, és a mátrix maximális mérete kisebb vagy egyenlő 100-nál, érdemes lehet szinkron kérést küldeni. Az API-hoz tartozó mátrix maximális mérete 100 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 10x10, 6x8, 9x8 (nem kell négyzetnek lennie).

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

Aszinkron útvonalmátrix-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett útválasztási kérések nagy mennyiségének feldolgozására. Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Ha waitForResults kérelem paramétere igaz, a felhasználó 200 választ kap, ha a kérés 120 másodperc alatt befejeződött.

Az API-hoz tartozó mátrix maximális mérete 700 (a források száma és a célhelyek számának szorzata). Ezt a kényszert szem előtt tartva a lehetséges mátrixdimenziók például a következők: 50x10, 10x10, 28x25. 10x70 (nem kell négyzet).

Az aszinkron válaszok tárolása 24 órán keresztül történik . Az átirányítási URL 404-választ ad vissza, ha a lejárati idő után használják.

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

Az aszinkron műveletek jellemző sorrendje a következő:

  1. Az ügyfél útválasztási mátrix POST-kérést küld az Azure Mapsnek

  2. A kiszolgáló a következők egyikével válaszol:

    HTTP 202 Accepted – Az útvonalmátrix kérése elfogadva.

    HTTP Error – Hiba történt az útvonalmátrix-kérelem feldolgozása során. Ez lehet egy 400-ás hibás kérés vagy bármely más hibaállapot-kód.

  3. Ha a mátrixútvonal-kérést sikeresen elfogadták, a válasz Hely fejléce tartalmazza a kérelem eredményeinek letöltéséhez használt URL-címet. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Az ügyfél get kérést ad ki a 3. lépésben beszerzett letöltési URL-címre az eredmények letöltéséhez

Szinkronizálási eredmények letöltése

Amikor POST kérelmet küld a Route Matrix Sync API-hoz, a szolgáltatás 200 válaszkódot ad vissza a sikeres kéréshez és egy választömbhöz. A válasz törzse tartalmazni fogja az adatokat, és később nem lesz lehetőség az eredmények lekérésére.

Aszinkron eredmények letöltése

Amikor egy kérés 202 Accepted választ ad ki, a kérés feldolgozása az aszinkron folyamatunkkal történik. Egy URL-címet kap, amely ellenőrzi az aszinkron kérés előrehaladását a válasz helyfejlécében. Az állapot URI-ja a következőhöz hasonlóan néz ki:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

A hely fejléce által megadott URL-cím a következő válaszokat adja vissza GET kérés kiadásakor.

HTTP 202 Accepted – A mátrixkérelem elfogadva, de még folyamatban van. Próbálkozzon újra egy ideig.

HTTP 200 OK – A mátrixkérés feldolgozása sikeresen megtörtént. A válasz törzse tartalmazza az összes eredményt.

RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább a startPointIndex, endPointIndexés sectionTypeelemeket tartalmazza.

RouteSectionTecCauseOutput

A forgalmi esemény oka. Tartalmazhat mainCauseCode és subCauseCode elemeket. Ikonográfia és leírások definiálására használható.

RouteSectionTecOutput

A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okozhat.

RouteSummaryOutput

Összegző objektum

Routes
SimplePollerLike

Egy egyszerű beporzó, amely egy hosszú ideig futó művelet lekérdezésére használható.

Típusaliasok

GeoJsonGeometry

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.

GeoJsonObject

Érvényes GeoJSON objektum. Részletekért tekintse meg RFC 7946.

MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Függvények

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Hozzon létre egy kötegelt kérelemtörzset egy csomó útvonalirány-kérésből.

default(AzureKeyCredential, ClientOptions)

Létrehoz egy MapsRouteClient-példányt egy előfizetési kulcsból.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Létrehoz egy MapsRoute-példányt egy Azure Identity TokenCredential.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Létrehoz egy MapsRoute-példányt egy Azure Identity AzureSASCredential.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Segédfüggvény, amely poller objektumot hoz létre egy hosszú ideig futó művelet lekérdezéséhez.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

[Latitude, Longtitute] tömb átalakítása sztringgé a következő formátumban: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Függvény adatai

buildMultiCollection(string[], string)

function buildMultiCollection(items: string[], parameterName: string): string

Paraméterek

items

string[]

parameterName

string

Válaszok

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Hozzon létre egy kötegelt kérelemtörzset egy csomó útvonalirány-kérésből.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Paraméterek

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Egy útvonalirány-kérelem lekérdezési paramétereinek objektuma

Válaszok

A kötegkérelem.

default(AzureKeyCredential, ClientOptions)

Létrehoz egy MapsRouteClient-példányt egy előfizetési kulcsból.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Paraméterek

credential
AzureKeyCredential

Egy AzureKeyCredential-példány, amely a szolgáltatáshoz érkező kérések hitelesítésére szolgál

options
ClientOptions

Az Útvonalügyfél konfigurálásához használt beállítások

Válaszok

default(TokenCredential, string, ClientOptions)

Létrehoz egy MapsRoute-példányt egy Azure Identity TokenCredential.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Paraméterek

credential
TokenCredential

TokenCredential-példány a szolgáltatáshoz érkező kérések hitelesítéséhez

mapsAccountClientId

string

Egy adott térképerőforrás Azure Maps-ügyfélazonosítója

options
ClientOptions

Az Útvonalügyfél konfigurálásához használt beállítások

Válaszok

default(AzureSASCredential, ClientOptions)

Létrehoz egy MapsRoute-példányt egy Azure Identity AzureSASCredential.

Példa

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Paraméterek

credential
AzureSASCredential

Egy AzureSASCredential-példány, amely a szolgáltatáshoz érkező kérések hitelesítésére szolgál

options
ClientOptions

Az Útvonalügyfél konfigurálásához használt beállítások

Válaszok

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Segédfüggvény, amely poller objektumot hoz létre egy hosszú ideig futó művelet lekérdezéséhez.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Paraméterek

client
Client

Az ügyfél további oldalak lekérésére szolgáló kérés elküldéséhez használható.

initialResponse

TResult

A kezdeti válasz.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Az önéletrajzállapot vagy az egyéni lekérdezési időköz beállításának beállításai.

Válaszok

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Egy lekérdezési objektum, amely lekérdezi a műveletállapot-frissítéseket, és végül megkapja a végső választ.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Paraméterek

Válaszok

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Paraméterek

Válaszok

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Paraméterek

Válaszok

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Paraméterek

Válaszok

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Paraméterek

Válaszok

response

toColonDelimitedLatLonString(LatLon[])

[Latitude, Longtitute] tömb átalakítása sztringgé a következő formátumban: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Paraméterek

coordinates

LatLon[]

Az átalakítandó szélességi/hosszúsági pár tömbje.

Válaszok

string

Az átalakított sztring.