@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 |
GeoJsonFeatureCollection |
Érvényes |
GeoJsonFeatureCollectionData | |
GeoJsonFeatureData | |
GeoJsonGeometryCollection |
Érvényes |
GeoJsonGeometryCollectionData | |
GeoJsonGeometryParent |
Érvényes |
GeoJsonLineString |
Érvényes |
GeoJsonLineStringData | |
GeoJsonMultiLineString |
Érvényes |
GeoJsonMultiLineStringData | |
GeoJsonMultiPoint |
Érvényes |
GeoJsonMultiPointData |
Egy |
GeoJsonMultiPolygon |
Érvényes |
GeoJsonMultiPolygonData | |
GeoJsonObjectParent |
Érvényes |
GeoJsonPoint |
Érvényes |
GeoJsonPointData |
Egy |
GeoJsonPolygon |
Érvényes |
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 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 Aszinkron Batch-eredmények letöltéseAz aszinkron köteg eredményeinek letöltéséhez
Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteGetRouteDirectionsBatch202Headers | |
RouteGetRouteDirectionsBatch202Response |
A Aszinkron Batch-eredmények letöltéseAz aszinkron köteg eredményeinek letöltéséhez
Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteGetRouteDirectionsDefaultResponse |
A 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 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 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 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 Szinkron útvonalmátrix-kérelem elküldéseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteGetRouteMatrix202Headers | |
RouteGetRouteMatrix202Response |
A 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 Szinkron útvonalmátrix-kérelem elküldéseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteGetRouteRange200Response |
A 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 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 Aszinkron batch-kérelem küldéseAz Aszinkron API alkalmas a viszonylag összetett útvonalké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.
Az aszinkron válaszok tárolása 24 órán keresztül történik Vegye figyelembe, hogy az aszinkron kötegkérelem hosszú ideig futó művelet. Íme egy tipikus műveletsor:
POST törzs a Batch-kérelemhezA útvonalirányok lekérdezések küldéséhez egy
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 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éseAz aszinkron köteg eredményeinek letöltéséhez
Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteRequestRouteDirectionsBatch202Headers | |
RouteRequestRouteDirectionsBatch202Response |
A Aszinkron batch-kérelem küldéseAz Aszinkron API alkalmas a viszonylag összetett útvonalké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.
Az aszinkron válaszok tárolása 24 órán keresztül történik Vegye figyelembe, hogy az aszinkron kötegkérelem hosszú ideig futó művelet. Íme egy tipikus műveletsor:
POST törzs a Batch-kérelemhezA útvonalirányok lekérdezések küldéséhez egy
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 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éseAz aszinkron köteg eredményeinek letöltéséhez
Íme a kötegeredmények letöltésére szolgáló műveletek tipikus sorrendje:
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteRequestRouteDirectionsBatchBodyParam | |
RouteRequestRouteDirectionsBatchMediaTypesParam | |
RouteRequestRouteDirectionsBatchSync200Response |
A Szinkronizálási kötegkérelem küldéseA 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
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteRequestRouteDirectionsBatchSync408Response |
A Szinkronizálási kötegkérelem küldéseA 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
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteRequestRouteDirectionsBatchSyncBodyParam | |
RouteRequestRouteDirectionsBatchSyncDefaultResponse |
A Szinkronizálási kötegkérelem küldéseA 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
Batch Response ModelA 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
Íme egy minta Batch-válasz 1 sikeres és 1 sikertelen eredménnyel:
|
RouteRequestRouteDirectionsBatchSyncMediaTypesParam | |
RouteRequestRouteMatrix200Response |
A 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 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éseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteRequestRouteMatrix202Headers | |
RouteRequestRouteMatrix202Response |
A 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 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éseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteRequestRouteMatrixBodyParam | |
RouteRequestRouteMatrixMediaTypesParam | |
RouteRequestRouteMatrixQueryParam | |
RouteRequestRouteMatrixQueryParamProperties | |
RouteRequestRouteMatrixSync200Response |
A 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 Szinkron útvonalmátrix-kérelem elküldéseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteRequestRouteMatrixSync408Response |
A 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 Szinkron útvonalmátrix-kérelem elküldéseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteRequestRouteMatrixSyncBodyParam | |
RouteRequestRouteMatrixSyncDefaultResponse |
A 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 Szinkron útvonalmátrix-kérelem elküldéseHa 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
Aszinkron útvonalmátrix-kérelem küldéseAz 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 Az API-hoz tartozó mátrix maximális mérete 700 Az aszinkron válaszok tárolása 24 órán keresztül történik
Az aszinkron műveletek jellemző sorrendje a következő:
Szinkronizálási eredmények letöltéseAmikor 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éseAmikor egy kérés
A hely fejléce által megadott URL-cím a következő válaszokat adja vissza
|
RouteRequestRouteMatrixSyncMediaTypesParam | |
RouteRequestRouteMatrixSyncQueryParam | |
RouteRequestRouteMatrixSyncQueryParamProperties | |
RouteSectionOutput |
Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább a |
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 |
GeoJsonObject |
Érvényes |
MapsRouteClient | |
RouteGetRouteDirectionsBatchParameters | |
RouteGetRouteDirectionsParameters | |
RouteGetRouteDirectionsWithAdditionalParametersParameters | |
RouteGetRouteMatrixParameters | |
RouteGetRouteRangeParameters | |
RouteRequestRouteDirectionsBatchParameters | |
RouteRequestRouteDirectionsBatchSyncParameters | |
RouteRequestRouteMatrixParameters | |
RouteRequestRouteMatrixSyncParameters |
Függvények
build |
|
create |
Hozzon létre egy kötegelt kérelemtörzset egy csomó útvonalirány-kérésből. |
default(Azure |
Létrehoz egy MapsRouteClient-példányt egy előfizetési kulcsból. Példa
|
default(Token |
Létrehoz egy MapsRoute-példányt egy Azure Identity Példa
|
default(Azure |
Létrehoz egy MapsRoute-példányt egy Azure Identity Példa
|
get |
Segédfüggvény, amely poller objektumot hoz létre egy hosszú ideig futó művelet lekérdezéséhez. |
is |
|
is |
|
is |
|
is |
|
is |
|
to |
[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
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.
Azure SDK for JavaScript