Route - Post Route Directions Batch Sync

Referencia

Szolgáltatás:: Maps

API-verzió:: 1.0

A használatával lekérdezések kötegét küldheti el az Útvonaltervek lekérése API-nak egyetlen szinkron kérésben.

Az Post Route Directions Batch Sync API egy HTTP-kérés POST , amely lekérdezések kötegeit küldi el a Get Route Directions API-nak egyetlen szinkron kéréssel. Az API-t meghívhatja Route Directions Batch aszinkron (aszinkron) vagy szinkron (szinkronizálási) futtatáshoz. Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 700 lekérdezést kötenek össze, és akár 100 lekérdezést szinkronizáljon az API-val. Ha egy aszinkron kérésben szeretné meghívni az Post Route Directions Batch API-t, tekintse meg az Útvonaltervek közzététele kötegben című témakört.

Szinkron batch-kérelem elküldése

A szinkron API használata egyszerű kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a batch-elemek kiszámítása után azonnal válaszol, és később nem lesz lehetőség az eredmények lekérésére. A szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma 100-ra van korlátozva.

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

Batch-válaszmodell

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ötegelt választ. Ez a kötegelt válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy az totalRequests eredeti kötegkérelm successfulRequestsrészét képezte, azaz a sikeresen végrehajtott lekérdezéseket. A batch-válasz egy batchItems tömböt is tartalmaz, 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. Minden elem tartalmaz batchItemsstatusCode és response mezőket. Mindegyik response a batchItems 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 elemet fog tartalmazni.

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

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
api-version	query	True	string	Az Azure Maps API verziószáma.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .

Kérelem törzse

Name	Típus	Description
batchItems	BatchRequestItem[]	A feldolgozandó lekérdezések listája.

Válaszok

Name	Típus	Description
200 OK	RouteDirectionsBatchResult	OK
Other Status Codes	ErrorResponse	Időtúllépés: A kérés befejezése hosszabb időt vett igénybe, mint az API-ban meghatározott maximális időtartam.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel, vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát x-ms-client-id annak jelzéséhez, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft identitásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiókot hoz létre az Azure Portalon, vagy a PowerShell, a CLI, az Azure SDK-k vagy a REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja az Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázása műveletéből jön létre az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Típus: apiKey
In: header

Példák

Successfully retrieve the route direction batch result synchronously

Mintakérelem

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "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"
    }
  ]
}

Mintaválasz

Állapotkód:: 200

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

Állapotkód:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definíciók

Name	Description
BatchRequest	Ez a típus a Batch szolgáltatás kérelemtörzsét jelöli.
BatchRequestItem	Batch-kérelemobjektum
DelayMagnitude	Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részleteinek lekérése API válaszmezőjének értékeinek felelnek meg.
DrivingSide	A bal oldali és a jobb oldali vezetést jelzi a manőver pontján.
EffectiveSetting	A Route API meghívásakor használt érvényes paraméter vagy adatok.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GuidanceInstructionType	Az utasítás típusa, például az úttest befordulása vagy módosítása.
GuidanceManeuver	Egy kód, amely azonosítja a manővert.
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
JunctionType	A csomópont típusa, ahol a manőver történik. Nagyobb körforgalmak esetén két külön utasítás jön létre a körforgalom be- és kilépéséhez.
LatLongPair	Földrajzi szélességként és hosszúságként megadott hely.
Response	A lekérdezés eredménye. RouteDirections ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.
ResponseSectionType	A jelentett útvonalválasz szakasztípusai
ResponseTravelMode	Utazási mód a számított útvonalhoz. Az érték akkor lesz beállítva, `other` ha a kért átviteli mód ebben a szakaszban nem lehetséges
Route
RouteDirectionsBatchItem	A Route Directions Batch szolgáltatáshívásából visszaadott elem.
RouteDirectionsBatchResult	Ezt az objektumot egy sikeres Route Directions Batch-szolgáltatáshívás adja vissza.
RouteGuidance	Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.
RouteInstruction	Egy manővert leíró attribútumok készlete, pl. "Jobbra fordulás", "Balra tartás", "Szálljon a kompra", "Autópályára", "Érkezés".
RouteInstructionGroup	Az egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja. A sorozattartományt a 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 instructionGroup egy összefoglaló üzenetet ad vissza, ha elérhető.
RouteLeg	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.
RouteLegSummary	Az útvonalszakasz összefoglaló objektuma.
RouteOptimizedWaypoint	Optimalizált útpont objektum.
RouteReport	Az aktuális hívásban használt érvényes beállításokat jelenti.
RouteSection	Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább az elemeket, a és `endPointIndexsectionType`a elemeket `startPointIndex`tartalmazza.
RouteSectionTec	A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okoz.
RouteSectionTecCause	A forgalmi esemény oka. Tartalmazhat mainCauseCode és subCauseCode elemeket. Ikonográfia és leírások definiálására használható.
RouteSummary	Összegző objektum
SimpleCategory	Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információkért lásd a "tec" (tec) című témakört.
Summary	A kötegelt kérelem eredményeinek összegzése

