Route - Get Route Directions Batch

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do wysyłania partii zapytań do interfejsu API Get Route Directions w jednym żądaniu asynchronicznym.

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

Pobieranie asynchronicznych wyników usługi Batch

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać GET żądanie do punktu końcowego pobierania wsadowego. Ten adres URL pobierania można uzyskać z Location nagłówka pomyślnego POST żądania wsadowego 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 GET żądanie przy użyciu adresu URL pobierania.
Serwer odpowie na jedną z następujących czynności:

HTTP 202 Accepted — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie w pewnym czasie.

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

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna do żą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 summary zawiera składnik wskazujący, że były one częścią oryginalnego żądania wsadowego totalRequests , czyli successfulRequestszapytań, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę zawierającą batchItems odpowiedź dla każdego zapytania w żądaniu wsadowym. Element 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 elemencie batchItems zawiera statusCode i response pola. Każdy response element 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ć element code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem pomyślnym 1 i 1 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."
                }
            }
        }
    ]
}

GET https://atlas.microsoft.com/route/directions/batch/{format}?api-version=1.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	string	Identyfikator usługi Batch do wykonywania zapytań dotyczących operacji.
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ń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

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. Żądanie zaakceptowane: żądanie zostało zaakceptowane do przetwarzania. 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. Żądanie zaakceptowane: żądanie zostało zaakceptowane do przetwarzania. 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 protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może 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 pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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.

Uwagi

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

Element Authorization URL jest specyficzny 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 z 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 Sdk sieci Web 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 Omówienie platformy tożsamości firmy Microsoft.

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 tworzenia 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.

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

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w 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 SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu 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 sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Successfully retrieve the status for the route direction batch request

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/route/directions/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

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

Definicje

Nazwa	Opis
DelayMagnitude	Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi w interfejsie API pobierania szczegółów zdarzenia ruchu.
DrivingSide	Wskazuje po lewej stronie i po prawej stronie jazdy w punkcie manewru.
EffectiveSetting	Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API trasy.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GuidanceInstructionType	Typ instrukcji, np. obrót lub zmiana formy drogi.
GuidanceManeuver	Kod identyfikujący manewr.
JunctionType	Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond generowane są dwie oddzielne instrukcje dotyczące wejścia 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łaszanej odpowiedzi na trasę
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 wskazówki powiązane elementy. 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 przez właściwość firstInstructionIndex i lastInstructionIndex. Gdy komunikaty tekstowe z możliwością odczytu przez człowieka są żądane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwrócony, 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 dodatkowy element w zwróconej trasie.
RouteLegSummary	Obiekt podsumowania dla sekcji trasy.
RouteOptimizedWaypoint	Zoptymalizowany obiekt punktu drogi.
RouteReport	Zgłasza 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óły zdarzenia ruchu, używając definicji w standardzie TPEG2-TEC . Może zawierać element effectCode i powoduje elementy.
RouteSectionTecCause	Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. 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

DelayMagnitude

Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi w interfejsie API pobierania szczegółów zdarzenia ruchu.

Nazwa	Typ	Opis
0	string	Nieznane.
1	string	Małoletni.
2	string	Średnia.
3	string	Major.
4	string	Niezdefiniowany, używany do zamknięcia dróg i innych nieokreślonych opóźnień.

DrivingSide

Wskazuje po lewej stronie i po prawej stronie jazdy w punkcie manewru.

Nazwa	Typ	Opis
LEFT	string	Lewa strona.
RIGHT	string	Po prawej stronie.

EffectiveSetting

Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API trasy.

Nazwa	Typ	Opis
key	string	Nazwa użytego 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. obrót lub zmiana formy drogi.

