Route - Post Route Directions Batch

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Użyj polecenia , aby wysłać partię zapytań do interfejsu API Get Route Directions w jednym żądaniu asynchronicznym.

Interfejs API Post Route Directions Batch to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania asynchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w żądaniu synchronicznym, zobacz Post Route Directions Batch Sync.

Przesyłanie asynchronicznego żądania usługi Batch

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań tras

Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobrań).
Asynchroniczny interfejs API jest zoptymalizowany pod kątem niezawodności i nie oczekuje się, że upłynął limit czasu.
Liczba elementów wsadowych jest ograniczona do 700 dla tego interfejsu API.

Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

Należy pamiętać, że asynchroniczne żądanie wsadowe jest długotrwałą operacją. Oto typowa sekwencja operacji:

Klient wysyła żądanie usługi Batch Directions Routes POST do usługi Azure Maps.

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

Serwer odpowie jednym z następujących elementów:

202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane.

Error HTTP — wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być 400 Bad Request lub inny kod stanu Error.
Jeśli żądanie wsadowe zostało pomyślnie zaakceptowane, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:

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

Klient wysyła żądanie GET na adres URL pobierania uzyskany w kroku 3 w celu pobrania wyników wsadowych.

Treść POST dla żądania wsadowego

Aby wysłać wskazówki tras zapytania, użyjesz żądania POST, w którym treść żądania będzie zawierać tablicę batchItems w formacie json, a nagłówek Content-Type zostanie ustawiony na wartość application/json. Oto przykładowa treść żądania zawierająca 3 wskazówki dotyczące tras zapytań:

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