BatchRequest

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

Name	Típus	Description
batchItems	BatchRequestItem[]	A feldolgozandó lekérdezések listája.

BatchRequestItem

Batch-kérelemobjektum

Name	Típus	Description
query	string	Ez a paraméter egy strukturálatlan geokódolási művelet végrehajtásához használt lekérdezési sztringet tartalmaz. A lekérdezési sztringet a rendszer szó szerint átadja a keresési API-nak feldolgozás céljából.

DelayMagnitude

Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részleteinek lekérése API válaszmezőjének értékeinek felelnek meg.

Name	Típus	Description
0	string	Unknown.
1	string	Kiskorú.
2	string	Közepes.
3	string	Őrnagy.
4	string	Meghatározatlan, útlezárásokhoz és egyéb határozatlan késésekhez használják.

DrivingSide

A bal oldali és a jobb oldali vezetést jelzi a manőver pontján.

Name	Típus	Description
LEFT	string	Bal oldalon.
RIGHT	string	Jobb oldalon.

EffectiveSetting

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

Name	Típus	Description
key	string	A használt paraméter neve.
value	string	A használt paraméter értéke.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GuidanceInstructionType

Az utasítás típusa, például az úttest befordulása vagy módosítása.

Name	Típus	Description
DIRECTION_INFO	string	Irányadatok.
LOCATION_ARRIVAL	string	Érkezés helye.
LOCATION_DEPARTURE	string	Indulási hely.
LOCATION_WAYPOINT	string	Útpont helye.
ROAD_CHANGE	string	Útváltás.
TURN	string	Fordít.

GuidanceManeuver

Egy kód, amely azonosítja a manővert.

Name	Típus	Description
ARRIVE	string	Megérkezett.
ARRIVE_LEFT	string	Megérkezett. A cél a bal oldalon van.
ARRIVE_RIGHT	string	Megérkezett. A cél a jobb oldalon van.
BEAR_LEFT	string	Medve balra.
BEAR_RIGHT	string	Medvét jobbra.
DEPART	string	Elhagy.
ENTER_FREEWAY	string	Az autópályán.
ENTER_HIGHWAY	string	Haladjon az autópályára.
ENTER_MOTORWAY	string	Az autópályán.
ENTRANCE_RAMP	string	Fogd a rámpa.
FOLLOW	string	Követ.
KEEP_LEFT	string	Maradjon balra.
KEEP_RIGHT	string	Maradjon jobbra.
MAKE_UTURN	string	Kapcsolja be az U-turnet.
MOTORWAY_EXIT_LEFT	string	A bal oldali kijáraton.
MOTORWAY_EXIT_RIGHT	string	A jobb oldali kijáraton.
ROUNDABOUT_BACK	string	Menj körbe a körforgalomban.
ROUNDABOUT_CROSS	string	Átkelni a körforgalomon.
ROUNDABOUT_LEFT	string	A körforgalomnál lépjen ki a bal oldalon.
ROUNDABOUT_RIGHT	string	A körforgalomnál lépjen ki a jobb oldalon.
SHARP_LEFT	string	Balra forduljon élesen.
SHARP_RIGHT	string	Élesen jobbra.
STRAIGHT	string	Legyen egyenes.
SWITCH_MAIN_ROAD	string	Váltson a főútra.
SWITCH_PARALLEL_ROAD	string	Váltson a párhuzamos útra.
TAKE_EXIT	string	Lépjen ki.
TAKE_FERRY	string	A kompon.
TRY_MAKE_UTURN	string	Próbálja meg u-turn.
TURN_LEFT	string	Fordulj balra.
TURN_RIGHT	string	Fordulj jobbra.
WAYPOINT_LEFT	string	Elérte az útpontot. A bal oldalon van.
WAYPOINT_REACHED	string	Elérte az útpontot.
WAYPOINT_RIGHT	string	Elérte az útpontot. A jobb oldalon van.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript-objektum jelölési adatcseréjének formátuma

