Route - Get Route Directions

Usługa:: Maps

Wersja interfejsu API:: 1.0

Umożliwia obliczanie trasy między określonym punktem początkowym a docelowym, przechodzącej przez dowolne określone punkty trasy.

Uwaga / Notatka

wycofywanie usługi Azure Maps Route v1

Usługa Azure Maps Route v1 jest teraz przestarzała i zostanie wycofana w dniu 3/31/28. Aby uniknąć przerw w działaniu usługi, należy zaktualizować wszystkie wywołania usługi Route v1, aby używać usługi Route v2025-01-01 do 31.31.28. Aby uzyskać więcej informacji, zobacz Migrate Azure Maps Route 1.0 APIs.

Interfejs API Get Route Directions to żądanie GET HTTP, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli określono. Trasa uwzględnia takie czynniki jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.

Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje turn by turn, w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdów. Aby uzyskać więcej informacji, zobacz Consumption Model.

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

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
query	query	True	string	Współrzędne, przez które jest obliczana trasa, rozdzielana dwukropkiem. Wymagana jest minimalna liczba dwóch współrzędnych. Pierwszy z nich to źródło, a ostatni to miejsce docelowe trasy. Opcjonalne współrzędne pośrednie działają jako punkty trasy na trasie. Możesz minąć do 150 punktów trasy.
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Określa wydajność konwersji energii chemicznej przechowywanej w paliwie na energię kinetyczną, gdy pojazd przyspiesza (tj. Kinetic EnergyGained/ChemicalEnerGained/ChemicalEnersumed). Chemical EnergyConsumed jest uzyskiwany przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaEnergiiInMJoulesPerLiter. Musi być sparowana z decelerationEfficiency. Dozwolony zakres wartości to od 0,0 do 1/decelerationEfficiency. Rozsądne wartości: dla modelu spalania : 0,33 dla modelu elektrycznego: 0,66
alternativeType	query		AlternativeRouteType	Kontroluje optymalność, w odniesieniu do podanych kryteriów planowania, obliczonych alternatyw w porównaniu z trasą referencyjną.
arriveAt	query		string (date-time)	Data i godzina przybycia do punktu docelowego sformatowane jako wartość `dateTime` zdefiniowana w RFC 3339, sekcja 5.6, z opcjonalnym przesunięciem strefy czasowej. Jeśli przesunięcie strefy czasowej nie zostanie określone, przyjmuje się, że jest to przesunięcie punktu docelowego. Przykłady: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Nie można użyć parametru `arriveAt` w połączeniu z `departAt`, `minDeviationDistance` lub `minDeviationTime`.
auxiliaryPowerInkW	query		number (double)	Określa ilość energii zużywanej do utrzymania systemów pomocniczych w kilowatach (kW). Może służyć do określania zużycia ze względu na urządzenia i systemy, takie jak systemy AC, radio, ogrzewanie itp. Rozsądne wartości: 1,7
auxiliaryPowerInLitersPerHour	query		number (double)	Określa ilość paliwa zużytego do utrzymania systemów pomocniczych pojazdu, w litrach na godzinę. Może służyć do określania zużycia ze względu na urządzenia i systemy, takie jak systemy AC, radio, ogrzewanie itp. Rozsądne wartości: 0,2
avoid	query		RouteAvoidType[]	Określa element, którego obliczenie trasy powinno próbować uniknąć podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=highways&avoid=tollRoads&avoid=promy". W żądaniach zakresu tras wartość jużUsedRoads nie może być używana.
computeBestOrder	query		boolean	Zmień kolejność punktów drogi tras przy użyciu szybkiego algorytmu heurystycznego, aby zmniejszyć długość trasy. Daje najlepsze wyniki w połączeniu z routeType najkrótszym. Zwróć uwagę, że źródło i miejsce docelowe są wykluczone ze zoptymalizowanych indeksów punktów waypoint. Aby uwzględnić źródło i miejsce docelowe w odpowiedzi, zwiększ wszystkie indeksy o 1, aby uwzględnić źródło, a następnie dodaj miejsce docelowe jako końcowy indeks. Możliwe wartości to true lub false. Prawda oblicza lepszą kolejność, jeśli jest to możliwe, ale nie może być używana w połączeniu z wartością maxAlternatives większą niż 0 lub w połączeniu z punktami kierunkowymi. Wartość False będzie używać lokalizacji w podanej kolejności i nie może być używana w połączeniu z routeRepresentation brak.
computeTravelTimeFor	query		ComputeTravelTime	Określa, czy zwracać dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu (brak, historyczny, na żywo), a także domyślny najlepszy szacowany czas podróży.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Określa składnik zależny od szybkości zużycia. Podana jako nieurządkowana lista par szybkości/szybkości użycia. Lista definiuje punkty na krzywej zużycia. Wskaźniki zużycia dla szybkości, które nie znajdują się na liście, znajdują się w następujący sposób: według interpolacji liniowej, jeśli dana prędkość leży między dwiema prędkościami na liście przez ekstrapolację liniową w przeciwnym razie przy założeniu stałej (ΔConsumption/ΔSpeed) określonej przez najbliższe dwa punkty na liście Lista musi zawierać od 1 do 25 punktów (włącznie) i może nie zawierać zduplikowanych punktów dla tej samej prędkości. Jeśli zawiera tylko jeden punkt, wskaźnik zużycia tego punktu jest używany bez dalszego przetwarzania. Zużycie określone dla największej prędkości musi być większe lub równe z przedostatnią największą prędkością. Gwarantuje to, że ekstrapolacja nie prowadzi do ujemnych wskaźników zużycia. Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia dla każdej mniejszej prędkości. Prawidłowy zakres wartości zużycia (wyrażony w kWh/100km) wynosi od 0,01 do 10000,0. Rozsądne wartości: 50,8.2:130,21.3 Ten parametr jest wymagany dla Modelu zużycia energii elektrycznej.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Określa składnik zależny od szybkości zużycia. Podana jako lista nieuprzedażych par szybkości rozdzielonych dwukropkiem & par zużycia. Lista definiuje punkty na krzywej zużycia. Wskaźniki zużycia dla szybkości, które nie znajdują się na liście, znajdują się w następujący sposób: według interpolacji liniowej, jeśli dana prędkość leży między dwiema prędkościami na liście przez ekstrapolację liniową w przeciwnym razie przy założeniu stałej (ΔConsumption/ΔSpeed) określonej przez najbliższe dwa punkty na liście Lista musi zawierać od 1 do 25 punktów (włącznie) i może nie zawierać zduplikowanych punktów dla tej samej prędkości. Jeśli zawiera tylko jeden punkt, wskaźnik zużycia tego punktu jest używany bez dalszego przetwarzania. Zużycie określone dla największej prędkości musi być większe lub równe z przedostatnią największą prędkością. Gwarantuje to, że ekstrapolacja nie prowadzi do ujemnych wskaźników zużycia. Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia dla każdej mniejszej prędkości. Prawidłowy zakres wartości zużycia (wyrażony w l/100km) wynosi od 0,01 do 10000,0. Rozsądne wartości: 50,6.3:130,11.5 Uwaga: ten parametr jest wymagany dla modelu zużycia spalania.
currentChargeInkWh	query		number (double)	Określa bieżące zasilanie energii elektrycznej w kilowatach godzin (kWh). Ten parametr współistnieje z parametrem maxChargeInkWh. Dozwolony zakres wartości to 0,0 do maxChargeInkWh. Rozsądne wartości: 43
currentFuelInLiters	query		number (double)	Określa bieżącą dostawę paliwa w litrach. Rozsądne wartości: 55
decelerationEfficiency	query		number (double) minimum: 0 maximum: 1	Określa wydajność konwersji energii kinetycznej w celu zaoszczędzenia (nieużytowanego) paliwa, gdy pojazd zwalnia (tj. ChemicalMachiSaved/KineticMachiLost). ChemicalMachiSaved jest uzyskiwany przez konwersję zapisanego (nieużywanego) paliwa na energię przy użyciu paliwaPrzezłodaneInMJoulesPerLiter. Musi być sparowana z accelerationEfficiency. Dozwolony zakres wartości to od 0,0 do 1/przyspieszanieSprawność. Rozsądne wartości: dla modelu spalania : 0,83 dla modelu elektrycznego : 0,91
departAt	query		string (date-time)	Data i godzina odejścia od punktu początkowego sformatowane jako wartość `dateTime` zdefiniowana w RFC 3339, sekcja 5.6, z opcjonalnym przesunięciem strefy czasowej. Jeśli nie określono przesunięcia strefy czasowej, przyjmuje się, że jest to przesunięcie punktu początkowego. Wartość domyślna: teraz Inna wartość: `dateTime` Przykłady: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Nie można użyć parametru `departAt` w połączeniu z `arriveAt`.
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	Określa wydajność konwersji potencjalnej energii w celu zaoszczędzenia (nieużytowanego) paliwa, gdy pojazd traci wysokość (tj. ChemicalMachiSaved/PotentialEnerLost). ChemicalMachiSaved jest uzyskiwany przez konwersję zapisanego (nieużywanego) paliwa na energię przy użyciu paliwaPrzezłodaneInMJoulesPerLiter. Musi być sparowana z pod góręEfficiency. Zakres dozwolonych wartości to od 0,0 do 1/pod góręEfficiency. Rozsądne wartości: dla modelu spalania : 0,51 dla modelu elektrycznego: 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number (double)	Określa ilość energii chemicznej przechowywanej w jednym litrze paliwa w megajulach (MJ). Jest on używany w połączeniu z *Wydajność parametrów konwersji między zaoszczędzone lub zużywane energii i paliwa. Na przykład gęstość energii wynosi 34,2 MJ/l dla benzyny i 35,8 MJ/l dla paliwa diesla. Ten parametr jest wymagany, jeśli jest ustawiony dowolny parametr *Wydajność. Rozsądne wartości: 34.2
hilliness	query		InclineLevel	Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z `routeType`=thrilling.
instructionsType	query		RouteInstructionsType	Jeśli zostanie określona, zostaną zwrócone instrukcje dotyczące wskazówek. Należy pamiętać, że parametr instructionsType nie może być używany w połączeniu z routeRepresentation=none.
language	query		string	Parametr języka określa język komunikatów ze wskazówkami. Odpowiednie cioły (nazwy ulic, placu itp.) są zwracane w określonym języku lub jeśli nie są dostępne, są zwracane w dostępnym języku, który jest blisko niego. Dozwolone wartości to (podzbiór) tagów języka IETF. Obecnie obsługiwane języki są wymienione w sekcji Obsługiwane języki. Wartość domyślna: en-GB
maxAlternatives	query		integer minimum: 0 maximum: 5	Liczba tras alternatywnych do obliczenia. Ustawienie domyślne: 0, minimum: 0 i maksimum: 5
maxChargeInkWh	query		number (double)	Określa maksymalny zasilacz energii elektrycznej w kilowatach (kWh), które mogą być przechowywane w baterii pojazdu. Ten parametr współistnieje z parametrem currentChargeInkWh. Wartość minimalna musi być większa lub równa currentChargeInkWh. Rozsądne wartości: 85
minDeviationDistance	query		integer	Wszystkie zwrócone trasy alternatywne będą podążać za trasą referencyjną (zobacz sekcję POST Requests) z punktu początkowego żądania calculateRoute dla co najmniej tej liczby metrów. Można go używać tylko podczas rekonstrukcyjnej trasy. Nie można użyć parametru minDeviationDistance w połączeniu z elementem arriveAt
minDeviationTime	query		integer	Wszystkie zwrócone trasy alternatywne będą podążać za trasą referencyjną (zobacz sekcję POST Requests) z punktu początkowego żądania calculateRoute przez co najmniej tę liczbę sekund. Można go używać tylko podczas rekonstrukcyjnej trasy. Parametr minDeviationTime nie może być używany w połączeniu z arriveAt. Wartość domyślna to 0. Ustawienie parametru )minDeviationTime_ wartości większej niż zero ma następujące konsekwencje: Punkt początkowy calculateRoute Request musi znajdować się (lub bardzo blisko) trasy referencyjnej wejściowej. Jeśli tak nie jest, zwracany jest błąd. Jednak punkt początkowy nie musi znajdować się na początku trasy odniesienia wejściowej (można ją traktować jako bieżącą pozycję pojazdu na trasie referencyjnej). Trasa referencyjna zwrócona jako pierwsza trasa w calculateRoute Response rozpocznie się w punkcie początkowym określonym w calculateRoute Request. Początkowa część trasy referencyjnej wejściowej do punktu początkowego zostanie wykluczona z odpowiedzi. Wartości minDeviationDistance i minDeviationTime określają, jak daleko alternatywne trasy będą zgodne z trasą referencyjną z punktu początkowego. Trasa musi używać departAt. Pojazd Przerzut jest ignorowany.
report	query		Report	Określa, które dane mają być zgłaszane w celach diagnostycznych. Jedyną możliwą wartością jest effectiveSettings. Raportuje obowiązujące parametry lub dane używane podczas wywoływania interfejsu API. W przypadku domyślnych parametrów wartość domyślna zostanie odzwierciedlona, gdy parametr nie został określony przez obiekt wywołujący.
routeRepresentation	query		RouteRepresentationForBestOrder	Określa reprezentację zestawu tras podanych jako odpowiedź.
routeType	query		RouteType	Żądany typ trasy.
sectionType	query		SectionType[]	Określa, które typy sekcji są zgłaszane w odpowiedzi trasy. Na przykład jeśli sekcja sectionType = sekcja dla pieszych, które są odpowiednie tylko dla pieszych, są zwracane. Można określić wiele razy w jednym żądaniu, na przykład "§ionType=carTrain§ionType=pedestrian§ionType=highway". Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód
traffic	query		boolean	Możliwe wartości: true — należy wziąć pod uwagę wszystkie dostępne informacje o ruchu podczas routingu false — ignoruj bieżące dane ruchu podczas routingu. Należy pamiętać, że chociaż bieżące dane ruchu są ignorowane podczas routingu, wpływ historycznego ruchu na efektywne prędkości drogowe jest nadal uwzględniany.
travelMode	query		TravelMode	Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach.
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	Określa efektywność konwersji energii chemicznej przechowywanej w paliwie na potencjalną energię, gdy pojazd zyskuje wysokość (tj. Potential EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed jest uzyskiwany przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaEnergiiInMJoulesPerLiter. Musi być sparowany z downhillEfficiency. Dozwolony zakres wartości to od 0,0 do 1/downhillEfficiency. Rozsądne wartości: dla modelu spalania : 0,27, dla modelu elektrycznego : 0,74
vehicleAxleWeight	query		integer	Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.
vehicleCommercial	query		boolean	Czy pojazd jest używany do celów komercyjnych. Pojazdy komercyjne mogą nie być dozwolone do jazdy na niektórych drogach.
vehicleEngineType	query		VehicleEngineType	Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType.
vehicleHeading	query		integer minimum: 0 maximum: 359	Kierunek pojazdu w stopniach rozpoczynających się od prawdziwej Północy i kontynuowany w kierunku wskazówek zegara. Północ jest 0 stopni, wschód jest 90 stopni, południe jest 180 stopni, zachód jest 270 stopni. Możliwe wartości 0–359
vehicleHeight	query		number (double)	Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.
vehicleLength	query		number (double)	Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.
vehicleLoadType	query		VehicleLoadType	Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy US Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach/regionach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu USA, podczas gdy innehazmat powinny być używane dla wszystkich innych krajów/regionów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie brany pod uwagę tylko dla travelMode=truck.
vehicleMaxSpeed	query		integer	Maksymalna prędkość pojazdu w km/godzinę. Maksymalna prędkość w profilu pojazdu służy do sprawdzania, czy pojazd jest dozwolony na autostradach. Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania tras. Wartość niezerowa może zostać zastąpiona podczas planowania trasy. Na przykład bieżący przepływ ruchu wynosi 60 km/godzinę. Jeśli maksymalna prędkość pojazdu wynosi 50 km/godzinę, silnik rozsyłania rozważy 60 km/godzinę, ponieważ jest to bieżąca sytuacja. Jeśli maksymalna prędkość pojazdu wynosi 80 km/godzinę, ale bieżący przepływ ruchu wynosi 60 km/godzinę, silnik routingu ponownie użyje 60 km/godzinę.
vehicleWeight	query		integer	Waga pojazdu w kilogramach. To jest obowiązkowe, jeśli którykolwiek z parametrów wydajności są ustawione. Musi być ściśle dodatnia, jeśli jest używana w kontekście modelu zużycia. Rozważane są ograniczenia wagi. Jeśli nie określono żadnych szczegółowych model zużycia, a wartość vehicleWeight* nie jest równa zero, należy rozważyć ograniczenia wagi. We wszystkich innych przypadkach ten parametr jest ignorowany. Rozsądne wartości: dla modelu spalania : 1600, dla modelu elektrycznego : 1900
vehicleWidth	query		number (double)	Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.
windingness	query		WindingnessLevel	Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z `routeType`=thrilling.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouteDirections	OK
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 retrieve a route between an origin and a destination

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Przykładowa odpowiedź

Kod stanu:: 200

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definicje

Nazwa	Opis
AlternativeRouteType	Kontroluje optymalność, w odniesieniu do podanych kryteriów planowania, obliczonych alternatyw w porównaniu z trasą referencyjną.
ComputeTravelTime	Określa, czy zwracać dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu (brak, historyczny, na żywo), a także domyślny najlepszy szacowany czas podróży.
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.
InclineLevel	Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z `routeType`=thrilling.
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.
Report	Określa, które dane mają być zgłaszane w celach diagnostycznych. Jedyną możliwą wartością jest effectiveSettings. Raportuje obowiązujące parametry lub dane używane podczas wywoływania interfejsu API. W przypadku domyślnych parametrów wartość domyślna zostanie odzwierciedlona, gdy parametr nie został określony przez obiekt wywołujący.
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
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
RouteAvoidType	Określa element, którego obliczenie trasy powinno próbować uniknąć podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=highways&avoid=tollRoads&avoid=promy". W żądaniach zakresu tras wartość jużUsedRoads nie może być używana.
RouteDirections	Ten obiekt jest zwracany z pomyślnego wywołania Route Directions
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.
RouteInstructionsType	Jeśli zostanie określona, zostaną zwrócone instrukcje dotyczące wskazówek. Należy pamiętać, że parametr instructionsType nie może być używany w połączeniu z routeRepresentation=none.
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.
RouteRepresentationForBestOrder	Określa reprezentację zestawu tras podanych jako odpowiedź.
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
RouteType	Żądany typ trasy.
SectionType	Określa, które typy sekcji są zgłaszane w odpowiedzi trasy. Na przykład jeśli sekcja sectionType = sekcja dla pieszych, które są odpowiednie tylko dla pieszych, są zwracane. Można określić wiele razy w jednym żądaniu, na przykład "§ionType=carTrain§ionType=pedestrian§ionType=highway". Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód
SimpleCategory	Typ zdarzenia. Obecnie może to być JAM, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec".
TravelMode	Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach.
VehicleEngineType	Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType.
VehicleLoadType	Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy US Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach/regionach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu USA, podczas gdy innehazmat powinny być używane dla wszystkich innych krajów/regionów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie brany pod uwagę tylko dla travelMode=truck.
WindingnessLevel	Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z `routeType`=thrilling.

AlternativeRouteType

Wyliczanie

Kontroluje optymalność, w odniesieniu do podanych kryteriów planowania, obliczonych alternatyw w porównaniu z trasą referencyjną.

Wartość	Opis
anyRoute	Zezwalaj na zwracanie dowolnej alternatywnej trasy, niezależnie od tego, jak wypada ona w porównaniu z trasą referencyjną pod względem optymalności.
betterRoute	Zwróć trasę alternatywną tylko wtedy, gdy jest lepsza niż trasa referencyjna zgodnie z podanymi kryteriami planowania.

ComputeTravelTime

Wyliczanie

Określa, czy zwracać dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu (brak, historyczny, na żywo), a także domyślny najlepszy szacowany czas podróży.

Wartość	Opis
none	Nie oblicza dodatkowych czasów podróży.
all	Oblicza czasy podróży dla wszystkich typów informacji o ruchu drogowym i określa wszystkie wyniki w polach noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds i liveTrafficIncidentsTravelTimeInSeconds, które są uwzględniane w podsumowaniach w odpowiedzi na trasę.

DelayMagnitude

Wyliczanie

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

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

DrivingSide

Wyliczanie

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

Wartość	Opis
LEFT	Lewa strona.
RIGHT	Prawa strona.

EffectiveSetting

Objekt

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

Objekt

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

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

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GuidanceInstructionType

Wyliczanie

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

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

GuidanceManeuver

Wyliczanie

Kod identyfikujący manewr.

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

InclineLevel

Wyliczanie

Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling.

Wartość	Opis
low	Niski
normal	normalny
high	wysoki

JunctionType

Wyliczanie

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.

Wartość	Opis
REGULAR	regularny
ROUNDABOUT	rondo
BIFURCATION	Rozwidlenia

LatLongPair

Objekt

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

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

Report

Wyliczanie

Określa, które dane mają być zgłaszane w celach diagnostycznych. Jedyną możliwą wartością jest effectiveSettings. Raportuje obowiązujące parametry lub dane używane podczas wywoływania interfejsu API. W przypadku domyślnych parametrów wartość domyślna zostanie odzwierciedlona, gdy parametr nie został określony przez obiekt wywołujący.

Wartość	Opis
effectiveSettings	Raportuje obowiązujące parametry lub dane używane podczas wywoływania interfejsu API.

ResponseFormat

Wyliczanie

Żądany format odpowiedzi. Wartość może być json lub xml.

Wartość	Opis
json	format wymiany danych notacji obiektów JavaScript
xml	rozszerzalnego języka znaczników

ResponseSectionType

Wyliczanie

Typy sekcji zgłoszonej odpowiedzi trasy

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

ResponseTravelMode

Wyliczanie

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

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

Route

Objekt

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

RouteAvoidType

Wyliczanie

Określa element, którego obliczenie trasy powinno próbować uniknąć podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=highways&avoid=tollRoads&avoid=promy". W żądaniach zakresu tras wartość jużUsedRoads nie może być używana.

Wartość	Opis
tollRoads	Omija drogi płatne.
motorways	Omija autostrady
ferries	Unika promów
unpavedRoads	Omija drogi nieutwardzone
carpools	Unika tras, które wymagają korzystania z pasów carpoolingu (HOV/High Occupancy Vehicle).
alreadyUsedRoads	Unika wielokrotnego korzystania z tej samej drogi. Najbardziej przydatne w połączeniu z `routeType`=ekscytujący.
borderCrossings	Unikanie przekraczania granic przy obliczaniu trasy.

RouteDirections

Objekt

Ten obiekt jest zwracany z pomyślnego wywołania Route Directions

Nazwa	Typ	Opis
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

RouteGuidance

Objekt

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

Objekt

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. 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 (int64)	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 = Zawrócenie [-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

Objekt

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.

RouteInstructionsType

Wyliczanie

Jeśli zostanie określona, zostaną zwrócone instrukcje dotyczące wskazówek. Należy pamiętać, że parametr instructionsType nie może być używany w połączeniu z routeRepresentation=none.

Wartość Opis

coded

Wartość	Opis
coded	Zwraca nieprzetworzone dane instrukcji bez komunikatów czytelnych dla człowieka.
text	Zwraca nieprzetworzone dane instrukcji z komunikatami czytelnymi dla człowieka w postaci zwykłego tekstu.
tagged	Zwraca nieprzetworzone dane instrukcji z otagowanymi komunikatami czytelnymi dla człowieka, aby umożliwić formatowanie. Przekaz czytelny dla człowieka jest zbudowany z powtarzalnych, zidentyfikowanych elementów. Są one oznaczone, aby umożliwić aplikacjom klienckim ich poprawne sformatowanie. Następujące składniki wiadomości są oznaczone, gdy instructionsType=tagged: ulica, numer_drogi, signpostText, exitNumber, rondoExitNumber. Przykład komunikatu oznaczonego tagiem "Skręć w lewo": `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`

Zwraca nieprzetworzone dane instrukcji bez komunikatów czytelnych dla człowieka.

text

Zwraca nieprzetworzone dane instrukcji z komunikatami czytelnymi dla człowieka w postaci zwykłego tekstu.

tagged

Zwraca nieprzetworzone dane instrukcji z otagowanymi komunikatami czytelnymi dla człowieka, aby umożliwić formatowanie. Przekaz czytelny dla człowieka jest zbudowany z powtarzalnych, zidentyfikowanych elementów. Są one oznaczone, aby umożliwić aplikacjom klienckim ich poprawne sformatowanie. Następujące składniki wiadomości są oznaczone, gdy instructionsType=tagged: ulica, numer_drogi, signpostText, exitNumber, rondoExitNumber.

Przykład komunikatu oznaczonego tagiem "Skręć w lewo":

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

RouteLeg

Objekt

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

Objekt

Obiekt podsumowania sekcji trasy.

Nazwa	Typ	Opis
arrivalTime	string (date-time)	Szacowany czas przybycia trasy lub nogi. Czas jest w formacie UTC.
batteryConsumptionInkWh	number (double)	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 (date-time)	Szacowany czas odlotu trasy lub nogi. Czas jest w formacie UTC.
fuelConsumptionInLiters	number (double)	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

Objekt

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

Objekt

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.

RouteRepresentationForBestOrder

Wyliczanie

Określa reprezentację zestawu tras podanych jako odpowiedź.

Wartość	Opis
polyline	Uwzględnia geometrię trasy w odpowiedzi.
summaryOnly	Podsumowanie zgodnie z polilinią, ale z wyłączeniem elementów geometrii punktów dla tras w odpowiedzi.
none	Uwzględnia tylko zoptymalizowane indeksy punktów trasy, ale nie uwzględnia geometrii trasy w odpowiedzi. Ta wartość parametru może być używana tylko w połączeniu z computeBestOrder=true.

RouteSection

Objekt

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

Objekt

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

Objekt

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

Objekt

Obiekt podsumowania

Nazwa	Typ	Opis
arrivalTime	string (date-time)	Szacowany czas przybycia trasy lub nogi. Czas jest w formacie UTC.
departureTime	string (date-time)	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.

RouteType

Wyliczanie

Żądany typ trasy.

Wartość	Opis
fastest	Najszybsza trasa.
shortest	Najkrótsza trasa pod względem odległości.
eco	Trasa zrównoważona pod względem ekonomii i prędkości.
thrilling	Obejmuje interesujące lub wymagające drogi i wykorzystuje jak najmniej autostrad. Możesz wybrać poziom dołączonych zakrętów, a także stopień pagórkowatości. Zobacz parametry pagórkowatości i uzwojenia, aby dowiedzieć się, jak to ustawić. Obowiązuje limit 900 km na trasach zaplanowanych z `routeType`=emocjonującą

SectionType

Wyliczanie

Określa, które typy sekcji są zgłaszane w odpowiedzi trasy.

Na przykład jeśli sekcja sectionType = sekcja dla pieszych, które są odpowiednie tylko dla pieszych, są zwracane. Można określić wiele razy w jednym żądaniu, na przykład "§ionType=carTrain§ionType=pedestrian§ionType=highway". Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód

Wartość	Opis
carTrain	Odcinki trasy, które są samochodami lub pociągami.
country	Sekcje wskazujące kraje/regiony, w których znajduje się trasa.
ferry	Odcinki trasy, które są promami.
motorway	Odcinki trasy, które są autostradami.
pedestrian	Odcinki trasy, które są odpowiednie tylko dla pieszych.
tollRoad	Odcinki trasy, na których należy uiścić opłatę drogową.
tollVignette	Odcinki trasy, które wymagają obecności płatnej vignette.
traffic	Sekcje trasy zawierającej informacje o ruchu.
travelMode	Sekcje w odniesieniu do parametru żądania `travelMode`.
tunnel	Sekcje trasy, które są tunelami.
carpool	Odcinki trasy, które wymagają korzystania z pul samochodowych (HOV/High Occupancy Vehicle) pasów ruchu.
urban	Odcinki trasy, które znajdują się na obszarach miejskich.

SimpleCategory

Wyliczanie

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

Wartość	Opis
JAM	Korek.
ROAD_WORK	Praca drogowa.
ROAD_CLOSURE	Zamknięcie drogi.
OTHER	Inne

TravelMode

Wyliczanie

Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach.

Wartość	Opis
car	Zwrócone trasy są zoptymalizowane pod kątem samochodów.
truck	Zwrócone trasy są zoptymalizowane pod kątem pojazdów komercyjnych, takich jak dla ciężarówek.
taxi	Zwrócone trasy są zoptymalizowane pod kątem taksówek. Funkcje beta.
bus	Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym korzystanie tylko z pasów ruchu autobusowego. Funkcje beta.
van	Zwrócone trasy są zoptymalizowane pod kątem furgonetek. Funkcje beta.
motorcycle	Zwrócone trasy są zoptymalizowane pod kątem motocykli. Funkcje beta.
bicycle	Zwrócone trasy są zoptymalizowane pod kątem rowerów, w tym korzystania z pasów rowerowych.
pedestrian	Zwrócone trasy są zoptymalizowane pod kątem pieszych, w tym korzystania z chodników.

VehicleEngineType

Wyliczanie

Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType.

Wartość	Opis
combustion	Silnik spalinowy.
electric	Silnik elektryczny.

VehicleLoadType

Wyliczanie

Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy US Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach/regionach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu USA, podczas gdy innehazmat powinny być używane dla wszystkich innych krajów/regionów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie brany pod uwagę tylko dla travelMode=truck.

Wartość	Opis
USHazmatClass1	Explosives
USHazmatClass2	Gaz sprężony
USHazmatClass3	Ciecze łatwopalne
USHazmatClass4	Substancje stałe łatwopalne
USHazmatClass5	Oxidizers
USHazmatClass6	Poisons
USHazmatClass7	Radioactive
USHazmatClass8	Corrosives
USHazmatClass9	Różne
otherHazmatExplosive	Explosives
otherHazmatGeneral	Różne
otherHazmatHarmfulToWater	Działa szkodliwie na wodę

WindingnessLevel

Wyliczanie

Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling.

Wartość	Opis
low	Niski
normal	normalny
high	wysoki

Udostępnij przez

Route - Get Route Directions

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Notatki

Zakresy

subscription-key

SAS Token

Przykłady

Successfully retrieve a route between an origin and a destination

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel