Route - Post Route Matrix

Rozhraní API Route Matrix je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí žádosti o synchronizaci. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Matice tras lze vypočítat pro jízdu, pěší a nákladní trasy. Například společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API Route Matrix a pomocí nákladů na cestování řadit řidiče podle jejich skutečné vzdálenosti nebo času z restaurace.

Matice tras se používají v několika různých typech aplikací, nejčastěji k řešení problému cestovního prodejce (TSP) a problému se směrováním vozidel (VRP). Pro každou dvojici určení původu v matici se vrátí doba cesty a vzdálenost. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

Maximální velikost matice pro žádost o synchronizaci je 2500 (počet původů vynásobený počtem cílů).

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 2500, můžete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 2500 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 50x50, 60x40, 90x20 (nemusí být čtvercové).

Omezení rozhraní API

Synchronní zpracování matice je nejvhodnější pro rychlé a malé matice výpočtu trasy. Pokud chcete vypočítat větší matice a výpočet těžké trasy, použijte asynchronní koncový bod. Následující omezení platí pro synchronní požadavky. Pokud žádný z řádků v následující tabulce neodpovídá parametrům požadavku, požadavek nesplňuje požadavky a nebude zpracován.

| Maximální velikost matice | Maximální počet počátků | Maximální počet destinací | Další limity

|------------------|------------------------|----------------------------|------------| | 100 | 100 | 100 | N/A | | 200 | 200 | 200 | Všechny výchozí a cílové body by měly být umístěny v ose zarovnaném ohraničovacím boxu o rozměrech 400 km x 400 km. V opačném případě budou některé maticové buňky vyřešeny jako OUT_OF_REGION. | | 2500 | 1000 | 1000 | - nebo departAtarriveAt musí být nějakým.
- traffic musí být historické.
- travelMode musí být buď řízení, nebo nákladní vůz
- Žádné jiné parametry nelze explicitně použít |

Příklady:

  • Požadavek matice 10x20 s traffic=live: Tento požadavek bude zpracován s limitem ohraničujícího rámečku, protože odpovídá limitu až 200, což zahrnuje omezení ohraničujícího rámečku.

  • Požadavek matice 10x20 s výchozími parametry (traffic=historical): Tento požadavek bude zpracován bez limitu ohraničujícího rámečku, protože odpovídá limitu až 2500, což neukládá omezení ohraničujícího rámečku.

POST {endpoint}/route/matrix?api-version=2025-01-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Media Types: "application/geo+json"

Name Vyžadováno Typ Description
x-ms-client-id

string

Označuje účet určený pro použití s bezpečnostním modelem Microsoft Entra ID. Toto jedinečné ID pro účet Azure Maps lze získat z API účtu Azure Maps management plane. Pro více informací o používání Microsoft Entra ID bezpečnosti v Azure Maps viz Spravovat autentizaci v Azure Maps.

Text požadavku

Media Types: "application/geo+json"

Name Vyžadováno Typ Description
features True

InputRouteMatrixFeaturesItem[]

Sada počátečních a cílových bodů předaných jako funkce GeoJSON MultiPoint pro vstupní matici. Podrobnosti o formátu GeoJSON najdete v dokumentu RFC 7946 .

type True

FeatureTypeEnum

Určuje typ GeoJSON. Jediný podporovaný typ objektu je FeatureCollection. Další informace naleznete v tématu RFC 7946.

arriveAt

string (date-time)

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

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

arriveAt podporuje také hodnotu any, která je přizpůsobena případu použití, kdy kontext času není relevantní. Hodnotu parametru traffic=live nelze použít společně s any.

Výchozí hodnota: any, pokud není zadán arriveAt.

Příklad: "arriveAt": "2024-12-01T09:30:00.000-07:00"

avoid

RouteMatrixAvoidEnum[]

Určuje omezení, která má výpočet trasy dodržovat při určování trasy. Vyhněte se podpoře více hodnot v požadavku a je podporován pouze pro jízdu a nákladní vůzMode.

departAt

string (date-time)

Datum a čas odjezdu z počátečního bodu formátovaného jako dateTime hodnota definovaná RFC 3339, bod 5.6. Pokud není zadán posun časového pásma, předpokládá se utc.

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

departAt také podporuje:

any hodnota přizpůsobená případu použití, kdy kontext času není relevantní. Hodnotu parametru traffic=live nelze použít společně s any.

now hodnotu, která nastaví čas odletu na dobu zpracování každé jednotlivé buňky. Doba zpracování může být mezi odesláním a jejím dokončením kdykoli. Tento režim se nejlépe používá společně s traffic=live.

Výchozí hodnota: any, pokud není zadán departAt.

Příklad:

"departAt": "2024-12-01T09:30:00.000-07:00"

optimizeRoute

RouteMatrixOptimizeRouteEnum

Určuje parametr, který se má použít k optimalizaci trasy. Pokud není definovaná, výchozí hodnota je "nejrychlejší", která vrací trasu, která minimalizuje dobu trvání cesty.

Příklad: "optimizeRoute":"nejrychlejší "

traffic

RouteMatrixTrafficEnum

Určuje, jak se provoz považuje za výpočetní trasy.

Výchozí hodnota: historical

travelMode

RouteMatrixTravelModeEnum

Určuje cestovní profil, který se má při výpočtu matice zvážit. Pokud není zadána, výchozí hodnota je "řízení".

Příklad: travelMode:"driving"

vehicleSpec

RouteMatrixVehicleSpec

Určuje atributy vozidla, jako je výška vozidla, hmotnost, maximální rychlost, typ nákladu atd. při výpočtu matice trasy. To pomáhá vyhnout se nízkým volným místům mostu, omezením silničního provozu, obtížnému pravému otočení, aby byla zajištěna optimalizovaná trasa na základě specifikací vozidel. Atributy vozidla jsou zadány v rámci vlastnosti vehicleSpec.

Odpovědi

Name Typ Description
200 OK

RouteMatrixResponse

Požadavek byl úspěšný.

Media Types: "application/geo+json", "application/json"

Other Status Codes

MapsErrorResponse

Neočekávaná chybová odpověď

Media Types: "application/geo+json", "application/json"

Zabezpečení

AadToken

Jsou to Microsoft Entra OAuth 2.0 Flows. V kombinaci s Azure řízením přístupu založeného na rolích lze použít k řízení přístupu k Azure Maps REST API. Role Azure kontroly přístupu se používají k určení přístupu k jednomu nebo více účtům nebo podzdrojům Azure Maps. Každému uživateli, skupině nebo principálu služby může být udělen přístup prostřednictvím vestavěné role nebo vlastní role složené z jednoho či více oprávnění k Azure Maps REST API.\n\nPro implementaci scénářů doporučujeme zobrazit koncepty autentizace. Shrnuto, tato definice bezpečnosti poskytuje řešení pro modelování aplikací pomocí objektů schopných kontroly přístupu ke specifickým API a rozsahům.\n\n#### Poznámky\n* Tato bezpečnostní definice vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému Azure Maps zdroji aplikace žádá přístup. Tuto možnost lze získat z API pro správu Maps.\n* \nAuthorization URL je specifický pro instanci Azure veřejného cloudu. Suverénní cloudy mají unikátní autorizační URL a konfigurace Microsoft Entra ID. \n* \nŘízení přístupu založené na rolích Azure je konfigurováno z Azure management plane prostřednictvím Azure portálu, PowerShellu, CLI, Sady Azure SDK nebo REST API.\n* \nVyužití Azure Maps Web SDK umožňuje konfigurační nastavení aplikace pro více případů použití.\n* Pro více informací o Microsoft identity platform viz přehled Microsoft identity platform přehled.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zpřístupní, když Vytvoříte Azure Maps účet v Azure portálu nebo pomocí PowerShell, CLI, Sady Azure SDK či REST API.\n\n S tímto klíčem může jakákoli aplikace přistupovat ke všem REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, na který jsou vydávány.\n\n Pro veřejně přístupné aplikace doporučujeme použít přístup confidential client applications k přístupu Azure Maps REST API, aby mohl být klíč bezpečně uložen.

Typ: apiKey
V: header

SAS Token

Tento token sdíleného přístupového podpisu je vytvořen operací List SAS na Azure Maps resource přes Azure management plane přes Azure portál, PowerShell, CLI, Sady Azure SDK nebo REST API.\n\n S tímto tokenem je jakákoli aplikace oprávněna přistupovat pomocí Azure Kontroly přístupu založené na rolích a jemná opatření k expiraci, rychlosti a regionům využití konkrétního tokenu. Jinými slovy, SAS Token lze použít k tomu, aby aplikace mohly bezpečněji kontrolovat přístup než sdílený klíč.\n\n Pro veřejně vystavené aplikace doporučujeme nastavit konkrétní seznam povolených původů na zdroji účtu Map, aby se omezilo zneužívání vykreslování a pravidelně obnovovat SAS Token.

Typ: apiKey
V: header

Příklady

Successfully retrieve a route matrix with additional parameters in the body

Ukázkový požadavek

POST {endpoint}/route/matrix?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "avoid": [
    "unpavedRoads"
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck"
}

Ukázková odpověď

{
  "type": "Feature",
  "geometry": null,
  "properties": {
    "matrix": [
      {
        "arrivalAt": "2022-12-19T22:30:03+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 0,
        "distanceInMeters": 492466,
        "durationInSeconds": 21007,
        "durationTrafficInSeconds": 21007,
        "originIndex": 0,
        "statusCode": 200
      },
      {
        "arrivalAt": "2022-12-20T02:00:19+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 1,
        "distanceInMeters": 877028,
        "durationInSeconds": 33623,
        "durationTrafficInSeconds": 33623,
        "originIndex": 0,
        "statusCode": 200
      },
      {
        "arrivalAt": "2022-12-19T22:05:16+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 0,
        "distanceInMeters": 427769,
        "durationInSeconds": 19520,
        "durationTrafficInSeconds": 19520,
        "originIndex": 1,
        "statusCode": 200
      },
      {
        "arrivalAt": "2022-12-20T01:34:27+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 1,
        "distanceInMeters": 836080,
        "durationInSeconds": 32070,
        "durationTrafficInSeconds": 32070,
        "originIndex": 1,
        "statusCode": 200
      }
    ],
    "summary": {
      "successfulCount": 4,
      "totalCount": 4
    }
  }
}

Definice

Name Description
AdrTunnelRestrictionCodeEnum

Kód omezení tunelu ADR. ADR je evropská dohoda o mezinárodní přepravě nebezpečného zboží po silnici. Kód omezení tunelu ADR slouží k určení, zda je vozidlo povoleno projít tunelem s omezeními pro přepravu nebezpečného zboží.

CommonErrorDetail

Podrobnosti o chybě.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

FeaturesItemTypeEnum

Určuje typ GeoJSON. Jediným podporovaným typem objektu je Funkce. Další informace naleznete v tématu RFC 7946.

FeatureTypeEnum

Určuje typ GeoJSON. Jediný podporovaný typ objektu je FeatureCollection. Další informace naleznete v tématu RFC 7946.

GeoJsonMultiPoint

Platný typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

GeoJsonObjectType

Určuje typ GeoJSON. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

InputRouteMatrixFeaturesItem

Určuje vstupní počáteční a cílové body a další vlastnosti pro objekt funkce GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

InputRouteMatrixProperties

Určuje objekt vlastností pro vstupní matici.

MapsErrorDetail

Podrobnosti o chybě.

MapsErrorResponse

Běžná chybová odpověď pro Azure Maps API pro vrácení chybových detailů pro neúspěšné operace.

MapsInnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.

RouteMatrixAvoidEnum

