Route - Post Route Directions
Służy do obliczania trasy między danym źródłem a miejscem docelowym, przechodząc przez wszystkie określone punkty waypoint.
Interfejs Post Route Directions
API to żądanie HTTP POST
, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty drogi, jeśli zostały określone. Trasa będzie uwzględniać czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i godziny 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. Zapoznaj się z modelem zużycia , aby uzyskać szczegółowe wyjaśnienie pojęć i parametrów.
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings§ionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Żądany format odpowiedzi. Wartość może być json lub xml. |
|
api-version
|
query | True |
string |
Numer wersji interfejsu API 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. |
acceleration
|
query |
number double |
Określa efektywność konwersji energii chemicznej przechowywanej w paliwie na energię kinetyczną, gdy pojazd przyspiesza (tj. KineticPrzekażed/ChemicalCareConsumed). Substancja ChemicznaWykonsumowana jest uzyskiwana przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaPrzeciągnięciaInMJoulesPerLiter. 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 |
|
alternative
|
query |
Kontroluje optymalność w odniesieniu do podanych kryteriów planowania obliczonych alternatyw w porównaniu z trasą referencyjną. |
||
arrive
|
query |
string date-time |
Data i godzina przybycia do punktu docelowego sformatowane jako wartość zdefiniowana Przykłady:
Nie można użyć parametru |
|
auxiliary
|
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 |
|
auxiliary
|
query |
number double |
Określa ilość paliwa zużywanego dla 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 |
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. |
||
compute
|
query |
boolean |
Zmień kolejność punktów trasy 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 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. |
|
compute
|
query |
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. |
||
constant
|
query |
string |
Określa składnik zużycia zależny od szybkości. Podana jako nieurządkowana lista par szybkości/szybkości użycia. Lista definiuje punkty na krzywej zużycia. Stawki zużycia dla prędkości, które nie znajdują się na liście, znajdują się w następujący sposób:
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 pojedynczy 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 niż lub równe z wyjątkiem największej prędkości. Gwarantuje to, że ekstrapolacja nie prowadzi do negatywnych 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 negatywnego wskaźnika zużycia dla mniejszej prędkości. Prawidłowy zakres wartości zużycia (wyrażony w kWh/100 km) wynosi od 0,01 do 100000,0. Rozsądne wartości: 50,8.2:130,21.3 Ten parametr jest wymagany dla modelu zużycia energii elektrycznej. |
|
constant
|
query |
string |
Określa składnik zużycia zależny od szybkości. Podana jako nieuorderowana lista dwukropków rozdzielonych prędkością & par z szybkością zużycia. Lista definiuje punkty na krzywej zużycia. Stawki zużycia dla prędkości, które nie znajdują się na liście, znajdują się w następujący sposób:
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 pojedynczy 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 niż lub równe z wyjątkiem największej prędkości. Gwarantuje to, że ekstrapolacja nie prowadzi do negatywnych 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 negatywnego wskaźnika zużycia dla 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. |
|
current
|
query |
number double |
Określa bieżące zasilanie energii elektrycznej w godzinach kilowatów (kWh). Ten parametr współistnieje z parametrem maxChargeInkWh . Dozwolony zakres wartości to 0,0 do maxChargeInkWh. Rozsądne wartości: 43 |
|
current
|
query |
number double |
Określa bieżącą dostawę paliwa w litrach. Rozsądne wartości: 55 |
|
deceleration
|
query |
number double |
Określa wydajność konwersji energii kinetycznej na zaoszczędzone (nieużywane) paliwo, gdy pojazd zwalnia (tj. Chemical ChemicalsSaved/KineticCareLost). Substancja ChemicznaSaved jest uzyskiwana przez konwersję zaoszczędzonego (nieużytowanego) paliwa na energię przy użyciu paliwaSerweryInMJoulesPerLiter. Musi być sparowana z przyspieszeniemSprawność. 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 |
|
depart
|
query |
string date-time |
Data i godzina odejścia z punktu początkowego sformatowane jako
Przykłady:
Nie można użyć parametru |
|
downhill
|
query |
number double |
Określa wydajność konwersji potencjalnej energii do zaoszczędzonego (nieużytowanego) paliwa, gdy pojazd traci wysokość (tj. Chemical AnabolicSaved/PotentialCareLost). Substancja ChemicznaSaved jest uzyskiwana przez konwersję zaoszczędzonego (nieużytowanego) paliwa na energię przy użyciu paliwaSerweryInMJoulesPerLiter. Musi być sparowana z pod góręSprawność. 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 |
|
fuel
|
query |
number double |
Określa ilość energii chemicznej przechowywanej w jednym litrze paliwa w megajoulach (MJ). Jest on używany w połączeniu z *Parametrami wydajności konwersji między zapisaną lub zużywaną energią a paliwem. Na przykład gęstość energii wynosi 34,2 MJ/l dla benzyny, a 35,8 MJ/l dla paliwa wysokoprężnego. Ten parametr jest wymagany, jeśli ustawiono dowolny parametr *Wydajność . Rozsądne wartości: 34.2 |
|
hilliness
|
query |
Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z |
||
instructions
|
query |
Jeśli zostanie określony, 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. Nie ma to wpływu na właściwe cioły (nazwy ulic, placu itp.) Nie ma wpływu na instrukcjeType=coded. Dozwolone wartości to (podzbiór) opisanych tagów języka IETF |
|
max
|
query |
integer |
Liczba żądanych tras alternatywnych do obliczenia. Ustawienie domyślne: 0, minimum: 0 i maksimum: 5 |
|
max
|
query |
number double |
Określa maksymalne zasilanie energii elektrycznej 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 bieżącejChargeInkWh. Rozsądne wartości: 85 |
|
min
|
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. Parametr minDeviationDistance nie może być używany w połączeniu z elementem arriveAt |
|
min
|
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 odbudowy trasy. Parametr minDeviationTime nie może być używany w połączeniu z elementem arriveAt. Wartość domyślna to 0. Ustawienie parametru )minDeviationTime_ na wartość większą niż zero ma następujące konsekwencje:
|
|
report
|
query |
Określa, które dane mają być zgłaszane do celów 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, gdzie parametr nie został określony przez obiekt wywołujący. |
||
route
|
query |
Określa reprezentację zestawu tras dostarczonych jako odpowiedź. Tej wartości parametru można używać tylko w połączeniu z parametrem computeBestOrder=true. |
||
route
|
query |
Żądany typ trasy. |
||
section
|
query |
Określa, które typy sekcji są zgłaszane w odpowiedzi trasy. |
||
traffic
|
query |
boolean |
Możliwe wartości:
|
|
travel
|
query |
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. |
||
uphill
|
query |
number double |
Określa wydajność konwersji energii chemicznej przechowywanej w paliwie na potencjalną energię, gdy pojazd zyskuje podniesienie (tj. Potential AnabolicGained/ChemicalScsiConsumed). Substancja ChemicznaWykonsumowana jest uzyskiwana przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaPrzeciągnięciaInMJoulesPerLiter. Musi być sparowana z wadą 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 |
|
vehicle
|
query |
integer |
Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę. |
|
vehicle
|
query |
boolean |
Czy pojazd jest używany do celów komercyjnych. Pojazdy komercyjne mogą nie być dozwolone do jazdy na niektórych drogach. |
|
vehicle
|
query |
Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType. |
||
vehicle
|
query |
integer |
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 |
|
vehicle
|
query |
number double |
Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę. |
|
vehicle
|
query |
number double |
Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę. |
|
vehicle
|
query |
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 uznawany tylko za travelMode=truck. |
||
vehicle
|
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.
|
|
vehicle
|
query |
integer |
Waga pojazdu w kilogramach.
Rozsądne wartości: dla modelu spalania : 1600, dla modelu elektrycznego : 1900 |
|
vehicle
|
query |
number double |
Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę. |
|
windingness
|
query |
Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z |
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ń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
allowVignette |
string[] |
Jest to lista 3-znakowych, ISO 3166-1, alfa-3 kodów krajów/regionów, w których są dozwolone drogi płatne z winietami, np. "AUS,CHE". Określenie parametru allowVignette z niektórymi krajami/regionami X jest równoważne określeniu opcji unikajVignette ze wszystkimi krajami/regionami, ale X. Określenie wartości allowVignette z pustą listą jest takie samo, jak unikanie wszystkich dróg płatnych z winietami. Uwaga: Jest to błąd określający zarówno opcję unikajVignette , jak i allowVignette. |
avoidAreas |
Wielopolygon GeoJSON reprezentujący listę obszarów, których należy unikać. Obsługiwane są tylko prostokątne wielokąty. Maksymalny rozmiar prostokąta wynosi około 160x160 km. Maksymalna liczba unikanych obszarów wynosi 10. Nie może przekroczyć 180. Musi należeć do zakresu od -80 do +80 stopni szerokości geograficznej. |
|
avoidVignette |
string[] |
Jest to lista 3-znakowych, ISO 3166-1, alfa-3 kodów krajów/regionów, w których należy unikać wszystkich dróg z winietami, np. "AUS,CHE". Nie ma to wpływu na drogi z winietami w krajach/regionach, które nie znajdują się na liście. Uwaga: Jest to błąd określający zarówno opcję unikajVignette , jak i allowVignette. |
supportingPoints |
Kolekcja Geometria GeoJSON reprezentująca sekwencję współrzędnych używanych jako dane wejściowe do rekonstrukcji trasy oraz do obliczania zera lub większej liczby alternatywnych tras do tej trasy referencyjnej.
|
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów 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 Azure Maps interfejsów API REST.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwagi
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
Element Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas Twórca konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.
Type:
apiKey
In:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.
Type:
apiKey
In:
header
Przykłady
Successfully retrieve a route between an origin and a destination with additional parameters in the body
Sample Request
POST https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
{
"supportingPoints": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Point",
"coordinates": [
13.42936,
52.5093
]
},
{
"type": "Point",
"coordinates": [
13.42859,
52.50844
]
}
]
},
"avoidVignette": [
"AUS",
"CHE"
],
"avoidAreas": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
-122.39456176757811,
47.489368981370724
],
[
-122.00454711914061,
47.489368981370724
],
[
-122.00454711914061,
47.65151268066222
],
[
-122.39456176757811,
47.65151268066222
],
[
-122.39456176757811,
47.489368981370724
]
]
],
[
[
[
100,
0
],
[
101,
0
],
[
101,
1
],
[
100,
1
],
[
100,
0
]
]
]
]
}
}
Sample Response
{
"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 |
---|---|
Alternative |
Kontroluje optymalność w odniesieniu do podanych kryteriów planowania obliczonych alternatyw w porównaniu z trasą referencyjną. |
Compute |
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. |
Delay |
Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi interfejsu API Pobierz szczegóły zdarzenia ruchu. |
Driving |
Wskazuje po lewej stronie i po prawej stronie jazdy w punkcie manewru. |
Effective |
Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API trasy. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Guidance |
Typ instrukcji, np. obrót lub zmiana formy drogi. |
Guidance |
Kod identyfikujący manewr. |
Incline |
Stopień wzgórza do porywającej trasy. Ten parametr może być używany tylko w połączeniu z |
Junction |
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. |
Lat |
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. |
Response |
Żądany format odpowiedzi. Wartość może być json lub xml. |
Response |
Typy sekcji zgłoszonej odpowiedzi trasy |
Response |
Tryb podróży dla trasy obliczeniowej. Wartość zostanie ustawiona na |
Route | |
Route |
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. |
Route |
Parametry treści wpisu dla wskazówek trasy. |
Route |
Ten obiekt jest zwracany z pomyślnego wywołania Route Directions |
Route |
Zawiera wskazówki powiązane elementy. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne. |
Route |
Zestaw atrybutów opisujących manewr, np. "Turn right", "Keep left", "Take the ferry", "Take the highway", "Arrive". |
Route |
Grupy sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony przez właściwość firstInstructionIndex i lastInstructionIndex. Gdy komunikaty tekstowe z możliwością odczytu przez człowieka są żądane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwrócony, gdy jest dostępny. |
Route |
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 |
Route |
Opis części trasy składający się z listy punktów. Każdy dodatkowy punkt waypoint podany w żądaniu spowoduje dodatkowy element w zwróconej trasie. |
Route |
Obiekt podsumowania dla sekcji trasy. |
Route |
Zoptymalizowany obiekt punktu. |
Route |
Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu. |
Route |
Określa reprezentację zestawu tras podanych jako odpowiedź. Ta wartość parametru może być używana tylko w połączeniu z computeBestOrder=true. |
Route |
Sekcje trasy zawierają dodatkowe informacje o częściach trasy. Każda sekcja zawiera co najmniej elementy |
Route |
Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC . Może zawierać efektCode i powoduje elementy. |
Route |
Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. Służy do definiowania ikonografii i opisów. |
Route |
Obiekt podsumowania |
Route |
Żądany typ trasy. |
Section |
Określa, które typy sekcji są zgłaszane w odpowiedzi trasy. |
Simple |
Typ zdarzenia. Obecnie może być jam, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec". |
Travel |
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. |
Vehicle |
Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType. |
Vehicle |
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. |
Windingness |
Poziom zwrotów dla porywającej trasy. Ten parametr może być używany tylko w połączeniu z |
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 |
Drobne. |
2 |
string |
Średnia. |
3 |
string |
Głównych. |
4 |
string |
Niezdefiniowane, używane do zamknięcia dróg i innych nieokreślonych opóźnień. |
DrivingSide
Wskazuje po lewej stronie i po prawej stronie jazdy w punkcie manewru.
Nazwa | Typ | Opis |
---|---|---|
LEFT |
string |
Lewa strona. |
RIGHT |
string |
Po prawej stronie. |
EffectiveSetting
Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API trasy.
Nazwa | Typ | Opis |
---|---|---|
key |
string |
Nazwa użytego parametru. |
value |
string |
Wartość użytego parametru. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
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 |
Obiekt error. |
GeoJsonGeometry
Prawidłowy GeoJSON
obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
type |
Geo |
Określa |
GeoJsonGeometryCollection
Prawidłowy GeoJSON GeometryCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
geometries | GeoJsonGeometry[]: |
Zawiera listę prawidłowych |
type |
string:
Geometry |
Określa |
GeoJsonLineString
Prawidłowy GeoJSON LineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Line |
Określa |
GeoJsonMultiLineString
Prawidłowy GeoJSON MultiLineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPoint
Prawidłowy GeoJSON MultiPoint
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPolygon
Prawidłowy GeoJSON MultiPolygon
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Zawiera listę prawidłowych |
type |
string:
Multi |
Określa |
GeoJsonPoint
Prawidłowy GeoJSON Point
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Określa |
GeoJsonPolygon
Prawidłowy GeoJSON Polygon
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne dla |
type |
string:
Polygon |
Określa |
GuidanceInstructionType
Typ instrukcji, np. obrót lub zmiana formy drogi.
Nazwa | Typ | Opis |
---|---|---|
DIRECTION_INFO |
string |
Informacje o kierunku. |
LOCATION_ARRIVAL |
string |
Lokalizacja przyjazdu. |
LOCATION_DEPARTURE |
string |
Lokalizacja odlotu. |
LOCATION_WAYPOINT |
string |
Lokalizacja punktu drogi. |
ROAD_CHANGE |
string |
Zmiana drogi. |
TURN |
string |
Włączyć. |
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 |
Pozostawić. |
ENTER_FREEWAY |
string |
Weź autostradę. |
ENTER_HIGHWAY |
string |
Weź autostradę. |
ENTER_MOTORWAY |
string |
Przejmij autostradę. |
ENTRANCE_RAMP |
string |
Przejmij rampę. |
FOLLOW |
string |
Wykonaj następujące. |
KEEP_LEFT |
string |
Pozostaw w lewo. |
KEEP_RIGHT |
string |
Zachowaj prawo. |
MAKE_UTURN |
string |
Utwórz zwrot u-turn. |
MOTORWAY_EXIT_LEFT |
string |
Wyjdź z lewego wyjścia. |
MOTORWAY_EXIT_RIGHT |
string |
Wyjdź z prawej strony. |
ROUNDABOUT_BACK |
string |
Pojechaj po rondzie. |
ROUNDABOUT_CROSS |
string |
Skrzyżowanie ronda. |
ROUNDABOUT_LEFT |
string |
Na rondzie zajmij się wyjściem po lewej stronie. |
ROUNDABOUT_RIGHT |
string |
Na rondzie zajmij się wyjściem po prawej stronie. |
SHARP_LEFT |
string |
Skręć w lewo. |
SHARP_RIGHT |
string |
Skręć ostro w prawo. |
STRAIGHT |
string |
Trzymaj się prosto. |
SWITCH_MAIN_ROAD |
string |
Przejdź do głównej drogi. |
SWITCH_PARALLEL_ROAD |
string |
Przełącz się na równoległą drogę. |
TAKE_EXIT |
string |
Wyjdź z wyjścia. |
TAKE_FERRY |
string |
Weź prom. |
TRY_MAKE_UTURN |
string |
Spróbuj wykonać u-turn. |
TURN_LEFT |
string |
Skręć w lewo. |
TURN_RIGHT |
string |
Skręć w prawo. |
WAYPOINT_LEFT |
string |
Osiągnięto punkt drogi. Jest po lewej stronie. |
WAYPOINT_REACHED |
string |
Osiągnięto punkt drogi. |
WAYPOINT_RIGHT |
string |
Osiągnięto punkt drogi. Jest po prawej stronie. |
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 |
Niskie |
normal |
string |
Normalne |
JunctionType
Typ skrzyżowania, w którym odbywa się manewr. W przypadku większych rond generowane są dwie oddzielne instrukcje dotyczące wejścia i opuszczenia ronda.
Nazwa | Typ | Opis |
---|---|---|
BIFURCATION |
string |
Rozwidlenia |
REGULAR |
string |
Regularne |
ROUNDABOUT |
string |
Rondzie |
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 |
|
xml |
string |
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 |
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 |
Zawiera elementy powiązane ze wskazówkami. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne. |
|
legs |
Route |
Tablica nogi |
sections |
Tablica sekcji |
|
summary |
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 |
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 |
RouteDirectionParameters
Parametry treści wpisu dla wskazówek trasy.
Nazwa | Typ | Opis |
---|---|---|
allowVignette |
string[] |
Jest to lista 3-znakowych, ISO 3166-1, alfa-3 kodów krajów/regionów, w których dozwolone są drogi płatne z winietami, np. "AUS,CHE". Określenie parametru allowVignette z niektórymi krajami/regionami X jest równoważne określeniu parametru avoidVignette ze wszystkimi krajami/regionami, ale X. Określenie parametru allowVignette z pustą listą jest takie samo, jak unikanie wszystkich dróg płatnych z winietami. Uwaga: Jest to błąd podczas określania zarówno parametru avoidVignette , jak i allowVignette. |
avoidAreas |
MultiPolygon GeoJSON reprezentujący listę obszarów, których należy unikać. Obsługiwane są tylko wielokąty prostokątne. Maksymalny rozmiar prostokąta wynosi około 160 x 160 km. Maksymalna liczba obszarów, których unika się, wynosi 10. Nie może przekroczyć 180. Musi należeć do zakresu od -80 do +80 stopni szerokości geograficznej. |
|
avoidVignette |
string[] |
Jest to lista 3-znakowych, ISO 3166-1, alfa-3 kodów krajów/regionów, w których należy unikać wszystkich dróg płatnych z winietami, np. "AUS,CHE". Nie ma to wpływu na drogi płatne z winietami w krajach/regionach, które nie znajdują się na liście. Uwaga: Jest to błąd podczas określania zarówno parametru avoidVignette , jak i allowVignette. |
supportingPoints |
Kolekcja Geometria GeoJSON reprezentująca sekwencję współrzędnych używanych jako dane wejściowe do rekonstrukcji trasy oraz do obliczania zerowych lub bardziej alternatywnych tras do tej trasy referencyjnej.
|
RouteDirections
Ten obiekt jest zwracany z pomyślnego wywołania Route Directions
Nazwa | Typ | Opis |
---|---|---|
formatVersion |
string |
Właściwość Formatuj wersję |
optimizedWaypoints |
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ź:
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 |
Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu. |
|
routes |
Route[] |
Tablica tras |
RouteGuidance
Zawiera wskazówki powiązane elementy. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne.
Nazwa | Typ | Opis |
---|---|---|
instructionGroups |
Grupy sekwencję elementów instrukcji, które są ze sobą powiązane. |
|
instructions |
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:
Możliwa flagaCombineWithNext w instrukcji 10 jest prawdziwa. Wskazuje to klientom zakodowanych wskazówek, że można je połączyć z instrukcją 11. Instrukcje zostaną automatycznie połączone dla klientów żądających wskazówek czytelnych dla człowieka. Pole połączoneMessage zawiera połączony komunikat:
|
countryCode |
string |
3-znakowy kod kraju ISO 3166-1 alfa-3. Np. USA. |
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 |
Typ instrukcji, np. obrót lub zmiana formy drogi. |
|
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 |
Kod identyfikujący manewr. |
|
message |
string |
Czytelny dla człowieka komunikat manewru. |
point |
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:
Jeśli junctionType wskazuje instrukcję bifurcation:
|
RouteInstructionGroup
Grupy sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony przez właściwość firstInstructionIndex i lastInstructionIndex. Gdy komunikaty tekstowe z możliwością odczytu przez człowieka są żądane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas instrukcjaGroup ma komunikat podsumowania zwrócony, gdy jest dostępny.
Nazwa | Typ | Opis |
---|---|---|
firstInstructionIndex |
integer |
Indeks pierwszej instrukcji w instrukcjach i należących do tej grupy. |
groupLengthInMeters |
integer |
Długość grupy. |
groupMessage |
string |
Komunikat podsumowania, gdy komunikaty tekstowe z możliwością odczytu przez człowieka są wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag). |
lastInstructionIndex |
integer |
Indeks ostatniej instrukcji w instrukcjach i należących do tej grupy. |
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):
|
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 dodatkowy element w zwróconej trasie.
Nazwa | Typ | Opis |
---|---|---|
points |
Tablica punktów |
|
summary |
Obiekt podsumowania dla sekcji trasy. |
RouteLegSummary
Obiekt podsumowania dla sekcji trasy.
Nazwa | Typ | Opis |
---|---|---|
arrivalTime |
string |
Szacowany czas przybycia trasy lub nogi. Godzina jest wyrażona w formacie UTC. |
batteryConsumptionInkWh |
number |
Szacowane zużycie energii elektrycznej w godzinach kilowatów (kWh) przy użyciu modelu zużycia energii elektrycznej. Uwzględnione, jeśli 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 nogi. Godzina jest wyrażona 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 obliczany przy użyciu danych historycznych zależnych od czasu. Uwzględnione tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu. |
lengthInMeters |
integer |
Długość w metrach, właściwość |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Szacowany czas podróży obliczany przy użyciu danych prędkości w czasie rzeczywistym. Uwzględnione tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu. |
noTrafficTravelTimeInSeconds |
integer |
Szacowany czas podróży obliczony tak, jakby nie było opóźnień na trasie ze względu na warunki ruchu (np. przeciążenie). Uwzględnione tylko wtedy, gdy parametr computeTravelTimeFor = wszystkie jest używany w zapytaniu. |
trafficDelayInSeconds |
integer |
Szacowane opóźnienie w sekundach spowodowane zdarzeniami w czasie rzeczywistym zgodnie z informacjami o ruchu. W przypadku tras planowanych z czasem odlotu w przyszłości opóźnienia są zawsze 0. Aby zwrócić dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu, parametr computeTravelTimeFor =wszystkie należy dodać. |
travelTimeInSeconds |
integer |
Szacowany czas podróży w sekundach, który obejmuje opóźnienie spowodowane ruchem w czasie rzeczywistym. Należy pamiętać, że nawet wtedy, gdy ruch =false travelTimeInSeconds nadal zawiera opóźnienie spowodowane ruchem. Jeśli funkcja DepartAt jest w przyszłości, czas podróży jest obliczany przy użyciu danych historycznych zależnych od czasu. |
RouteOptimizedWaypoint
Zoptymalizowany obiekt punktu.
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 |
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
, endPointIndex
i sectionType
.
Nazwa | Typ | Opis |
---|---|---|
delayInSeconds |
integer |
Opóźnienie w sekundach spowodowane zdarzeniem. |
effectiveSpeedInKmh |
integer |
Efektywna prędkość zdarzenia w km/h, średnia na całej długości. |
endPointIndex |
integer |
Indeks ostatniego punktu (przesunięcie 0) w trasie, do których ma zastosowanie ta sekcja. |
magnitudeOfDelay |
Wielkość opóźnienia spowodowanego incydentem. Te wartości odpowiadają wartościom pola odpowiedzi interfejsu API Pobierz szczegóły zdarzenia ruchu. |
|
sectionType |
Typy sekcji zgłoszonej odpowiedzi trasy |
|
simpleCategory |
Typ zdarzenia. Obecnie może być jam, ROAD_WORK, ROAD_CLOSURE lub INNE. Aby uzyskać szczegółowe informacje, zobacz "tec". |
|
startPointIndex |
integer |
Indeks pierwszego punktu (przesunięcie 0) w trasie, do których ma zastosowanie ta sekcja. |
tec |
Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC . Może zawierać efektCode i powoduje elementy. |
|
travelMode |
Tryb podróży dla trasy obliczeniowej. Wartość zostanie ustawiona na |
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 |
Powoduje tablicę |
|
effectCode |
integer |
Wpływ na przepływ ruchu. Zawiera wartość w tabeli tec001:EffectCode, zgodnie z definicją w standardzie TPEG2-TEC . Może służyć do kolorowania zdarzeń ruchu zgodnie z ważnością. |
RouteSectionTecCause
Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. Służy do definiowania ikonografii i opisów.
Nazwa | Typ | Opis |
---|---|---|
mainCauseCode |
integer |
Główną przyczyną zdarzenia ruchu. Zawiera wartość w tabeli tec002:CauseCode, zgodnie z definicją w standardzie TPEG2-TEC . |
subCauseCode |
integer |
Podkatazy zdarzenia ruchu. Zawiera wartość w tabeli przyczyny podrzędnej zdefiniowanej przez element mainCauseCode zgodnie z definicją w standardzie TPEG2-TEC . |
RouteSummary
Obiekt podsumowania
Nazwa | Typ | Opis |
---|---|---|
arrivalTime |
string |
Szacowany czas przybycia trasy lub nogi. Godzina jest wyrażona w formacie UTC. |
departureTime |
string |
Szacowany czas odlotu dla trasy lub nogi. Godzina jest wyrażona w formacie UTC. |
lengthInMeters |
integer |
Długość w metrach, właściwość |
trafficDelayInSeconds |
integer |
Szacowane opóźnienie w sekundach spowodowane zdarzeniami w czasie rzeczywistym zgodnie z informacjami o ruchu. W przypadku tras planowanych z czasem odlotu w przyszłości opóźnienia są zawsze 0. Aby zwrócić dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu, parametr computeTravelTimeFor =wszystkie należy dodać. |
travelTimeInSeconds |
integer |
Szacowany czas podróży w sekundach, który obejmuje opóźnienie spowodowane ruchem w czasie rzeczywistym. Należy pamiętać, że nawet wtedy, gdy ruch =false travelTimeInSeconds nadal zawiera opóźnienie spowodowane ruchem. Jeśli funkcja DepartAt jest w przyszłości, czas podróży jest obliczany przy użyciu danych historycznych zależnych od czasu. |
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 |
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 |
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 |
Korku. |
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 |
Niskie |
normal |
string |
Normalne |