Route - Post Route Matrix Sync
Użyj polecenia , aby uzyskać macierz tras przedstawiającą czas podróży i odległość dla wszystkich możliwych par na liście źródeł i miejsc docelowych przy użyciu żądania synchronicznego.
Interfejs Post Route Matrix Sync
API to żądanie HTTP POST
, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu pojedynczego żądania synchronicznego (synchronizacji). Aby utworzyć żądanie asynchroniczne (asynchroniczne), zobacz Post Route Matrix (Macierz tras post). Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego danego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako kolumny i nagłówki wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu ze źródła do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.
Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Kierunek trasy.
Maksymalny rozmiar macierzy dla żądania asynchronicznego wynosi 700 , a żądanie synchronizacji wynosi 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych).
Prześlij żądanie macierzy tras synchronicznych
Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, może być konieczne wykonanie synchronicznego żądania. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
Przesyłanie żądania macierzy tras asynchronicznych
Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych woluminów stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wzdłuż adresu URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli waitForResults
parametr w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.
Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).
Odpowiedzi asynchroniczne są przechowywane przez 14 dni. Adres URL przekierowania zwraca odpowiedź 404, jeśli zostanie użyta po upływie okresu ważności.
POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
Oto typowa sekwencja operacji asynchronicznych:
Klient wysyła żądanie POST macierzy tras do usługi Azure Maps
Serwer odpowie jednym z następujących elementów:
HTTP
202 Accepted
— żądanie macierzy tras zostało zaakceptowane.HTTP
Error
— wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być błąd 400 Nieprawidłowe żądanie lub inny kod stanu błędu.Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:
GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
- Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3 w celu pobrania wyników
Pobieranie wyników synchronizacji
Po utworzeniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie możliwości późniejszego pobrania wyników.
Pobieranie wyników asynchronicznych
Gdy żądanie wysyła 202 Accepted
odpowiedź, żądanie jest przetwarzane przy użyciu potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:
GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu GET
żądania.
HTTP
202 Accepted
— żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.
HTTP
200 OK
— pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}§ionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Żądany format odpowiedzi. Obsługiwany jest tylko |
|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
arrive
|
query |
string date-time |
Data i godzina przybycia do punktu docelowego sformatowane jako wartość zdefiniowana Przykłady:
Nie można użyć parametru |
|
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 |
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. |
||
depart
|
query |
string date-time |
Data i godzina odejścia z punktu początkowego sformatowane jako
Przykłady:
Nie można użyć parametru |
|
hilliness
|
query |
Stopień hilliness do porywającej trasy. Tego parametru można używać tylko w połączeniu z |
||
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. |
||
vehicle
|
query |
integer |
Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę. |
|
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 uwzględniany tylko dla parametru 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. |
|
vehicle
|
query |
number double |
Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę. |
|
wait
|
query |
boolean |
Wartość logiczna określająca, czy żądanie ma być wykonywane synchronicznie. W przypadku ustawienia wartości true użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund. W przeciwnym razie użytkownik od razu otrzyma odpowiedź 202. Aby uzyskać więcej informacji na temat odpowiedzi na 202 r., zapoznaj się z opisem interfejsu API. Obsługiwane tylko w przypadku żądania asynchronicznego. |
|
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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
destinations |
Prawidłowy |
|
origins |
Prawidłowy |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki. |
|
Other Status Codes |
Limit czasu: żądanie trwało dłużej niż maksymalny czas zdefiniowany w interfejsie API. |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwagi
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
Element Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.
Typ:
apiKey
W:
header
Przykłady
Successfully retrieve a route matrix request result synchronously
Przykładowe żądanie
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest
{
"origins": {
"type": "MultiPoint",
"coordinates": [
[
4.85106,
52.36006
],
[
4.85056,
52.36187
]
]
},
"destinations": {
"type": "MultiPoint",
"coordinates": [
[
4.85003,
52.36241
],
[
13.42937,
52.50931
]
]
}
}
Przykładowa odpowiedź
{
"formatVersion": "0.0.1",
"matrix": [
[
{
"statusCode": 200,
"response": {
"routeSummary": {
"lengthInMeters": 495,
"travelTimeInSeconds": 134,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-27T22:55:29+00:00",
"arrivalTime": "2018-07-27T22:57:43+00:00"
}
}
},
{
"statusCode": 200,
"response": {
"routeSummary": {
"lengthInMeters": 647651,
"travelTimeInSeconds": 26835,
"trafficDelayInSeconds": 489,
"departureTime": "2018-07-27T22:55:29+00:00",
"arrivalTime": "2018-07-28T06:22:44+00:00"
}
}
}
],
[
{
"statusCode": 200,
"response": {
"routeSummary": {
"lengthInMeters": 338,
"travelTimeInSeconds": 104,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-27T22:55:29+00:00",
"arrivalTime": "2018-07-27T22:57:13+00:00"
}
}
},
{
"statusCode": 200,
"response": {
"routeSummary": {
"lengthInMeters": 647494,
"travelTimeInSeconds": 26763,
"trafficDelayInSeconds": 469,
"departureTime": "2018-07-27T22:55:29+00:00",
"arrivalTime": "2018-07-28T06:21:32+00:00"
}
}
}
]
],
"summary": {
"successfulRoutes": 4,
"totalRoutes": 4
}
}
{
"error": {
"code": "408 Timeout",
"message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
}
}
Definicje
Nazwa | Opis |
---|---|
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. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geo |
Prawidłowy |
Incline |
Stopień wzgórza do porywającej trasy. Ten parametr może być używany tylko w połączeniu z |
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko |
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 |
Obiekt podsumowania dla sekcji trasy. |
Route |
Obiekt wynikowy macierzy |
Route |
Obiekt z macierzą współrzędnych. |
Route |
Ten obiekt jest zwracany z pomyślnego wywołania macierzy tras. Na przykład, jeśli podano 2 źródła i 3 miejsca docelowe, w każdym z nich będzie 2 tablice z 3 elementami. Zawartość każdego elementu zależy od opcji podanych w zapytaniu. |
Route |
Obiekt odpowiedzi bieżącej komórki w macierzy wejściowej. |
Route |
Obiekt podsumowania |
Route |
Żądany typ trasy. |
Section |
Określa, które typy sekcji są zgłaszane w odpowiedzi trasy. |
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 |
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 |
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. |
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. |
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 |
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 |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko json
format.
Nazwa | Typ | Opis |
---|---|---|
json |
string |
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 |
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. |
RouteMatrix
Obiekt wynikowy macierzy
Nazwa | Typ | Opis |
---|---|---|
response |
Obiekt odpowiedzi bieżącej komórki w macierzy wejściowej. |
|
statusCode |
integer |
Właściwość StatusCode dla bieżącej komórki w macierzy wejściowej. |
RouteMatrixQuery
Obiekt z macierzą współrzędnych.
Nazwa | Typ | Opis |
---|---|---|
destinations |
Prawidłowy |
|
origins |
Prawidłowy |
RouteMatrixResult
Ten obiekt jest zwracany z pomyślnego wywołania macierzy tras. Na przykład, jeśli podano 2 źródła i 3 miejsca docelowe, w każdym z nich będzie 2 tablice z 3 elementami. Zawartość każdego elementu zależy od opcji podanych w zapytaniu.
Nazwa | Typ | Opis |
---|---|---|
formatVersion |
string |
Formatowanie właściwości Version |
matrix |
Wyniki są 2-wymiarową tablicą podsumowań tras. |
|
summary |
Obiekt podsumowania |
RouteMatrixResultResponse
Obiekt odpowiedzi bieżącej komórki w macierzy wejściowej.
Nazwa | Typ | Opis |
---|---|---|
routeSummary |
Obiekt podsumowania dla sekcji trasy. |
RouteMatrixSummary
Obiekt podsumowania
Nazwa | Typ | Opis |
---|---|---|
successfulRoutes |
integer |
Liczba pomyślnych tras w odpowiedzi. |
totalRoutes |
integer |
Łączna liczba żądanych tras. Liczba komórek w macierzy wejściowej. |
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. |
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. |
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 |