Sdílet prostřednictvím

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Reference
Balíček:
@azure-rest/maps-route

Vlastnosti

arriveAt

Datum a čas doručení v cílovém bodě formátovaný jako hodnota dateTime definovaná v RFC 3339, oddíl 5.6s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o cílový bod.

Příklady:

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

Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.
avoid

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.
computeTravelTimeFor

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.
departAt

Datum a čas odjezdu od počátečního bodu formátované jako dateTime hodnota definovaná v RFC 3339, oddíl 5.6, s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o počáteční bod.

  • Výchozí hodnota: teď
  • Jiná hodnota: dateTime

Příklady:

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

Parametr departAt nelze použít ve spojení s arriveAt.
hilliness

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.
routeType

Typ požadované trasy.
sectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto
traffic

Možné hodnoty:

  • true – Zvažte všechny dostupné informace o provozu během směrování.
  • false – Během směrování ignorujte aktuální data provozu. Mějte na paměti, že i když se aktuální data provozu během směrování ignorují, vliv historického provozu na efektivní rychlosti silničního provozu je stále začleněn.
travelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.
vehicleAxleWeight

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nebere v úvahu omezení hmotnosti na nápravu.
vehicleHeight

Výška vozidla v metrech. Hodnota 0 znamená, že se omezení výšky nepovažují.
vehicleLength

Délka vozidla v metrech. Hodnota 0 znamená, že omezení délky se nepovažují.
vehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.
vehicleMaxSpeed

Maximální rychlost vozidla v km/hodině. Maximální rychlost profilu vozidla se používá ke kontrole, zda je vozidlo povoleno na dálnicích.

  • Hodnota 0 znamená, že při plánování trasy se určí a použije příslušná hodnota pro vozidlo.

  • Během plánování trasy může být přepsána nenulová hodnota. Například aktuální tok provozu je 60 km/hodina. Pokud je maximální rychlost vozidla nastavená na 50 km/hodinu, bude směrovací motor považovat za aktuální situaci 60 km/hodinu. Pokud je maximální rychlost vozidla poskytována jako 80 km/hodina, ale aktuální tok provozu je 60 km/hodina, směrovací motor znovu použije 60 km/hodinu.
vehicleWeight

Hmotnost vozidla v kg.
vehicleWidth

Šířka vozidla v metrech. Hodnota 0 znamená, že se omezení šířky nepovažují.
waitForResults

Logická hodnota označující, jestli se má požadavek spustit synchronně. Pokud je nastavená hodnota true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund. V opačném případě uživatel okamžitě obdrží odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API. Podporováno pouze pro asynchronní požadavek.
windingness

Úroveň otáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

Podrobnosti vlastnosti

arriveAt

Datum a čas doručení v cílovém bodě formátovaný jako hodnota dateTime definovaná v RFC 3339, oddíl 5.6s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o cílový bod.

Příklady:

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

Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.

arriveAt?: string | Date

Hodnota vlastnosti

string | Date

avoid

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.

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

Hodnota vlastnosti

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

computeTravelTimeFor

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.

computeTravelTimeFor?: "none" | "all"

Hodnota vlastnosti

"none" | "all"

departAt

Datum a čas odjezdu od počátečního bodu formátované jako dateTime hodnota definovaná v RFC 3339, oddíl 5.6, s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o počáteční bod.

  • Výchozí hodnota: teď
  • Jiná hodnota: dateTime

Příklady:

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

Parametr departAt nelze použít ve spojení s arriveAt.

departAt?: string | Date

Hodnota vlastnosti

string | Date

hilliness

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

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

Hodnota vlastnosti

"low" | "normal" | "high"

routeType

Typ požadované trasy.

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

Hodnota vlastnosti

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

sectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto

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

Hodnota vlastnosti

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

traffic

Možné hodnoty:

  • true – Zvažte všechny dostupné informace o provozu během směrování.
  • false – Během směrování ignorujte aktuální data provozu. Mějte na paměti, že i když se aktuální data provozu během směrování ignorují, vliv historického provozu na efektivní rychlosti silničního provozu je stále začleněn.
traffic?: boolean

Hodnota vlastnosti

boolean

travelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.

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

Hodnota vlastnosti

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

vehicleAxleWeight

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nebere v úvahu omezení hmotnosti na nápravu.

vehicleAxleWeight?: number

Hodnota vlastnosti

number

vehicleHeight

Výška vozidla v metrech. Hodnota 0 znamená, že se omezení výšky nepovažují.

vehicleHeight?: number

Hodnota vlastnosti

number

vehicleLength

Délka vozidla v metrech. Hodnota 0 znamená, že omezení délky se nepovažují.

vehicleLength?: number

Hodnota vlastnosti

number

vehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.

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

Hodnota vlastnosti

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

vehicleMaxSpeed

Maximální rychlost vozidla v km/hodině. Maximální rychlost profilu vozidla se používá ke kontrole, zda je vozidlo povoleno na dálnicích.

  • Hodnota 0 znamená, že při plánování trasy se určí a použije příslušná hodnota pro vozidlo.

  • Během plánování trasy může být přepsána nenulová hodnota. Například aktuální tok provozu je 60 km/hodina. Pokud je maximální rychlost vozidla nastavená na 50 km/hodinu, bude směrovací motor považovat za aktuální situaci 60 km/hodinu. Pokud je maximální rychlost vozidla poskytována jako 80 km/hodina, ale aktuální tok provozu je 60 km/hodina, směrovací motor znovu použije 60 km/hodinu.

vehicleMaxSpeed?: number

Hodnota vlastnosti

number

vehicleWeight

Hmotnost vozidla v kg.

vehicleWeight?: number

Hodnota vlastnosti

number

vehicleWidth

Šířka vozidla v metrech. Hodnota 0 znamená, že se omezení šířky nepovažují.

vehicleWidth?: number

Hodnota vlastnosti

number

waitForResults

Logická hodnota označující, jestli se má požadavek spustit synchronně. Pokud je nastavená hodnota true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund. V opačném případě uživatel okamžitě obdrží odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API. Podporováno pouze pro asynchronní požadavek.

waitForResults?: boolean

Hodnota vlastnosti

boolean

windingness

Úroveň otáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

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

Hodnota vlastnosti

"low" | "normal" | "high"