Route - Get Route Range
Umożliwia tworzenie mapy przedstawiającej obszar dostępny z danego punktu w określonym progu na podstawie czasu, odległości lub pojemności paliwa.
Uwaga / Notatka
wycofywanie usługi Azure Maps Route v1
Usługa Azure Maps Route v1 jest teraz przestarzała i zostanie wycofana w dniu 3/31/28. Aby uniknąć przerw w działaniu usługi, należy zaktualizować wszystkie wywołania usługi Route v1, aby używać usługi Route v2025-01-01 do 31.31.28. Aby uzyskać więcej informacji, zobacz Migrate Azure Maps Route 1.0 APIs.
Interfejs API Get Route Range (Isochrone) to żądanie GET HTTP, które oblicza zestaw lokalizacji, które można uzyskać z punktu początkowego na podstawie określonego paliwa, energii, czasu lub budżetu odległości. Granica wielokąta (lub Isochrone) jest zwracana w orientacji odwrotnej, a także dokładnego środka wielokąta, który był wynikiem punktu początkowego.
Zwrócony wielokąt może służyć do dalszego przetwarzania, takiego jak Search Inside Geometry w celu wyszukiwania punktów weryfikacji w ramach podanego izochronu.
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&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 usługi Azure Maps. |
|
query
|
query | True |
number[] |
Współrzędna, z której ma zostać uruchomione obliczenie zakresu. |
|
acceleration
|
query |
number (double) minimum: 0maximum: 1 |
Określa wydajność konwersji energii chemicznej przechowywanej w paliwie na energię kinetyczną, gdy pojazd przyspiesza (tj. Kinetic EnergyGained/ChemicalEnerGained/ChemicalEnersumed). Chemical EnergyConsumed jest uzyskiwany przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaEnergiiInMJoulesPerLiter. Musi być sparowana z decelerationEfficiency. Dozwolony zakres wartości to od 0,0 do 1/decelerationEfficiency. Rozsądne wartości: dla modelu spalania : 0,33 dla modelu elektrycznego: 0,66 |
|
|
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żytego do utrzymania systemów pomocniczych pojazdu, w litrach na godzinę. Może służyć do określania zużycia ze względu na urządzenia i systemy, takie jak systemy AC, radio, ogrzewanie itp. Rozsądne wartości: 0,2 |
|
|
avoid
|
query |
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. |
||
|
constant
|
query |
string |
Określa składnik zależny od szybkości zużycia. Podana jako nieurządkowana lista par szybkości/szybkości użycia. Lista definiuje punkty na krzywej zużycia. Wskaźniki zużycia dla szybkości, które nie znajdują się na liście, znajdują się w następujący sposób:
Lista musi zawierać od 1 do 25 punktów (włącznie) i może nie zawierać zduplikowanych punktów dla tej samej prędkości. Jeśli zawiera tylko jeden punkt, wskaźnik zużycia tego punktu jest używany bez dalszego przetwarzania. Zużycie określone dla największej prędkości musi być większe lub równe z przedostatnią największą prędkością. Gwarantuje to, że ekstrapolacja nie prowadzi do ujemnych wskaźników zużycia. Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia dla każdej mniejszej prędkości. Prawidłowy zakres wartości zużycia (wyrażony w kWh/100km) wynosi od 0,01 do 10000,0. Rozsądne wartości: 50,8.2:130,21.3 Ten parametr jest wymagany dla Modelu zużycia energii elektrycznej. |
|
|
constant
|
query |
string |
Określa składnik zależny od szybkości zużycia. Podana jako lista nieuprzedażych par szybkości rozdzielonych dwukropkiem & par zużycia. Lista definiuje punkty na krzywej zużycia. Wskaźniki zużycia dla szybkości, które nie znajdują się na liście, znajdują się w następujący sposób:
Lista musi zawierać od 1 do 25 punktów (włącznie) i może nie zawierać zduplikowanych punktów dla tej samej prędkości. Jeśli zawiera tylko jeden punkt, wskaźnik zużycia tego punktu jest używany bez dalszego przetwarzania. Zużycie określone dla największej prędkości musi być większe lub równe z przedostatnią największą prędkością. Gwarantuje to, że ekstrapolacja nie prowadzi do ujemnych wskaźników zużycia. Podobnie wartości zużycia określone dla dwóch najmniejszych prędkości na liście nie mogą prowadzić do ujemnego zużycia dla każdej mniejszej prędkości. Prawidłowy zakres wartości zużycia (wyrażony w l/100km) wynosi od 0,01 do 10000,0. Rozsądne wartości: 50,6.3:130,11.5 Uwaga: ten parametr jest wymagany dla modelu zużycia spalania. |
|
|
current
|
query |
number (double) |
Określa bieżące zasilanie energii elektrycznej w kilowatach godzin (kWh). Ten parametr współistnieje z parametrem maxChargeInkWh. Dozwolony zakres wartości to 0,0 do maxChargeInkWh. Rozsądne wartości: 43 |
|
|
current
|
query |
number (double) |
Określa bieżącą dostawę paliwa w litrach. Rozsądne wartości: 55 |
|
|
deceleration
|
query |
number (double) minimum: 0maximum: 1 |
Określa wydajność konwersji energii kinetycznej w celu zaoszczędzenia (nieużytowanego) paliwa, gdy pojazd zwalnia (tj. ChemicalMachiSaved/KineticMachiLost). ChemicalMachiSaved jest uzyskiwany przez konwersję zapisanego (nieużywanego) paliwa na energię przy użyciu paliwaPrzezłodaneInMJoulesPerLiter. Musi być sparowana z accelerationEfficiency. Dozwolony zakres wartości to od 0,0 do 1/przyspieszanieSprawność. Rozsądne wartości: dla modelu spalania : 0,83 dla modelu elektrycznego : 0,91 |
|
|
depart
|
query |
string (date-time) |
Data i godzina odejścia od punktu początkowego sformatowane jako wartość
Przykłady:
Nie można użyć parametru |
|
|
distance
|
query |
number (double) |
Budżet odległości w metrach, który określa maksymalny zakres, który można pokonać przy użyciu odległości jazdy. Model zużycia będzie mieć wpływ tylko na zakres, gdy typ routeType jest ekologiczny. |
|
|
downhill
|
query |
number (double) minimum: 0maximum: 1 |
Określa wydajność konwersji potencjalnej energii w celu zaoszczędzenia (nieużytowanego) paliwa, gdy pojazd traci wysokość (tj. ChemicalMachiSaved/PotentialEnerLost). ChemicalMachiSaved jest uzyskiwany przez konwersję zapisanego (nieużywanego) paliwa na energię przy użyciu paliwaPrzezłodaneInMJoulesPerLiter. Musi być sparowana z pod góręEfficiency. Zakres dozwolonych wartości to od 0,0 do 1/pod góręEfficiency. Rozsądne wartości: dla modelu spalania : 0,51 dla modelu elektrycznego: 0,73 |
|
|
energy
|
query |
number (double) |
Budżet energii elektrycznej w godzinach kilowatów (kWh), który określa maksymalny zakres, który można użyć przy użyciu określonego modelu zużycia energii elektrycznej. |
|
|
fuel
|
query |
number (double) |
Budżet paliwa w litrach, który określa maksymalny zakres, który można przejeżdżać przy użyciu określonego modelu zużycia spalania. |
|
|
fuel
|
query |
number (double) |
Określa ilość energii chemicznej przechowywanej w jednym litrze paliwa w megajulach (MJ). Jest on używany w połączeniu z *Wydajność parametrów konwersji między zaoszczędzone lub zużywane energii i paliwa. Na przykład gęstość energii wynosi 34,2 MJ/l dla benzyny i 35,8 MJ/l dla paliwa diesla. Ten parametr jest wymagany, jeśli jest ustawiony dowolny parametr *Wydajność. Rozsądne wartości: 34.2 |
|
|
hilliness
|
query |
Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z |
||
|
max
|
query |
number (double) |
Określa maksymalny zasilacz energii elektrycznej w kilowatach (kWh), które mogą być przechowywane w baterii pojazdu. Ten parametr współistnieje z parametrem currentChargeInkWh. Wartość minimalna musi być większa lub równa currentChargeInkWh. Rozsądne wartości: 85 |
|
|
route
|
query |
Żądany typ trasy. |
||
|
time
|
query |
number (double) |
Budżet czasu w sekundach określający maksymalny zakres, który można podróżować przy użyciu czasu jazdy. Model zużycia będzie mieć wpływ tylko na zakres, gdy typ routeType jest ekologiczny. |
|
|
traffic
|
query |
boolean |
Możliwe wartości:
|
|
|
travel
|
query |
Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach. |
||
|
uphill
|
query |
number (double) minimum: 0maximum: 1 |
Określa efektywność konwersji energii chemicznej przechowywanej w paliwie na potencjalną energię, gdy pojazd zyskuje wysokość (tj. Potential EnergyGained/Chemical EnergyConsumed). Chemical EnergyConsumed jest uzyskiwany przez konwersję zużytego paliwa na energię chemiczną przy użyciu paliwaEnergiiInMJoulesPerLiter. Musi być sparowany z downhillEfficiency. Dozwolony zakres wartości to od 0,0 do 1/downhillEfficiency. Rozsądne wartości: dla modelu spalania : 0,27, dla modelu elektrycznego : 0,74 |
|
|
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 |
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 |
Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy US Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach/regionach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu USA, podczas gdy innehazmat powinny być używane dla wszystkich innych krajów/regionów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie brany pod uwagę tylko dla travelMode=truck. |
||
|
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 |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Notatki
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Successfully retrieve a set of locations that can be reached from the origin point based on various conditions
Przykładowe żądanie
GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000
Przykładowa odpowiedź
{
"formatVersion": "0.0.1",
"reachableRange": {
"center": {
"latitude": 50.9745,
"longitude": 5.86605
},
"boundary": [
{
"latitude": 52.03704,
"longitude": 5.73602
},
{
"latitude": 52.09456,
"longitude": 5.59435
},
{
"latitude": 52.16815,
"longitude": 5.42279
},
{
"latitude": 52.25047,
"longitude": 5.21276
},
{
"latitude": 52.21374,
"longitude": 5.15355
},
{
"latitude": 52.25674,
"longitude": 4.96687
},
{
"latitude": 52.07834,
"longitude": 4.739
},
{
"latitude": 52.05647,
"longitude": 4.72513
},
{
"latitude": 51.94553,
"longitude": 4.53237
},
{
"latitude": 51.70119,
"longitude": 4.31165
},
{
"latitude": 51.5837,
"longitude": 4.28917
},
{
"latitude": 51.48463,
"longitude": 3.82685
},
{
"latitude": 51.21096,
"longitude": 3.62838
},
{
"latitude": 50.6814,
"longitude": 3.89244
},
{
"latitude": 50.66791,
"longitude": 3.93493
},
{
"latitude": 50.49042,
"longitude": 3.98156
},
{
"latitude": 50.30944,
"longitude": 4.47995
},
{
"latitude": 50.24448,
"longitude": 4.60502
},
{
"latitude": 50.24467,
"longitude": 4.89999
},
{
"latitude": 50.08735,
"longitude": 5.04206
},
{
"latitude": 49.99214,
"longitude": 5.23042
},
{
"latitude": 49.88478,
"longitude": 5.40994
},
{
"latitude": 49.85797,
"longitude": 5.46178
},
{
"latitude": 49.86279,
"longitude": 5.7196
},
{
"latitude": 49.83259,
"longitude": 5.74151
},
{
"latitude": 50.22239,
"longitude": 5.9387
},
{
"latitude": 50.0011,
"longitude": 6.08535
},
{
"latitude": 50.04616,
"longitude": 6.12089
},
{
"latitude": 50.09472,
"longitude": 6.28373
},
{
"latitude": 49.95863,
"longitude": 6.51654
},
{
"latitude": 50.00485,
"longitude": 6.61034
},
{
"latitude": 50.00587,
"longitude": 6.70295
},
{
"latitude": 50.2947,
"longitude": 6.65865
},
{
"latitude": 50.36903,
"longitude": 6.79276
},
{
"latitude": 50.31614,
"longitude": 7.32163
},
{
"latitude": 50.36737,
"longitude": 7.58782
},
{
"latitude": 50.46919,
"longitude": 7.7626
},
{
"latitude": 50.96246,
"longitude": 7.9826
},
{
"latitude": 51.07086,
"longitude": 7.55924
},
{
"latitude": 51.36614,
"longitude": 7.58138
},
{
"latitude": 51.52015,
"longitude": 7.67861
},
{
"latitude": 51.65781,
"longitude": 7.35175
},
{
"latitude": 51.81916,
"longitude": 7.21664
},
{
"latitude": 51.9587,
"longitude": 7.0467
},
{
"latitude": 51.82713,
"longitude": 6.67267
},
{
"latitude": 51.81133,
"longitude": 6.48424
},
{
"latitude": 51.9368,
"longitude": 6.27316
},
{
"latitude": 52.01701,
"longitude": 6.14452
},
{
"latitude": 52.20847,
"longitude": 6.09312
},
{
"latitude": 52.23705,
"longitude": 6.01297
}
]
}
}
Definicje
| Nazwa | Opis |
|---|---|
|
Effective |
Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API usługi Route. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Incline |
Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z |
|
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna. |
|
Response |
Żądany format odpowiedzi. Wartość może być json lub xml. |
|
Route |
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. |
|
Route |
Osiągalny zakres |
|
Route |
Ten obiekt jest zwracany z pomyślnego wywołania zakresu osiągalnego trasy |
|
Route |
Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu. |
|
Route |
Żądany typ trasy. |
|
Travel |
Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach. |
|
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 brany pod uwagę tylko dla travelMode=truck. |
|
Windingness |
Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z |
EffectiveSetting
Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API usługi Route.
| Nazwa | Typ | Opis |
|---|---|---|
| key |
string |
Nazwa używanego parametru. |
| value |
string |
Wartość użytego parametru. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
object |
Dodatkowe informacje. |
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
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 błędu. |
InclineLevel
Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling.
| Wartość | Opis |
|---|---|
| low |
Niski |
| normal |
normalny |
| high |
wysoki |
LatLongPair
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
| Nazwa | Typ | Opis |
|---|---|---|
| latitude |
number (double) |
Właściwość Szerokość geograficzna |
| longitude |
number (double) |
Właściwość Długość geograficzna |
ResponseFormat
Żądany format odpowiedzi. Wartość może być json lub xml.
| Wartość | Opis |
|---|---|
| json | |
| xml |
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.
| Wartość | Opis |
|---|---|
| tollRoads |
Omija drogi płatne. |
| motorways |
Omija autostrady |
| ferries |
Unika promów |
| unpavedRoads |
Omija drogi nieutwardzone |
| carpools |
Unika tras, które wymagają korzystania z pasów carpoolingu (HOV/High Occupancy Vehicle). |
| alreadyUsedRoads |
Unika wielokrotnego korzystania z tej samej drogi. Najbardziej przydatne w połączeniu z |
| borderCrossings |
Unikanie przekraczania granic przy obliczaniu trasy. |
RouteRange
Osiągalny zakres
| Nazwa | Typ | Opis |
|---|---|---|
| boundary |
Wielokątna granica osiągalnego zakresu reprezentowana jako lista punktów. |
|
| center |
Punkt środkowy dostępnego zakresu |
RouteRangeResult
Ten obiekt jest zwracany z pomyślnego wywołania zakresu osiągalnego trasy
| Nazwa | Typ | Opis |
|---|---|---|
| formatVersion |
string |
Formatowanie właściwości Version |
| reachableRange |
Osiągalny zakres |
|
| report |
Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu. |
RouteReport
Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu.
| Nazwa | Typ | Opis |
|---|---|---|
| effectiveSettings |
Obowiązujące parametry lub dane używane podczas wywoływania tego interfejsu API trasy. |
RouteType
Żądany typ trasy.
| Wartość | Opis |
|---|---|
| fastest |
Najszybsza trasa. |
| shortest |
Najkrótsza trasa pod względem odległości. |
| eco |
Trasa zrównoważona pod względem ekonomii i prędkości. |
| thrilling |
Obejmuje interesujące lub wymagające drogi i wykorzystuje jak najmniej autostrad. Możesz wybrać poziom dołączonych zakrętów, a także stopień pagórkowatości. Zobacz parametry pagórkowatości i uzwojenia, aby dowiedzieć się, jak to ustawić. Obowiązuje limit 900 km na trasach zaplanowanych z |
TravelMode
Tryb podróży dla żądanej trasy. Jeśli nie jest zdefiniowana, wartość domyślna to "samochód". Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie "inny". Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach.
| Wartość | Opis |
|---|---|
| car |
Zwrócone trasy są zoptymalizowane pod kątem samochodów. |
| truck |
Zwrócone trasy są zoptymalizowane pod kątem pojazdów komercyjnych, takich jak dla ciężarówek. |
| taxi |
Zwrócone trasy są zoptymalizowane pod kątem taksówek. Funkcje beta. |
| bus |
Zwrócone trasy są zoptymalizowane pod kątem autobusów, w tym korzystanie tylko z pasów ruchu autobusowego. Funkcje beta. |
| van |
Zwrócone trasy są zoptymalizowane pod kątem furgonetek. Funkcje beta. |
| motorcycle |
Zwrócone trasy są zoptymalizowane pod kątem motocykli. Funkcje beta. |
VehicleEngineType
Typ silnika pojazdu. Po określeniu szczegółowego modelu zużycia musi być zgodny z wartością vehicleEngineType.
| Wartość | Opis |
|---|---|
| combustion |
Silnik spalinowy. |
| electric |
Silnik elektryczny. |
VehicleLoadType
Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy US Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach/regionach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu USA, podczas gdy innehazmat powinny być używane dla wszystkich innych krajów/regionów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie brany pod uwagę tylko dla travelMode=truck.
| Wartość | Opis |
|---|---|
| USHazmatClass1 |
Explosives |
| USHazmatClass2 |
Gaz sprężony |
| USHazmatClass3 |
Ciecze łatwopalne |
| USHazmatClass4 |
Substancje stałe łatwopalne |
| USHazmatClass5 |
Oxidizers |
| USHazmatClass6 |
Poisons |
| USHazmatClass7 |
Radioactive |
| USHazmatClass8 |
Corrosives |
| USHazmatClass9 |
Różne |
| otherHazmatExplosive |
Explosives |
| otherHazmatGeneral |
Różne |
| otherHazmatHarmfulToWater |
Działa szkodliwie na wodę |
WindingnessLevel
Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling.
| Wartość | Opis |
|---|---|
| low |
Niski |
| normal |
normalny |
| high |
wysoki |