Určuje omezení, která má výpočet trasy dodržovat při určování trasy. Vyhněte se podpoře více hodnot v požadavku a je podporován pouze pro jízdu a nákladní vůzMode.

RouteMatrixFeatureProperties

Vlastnosti matice směrování

RouteMatrixItemResult

Výsledek položky matice směrování

RouteMatrixOptimizeRouteEnum

Určuje parametr, který se má použít k optimalizaci trasy. Pokud není definovaná, výchozí hodnota je "nejrychlejší", která vrací trasu, která minimalizuje dobu trvání cesty.

Příklad: "optimizeRoute":"nejrychlejší "

RouteMatrixRequest

Umožňuje získat matici tras zobrazující dobu cesty a vzdálenost pro všechny možné páry v seznamu původu a cíle. GeoJSON objekt funkce a další vlastnosti. Podrobnosti najdete v RFC 7946.

RouteMatrixResponse

Tento objekt se vrátí z úspěšného volání.

RouteMatrixSummary

Souhrn požadavku na matici tras

RouteMatrixTrafficEnum

Určuje, jak se provoz považuje za výpočetní trasy.

Výchozí hodnota: historical

RouteMatrixTravelModeEnum

Určuje cestovní profil, který se má při výpočtu matice zvážit. Pokud není zadána, výchozí hodnota je "řízení".

Příklad: travelMode:"driving"

RouteMatrixTypeEnum

Určuje původní typ MultiPointu a cílový typ MultiPointu pro vstupní matici.

RouteMatrixVehicleSpec

Určuje atributy vozidla, jako je výška vozidla, hmotnost, maximální rychlost, typ nákladu atd. při výpočtu matice trasy. To pomáhá vyhnout se nízkým volným místům mostu, omezením silničního provozu, obtížnému pravému otočení, aby byla zajištěna optimalizovaná trasa na základě specifikací vozidel. Atributy vozidla jsou zadány v rámci vlastnosti vehicleSpec.

VehicleLoadTypeEnum

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice.

AdrTunnelRestrictionCodeEnum

Kód omezení tunelu ADR. ADR je evropská dohoda o mezinárodní přepravě nebezpečného zboží po silnici. Kód omezení tunelu ADR slouží k určení, zda je vozidlo povoleno projít tunelem s omezeními pro přepravu nebezpečného zboží.

Hodnota Description
B

Vozidla s kódem B jsou omezena na silnice s kategoriemi tunelu ADR B, C, D a E.

C

Vozidla s kódem C jsou omezena na silnice s kategoriemi tunelu ADR C, D a E

D

Vozidla s kódem D jsou omezena na silnice s kategoriemi tunelu ADR D a E.

E

Vozidla s kódem E jsou omezena na silnice s kategorií tunelu ADR E.

CommonErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

CommonErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

FeaturesItemTypeEnum

Určuje typ GeoJSON. Jediným podporovaným typem objektu je Funkce. Další informace naleznete v tématu RFC 7946.

Hodnota Description
Feature

Určuje typ objektu GeoJSON Feature.

FeatureTypeEnum

Určuje typ GeoJSON. Jediný podporovaný typ objektu je FeatureCollection. Další informace naleznete v tématu RFC 7946.

Hodnota Description
FeatureCollection

Určuje typ objektu GeoJSONFeatureCollection.

GeoJsonMultiPoint

Platný typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

Name Typ Description
coordinates

number[] (double)

Souřadnice pro geometrii GeoJson MultiPoint.

type string:

MultiPoint

Určuje typ GeoJSON. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonObjectType

Určuje typ GeoJSON. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Hodnota Description
Point

GeoJSON Point geometrie.

MultiPoint

GeoJSON MultiPoint geometrie.

LineString

GeoJSON LineString geometrie.

MultiLineString

GeoJSON MultiLineString geometrie.

Polygon

GeoJSON Polygon geometrie.

MultiPolygon

GeoJSON MultiPolygon geometrie.

