Udostępnij za pośrednictwem

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Odwołanie
Pakiet:
@azure-rest/maps-route

Właściwości

arriveAt

Data i godzina przybycia do punktu docelowego sformatowane jako wartość dateTime zdefiniowana w RFC 3339, sekcja 5.6, z opcjonalnym przesunięciem strefy czasowej. Jeśli przesunięcie strefy czasowej nie zostanie określone, przyjmuje się, że jest to przesunięcie punktu docelowego.

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Nie można użyć parametru arriveAt w połączeniu z departAt, minDeviationDistance lub minDeviationTime.
avoid

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

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

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

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

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

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

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

Żądany typ trasy.
sectionType

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

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

Możliwe wartości:

  • true — należy wziąć pod uwagę wszystkie dostępne informacje o ruchu podczas routingu
  • false — ignoruj bieżące dane ruchu podczas routingu. Należy pamiętać, że chociaż bieżące dane ruchu są ignorowane podczas routingu, wpływ historycznego ruchu na efektywne prędkości drogowe jest nadal uwzględniany.
travelMode

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

Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.
vehicleHeight

Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.
vehicleLength

Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.
vehicleLoadType

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

Maksymalna prędkość pojazdu w km/godzinę. Maksymalna prędkość w profilu pojazdu służy do sprawdzania, czy pojazd jest dozwolony na autostradach.

  • Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania tras.

  • Wartość niezerowa może zostać zastąpiona podczas planowania trasy. Na przykład bieżący przepływ ruchu wynosi 60 km/godzinę. Jeśli maksymalna prędkość pojazdu wynosi 50 km/godzinę, silnik rozsyłania rozważy 60 km/godzinę, ponieważ jest to bieżąca sytuacja. Jeśli maksymalna prędkość pojazdu wynosi 80 km/godzinę, ale bieżący przepływ ruchu wynosi 60 km/godzinę, silnik routingu ponownie użyje 60 km/godzinę.
vehicleWeight

Waga pojazdu w kilogramach.
vehicleWidth

Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.
waitForResults

Wartość logiczna określająca, czy żądanie ma być wykonywane synchronicznie. Jeśli ustawiono wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund. W przeciwnym razie użytkownik otrzyma od razu odpowiedź 202. Aby uzyskać więcej informacji na temat odpowiedzi na 202, zapoznaj się z opisem interfejsu API. Obsługiwane tylko w przypadku żądania asynchronicznego.
windingness

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

Szczegóły właściwości

arriveAt

Data i godzina przybycia do punktu docelowego sformatowane jako wartość dateTime zdefiniowana w RFC 3339, sekcja 5.6, z opcjonalnym przesunięciem strefy czasowej. Jeśli przesunięcie strefy czasowej nie zostanie określone, przyjmuje się, że jest to przesunięcie punktu docelowego.

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Nie można użyć parametru arriveAt w połączeniu z departAt, minDeviationDistance lub minDeviationTime.

arriveAt?: string | Date

Wartość właściwości

string | Date

avoid

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.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Wartość właściwości

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

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.

computeTravelTimeFor?: "none" | "all"

Wartość właściwości

"none" | "all"

departAt

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

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

Przykłady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

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

departAt?: string | Date

Wartość właściwości

string | Date

hilliness

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

hilliness?: "low" | "normal" | "high"

Wartość właściwości

"low" | "normal" | "high"

routeType

Żądany typ trasy.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Wartość właściwości

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

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

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

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Wartość właściwości

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

Możliwe wartości:

  • true — należy wziąć pod uwagę wszystkie dostępne informacje o ruchu podczas routingu
  • false — ignoruj bieżące dane ruchu podczas routingu. Należy pamiętać, że chociaż bieżące dane ruchu są ignorowane podczas routingu, wpływ historycznego ruchu na efektywne prędkości drogowe jest nadal uwzględniany.
traffic?: boolean

Wartość właściwości

boolean

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.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Wartość właściwości

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.

vehicleAxleWeight?: number

Wartość właściwości

number

vehicleHeight

Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.

vehicleHeight?: number

Wartość właściwości

number

vehicleLength

Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.

vehicleLength?: number

Wartość właściwości

number

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.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Wartość właściwości

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

Maksymalna prędkość pojazdu w km/godzinę. Maksymalna prędkość w profilu pojazdu służy do sprawdzania, czy pojazd jest dozwolony na autostradach.

  • Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania tras.

  • Wartość niezerowa może zostać zastąpiona podczas planowania trasy. Na przykład bieżący przepływ ruchu wynosi 60 km/godzinę. Jeśli maksymalna prędkość pojazdu wynosi 50 km/godzinę, silnik rozsyłania rozważy 60 km/godzinę, ponieważ jest to bieżąca sytuacja. Jeśli maksymalna prędkość pojazdu wynosi 80 km/godzinę, ale bieżący przepływ ruchu wynosi 60 km/godzinę, silnik routingu ponownie użyje 60 km/godzinę.

vehicleMaxSpeed?: number

Wartość właściwości

number

vehicleWeight

Waga pojazdu w kilogramach.

vehicleWeight?: number

Wartość właściwości

number

vehicleWidth

Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.

vehicleWidth?: number

Wartość właściwości

number

waitForResults

Wartość logiczna określająca, czy żądanie ma być wykonywane synchronicznie. Jeśli ustawiono wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund. W przeciwnym razie użytkownik otrzyma od razu odpowiedź 202. Aby uzyskać więcej informacji na temat odpowiedzi na 202, zapoznaj się z opisem interfejsu API. Obsługiwane tylko w przypadku żądania asynchronicznego.

waitForResults?: boolean

Wartość właściwości

boolean

windingness

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

windingness?: "low" | "normal" | "high"

Wartość właściwości

"low" | "normal" | "high"