JunctionType

A csomópont típusa, ahol a manőver történik. Nagyobb körforgalmak esetén két külön utasítás jön létre a körforgalom be- és kilépéséhez.

Name	Típus	Description
BIFURCATION	string	elágazás
REGULAR	string	rendszeres
ROUNDABOUT	string	körforgalom

LatLongPair

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

Name	Típus	Description
latitude	number	Latitude tulajdonság
longitude	number	Hosszúság tulajdonság

Response

A lekérdezés eredménye. RouteDirections ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.
formatVersion	string	Verzió formázása tulajdonság
optimizedWaypoints	RouteOptimizedWaypoint[]	Útpontok optimalizált sorozata. Az eredeti és optimalizált lista felhasználó által megadott waypoint-sorozatának indexét jeleníti meg. Például egy válasz: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` azt jelenti, hogy az eredeti sorozat [0, 1, 2] és az optimalizált sorozat [1, 2, 0]. Mivel az index 0-tal kezdődik, az eredeti "első, második, harmadik", az optimalizált pedig "második, harmadik, első".
report	RouteReport	Az aktuális hívásban használt érvényes beállításokat jelenti.
routes	Route[]	Útvonaltömb

ResponseSectionType

A jelentett útvonalválasz szakasztípusai

Name	Típus	Description
CARPOOL	string	Az útvonalnak azokat a szakaszait, amelyek telekocsi (HOV/Magas kihasználtságú jármű) sávokat igényelnek.
CAR_TRAIN	string	Az útvonal egyes szakaszai, amelyek autók vagy vonatok.
COUNTRY	string	Szakaszok, amelyek jelzik, hogy az útvonal mely országokban/régiókban található.
FERRY	string	Az útvonal kompokat tartalmazó szakaszai.
MOTORWAY	string	Az útszakaszok, amelyek autópályák.
PEDESTRIAN	string	Az útvonal olyan szakaszai, amelyek csak gyalogosok számára alkalmasak.
TOLL_ROAD	string	Az útvonal azon szakaszai, amelyek díjfizetést igényelnek.
TOLL_VIGNETTE	string	Az útvonal azon szakaszai, amelyekhez díjköteles matrica szükséges.
TRAFFIC	string	Az útvonal forgalmi adatokat tartalmazó szakaszai.
TRAVEL_MODE	string	A kérelemparaméterhez `travelMode`kapcsolódó szakaszok.
TUNNEL	string	Az útvonal alagútként megadott szakaszai.
URBAN	string	Az útvonalnak a városi területeken belüli szakaszai.

ResponseTravelMode

Utazási mód a számított útvonalhoz. Az érték akkor lesz beállítva, other ha a kért átviteli mód ebben a szakaszban nem lehetséges

Name	Típus	Description
bicycle	string	A visszaadott útvonalak kerékpárokra vannak optimalizálva, beleértve a kerékpársávok használatát is.
bus	string	A visszaadott útvonalak buszokra vannak optimalizálva, beleértve a csak buszsávok használatát is. BÉTA-funkciók.
car	string	A visszaadott útvonalak autókhoz vannak optimalizálva.
motorcycle	string	A visszaadott útvonalak motorkerékpárokhoz vannak optimalizálva. BÉTA-funkciók.
other	string	Ebben a szakaszban nem lehetséges az adott átviteli mód
pedestrian	string	A visszaküldött útvonalak gyalogosok számára vannak optimalizálva, beleértve a járdák használatát is.
taxi	string	A visszaadott útvonalak taxikra vannak optimalizálva. BÉTA-funkciók.
truck	string	A visszaadott útvonalak haszongépjárművekhez, például teherautókhoz vannak optimalizálva.
van	string	A visszaadott útvonalak kisteherautókhoz vannak optimalizálva. BÉTA-funkciók.

Route

Name	Típus	Description
guidance	RouteGuidance	Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.
legs	RouteLeg[]	Láb tömb
sections	RouteSection[]	Szakaszok tömb
summary	RouteSummary	Összegző objektum

RouteDirectionsBatchItem

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

Name	Típus	Description
response	Response	A lekérdezés eredménye. RouteDirections ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.
statusCode	integer	HTTP-kérés állapotkódja.

RouteDirectionsBatchResult

Ezt az objektumot egy sikeres Route Directions Batch-szolgáltatáshívás adja vissza.

Name	Típus	Description
batchItems	RouteDirectionsBatchItem[]	A kötegelt eredményeket tartalmazó tömb.
summary	Summary	A kötegelt kérelem eredményeinek összegzése

RouteGuidance

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

Name	Típus	Description
instructionGroups	RouteInstructionGroup[]	Az egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja.
instructions	RouteInstruction[]	A manővereket leíró utasítások listája.

RouteInstruction

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

Name	Típus	Description
combinedMessage	string	Egy ember által olvasható üzenet a manőverhez a következő utasítás üzenetével kombinálva. Néha előfordulhat, hogy két egymást követő utasítást egyetlen utasításba egyesítünk, így könnyebben követhető. Ebben az esetben a lehetségesCombineWithNext jelölő igaz lesz. Például: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` A 10-es utasítás lehetségesCombineWithNext jelzője igaz. Ez azt jelzi a kódolt útmutató ügyfeleinek, hogy kombinálhatók a 11. utasítással. Az utasításokat a rendszer automatikusan kombinálja azoknak az ügyfeleknek, akik emberi olvasási útmutatást kérnek. A combinedMessage mező a kombinált üzenetet tartalmazza: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3 karakteres ISO 3166-1 alfa-3 országkód. Pl. USA.
drivingSide	DrivingSide	A bal oldali és a jobb oldali vezetést jelzi a manőver pontján.
exitNumber	string	A jelenlegi manőver által megtett autópálya-kilépések száma(i). Ha egy kilépés több kilépési számmal is rendelkezik, azokat a "", és esetleg "-" összesíti, például "10, 13-15".
instructionType	GuidanceInstructionType	Az utasítás típusa, például az úttest befordulása vagy módosítása.
junctionType	JunctionType	A csomópont típusa, ahol a manőver történik. Nagyobb körforgalmak esetén két külön utasítás jön létre a körforgalom be- és kilépéséhez.
maneuver	GuidanceManeuver	Egy kód, amely azonosítja a manővert.
message	string	Egy ember által olvasható üzenet a manőverhez.
point	LatLongPair	Földrajzi szélességként és hosszúságként megadott hely.
pointIndex	integer	Az utasítás pontjának megfelelő többsoros "pontok" listájában szereplő pont indexe.
possibleCombineWithNext	boolean	Lehetőség van az utasítás és a következő kombinálására is. Ez olyan üzenetek létrehozására használható, mint a "Balra fordulás, majd jobbra fordulás".
roadNumbers	string[]	A manőver után a következő jelentős útszakasz(ok) vagy a követendő út(ok) útszáma(i). Példa: ["E34", "N205"]
roundaboutExitNumber	integer	Ez azt jelzi, hogy melyik kijáratot kell a körforgalomnál átvenni.
routeOffsetInMeters	integer	Távolság az útvonal kezdetétől az utasítás pontjától.
signpostText	string	A manőver szempontjából legrelevánsabb szöveg a jelzőtáblán, illetve a követendő irányban.
stateCode	string	Az országnak az ISO 3166-2 kód második része által képviselt részegysége (pl. állam). Ez csak bizonyos országokban/régiókban érhető el, például az Egyesült Államokban, Kanadában és Mexikóban.
street	string	A következő jelentős útszakasz utcaneve a manőver után, vagy a követendő utca neve.
travelTimeInSeconds	integer	Becsült utazási idő a routeOffsetInMetersnek megfelelő pontig.
turnAngleInDecimalDegrees	integer	Egy utasítás irányát jelzi. Ha a junctionType fordulóutasítást jelez: 180 = U-turn [-179, -1] = Balra 0 = Egyenes bekapcsolás (0 fok) [1, 179] = Jobbra fordulás Ha a junctionType kétágú utasítást jelez: <0 – balra >0 – tartsa jobbra

