Udostępnij za pośrednictwem

Route - Get Route Directions

  • Odwołanie
Usługa:
Maps
Wersja interfejsu API:
1.0

Służy do obliczania trasy między określonym źródłem i miejscem docelowym, przechodząc przez wszystkie określone punkty waypoint.

Interfejs Get Route Directions API jest żądaniem HTTP GET , które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli określono. Trasa uwzględnia czynniki, takie 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 Model użycia.

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 między pełnią rolę WayPoints w trasie. Możesz przekazać maksymalnie 150 punktów WayPoint.
accelerationEfficiency
 query

number

double

Określa wydajność konwersji energii chemicznej przechowywanej w paliwie na energię kinetyczną, gdy pojazd przyspiesza (tj. Kinetic EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed uzyskuje się poprzez przekonwertowanie zużytego paliwa na energię chemiczną przy użyciu paliwa EnergyDensityInMJoulesPerLiter.

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ść zdefiniowana dateTime w dokumencie RFC 3339, sekcja 5.6 z opcjonalnym przesunięciem strefy czasowej. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt docelowy.

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

Nie można użyć parametru arriveAt w połączeniu z parametrem departAtlub minDeviationDistanceminDeviationTime.
auxiliaryPowerInkW
 query

number

double

Określa ilość zużytej mocy do utrzymania systemów pomocniczych w kilowatach (kW).

Może służyć do określania zużycia z powodu urządzeń i systemów, takich jak systemy AC, radio, ogrzewanie itp.

Rozsądne wartości: 1,7
auxiliaryPowerInLitersPerHour
 query

number

double

Określa ilość zużytego paliwa do utrzymania systemów pomocniczych pojazdu, w litrach na godzinę.

Może służyć do określania zużycia z powodu urządzeń i systemów, takich 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 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ła 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 są prawdziwe lub fałszywe. 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 drogi okręgu. Wartość False będzie używać lokalizacji w podanej kolejności i nie może być używana w połączeniu z routeRepresentation none.
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 czas podróży najlepiej szacowany.
constantSpeedConsumptionInkWhPerHundredkm
 query

string

Określa składnik zależny od szybkości zużycia.

Podana jako nieurządkowana lista par szybkości/szybkości/szybkości. Lista definiuje punkty na krzywej zużycia. Stawki zużycia dla szybkości, które nie znajdują się na liście, są następujące:

  • przez interpolację liniową, jeśli dana prędkość znajduje się 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ą. Dzięki temu ekstrapolacja nie prowadzi do ujemnych wskaźników konsumpcji.

Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia w przypadku mniejszej prędkości.

Prawidłowy zakres wartości zużycia (wyrażony w kWh/100 km) wynosi od 0,01 do 10000,0.

Rozsądne wartości: 50,8.2:130,21.3

Ten parametr jest wymagany w przypadku modelu zużycia energii elektrycznej.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

Określa składnik zależny od szybkości zużycia.

Podana jako lista nieurządkowanych par szybkości rozdzielanych dwukropkami & szybkości użycia. Lista definiuje punkty na krzywej zużycia. Stawki zużycia dla szybkości, które nie znajdują się na liście, są następujące:

  • przez interpolację liniową, jeśli dana prędkość znajduje się 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ą. Dzięki temu ekstrapolacja nie prowadzi do ujemnych wskaźników konsumpcji.

Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia w przypadku mniejszej prędkości.

Prawidłowy zakres wartości zużycia (wyrażony w l/100 km) wynosi od 0,01 do 100000,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żącą energię elektryczną w godzinach kilowatów (kWh).

Ten parametr współistnieje z parametrem maxChargeInkWh .

Dozwolony zakres wartości to od 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

Określa wydajność konwersji energii kinetycznej w celu zaoszczędzenia (nieużywanego) paliwa, gdy pojazd zwalnia (tj. Chemical EnergySaved/Kinetic EnergyLost). Chemical EnergySaved uzyskuje się poprzez konwersję zapisanego (nieużytowanego) paliwa na energię przy użyciu paliwa EnergyDensityInMJoulesPerLiter.

Musi być sparowana z akceleratoremSprawność.

Dozwolony zakres wartości to od 0,0 do 1/accelerationEfficiency.

Rozsądne wartości: dla modelu spalania : 0,83, dla modelu elektrycznego : 0,91
departAt
 query

string

date-time

Data i godzina odejścia z punktu początkowego sformatowane jako wartość zdefiniowana dateTime w dokumencie RFC 3339, sekcja 5.6 z opcjonalnym przesunięciem strefy czasowej. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt początkowy.

  • Wartość domyślna: teraz
  • Inna wartość: dateTime

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

Nie można użyć parametru departAt w połączeniu z parametrem arriveAt.
downhillEfficiency
 query

number

double

Określa wydajność konwersji potencjalnej energii w celu zaoszczędzenia (nieużywanego) paliwa, gdy pojazd traci wysokość (tj. Chemical EnergySaved/Potential EnergyLost). Chemical EnergySaved uzyskuje się poprzez konwersję zapisanego (nieużytowanego) paliwa na energię przy użyciu paliwa EnergyDensityInMJoulesPerLiter.

Musi być sparowana z pod góręEfficiency.

Dozwolony zakres wartości to od 0,0 do 1/pod góręSprawność.

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 megadżuli (MJ). Jest on używany w połączeniu z *Parametry wydajności do konwersji między zaoszczędzonej lub zużytej energii i paliwa. Na przykład gęstość energetyczna wynosi 34,2 MJ/l dla benzyny i 35,8 MJ/l dla paliwa wysokoprężnego.

Ten parametr jest wymagany, jeśli jest ustawiony dowolny parametr *Wydajność .

Rozsądne wartości: 34,2
hilliness
 query

InclineLevel

Stopień wzgórza 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 wskazówek. Odpowiednie nouns (nazwy ulic, placów 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 (podzestaw) 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

Liczba żądanych tras alternatywnych do obliczenia. Ustawienie domyślne: 0, minimum: 0 i maksimum: 5
maxChargeInkWh
 query

number

double

Określa maksymalną energię elektryczną w godzinach kilowatów (kWh), które mogą być przechowywane w baterii pojazdu.

Ten parametr współistnieje z bieżącym parametremChargeInkWh .

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 parametrem arriveAt. Wartość domyślna to 0. Ustawienie )minDeviationTime_ wartości większej niż zero ma następujące konsekwencje:

  • Punkt początkowy żądania calculateRoute musi znajdować się (lub bardzo blisko) trasy odwołania wejściowego.
    • 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 odniesienia).
  • Trasa referencyjna zwrócona jako pierwsza trasa w odpowiedź usługi calculateRoute rozpocznie się w punkcie początkowym określonym w żądaniu calculateRoute . Początkowa część trasy odwołania wejściowego do momentu wykluczenia punktu początkowego z odpowiedzi.
  • Wartości minDeviationDistance i minDeviationTime określają, jak daleko alternatywne trasy będą gwarantowane, aby postępować zgodnie z trasą referencyjną z punktu początkowego.
  • Trasa musi używać funkcji odlotu.
  • PojazdHeading jest ignorowany.