Nazwa	Typ	Opis
DIRECTION_INFO	string	Informacje o kierunku.
LOCATION_ARRIVAL	string	Lokalizacja przyjazdu.
LOCATION_DEPARTURE	string	Lokalizacja odlotu.
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	Weź autostradę.
ENTER_HIGHWAY	string	Weź autostradę.
ENTER_MOTORWAY	string	Przejmij autostradę.
ENTRANCE_RAMP	string	Przejmij rampę.
FOLLOW	string	Następować.
KEEP_LEFT	string	Pozostaw w lewo.
KEEP_RIGHT	string	Zachowaj prawo.
MAKE_UTURN	string	Utwórz zwrot u-turn.
MOTORWAY_EXIT_LEFT	string	Wyjdź z lewego wyjścia.
MOTORWAY_EXIT_RIGHT	string	Wyjdź z prawej strony.
ROUNDABOUT_BACK	string	Pojechaj po rondzie.
ROUNDABOUT_CROSS	string	Skrzyżowanie ronda.
ROUNDABOUT_LEFT	string	Na rondzie zajmij się wyjściem po lewej stronie.
ROUNDABOUT_RIGHT	string	Na rondzie zajmij się wyjściem po prawej stronie.
SHARP_LEFT	string	Skręć 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	Wyjdź z wyjścia.
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.

JunctionType

Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond generowane są dwie oddzielne instrukcje dotyczące wejścia 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 indeks z podanej przez użytkownika sekwencji punktów waypoint 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	Zgłasza obowiązujące ustawienia używane w bieżącym wywołaniu.
routes	Route[]	Tablica tras

ResponseSectionType

Typy sekcji zgłaszanej odpowiedzi na trasę

Nazwa	Typ	Opis
CARPOOL	string	Odcinki trasy, które wymagają korzystania z carpool (HOV/High Occupancy Vehicle) pasów ruchu.
CAR_TRAIN	string	Odcinki trasy, które są samochodami lub pociągami.
COUNTRY	string	Sekcje wskazujące, w których krajach/regionach 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ą opłaty za przejazd.
TOLL_VIGNETTE	string	Odcinki trasy, które wymagają obecności płatnej winiety.
TRAFFIC	string	Sekcje trasy zawierające informacje o ruchu.
TRAVEL_MODE	string	Sekcje w odniesieniu do parametru `travelMode`żądania .
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 ścieżek rowerowych.
bus	string	Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym korzystanie tylko z pasów ruchu autobusowego. Funkcjonalność beta.
car	string	Zwrócone trasy są zoptymalizowane pod kątem samochodów.
motorcycle	string	Zwrócone trasy są zoptymalizowane pod kątem motocykli. Funkcjonalność beta.
other	string	Dany rodzaj 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. Funkcjonalność 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 samochodów dostawczych. Funkcjonalność beta.

Route

Nazwa	Typ	Opis
guidance	RouteGuidance	Zawiera wskazówki powiązane elementy. 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 wskazówki powiązane elementy. 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 wiadomością z następnej instrukcji. Czasami można połączyć dwie kolejne instrukcje w jedną instrukcję, co ułatwia śledzenie. W takim przypadku możliwa flagaCombineWithNext 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` Możliwa flagaCombineWithNext 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 połączoneMessage 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 leworęczną a prawą stronę jazdy w punkcie manewru.
exitNumber	string	Liczba wyjść autostrady podjęta przez obecny manewr. Jeśli wyjście zawiera wiele numerów zakończenia, zostaną one rozdzielone znakami "", a prawdopodobnie zagregowane przez "-", np. "10, 13–15".
instructionType	GuidanceInstructionType	Typ instrukcji, np. skręć lub zmienić 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	Czytelna dla człowieka wiadomość do 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 kolejnych znaczących segmentów dróg po manewrze lub drogach, które mają być obserwowane. 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 powinien być obserwowany.
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 STANY Zjednoczone, Kanada i Meksyk.
street	string	Nazwa ulicy następnego istotnego segmentu drogowego po manewrie lub ulicy, która powinna być obserwowana.
travelTimeInSeconds	integer	Szacowany czas podróży do punktu odpowiadającego parametrom routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Wskazuje kierunek instrukcji. Jeśli junctionType wskazuje instrukcję kolei: 180 = U-turn [-179, -1] = Lewy obrót 0 = Prosto na (obrót "0 stopni") [1, 179] = Skręć w prawo Jeśli junctionType wskazuje instrukcję rozdwoju: <0 — zachowaj lewo >0 — zachowaj prawo

RouteInstructionGroup

Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony przez właściwość firstInstructionIndex i lastInstructionIndex. Gdy komunikaty tekstowe z możliwością odczytu przez człowieka są żądane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwrócony, 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 podsumowania, gdy komunikaty tekstowe z możliwością odczytu przez człowieka są wymagane 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 dodatkowy element w zwróconej trasie.

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

RouteLegSummary

Obiekt podsumowania dla sekcji trasy.

Nazwa	Typ	Opis
arrivalTime	string	Szacowany czas przybycia trasy lub nogi. Godzina jest wyrażona w formacie UTC.
batteryConsumptionInkWh	number	Szacowane zużycie energii elektrycznej w godzinach kilowatów (kWh) przy użyciu modelu zużycia energii elektrycznej. Uwzględnione, jeśli właściwość vehicleEngineType jest ustawiona na wartość elektryczną i stałąSpeedConsumptionInkWhPerHundredkm jest określona. Wartość batteryConsumptionInkWh obejmuje odzyskaną energię elektryczną i w związku z tym może być ujemna (co wskazuje na uzyskanie energii). Jeśli określono zarówno wartość maxChargeInkWh, jak i currentChargeInkWh, rekonwalescacja zostanie ograniczona w celu zapewnienia, że poziom naładowania baterii nigdy nie przekracza maksymalnej wartości maxChargeInkWh. Jeśli w obliczeniu zużycia nie określono wartości maxChargeInkWh ani currentChargeInkWh, nieskrępowana rekonsuperacja jest zakładana.
departureTime	string	Szacowany czas odlotu dla trasy lub nogi. Godzina jest wyrażona w formacie UTC.
fuelConsumptionInLiters	number	Szacowane zużycie paliwa w litrach przy użyciu modelu zużycia spalania. Uwzględnione, jeśli parametr vehicleEngineType jest ustawiony na spalanie , a określono wartość constantSpeedConsumptionInLitersPerHundredkm. Wartość będzie nieujemna.
historicTrafficTravelTimeInSeconds	integer	Szacowany czas podróży obliczany przy użyciu danych historycznych zależnych od czasu. Uwzględnione 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ń na trasie ze względu na warunki ruchu (np. przeciążenie). Uwzględnione 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 wtedy, gdy ruch =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 punktu drogi z systemu.
providedIndex	integer	Indeks punktów drogi udostępniany przez użytkownika.

RouteReport

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

Nazwa	Typ	Opis
effectiveSettings	EffectiveSetting[]	Skuteczne 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 zdarzeniem.
effectiveSpeedInKmh	integer	Efektywna prędkość zdarzenia w km/h, średnia 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 interfejsu API Pobierz szczegóły zdarzenia ruchu.
sectionType	ResponseSectionType	Typy sekcji zgłoszonej odpowiedzi trasy
simpleCategory	SimpleCategory	Typ zdarzenia. Obecnie może 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` wartość , jeśli żądany tryb transportu nie jest możliwy w tej sekcji

RouteSectionTec

Szczegóły zdarzenia ruchu, używając definicji w standardzie TPEG2-TEC . Może zawierać element effectCode 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. 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	Podkatazy zdarzenia ruchu. Zawiera wartość w tabeli przyczyny podrzędnej zdefiniowanej przez element mainCauseCode zgodnie z definicją w standardzie TPEG2-TEC .

RouteSummary

Obiekt podsumowania

Nazwa	Typ	Opis
arrivalTime	string	Szacowany czas przybycia trasy lub nogi. Godzina jest wyrażona w formacie UTC.
departureTime	string	Szacowany czas odlotu dla trasy lub nogi. Godzina jest wyrażona 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 wtedy, gdy ruch =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	Inne.
ROAD_CLOSURE	string	Zamknięcie drogi.
ROAD_WORK	string	Prace drogowe.

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 - Get Route Directions Batch

Pobieranie asynchronicznych wyników usługi Batch

Model odpowiedzi wsadowej

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Uwagi

Zakresy

subscription-key

SAS Token

Przykłady

Successfully retrieve the status for the route direction batch request

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Dodatkowe zasoby