RouteInstructionGroup

Az egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja. A sorozattartományt a 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 instructionGroup egy összefoglaló üzenetet ad vissza, ha elérhető.

Name	Típus	Description
firstInstructionIndex	integer	Az utasítások első utasításának indexe, amely ebbe a csoportba tartozik.
groupLengthInMeters	integer	A csoport hossza.
groupMessage	string	Összefoglaló üzenet, ha emberi olvasásra alkalmas szöveges üzeneteket kérnek útmutatásért (instructionType=text vagy tagged).
lastInstructionIndex	integer	Az utasítások utolsó utasításának indexe, amely ebbe a csoportba tartozik.

RouteLeg

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.

Name	Típus	Description
points	LatLongPair[]	Ponttömb
summary	RouteLegSummary	Az útvonalszakasz összefoglaló objektuma.

RouteLegSummary

Az útvonalszakasz összefoglaló objektuma.

Name	Típus	Description
arrivalTime	string	Az útvonal vagy a láb becsült érkezési ideje. Az idő UTC-ben van.
batteryConsumptionInkWh	number	Becsült elektromos energiafogyasztás kilowattórában (kWh) az elektromos fogyasztási modell használatával. Tartalmazza, ha a vehicleEngineType elektromos és állandóSpeedConsumptionInkWhPerHundredkm értékre van állítva. A batteryConsumptionInkWh értéke magában foglalja a visszanyert elektromos energiát, ezért negatív lehet (ami energiagyarapodást jelez). Ha a maxChargeInkWh és az aktuálisChargeInkWh is meg van adva, a rendszer leképezi a feltöltést, hogy az akkumulátor töltöttségi szintje soha ne haladja meg a maxChargeInkWh értéket. Ha sem a maxChargeInkWh, sem az currentChargeInkWh nincs megadva, a rendszer nem korlátozott újrafelvételt feltételez a felhasználás kiszámítása során.
departureTime	string	Az útvonal vagy a láb becsült indulási ideje. Az idő UTC-ben van.
fuelConsumptionInLiters	number	Becsült üzemanyag-fogyasztás literben az égési fogyasztási modell használatával. Tartalmazza, ha a vehicleEngineType égési értékre van állítva, és konstansSpeedConsumptionInLitersPerHundredkm van megadva. Az érték nem negatív lesz.
historicTrafficTravelTimeInSeconds	integer	Az időfüggő előzmény forgalmi adatokkal kiszámított becsült utazási idő. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
lengthInMeters	integer	Hossz a Meters tulajdonságban
liveTrafficIncidentsTravelTimeInSeconds	integer	Valós idejű sebességadatokkal kiszámított becsült utazási idő. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
noTrafficTravelTimeInSeconds	integer	Becsült utazási idő úgy számítva, mintha a forgalmi körülmények (pl. torlódás) miatt nem történnek késések az útvonalon. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
trafficDelayInSeconds	integer	A valós idejű incidens(ek) által okozott becsült késés másodpercben a forgalmi információk alapján. A jövőbeni indulási idővel tervezett útvonalak esetében a késések mindig 0-ra esnek. Ha további utazási időt szeretne visszaadni különböző típusú forgalmi adatok használatával, a computeTravelTimeFor=all paramétert hozzá kell adni.
travelTimeInSeconds	integer	Becsült utazási idő másodpercben tulajdonság, amely magában foglalja a valós idejű forgalom miatti késést. Vegye figyelembe, hogy még ha a traffic=false travelTimeInSeconds is tartalmazza a forgalom miatti késést. Ha a DepartAt a jövőben jelenik meg, az utazási idő időfüggő előzmény forgalmi adatokkal lesz kiszámítva.