GeometryCollection

GeoJSON GeometryCollection geometrie.

Feature

GeoJSON Feature objekt.

FeatureCollection

GeoJSON FeatureCollection objekt.

InputRouteMatrixFeaturesItem

Určuje vstupní počáteční a cílové body a další vlastnosti pro objekt funkce GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

Name Typ Description
geometry

GeoJsonMultiPoint

Platný typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

properties

InputRouteMatrixProperties

Objekt vlastností funkce MultiPointu, který určuje funkce původu a cílové funkce pro vstupní matici.

type

FeaturesItemTypeEnum

Určuje typ GeoJSON. Jediným podporovaným typem objektu je Funkce. Další informace naleznete v tématu RFC 7946.

InputRouteMatrixProperties

Určuje objekt vlastností pro vstupní matici.

Name Typ Description
pointType

RouteMatrixTypeEnum

Určuje původní typ MultiPointu a cílový typ MultiPointu pro vstupní matici.

MapsErrorDetail

Podrobnosti o chybě.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.

details

MapsErrorDetail[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.

innererror

MapsInnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.

message

string

Čitelné znázornění chyby člověkem.

target

string

Cíl chyby.

MapsErrorResponse

Běžná chybová odpověď pro Azure Maps API pro vrácení chybových detailů pro neúspěšné operace.

Name Typ Description
error

MapsErrorDetail

Podrobnosti o chybě.

MapsInnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.

Name Typ Description
code

string

Kód chyby.

innererror

MapsInnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.

RouteMatrixAvoidEnum

Určuje omezení, která má výpočet trasy dodržovat při určování trasy. Vyhněte se podpoře více hodnot v požadavku a je podporován pouze pro jízdu a nákladní vůzMode.

Hodnota Description
tollRoads

Vyhne se používání zpoplatněných silnic v trase.

unpavedRoads

Vyhýbá se nepopáděným cestám v trase.

RouteMatrixFeatureProperties

Vlastnosti matice směrování

Name Typ Description
matrix

RouteMatrixItemResult[]

Matice výsledků trasy.

summary

RouteMatrixSummary

Souhrn požadavku na matici tras

RouteMatrixItemResult

Výsledek položky matice směrování

Name Typ Description
arrivalAt

string (date-time)

Odhadovaná doba příjezdu, která bere v úvahu dopravní podmínky, je formátována jako hodnota dateTime definovaná RFC 3339, oddíl 5.6. Bude odkazovat na posun časového pásma departAt nebo arrivalAt. Pokud ne, použije se čas UTC. Pokud je departAt nebo arriveAt jakýkoli, pak departureAt chybí.

departureAt

string (date-time)

Odhadovaná doba odletu, která bere v úvahu dopravní podmínky, je formátována jako hodnota dateTime definovaná RFC 3339, oddíl 5.6. Bude odkazovat na posun časového pásma departAt nebo arrivalAt. Pokud ne, použije se čas UTC. Pokud je departAt nebo arriveAt , anypak departureAt chybí.

destinationIndex

integer (int32)

Index cílového bodu

distanceInMeters

number (double)

Vlastnost Délka v metrech

durationInSeconds

integer (int64)

Odhadovaná doba trvání cesty v sekundách, která nezahrnuje zpoždění na trase kvůli dopravním podmínkám.

durationTrafficInSeconds

integer (int64)

Doba, kterou trvá cesta odpovídajícího TravelDistance s aktuálními dopravními podmínkami, trvá v sekundách. Tato hodnota se poskytuje, pokud optimizeRoute zahrnuje aspekty provozu.

error

CommonErrorDetail

Podrobnosti o chybě.

originIndex

integer (int32)

Index počátečního bodu

statusCode

integer (int32)

Stavový kód HTTP aktuální buňky.

RouteMatrixOptimizeRouteEnum

Určuje parametr, který se má použít k optimalizaci trasy. Pokud není definovaná, výchozí hodnota je "nejrychlejší", která vrací trasu, která minimalizuje dobu trvání cesty.

Příklad: "optimizeRoute":"nejrychlejší "

Hodnota Description
fastest

Najde nejrychlejší trasu pro optimalizaci trasy podle doby cesty.

Rozhraní API pro synchronizaci směrovací matice je podporováno pouze fastest. Pokud chcete použít jiné typy, zkontrolujte asynchronní rozhraní API matice směrování.

RouteMatrixRequest

Umožňuje získat matici tras zobrazující dobu cesty a vzdálenost pro všechny možné páry v seznamu původu a cíle. GeoJSON objekt funkce a další vlastnosti. Podrobnosti najdete v RFC 7946.

Name Typ Default value Description
arriveAt

string (date-time)

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

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

arriveAt podporuje také hodnotu any, která je přizpůsobena případu použití, kdy kontext času není relevantní. Hodnotu parametru traffic=live nelze použít společně s any.

Výchozí hodnota: any, pokud není zadán arriveAt.

Příklad: "arriveAt": "2024-12-01T09:30:00.000-07:00"

avoid

RouteMatrixAvoidEnum[]

Určuje omezení, která má výpočet trasy dodržovat při určování trasy. Vyhněte se podpoře více hodnot v požadavku a je podporován pouze pro jízdu a nákladní vůzMode.

departAt

string (date-time)

Datum a čas odjezdu z počátečního bodu formátovaného jako dateTime hodnota definovaná RFC 3339, bod 5.6. Pokud není zadán posun časového pásma, předpokládá se utc.

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

departAt také podporuje:

any hodnota přizpůsobená případu použití, kdy kontext času není relevantní. Hodnotu parametru traffic=live nelze použít společně s any.

now hodnotu, která nastaví čas odletu na dobu zpracování každé jednotlivé buňky. Doba zpracování může být mezi odesláním a jejím dokončením kdykoli. Tento režim se nejlépe používá společně s traffic=live.

Výchozí hodnota: any, pokud není zadán departAt.

Příklad:

"departAt": "2024-12-01T09:30:00.000-07:00"

features

InputRouteMatrixFeaturesItem[]

Sada počátečních a cílových bodů předaných jako funkce GeoJSON MultiPoint pro vstupní matici. Podrobnosti o formátu GeoJSON najdete v dokumentu RFC 7946 .

optimizeRoute

RouteMatrixOptimizeRouteEnum

fastest

Určuje parametr, který se má použít k optimalizaci trasy. Pokud není definovaná, výchozí hodnota je "nejrychlejší", která vrací trasu, která minimalizuje dobu trvání cesty.

Příklad: "optimizeRoute":"nejrychlejší "

traffic

RouteMatrixTrafficEnum

historical

Určuje, jak se provoz považuje za výpočetní trasy.

Výchozí hodnota: historical

travelMode

RouteMatrixTravelModeEnum

driving

Určuje cestovní profil, který se má při výpočtu matice zvážit. Pokud není zadána, výchozí hodnota je "řízení".

Příklad: travelMode:"driving"

type

FeatureTypeEnum

Určuje typ GeoJSON. Jediný podporovaný typ objektu je FeatureCollection. Další informace naleznete v tématu RFC 7946.

vehicleSpec

RouteMatrixVehicleSpec

Určuje atributy vozidla, jako je výška vozidla, hmotnost, maximální rychlost, typ nákladu atd. při výpočtu matice trasy. To pomáhá vyhnout se nízkým volným místům mostu, omezením silničního provozu, obtížnému pravému otočení, aby byla zajištěna optimalizovaná trasa na základě specifikací vozidel. Atributy vozidla jsou zadány v rámci vlastnosti vehicleSpec.

RouteMatrixResponse

Tento objekt se vrátí z úspěšného volání.

Name Typ Description
geometry

Objekt geometrie má hodnotu null.

properties

RouteMatrixFeatureProperties

Vlastnosti matice směrování

type

FeaturesItemTypeEnum

Určuje typ GeoJSON. Jediným podporovaným typem objektu je Funkce. Další informace naleznete v tématu RFC 7946.

RouteMatrixSummary

Souhrn požadavku na matici tras

Name Typ Description
successfulCount

integer (int32)

Počet úspěšných tras v rámci této matice

totalCount

integer (int32)

Celkový počet tras v rámci této matice

RouteMatrixTrafficEnum

Určuje, jak se provoz považuje za výpočetní trasy.

Výchozí hodnota: historical

Hodnota Description
historical

Výpočet trasy bere v úvahu historické doby cesty a dlouhodobé uzavření. Dopravní zácpy a krátkodobé uzavření během časového období cesty neovlivňují směrování ani dobu cesty.

live

Kromě historických cestovních časů počítá výpočet trasy dopravní zácpy a krátkodobé a dlouhodobé uzavření během časového intervalu cesty.

Note: traffic=live nelze použít ve spojení s arriveAt=any a departAt=any

RouteMatrixTravelModeEnum

Určuje cestovní profil, který se má při výpočtu matice zvážit. Pokud není zadána, výchozí hodnota je "řízení".

Příklad: travelMode:"driving"

Hodnota Description
driving

Profil směrování vhodný pro vozy se používá pro výpočet matice tras.

truck

Profil směrování vhodný pro obchodní vozidla, jako jsou nákladní vozy, se používají pro výpočet matice tras.

walking

Vrácené trasy jsou optimalizované pro chodce, včetně použití chodníků.

RouteMatrixTypeEnum

Určuje původní typ MultiPointu a cílový typ MultiPointu pro vstupní matici.

Hodnota Description
origins

Funkce systému MultiPoint, které definují umístění původu ve vstupní matici.

destinations

Funkce systému MultiPoint, které definují cílová umístění ve vstupní matici.

RouteMatrixVehicleSpec

Určuje atributy vozidla, jako je výška vozidla, hmotnost, maximální rychlost, typ nákladu atd. při výpočtu matice trasy. To pomáhá vyhnout se nízkým volným místům mostu, omezením silničního provozu, obtížnému pravému otočení, aby byla zajištěna optimalizovaná trasa na základě specifikací vozidel. Atributy vozidla jsou zadány v rámci vlastnosti vehicleSpec.

Name Typ Default value Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Kód omezení tunelu ADR. ADR je evropská dohoda o mezinárodní přepravě nebezpečného zboží po silnici. Kód omezení tunelu ADR slouží k určení, zda je vozidlo povoleno projít tunelem s omezeními pro přepravu nebezpečného zboží.

axleWeight

integer (int64)

minimum: 0
maximum: 1000000
0

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

height

number (double)

minimum: 0
maximum: 1000000
0

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

isVehicleCommercial

boolean

False

Zda se vozidlo používá pro komerční účely. Na některých silnicích nesmí být povolena jízda na komerčních vozidlech.

length

number (double)

minimum: 0
maximum: 1000000
0

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

loadType

VehicleLoadTypeEnum[]

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. 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ě. vehicleLoadType podporuje více hodnot v požadavku.

maxSpeed

integer (int64)

minimum: 0
maximum: 250
0

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.

weight

integer (int64)

minimum: 0
maximum: 1000000
0

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

width

number (double)

minimum: 0
maximum: 1000000
0

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

VehicleLoadTypeEnum

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice.

Hodnota Description
USHazmatClass1

Výbušniny

USHazmatClass2

Stlačený plyn

USHazmatClass3

Hořlavé kapaliny

USHazmatClass4

Hořlavé pevné látky

USHazmatClass5

Oxidační činidla

USHazmatClass6

Jedy

USHazmatClass7

Radioaktivní

USHazmatClass8

Corrosives

USHazmatClass9

Různé

otherHazmatExplosive

Výbušniny

otherHazmatGeneral

Různé

otherHazmatHarmfulToWater

Škodlivé pro vodu