report
 query

Report

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

RouteRepresentationForBestOrder

Określa reprezentację zestawu tras podanych jako odpowiedź. Ta wartość parametru może być używana tylko w połączeniu z computeBestOrder=true.
routeType
 query

RouteType

Żądany typ trasy.
sectionType
 query

SectionType

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

Jeśli na przykład sekcjaType = piesi, są zwracane tylko sekcje odpowiednie dla pieszych. Można użyć wielu typów. 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 mimo że 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 zostanie 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 tryb 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 autobusem, motocyklem, taksówką i furgonetki są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach.
uphillEfficiency
 query

number

double

Określa wydajność konwersji energii chemicznej przechowywanej w paliwie na potencjalną energię, gdy pojazd zyskuje wysokość (tj. Potential EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed uzyskuje się poprzez przekonwertowanie zużytego paliwa na energię chemiczną przy użyciu paliwa EnergyDensityInMJoulesPerLiter.

Musi być sparowana z dółSprawność.

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

Kierunek pojazdu w stopniach rozpoczynających się na prawdziwej Północy i kontynuowaniu 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

Rodzaje ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone do 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 uwzględniany tylko dla parametru 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 trasy.

  • 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 jest ustawiona na 50 km/godzinę, silnik routingu rozważy 60 km/godzinę, ponieważ jest to bieżąca sytuacja. Jeśli maksymalna prędkość pojazdu zostanie podana jako 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.

  • Jest to obowiązkowe, jeśli którykolwiek z parametrów *Wydajność jest ustawiony.

  • Musi być ściśle dodatnia, gdy jest używana w kontekście modelu zużycia. Ograniczenia wagi są brane pod uwagę.

  • Jeśli nie określono żadnego szczegółowego modelu zużycia , a wartość pojazduWeight nie jest zerowa, 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 zwrotów dla porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-id

string

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

Odpowiedzi

Nazwa Typ Opis
200 OK

RouteDirections

OK
Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej 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 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

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 poziomu 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 skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

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ółużytkowany 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.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów 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 podejścia do poufnych aplikacji klienckich w celu uzyskania 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 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 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 oraz 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 bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Successfully retrieve a route between an origin and a destination

Przykładowe żądanie

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 czas podróży najlepiej szacowany.
DelayMagnitude

Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi interfejsu API Pobierz szczegóły zdarzenia ruchu.
DrivingSide

Wskazuje leworęczną a prawą stronę jazdy w punkcie manewru.
EffectiveSetting

Efektywny 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. skręć lub zmienić formę drogi.
GuidanceManeuver

Kod identyfikujący manewr.
InclineLevel

Stopień wzgórza do porywającej trasy. Ten parametr może być używany 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 do celów diagnostycznych. Jedyną możliwą wartością jest effectiveSettings. Zgłasza obowiązujące parametry lub dane używane podczas wywoływania interfejsu API. W przypadku domyślnych parametrów wartość domyślna zostanie odzwierciedlona, gdzie 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 wartość , jeśli żądany tryb transportu nie jest możliwy w tej sekcji
Route
RouteAvoidType

Określa coś, czego należy unikać podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=autostrady&avoid=tollRoads&unikaj =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 żądanie wiadomości tekstowych z możliwością odczytu przez człowieka jest wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwracany, 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.
RouteReport

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

Określa reprezentację zestawu tras podanych jako odpowiedź. Ta wartość parametru może być używana tylko w połączeniu z computeBestOrder=true.
RouteSection

Sekcje trasy zawierają dodatkowe informacje o częściach trasy. Każda sekcja zawiera co najmniej elementy startPointIndex, endPointIndexi 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.

Jeśli na przykład sekcjaType = piesi, są zwracane tylko sekcje odpowiednie dla pieszych. Można użyć wielu typów. 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 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 zdefiniowano, 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 uznawany tylko za travelMode=truck.
WindingnessLevel

Poziom zwrotów dla porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling.

AlternativeRouteType

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

Nazwa Typ Opis
anyRoute

string

Zezwalaj na zwracanie dowolnej alternatywnej trasy niezależnie od tego, w jaki sposób porównuje się z trasą referencyjną pod względem optymalnej wartości.
betterRoute

string

Zwróć alternatywną trasę tylko wtedy, gdy jest lepsza niż trasa referencyjna zgodnie z podanymi kryteriami planowania.

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 czas podróży najlepiej szacowany.

Nazwa Typ Opis
all

string

Oblicza czas podróży dla wszystkich typów informacji o ruchu i określa wszystkie wyniki w polach noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds i liveTrafficIncidentsTravelTimeInSeconds dołączane do podsumowań w odpowiedzi trasy.
none

string

Nie oblicza dodatkowych czasów podróży.

DelayMagnitude

Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi interfejsu API Pobierz szczegóły zdarzenia ruchu.

Nazwa Typ Opis
0

string

Nieznane.
1

string

Małoletni.
2

string

Średnia.
3

string

Major.
4

string

Niezdefiniowane, używane do zamknięcia dróg i innych nieokreślonych opóźnień.

DrivingSide

Wskazuje leworęczną a prawą stronę jazdy w punkcie manewru.

Nazwa Typ Opis
LEFT

string

Lewa strona.
RIGHT

string

Prawa strona.

EffectiveSetting

Efektywny 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 error.

GuidanceInstructionType

Typ instrukcji, np. skręć lub zmienić formę drogi.

Nazwa Typ Opis
DIRECTION_INFO

string

Informacje o kierunku.
LOCATION_ARRIVAL

string

Lokalizacja przylotu.
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

Wjeżż na autostradę.
ENTRANCE_RAMP

string

Weź rampę.
FOLLOW

string

Następować.
KEEP_LEFT

string

Pozostaw w lewo.
KEEP_RIGHT

string

Zachowaj rację.
MAKE_UTURN

string

Wykonaj zwrot u-turn.
MOTORWAY_EXIT_LEFT

string

Wybierz wyjście po lewej stronie.
MOTORWAY_EXIT_RIGHT

string

Wyjdź z prawej strony.
ROUNDABOUT_BACK

string

Idź po rondzie.
ROUNDABOUT_CROSS

string

Przejeżdą przez rondę.
ROUNDABOUT_LEFT

string

Na rondzie zjechasz z lewej strony.
ROUNDABOUT_RIGHT

string

Na rondzie weź wyjście po prawej stronie.
SHARP_LEFT

string

Skręć ostro w lewo.
SHARP_RIGHT

string

Skręć ostro w prawo.
STRAIGHT

string

Trzymaj się prosto.
SWITCH_MAIN_ROAD

string

Przejdź do głównej drogi.
SWITCH_PARALLEL_ROAD

string

Przełącz się na równoległą drogę.
TAKE_EXIT

string

Wyjdź z wyjścia.
TAKE_FERRY

string

Weź prom.
TRY_MAKE_UTURN

string

Spróbuj zrobić zwrot.
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.

InclineLevel

Stopień wzgórza do porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling.

Nazwa Typ Opis
high

string

wysoka
low

string

niski
normal

string

normalny

JunctionType

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

Nazwa Typ Opis
BIFURCATION

string

Rozwidlenia
REGULAR

string

regularny
ROUNDABOUT

string

rondo

LatLongPair

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

Nazwa Typ Opis
latitude

number

Właściwość Szerokość geograficzna
longitude

number

Właściwość Długość geograficzna

Report

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

Nazwa Typ Opis
effectiveSettings

string

Zgłasza obowiązujące parametry lub dane używane podczas wywoływania interfejsu API.

ResponseFormat

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

Nazwa Typ Opis
json

string

Format wymiany danych notacji obiektów JavaScript
xml

string

Rozszerzalny język znaczników

ResponseSectionType

Typy sekcji zgłoszonej odpowiedzi trasy

Nazwa Typ Opis
CARPOOL

string

Odcinki trasy, które wymagają korzystania z puli samochodów (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

Sekcje trasy, które są promami.
MOTORWAY

string

Odcinki trasy, które są autostradami.
PEDESTRIAN

string

Odcinki trasy, które są odpowiednie tylko dla pieszych.
TOLL_ROAD

string

Odcinki trasy, które wymagają zapłaty opłaty.
TOLL_VIGNETTE

string

Sekcje trasy, które wymagają obecności winiety opłat.
TRAFFIC

string

Sekcje trasy zawierającej 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 wartość , jeśli żądany tryb transportu nie jest możliwy w tej sekcji

Nazwa Typ Opis
bicycle

string

Zwrócone trasy są zoptymalizowane pod kątem rowerów, w tym korzystania z pasów rowerowych.
bus

string

Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym użycia tylko pasów autobusowych. 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 tryb 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 ciężarówki.
van

string

Zwrócone trasy są zoptymalizowane pod kątem furgonetek. Funkcjonalność beta.

Route

Nazwa Typ Opis
guidance

RouteGuidance

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

RouteLeg[]

Tablica nogi
sections

RouteSection[]

Tablica sekcji
summary

RouteSummary

Obiekt podsumowania

RouteAvoidType

Określa coś, czego należy unikać podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=autostrady&avoid=tollRoads&unikaj =promy". W żądaniach zakresu tras wartość jużUsedRoads nie może być używana.

Nazwa Typ Opis
alreadyUsedRoads

string

Unika wielokrotnego korzystania z tej samej drogi. Najbardziej przydatne w połączeniu z routeType=thrilling.
borderCrossings

string

Unika przekraczania granic w obliczeniach tras.
carpools

string

Unika tras, które wymagają korzystania z puli samochodów (HOV/High Occupancy Vehicle) pasów ruchu.
ferries

string

Unika promów
motorways

string

Unikaj autostrad
tollRoads

string

Unika dróg żniwnych.
unpavedRoads

string

Unika niepavowanych dróg

RouteDirections

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

Nazwa Typ Opis
formatVersion

string

Właściwość Formatuj wersję
optimizedWaypoints

RouteOptimizedWaypoint[]

Zoptymalizowana sekwencja punktów waypoint. Przedstawia on 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ę o 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

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

Nazwa Typ Opis
instructionGroups

RouteInstructionGroup[]

Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane.
instructions

RouteInstruction[]

Lista instrukcji opisujących manewry.

RouteInstruction

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

Nazwa Typ Opis
combinedMessage

string

Czytelny dla człowieka komunikat manewru w połączeniu z komunikatem z następnej instrukcji. Czasami można połączyć dwie kolejne instrukcje w jedną instrukcję, co ułatwia wykonywanie tych czynności. W takim przypadku możliwa flagaCombineWithNext będzie prawdziwa. 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 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 po lewej stronie i po prawej stronie jazdy w punkcie manewru.
exitNumber

string

Liczba wyjść autostrady podjęta przez obecny manewr. Jeśli wyjście zawiera wiele numerów wyjścia, zostaną one oddzielone ciągiem "", i prawdopodobnie zagregowane przez "-", np. "10, 13-15".
instructionType

GuidanceInstructionType

Typ instrukcji, np. obrót lub zmiana formy drogi.
junctionType

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.
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 punktów wieloliniowych "punktów" odpowiadający punktowi instrukcji.
possibleCombineWithNext

boolean

Opcjonalnie można połączyć instrukcję z następną. Może to służyć do kompilowania komunikatów, takich jak "Odwróć w lewo, a następnie skręć w prawo".
roadNumbers

string[]

Numery drogowe kolejnych znaczących segmentów dróg po manewrze lub na drogach, które mają być przestrzegane. Przykład: ["E34", "N205"]
roundaboutExitNumber

string

Oznacza 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 posterunku, który jest najbardziej istotny dla manewru, lub kierunku, który powinien być obserwowany.
stateCode

string

Podział podrzędny (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 znaczącego segmentu drogowego po manewrie lub ulicy, która powinna być obserwowana.
travelTimeInSeconds

integer

Szacowany czas podróży do punktu odpowiadającego parametrowi routeOffsetInMeters.
turnAngleInDecimalDegrees

integer

Wskazuje kierunek instrukcji. Jeśli parametr junctionType wskazuje instrukcję zwrotu:

  • 180 = U-turn
  • [-179, -1] = Lewy obrót
  • 0 = Prosto na (obrót "0 stopni")
  • [1, 179] = Prawy obrót

Jeśli junctionType wskazuje instrukcję bifurcation:

  • <0 — pozostaw do lewej
  • >0 — zachowaj prawo

RouteInstructionGroup

Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony za pomocą parametru firstInstructionIndex i lastInstructionIndex. Gdy żądanie wiadomości tekstowych z możliwością odczytu przez człowieka jest wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwracany, 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 żądania dotyczące wiadomości TEKSTowych 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.

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

Nazwa Typ Opis
coded

string

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

string

Zwraca nieprzetworzone dane instrukcji z oznaczonymi komunikatami czytelnymi dla człowieka, aby umożliwić formatowanie. Czytelny dla człowieka komunikat jest tworzony na podstawie powtarzalnych zidentyfikowanych elementów. Są one oznaczone, aby umożliwić aplikacjom klienckim poprawne ich formatowanie. Następujące składniki komunikatów są oznakowane, gdy instrukcjeType=tag: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Przykład oznaczonego komunikatu "Turn left" (Odwróć w lewo):

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

string

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

RouteLeg

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

Nazwa Typ Opis
points

LatLongPair[]

Tablica punktów
summary

RouteLegSummary

Obiekt podsumowania sekcji trasy.

RouteLegSummary

Obiekt podsumowania sekcji trasy.

Nazwa Typ Opis
arrivalTime

string

Szacowany czas przybycia dla trasy lub nogi. Czas jest 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 parametr vehicleEngineType jest ustawiony na wartość elektryczną i stałąSpeedConsumptionInkPerHundredkm 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, odzyskanie zostanie ograniczone, aby upewnić się, że poziom naładowania baterii nigdy nie przekracza wartości maxChargeInkWh. Jeśli w obliczeniu zużycia nie określono wartości maxChargeInkWh ani currentChargeInkWh, nieobsługiwane odzyskanie jest zakładane.
departureTime

string

Szacowany czas odlotu dla trasy lub odcinka. Czas jest w formacie UTC.
fuelConsumptionInLiters

number

Szacowane zużycie paliwa w litrach przy użyciu modelu zużycia spalania. Uwzględniane, jeśli parametr vehicleEngineType ma ustawioną wartość spalania i określono wartość constantSpeedConsumptionInLitersPerHundredkm. Wartość będzie nie ujemna.
historicTrafficTravelTimeInSeconds

integer

Szacowany czas podróży obliczony 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ędnione tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu.
noTrafficTravelTimeInSeconds

integer

Szacowany czas podróży obliczony tak, jakby na trasie nie wystąpiły żadne opóźnienia z powodu warunków ruchu (np. przeciążenia). 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 drogowym. 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 właściwości, która 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.

Nazwa Typ Opis
optimizedIndex

integer

Zoptymalizowany indeks punktów z systemu.
providedIndex

integer

Indeks punktów drogi udostępniany przez użytkownika.

RouteReport

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

RouteRepresentationForBestOrder

Określa reprezentację zestawu tras podanych jako odpowiedź. Ta wartość parametru może być używana tylko w połączeniu z computeBestOrder=true.

Nazwa Typ Opis
none

string

Zawiera tylko zoptymalizowane indeksy punktów waypoint, ale nie zawierają geometrii trasy w odpowiedzi.
polyline

string

Zawiera geometrię trasy w odpowiedzi.
summaryOnly

string

Podsumowanie jako na polilinię, ale z wyłączeniem elementów geometrii punktów dla tras w odpowiedzi.

RouteSection

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

Nazwa Typ Opis
delayInSeconds

integer

Opóźnienie w sekundach spowodowane przez zdarzenie.
effectiveSpeedInKmh

integer

Efektywna prędkość zdarzenia w km/h, uśredniona 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 w interfejsie API pobierania szczegółów zdarzenia ruchu.
sectionType

ResponseSectionType

Typy sekcji zgłaszanej odpowiedzi na trasę
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óły zdarzenia ruchu, używając definicji w standardzie TPEG2-TEC . Może zawierać element effectCode i powoduje elementy.
travelMode

ResponseTravelMode

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

RouteSectionTec

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

Nazwa Typ Opis
causes

RouteSectionTecCause[]

Powoduje tablicę
effectCode

integer

Wpływ na przepływ ruchu. Zawiera wartość w tabeli tec001:EffectCode, zgodnie z definicją w standardzie TPEG2-TEC . Może służyć do kolorowania zdarzeń ruchu zgodnie z ważnością.

RouteSectionTecCause

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

Nazwa Typ Opis
mainCauseCode

integer

Główną przyczyną zdarzenia ruchu. Zawiera wartość w tabeli tec002:CauseCode, zgodnie z definicją w standardzie TPEG2-TEC .
subCauseCode

integer

Podużycie zdarzenia ruchu. Zawiera wartość w tabeli podrzędnej przyczyny zdefiniowanej przez mainCauseCode zgodnie z definicją w standardzie TPEG2-TEC .

RouteSummary

Obiekt podsumowania

Nazwa Typ Opis
arrivalTime

string

Szacowany czas przybycia dla trasy lub nogi. Czas jest w formacie UTC.
departureTime

string

Szacowany czas odlotu dla trasy lub odcinka. 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 drogowym. 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 właściwości, która 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.

RouteType

Żądany typ trasy.

Nazwa Typ Opis
eco

string

Trasa zrównoważona przez gospodarkę i szybkość.
fastest

string

Najszybsza trasa.
shortest

string

Najkrótsza trasa według odległości.
thrilling

string

Obejmuje interesujące lub trudne drogi i wykorzystuje jak najwięcej autostrad. Można wybrać poziom uwzględnionych zakrętów, a także stopień wzgórza. Zobacz parametry hilliness i uzwojenia, aby dowiedzieć się, jak to ustawić. Istnieje limit 900 km na trasach planowanych z routeType=porywający

SectionType

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

Jeśli na przykład sekcjaType = piesi, są zwracane tylko sekcje odpowiednie dla pieszych. Można użyć wielu typów. Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód

Nazwa Typ Opis
carTrain

string

Odcinki trasy, które są samochodami lub pociągami.
carpool

string

Odcinki trasy, które wymagają korzystania z puli samochodów (HOV/High Occupancy Vehicle) pasów ruchu.
country

string

Sekcje wskazujące, w których krajach/regionach znajduje się trasa.
ferry

string

Sekcje trasy, które są promami.
motorway

string

Odcinki trasy, które są autostradami.
pedestrian

string

Odcinki trasy, które są odpowiednie tylko dla pieszych.
tollRoad

string

Odcinki trasy, które wymagają zapłaty opłaty.
tollVignette

string

Sekcje trasy, które wymagają obecności winiety opłat.
traffic

string

Sekcje trasy zawierającej informacje o ruchu.
travelMode

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.

SimpleCategory

Typ zdarzenia. Obecnie może 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.

TravelMode

Tryb podróży dla żądanej trasy. Jeśli nie zdefiniowano, 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.

Nazwa Typ Opis
bicycle

string

Zwrócone trasy są zoptymalizowane pod kątem rowerów, w tym korzystania z pasów rowerowych.
bus

string

Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym użycia tylko pasów autobusowych. 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.
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 ciężarówki.
van

string

Zwrócone trasy są zoptymalizowane pod kątem furgonetek. Funkcjonalność beta.

VehicleEngineType

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

Nazwa Typ Opis
combustion

string

Silnik spalania wewnętrznego.
electric

string

Silnik elektryczny.

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 uznawany tylko za travelMode=truck.

Nazwa Typ Opis
USHazmatClass1

string

Materiały wybuchowe
USHazmatClass2

string

Gaz skompresowany
USHazmatClass3

string

Łatwopalne płyny
USHazmatClass4

string

Łatwopalne stałe
USHazmatClass5

string

Utleniacze
USHazmatClass6

string

Trucizny
USHazmatClass7

string

Materiały radioaktywne
USHazmatClass8

string

Substancje żrące
USHazmatClass9

string

Różne
otherHazmatExplosive

string

Materiały wybuchowe
otherHazmatGeneral

string

Różne
otherHazmatHarmfulToWater

string

Szkodliwe dla wody

WindingnessLevel

Poziom zwrotów dla porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling.

Nazwa Typ Opis
high

string

wysoka
low

string

niski
normal

string

normalny