RouteOptimizedWaypoint

Optimalizált útpont objektum.

Name	Típus	Description
optimizedIndex	integer	Optimalizált útpontindex a rendszerből.
providedIndex	integer	A felhasználó által megadott útpontindex.

RouteReport

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

Name	Típus	Description
effectiveSettings	EffectiveSetting[]	A Route API meghívásakor használt hatályos paraméterek vagy adatok.

RouteSection

Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább az elemeket, a és endPointIndexsectionTypea elemeket startPointIndextartalmazza.

Name	Típus	Description
delayInSeconds	integer	Az incidens által okozott késés másodpercben.
effectiveSpeedInKmh	integer	Az incidens tényleges sebessége km/h-ban, átlagosan a teljes hosszában.
endPointIndex	integer	Az útvonal utolsó pontjának (0 eltolásának) indexe az útvonalra vonatkozik.
magnitudeOfDelay	DelayMagnitude	Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részleteinek lekérése API válaszmezőjének értékeinek felelnek meg.
sectionType	ResponseSectionType	A jelentett útvonalválasz szakasztípusai
simpleCategory	SimpleCategory	Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információkért lásd a "tec" (tec) című témakört.
startPointIndex	integer	Az útvonal első pontjának (0 eltolásának) indexe erre a szakaszra vonatkozik.
tec	RouteSectionTec	A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okoz.
travelMode	ResponseTravelMode	Utazási mód a számított útvonalhoz. Az érték akkor lesz beállítva, `other` ha a kért átviteli mód ebben a szakaszban nem lehetséges

RouteSectionTec

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

Name	Típus	Description
causes	RouteSectionTecCause[]	Tömb okai
effectCode	integer	A forgalomra gyakorolt hatás. A TPEG2-TEC szabványban meghatározott értéket tartalmaz a tec001:EffectCode táblában. A forgalom eseményeinek színkódját a súlyosságnak megfelelően lehet használni.

RouteSectionTecCause

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

Name	Típus	Description
mainCauseCode	integer	A forgalmi esemény fő oka. A TPEG2-TEC szabványban meghatározott értéket tartalmaz a tec002:CauseCode táblában.
subCauseCode	integer	A forgalmi esemény alkonyata. A mainCauseCode által definiált, a TPEG2-TEC szabványban meghatározott al-ok táblában lévő értéket tartalmazza.

RouteSummary

Összegző objektum

Name	Típus	Description
arrivalTime	string	Az útvonal vagy a láb becsült érkezési ideje. Az idő UTC-ben van.
departureTime	string	Az útvonal vagy a láb becsült indulási ideje. Az idő UTC-ben van.
lengthInMeters	integer	Hossz a Meters tulajdonságban
trafficDelayInSeconds	integer	A valós idejű incidens(ek) által okozott becsült késés másodpercben a forgalmi információk alapján. A jövőbeni indulási idővel tervezett útvonalak esetében a késések mindig 0-ra esnek. Ha további utazási időt szeretne visszaadni különböző típusú forgalmi adatok használatával, a computeTravelTimeFor=all paramétert hozzá kell adni.
travelTimeInSeconds	integer	Becsült utazási idő másodpercben tulajdonság, amely magában foglalja a valós idejű forgalom miatti késést. Vegye figyelembe, hogy még ha a traffic=false travelTimeInSeconds is tartalmazza a forgalom miatti késést. Ha a DepartAt a jövőben jelenik meg, az utazási idő időfüggő előzmény forgalmi adatokkal lesz kiszámítva.

SimpleCategory

Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információkért lásd a "tec" (tec) című témakört.

Name	Típus	Description
JAM	string	Forgalmi dugó.
OTHER	string	Egyéb.
ROAD_CLOSURE	string	Útlezárás.
ROAD_WORK	string	Közúti munka.

Summary

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

Name	Típus	Description
successfulRequests	integer	Sikeres kérelmek száma a kötegben
totalRequests	integer	A kötegben lévő kérések teljes száma

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