Wskazówki kierowania zapytania w partii to tylko częściowy adres URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może zaakceptować dowolny z obsługiwanych wskazówek trasparametrów identyfikatora URI. Wartości ciągów w kierunkach trasy kwerendy muszą być prawidłowo uniknięte (np. "znak powinien zostać uniknięta znakiem \ ), a także powinien być prawidłowo zakodowany pod adresem URL.

Asynchroniczny interfejs API umożliwia obiektowi wywołującym wykonywanie partii do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytania.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

Klient wysyła żądanie GET przy użyciu adresu URL pobierania .
Serwer odpowie jednym z następujących elementów:

202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.
Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

{
    "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/json?api-version=1.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Treść żądania

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouteDirectionsBatchResult	Pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.
202 Accepted		Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowane żądanie: żądanie zostało zaakceptowane do przetworzenia. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Nazwa

Typ

Opis

200 OK

RouteDirectionsBatchResult

Pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

202 Accepted

Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowane żądanie: żądanie zostało zaakceptowane do przetworzenia. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Notatki

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.

Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Successfully submit a route direction batch request

Przykładowe żądanie

HTTP

POST https://atlas.microsoft.com/route/directions/batch/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"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 202

operation-Location: URL to download the results of the long-running batch request.

Definicje

Nazwa	Opis
BatchRequest	Ten typ reprezentuje treść żądania dla usługi Batch.
BatchRequestItem	Obiekt żądania usługi Batch
DelayMagnitude	Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi Get Traffic Incident Detail API.
DrivingSide	Wskazuje lewą i prawą stronę jazdy w punkcie manewru.
EffectiveSetting	Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API usługi Route.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GuidanceInstructionType	Typ instrukcji, np. skręć lub zmień formę drogi.
GuidanceManeuver	Kod identyfikujący manewr.
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
JunctionType	Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond są generowane dwie oddzielne instrukcje dotyczące wjazdu i opuszczenia ronda.
LatLongPair	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
Response	Wynik zapytania. RouteDirections, jeśli zapytanie zostało ukończone pomyślnie, ErrorResponse w przeciwnym razie.
ResponseSectionType	Typy sekcji zgłoszonej odpowiedzi trasy
ResponseTravelMode	Tryb podróży dla trasy obliczeniowej. Wartość zostanie ustawiona na `other`, jeśli żądany tryb transportu nie jest możliwy w tej sekcji
Route
RouteDirectionsBatchItem	Element zwrócony z wywołania usługi Route Directions Batch.
RouteDirectionsBatchResult	Ten obiekt jest zwracany z pomyślnego wywołania usługi Route Directions Batch.
RouteGuidance	Zawiera elementy powiązane ze wskazówkami. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne.
RouteInstruction	Zestaw atrybutów opisujących manewr, np. "Turn right", "Keep left", "Take the ferry", "Take the highway", "Arrive".
RouteInstructionGroup	Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony za pomocą parametru firstInstructionIndex i lastInstructionIndex. Gdy żądania dotyczące komunikatów tekstowych z możliwością odczytu przez człowieka są wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas w grupie instrukcji jest zwracany komunikat podsumowania, gdy jest dostępny.
RouteLeg	Opis części trasy składający się z listy punktów. Każdy dodatkowy punkt waypoint podany w żądaniu spowoduje dodatkową nogę w zwróconej trasie.
RouteLegSummary	Obiekt podsumowania sekcji trasy.
RouteOptimizedWaypoint	Zoptymalizowany obiekt punktu drogi.
RouteReport	Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu.
RouteSection	Sekcje trasy zawierają dodatkowe informacje o częściach trasy. Każda sekcja zawiera co najmniej elementy `startPointIndex`, `endPointIndex`i `sectionType`.
RouteSectionTec	Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC. Może zawierać efektCode i powoduje elementy.
RouteSectionTecCause	Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. Może służyć do definiowania ikonografii i opisów.
RouteSummary	Obiekt podsumowania
SimpleCategory	Typ zdarzenia. Obecnie może to być JAM, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec".
Summary	Podsumowanie wyników żądania wsadowego

BatchRequest

Ten typ reprezentuje treść żądania dla usługi Batch.

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

BatchRequestItem

Obiekt żądania usługi Batch

Nazwa	Typ	Opis
query	string	Ten parametr zawiera ciąg zapytania używany do wykonywania operacji geokodowania bez struktury. Ciąg zapytania zostanie przekazany dosłowny do interfejsu API wyszukiwania na potrzeby przetwarzania.

DelayMagnitude

Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi Get Traffic Incident Detail API.

Nazwa	Typ	Opis
0	string	Nieznany.
1	string	Małoletni.
2	string	Umiarkowany.
3	string	Major.
4	string	Niezdefiniowane, używane do zamknięcia dróg i innych nieokreślonych opóźnień.

DrivingSide

Wskazuje lewą i prawą stronę jazdy w punkcie manewru.

Nazwa	Typ	Opis
LEFT	string	Lewa strona.
RIGHT	string	Prawa strona.

EffectiveSetting

Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API usługi Route.

Nazwa	Typ	Opis
key	string	Nazwa używanego parametru.
value	string	Wartość użytego parametru.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GuidanceInstructionType

Typ instrukcji, np. skręć lub zmień formę drogi.

Nazwa	Typ	Opis
DIRECTION_INFO	string	Informacje o kierunku.
LOCATION_ARRIVAL	string	Lokalizacja przyjazdu.
LOCATION_DEPARTURE	string	Lokalizacja wyjazdu.
LOCATION_WAYPOINT	string	Lokalizacja punktu drogi.
ROAD_CHANGE	string	Zmiana drogi.
TURN	string	Skręcić.

GuidanceManeuver

Kod identyfikujący manewr.

Nazwa	Typ	Opis
ARRIVE	string	Przybyłeś.
ARRIVE_LEFT	string	Przybyłeś. Miejsce docelowe znajduje się po lewej stronie.
ARRIVE_RIGHT	string	Przybyłeś. Miejsce docelowe znajduje się po prawej stronie.
BEAR_LEFT	string	Niedźwiedź w lewo.
BEAR_RIGHT	string	Niedźwiedź w prawo.
DEPART	string	Opuszczać.
ENTER_FREEWAY	string	Przejeżż na autostradę.
ENTER_HIGHWAY	string	Zajmij się autostradą.
ENTER_MOTORWAY	string	Autostrada.
ENTRANCE_RAMP	string	Zajmij się rampą.
FOLLOW	string	Następować.
KEEP_LEFT	string	Pozostaw w lewo.
KEEP_RIGHT	string	Zachowaj rację.
MAKE_UTURN	string	Wykonaj zakręt u.
MOTORWAY_EXIT_LEFT	string	Wyjdź z lewego wyjścia.
MOTORWAY_EXIT_RIGHT	string	Wyjdź z prawej strony.
ROUNDABOUT_BACK	string	Chodź po rondzie.
ROUNDABOUT_CROSS	string	Przejeżżdę przez rondę.
ROUNDABOUT_LEFT	string	Na rondzie zajmij się wyjściem po lewej stronie.
ROUNDABOUT_RIGHT	string	Na rondzie wyjdź z prawej strony.
SHARP_LEFT	string	Skręć ostro w lewo.
SHARP_RIGHT	string	Skręć ostro w prawo.
STRAIGHT	string	Trzymaj się prosto.
SWITCH_MAIN_ROAD	string	Przejdź do głównej drogi.
SWITCH_PARALLEL_ROAD	string	Przełącz się na równoległą drogę.
TAKE_EXIT	string	Weź wyjście.
TAKE_FERRY	string	Weź prom.
TRY_MAKE_UTURN	string	Spróbuj wykonać u-turn.
TURN_LEFT	string	Skręć w lewo.
TURN_RIGHT	string	Skręć w prawo.
WAYPOINT_LEFT	string	Osiągnięto punkt drogi. Jest po lewej stronie.
WAYPOINT_REACHED	string	Osiągnięto punkt drogi.
WAYPOINT_RIGHT	string	Osiągnięto punkt drogi. Jest po prawej stronie.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko format json.

Nazwa	Typ	Opis
json	string	format wymiany danych notacji obiektów JavaScript

JunctionType

Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond są generowane dwie oddzielne instrukcje dotyczące wjazdu i opuszczenia ronda.

Nazwa	Typ	Opis
BIFURCATION	string	Rozwidlenia
REGULAR	string	regularny
ROUNDABOUT	string	rondo

LatLongPair

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.

Nazwa	Typ	Opis
latitude	number	Właściwość Szerokość geograficzna
longitude	number	Właściwość Długość geograficzna

Response

Wynik zapytania. RouteDirections, jeśli zapytanie zostało ukończone pomyślnie, ErrorResponse w przeciwnym razie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.
formatVersion	string	Formatowanie właściwości Version
optimizedWaypoints	RouteOptimizedWaypoint[]	Zoptymalizowana sekwencja punktów drogi. Przedstawia on indeks z sekwencji punktów drogi dla oryginalnej i zoptymalizowanej listy. Na przykład odpowiedź: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` oznacza, że oryginalna sekwencja to [0, 1, 2] i zoptymalizowana sekwencja to [1, 2, 0]. Ponieważ indeks zaczyna się od 0, oryginalny jest "pierwszy, drugi, trzeci", podczas gdy zoptymalizowany jest "drugi, trzeci, pierwszy".
report	RouteReport	Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu.
routes	Route[]	Tablica tras

ResponseSectionType

Typy sekcji zgłoszonej odpowiedzi trasy

Nazwa	Typ	Opis
CARPOOL	string	Odcinki trasy, które wymagają korzystania z pul samochodowych (HOV/High Occupancy Vehicle) pasów ruchu.
CAR_TRAIN	string	Odcinki trasy, które są samochodami lub pociągami.
COUNTRY	string	Sekcje wskazujące kraje/regiony, w których znajduje się trasa.
FERRY	string	Odcinki trasy, które są promami.
MOTORWAY	string	Odcinki trasy, które są autostradami.
PEDESTRIAN	string	Odcinki trasy, które są odpowiednie tylko dla pieszych.
TOLL_ROAD	string	Odcinki trasy, które wymagają zapłaty opłaty za opłatę.
TOLL_VIGNETTE	string	Odcinki trasy, które wymagają obecności płatnej vignette.
TRAFFIC	string	Sekcje trasy zawierającej informacje o ruchu.
TRAVEL_MODE	string	Sekcje w odniesieniu do parametru żądania `travelMode`.
TUNNEL	string	Sekcje trasy, które są tunelami.
URBAN	string	Odcinki trasy, które znajdują się na obszarach miejskich.

ResponseTravelMode

Tryb podróży dla trasy obliczeniowej. Wartość zostanie ustawiona na other, jeśli żądany tryb transportu nie jest możliwy w tej sekcji

Nazwa	Typ	Opis
bicycle	string	Zwrócone trasy są zoptymalizowane pod kątem rowerów, w tym korzystania z pasów rowerowych.
bus	string	Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym korzystanie tylko z pasów ruchu autobusowego. Funkcje beta.
car	string	Zwrócone trasy są zoptymalizowane pod kątem samochodów.
motorcycle	string	Zwrócone trasy są zoptymalizowane pod kątem motocykli. Funkcje beta.
other	string	Dany środek transportu nie jest możliwy w tej sekcji
pedestrian	string	Zwrócone trasy są zoptymalizowane pod kątem pieszych, w tym korzystania z chodników.
taxi	string	Zwrócone trasy są zoptymalizowane pod kątem taksówek. Funkcje beta.
truck	string	Zwrócone trasy są zoptymalizowane pod kątem pojazdów komercyjnych, takich jak dla ciężarówek.
van	string	Zwrócone trasy są zoptymalizowane pod kątem furgonetek. Funkcje beta.

Route

Nazwa	Typ	Opis
guidance	RouteGuidance	Zawiera elementy powiązane ze wskazówkami. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne.
legs	RouteLeg[]	Tablica nogi
sections	RouteSection[]	Tablica sekcji
summary	RouteSummary	Obiekt podsumowania

RouteDirectionsBatchItem

Element zwrócony z wywołania usługi Route Directions Batch.

Nazwa	Typ	Opis
response	Response	Wynik zapytania. RouteDirections, jeśli zapytanie zostało ukończone pomyślnie, ErrorResponse w przeciwnym razie.
statusCode	integer	Kod stanu żądania HTTP.

RouteDirectionsBatchResult

Ten obiekt jest zwracany z pomyślnego wywołania usługi Route Directions Batch.

Nazwa	Typ	Opis
batchItems	RouteDirectionsBatchItem[]	Tablica zawierająca wyniki wsadowe.
summary	Summary	Podsumowanie wyników żądania wsadowego

RouteGuidance

Zawiera elementy powiązane ze wskazówkami. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne.

Nazwa	Typ	Opis
instructionGroups	RouteInstructionGroup[]	Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane.
instructions	RouteInstruction[]	Lista instrukcji opisujących manewry.

RouteInstruction

Zestaw atrybutów opisujących manewr, np. "Turn right", "Keep left", "Take the ferry", "Take the highway", "Arrive".

Nazwa	Typ	Opis
combinedMessage	string	Czytelny dla człowieka komunikat manewru w połączeniu z komunikatem z następnej instrukcji. Czasami można połączyć dwie kolejne instrukcje w jedną instrukcję, co ułatwia wykonywanie. W takim przypadku flaga possibleCombineWithNext będzie mieć wartość true. Na przykład: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` Flaga possibleCombineWithNext w instrukcji 10 jest prawdziwa. Wskazuje to klientom zakodowanych wskazówek, że można je połączyć z instrukcją 11. Instrukcje zostaną automatycznie połączone dla klientów żądających wskazówek czytelnych dla człowieka. Pole combinedMessage zawiera połączony komunikat: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3-znakowy kod kraju ISO 3166-1 alfa-3. Np. USA.
drivingSide	DrivingSide	Wskazuje lewą i prawą stronę jazdy w punkcie manewru.
exitNumber	string	Liczba wyjść autostrady podjęta przez obecny manewr. Jeśli wyjście ma wiele numerów wyjścia, zostaną one oddzielone ciągiem "", a prawdopodobnie zagregowane przez "-", np. "10, 13-15".
instructionType	GuidanceInstructionType	Typ instrukcji, np. skręć lub zmień formę drogi.
junctionType	JunctionType	Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond są generowane dwie oddzielne instrukcje dotyczące wjazdu i opuszczenia ronda.
maneuver	GuidanceManeuver	Kod identyfikujący manewr.
message	string	Czytelny dla człowieka komunikat manewru.
point	LatLongPair	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
pointIndex	integer	Indeks punktu na liście wieloliniowych "punktów" odpowiadający punktowi instrukcji.
possibleCombineWithNext	boolean	Opcjonalnie można połączyć instrukcję z następnym. Może to służyć do tworzenia komunikatów, takich jak "Skręć w lewo, a następnie skręć w prawo".
roadNumbers	string[]	Numery drogowe następnych znaczących segmentów dróg po manewrze lub drogach, które mają być przestrzegane. Przykład: ["E34", "N205"]
roundaboutExitNumber	integer	Wskazuje to, które wyjście należy podjąć na rondzie.
routeOffsetInMeters	integer	Odległość od początku trasy do punktu instrukcji.
signpostText	string	Tekst na znaku, który jest najbardziej istotny dla manewru, lub kierunku, który należy wykonać.
stateCode	string	Podział (np. stan) kraju reprezentowany przez drugą część kodu ISO 3166- 2. Jest to dostępne tylko dla niektórych krajów/regionów, takich jak USA, Kanada i Meksyk.
street	string	Nazwa ulicy następnego znaczącego segmentu drogowego po manewrie lub ulicy, która powinna być podążana.
travelTimeInSeconds	integer	Szacowany czas podróży do punktu odpowiadającego routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Wskazuje kierunek instrukcji. Jeśli junctionType wskazuje instrukcję kolei: 180 = U-turn [-179, -1] = Lewy obrót 0 = prosty (obrót "0 stopni") [1, 179] = Prawy obrót Jeśli junctionType wskazuje instrukcję bifurcation: <0 — pozostaw w lewo >0 — zachowaj prawo

RouteInstructionGroup

Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony za pomocą parametru firstInstructionIndex i lastInstructionIndex. Gdy żądania dotyczące komunikatów tekstowych z możliwością odczytu przez człowieka są wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas w grupie instrukcji jest zwracany komunikat podsumowania, gdy jest dostępny.

Nazwa	Typ	Opis
firstInstructionIndex	integer	Indeks pierwszej instrukcji w instrukcjach i należących do tej grupy.
groupLengthInMeters	integer	Długość grupy.
groupMessage	string	Komunikat podsumowujący, gdy zażądano wiadomości tekstowych z możliwością odczytu przez człowieka w celu uzyskania wskazówek (instrukcjaType=tekst lub tag).
lastInstructionIndex	integer	Indeks ostatniej instrukcji w instrukcjach i należących do tej grupy.

RouteLeg

Opis części trasy składający się z listy punktów. Każdy dodatkowy punkt waypoint podany w żądaniu spowoduje dodatkową nogę w zwróconej trasie.

Nazwa	Typ	Opis
points	LatLongPair[]	Tablica punktów
summary	RouteLegSummary	Obiekt podsumowania sekcji trasy.

RouteLegSummary

Obiekt podsumowania sekcji trasy.

Nazwa	Typ	Opis
arrivalTime	string	Szacowany czas przybycia trasy lub nogi. Czas jest w formacie UTC.
batteryConsumptionInkWh	number	Szacowane zużycie energii elektrycznej w kilowatach (kWh) przy użyciu modelu zużycia energii elektrycznej. Uwzględnione, jeśli parametr vehicleEngineType ma ustawioną wartość elektryczną i stałąSpeedConsumptionInkWhPerHundredkm jest określona. Wartość bateriiConsumptionInkWh obejmuje odzyskaną energię elektryczną i dlatego może być ujemna (co wskazuje na uzyskanie energii). Jeśli określono zarówno wartość maxChargeInkWh, jak i currentChargeInkWh, reuperacja zostanie ograniczona w celu zapewnienia, że poziom naładowania baterii nigdy nie przekracza maksymalnej wartości MaxChargeInkWh. Jeśli nie określono parametru maxChargeInkWh ani currentChargeInkWh, w obliczeniu zużycia przyjmuje się, że nieskrępowana reuperacja jest przyjmowana.
departureTime	string	Szacowany czas odlotu trasy lub nogi. Czas jest w formacie UTC.
fuelConsumptionInLiters	number	Szacowane zużycie paliwa w litrach przy użyciu modelu zużycia spalania. Uwzględnione, jeśli parametr vehicleEngineType ma ustawioną wartość spalania i określono stałąSpeedConsumptionInLitersPerHundredkm. Wartość będzie nieujemna.
historicTrafficTravelTimeInSeconds	integer	Szacowany czas podróży obliczany przy użyciu danych historycznych zależnych od czasu. Uwzględniane tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu.
lengthInMeters	integer	Długość w metrach, właściwość
liveTrafficIncidentsTravelTimeInSeconds	integer	Szacowany czas podróży obliczany przy użyciu danych prędkości w czasie rzeczywistym. Uwzględniane tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu.
noTrafficTravelTimeInSeconds	integer	Szacowany czas podróży obliczony tak, jakby nie było opóźnień w trasie ze względu na warunki ruchu (np. przeciążenie). Uwzględniane tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu.
trafficDelayInSeconds	integer	Szacowane opóźnienie w sekundach spowodowane zdarzeniami w czasie rzeczywistym zgodnie z informacjami o ruchu. W przypadku tras planowanych z czasem odlotu w przyszłości opóźnienia są zawsze 0. Aby zwrócić dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu, parametr computeTravelTimeFor=wszystkie należy dodać.
travelTimeInSeconds	integer	Szacowany czas podróży w sekundach, który obejmuje opóźnienie spowodowane ruchem w czasie rzeczywistym. Należy pamiętać, że nawet gdy traffic=false travelTimeInSeconds nadal zawiera opóźnienie spowodowane ruchem. Jeśli funkcja DepartAt jest w przyszłości, czas podróży jest obliczany przy użyciu danych historycznych zależnych od czasu.

RouteOptimizedWaypoint

Zoptymalizowany obiekt punktu drogi.

Nazwa	Typ	Opis
optimizedIndex	integer	Zoptymalizowany indeks punktów z systemu.
providedIndex	integer	Indeks punktu drogi udostępniany przez użytkownika.

RouteReport

Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu.

Nazwa	Typ	Opis
effectiveSettings	EffectiveSetting[]	Obowiązujące parametry lub dane używane podczas wywoływania tego interfejsu API trasy.

RouteSection

Sekcje trasy zawierają dodatkowe informacje o częściach trasy. Każda sekcja zawiera co najmniej elementy startPointIndex, endPointIndexi sectionType.

Nazwa	Typ	Opis
delayInSeconds	integer	Opóźnienie w sekundach spowodowane przez zdarzenie.
effectiveSpeedInKmh	integer	Efektywna prędkość zdarzenia w km/h, średnio na całej długości.
endPointIndex	integer	Indeks ostatniego punktu (przesunięcie 0) w trasie, do których ma zastosowanie ta sekcja.
magnitudeOfDelay	DelayMagnitude	Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi Get Traffic Incident Detail API.
sectionType	ResponseSectionType	Typy sekcji zgłoszonej odpowiedzi trasy
simpleCategory	SimpleCategory	Typ zdarzenia. Obecnie może to być JAM, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec".
startPointIndex	integer	Indeks pierwszego punktu (przesunięcie 0) w trasie, do których ma zastosowanie ta sekcja.
tec	RouteSectionTec	Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC. Może zawierać efektCode i powoduje elementy.
travelMode	ResponseTravelMode	Tryb podróży dla trasy obliczeniowej. Wartość zostanie ustawiona na `other`, jeśli żądany tryb transportu nie jest możliwy w tej sekcji

RouteSectionTec

Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC. Może zawierać efektCode i powoduje elementy.

Nazwa	Typ	Opis
causes	RouteSectionTecCause[]	Powoduje tablicę
effectCode	integer	Wpływ na przepływ ruchu. Zawiera wartość w tabeli tec001:EffectCode, zgodnie z definicją w standardzie TPEG2-TEC. Może służyć do kolorowania zdarzeń ruchu zgodnie z ważnością.

RouteSectionTecCause

Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. Może służyć do definiowania ikonografii i opisów.

Nazwa	Typ	Opis
mainCauseCode	integer	Główną przyczyną zdarzenia ruchu. Zawiera wartość w tabeli tec002:CauseCode zgodnie z definicją w standardzie TPEG2-TEC.
subCauseCode	integer	Subcause zdarzenia ruchu. Zawiera wartość w tabeli przyczyny podrzędnej zdefiniowanej przez mainCauseCode zgodnie z definicją w standardzie TPEG2-TEC.

RouteSummary

Obiekt podsumowania

Nazwa	Typ	Opis
arrivalTime	string	Szacowany czas przybycia trasy lub nogi. Czas jest w formacie UTC.
departureTime	string	Szacowany czas odlotu trasy lub nogi. Czas jest w formacie UTC.
lengthInMeters	integer	Długość w metrach, właściwość
trafficDelayInSeconds	integer	Szacowane opóźnienie w sekundach spowodowane zdarzeniami w czasie rzeczywistym zgodnie z informacjami o ruchu. W przypadku tras planowanych z czasem odlotu w przyszłości opóźnienia są zawsze 0. Aby zwrócić dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu, parametr computeTravelTimeFor=wszystkie należy dodać.
travelTimeInSeconds	integer	Szacowany czas podróży w sekundach, który obejmuje opóźnienie spowodowane ruchem w czasie rzeczywistym. Należy pamiętać, że nawet gdy traffic=false travelTimeInSeconds nadal zawiera opóźnienie spowodowane ruchem. Jeśli funkcja DepartAt jest w przyszłości, czas podróży jest obliczany przy użyciu danych historycznych zależnych od czasu.

SimpleCategory

Typ zdarzenia. Obecnie może to być JAM, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec".

Nazwa	Typ	Opis
JAM	string	Korek.
OTHER	string	Inny.
ROAD_CLOSURE	string	Zamknięcie drogi.
ROAD_WORK	string	Praca drogowa.

Summary

Podsumowanie wyników żądania wsadowego

Nazwa	Typ	Opis
successfulRequests	integer	Liczba pomyślnych żądań w partii
totalRequests	integer	Łączna liczba żądań w partii

Udostępnij za pośrednictwem

Route - Post Route Directions Batch

Przesyłanie asynchronicznego żądania usługi Batch

Treść POST dla żądania wsadowego

Pobieranie wyników asynchronicznych wsadowych

Model odpowiedzi wsadowej

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Notatki

Zakresy

subscription-key

SAS Token

Przykłady

Successfully submit a route direction batch request

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Dodatkowe zasoby