Route - Post Route Range

Usługa:: Maps

Wersja interfejsu API:: 2025-01-01

Interfejs API Route Range tworzy wielokąt, który przedstawia obszar, do którego można dotrzeć z danej lokalizacji w określonym progu na podstawie określonego budżetu czasu lub 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 być używany do filtrowania przestrzennego w celu wyszukania interesujących obiektów w podanej izochronie.

Aby uzyskać informacje na temat routingu dostępności w krajach/regionach, zobacz pokrycie routingu usługi Azure Maps.

POST https://atlas.microsoft.com/route/range?api-version=2025-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.

Nagłówek żądania

Media Types: "application/geo+json"

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.

Treść żądania

Media Types: "application/geo+json"

Nazwa	Wymagane	Typ	Opis
geometry	True	RouteRangePointGeometry	Określa obiekt Geometria `GeoJSON` punktu. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .
properties	True	InputRouteRangeProperties	Określa parametry, które mają być używane do obliczania wielokąta izoochrony.
type	True	FeaturesItemTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouteRangeResponse	OK Media Types: "application/geo+json", "application/json"
Other Status Codes	MapsErrorResponse	Wystąpił nieoczekiwany błąd. Media Types: "application/geo+json", "application/json" Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

RouteRangeResponse

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

Other Status Codes

MapsErrorResponse

Wystąpił nieoczekiwany błąd.

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

Nagłówki

x-ms-error-code: string

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.

Uwaga / Notatka

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w 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 skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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 tworzenia zasobów 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.

Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwer-serwer interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

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 the specified conditions

Przykładowe żądanie

HTTP

POST https://atlas.microsoft.com/route/range?api-version=2025-01-01

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [
      5.86605,
      50.9745
    ]
  },
  "properties": {
    "timeBudgetInSec": 6000
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "type": "center"
      }
    },
    {
      "type": "Feature",
      "bbox": [
        3.62838,
        49.83259,
        7.9826,
        52.25674
      ],
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              5.73602,
              52.03704
            ],
            [
              5.59435,
              52.09456
            ],
            [
              5.42279,
              52.16815
            ],
            [
              5.21276,
              52.25047
            ],
            [
              5.15355,
              52.21374
            ],
            [
              4.96687,
              52.25674
            ],
            [
              4.739,
              52.07834
            ],
            [
              4.72513,
              52.05647
            ],
            [
              4.53237,
              51.94553
            ],
            [
              4.31165,
              51.70119
            ],
            [
              4.28917,
              51.5837
            ],
            [
              3.82685,
              51.48463
            ],
            [
              3.62838,
              51.21096
            ],
            [
              3.89244,
              50.6814
            ],
            [
              3.93493,
              50.66791
            ],
            [
              3.98156,
              50.49042
            ],
            [
              4.47995,
              50.30944
            ],
            [
              4.60502,
              50.24448
            ],
            [
              4.89999,
              50.24467
            ],
            [
              5.04206,
              50.08735
            ],
            [
              5.23042,
              49.99214
            ],
            [
              5.40994,
              49.88478
            ],
            [
              5.46178,
              49.85797
            ],
            [
              5.7196,
              49.86279
            ],
            [
              5.74151,
              49.83259
            ],
            [
              5.9387,
              50.22239
            ],
            [
              6.08535,
              50.0011
            ],
            [
              6.12089,
              50.04616
            ],
            [
              6.28373,
              50.09472
            ],
            [
              6.51654,
              49.95863
            ],
            [
              6.61034,
              50.00485
            ],
            [
              6.70295,
              50.00587
            ],
            [
              6.65865,
              50.2947
            ],
            [
              6.79276,
              50.36903
            ],
            [
              7.32163,
              50.31614
            ],
            [
              7.58782,
              50.36737
            ],
            [
              7.7626,
              50.46919
            ],
            [
              7.9826,
              50.96246
            ],
            [
              7.55924,
              51.07086
            ],
            [
              7.58138,
              51.36614
            ],
            [
              7.67861,
              51.52015
            ],
            [
              7.35175,
              51.65781
            ],
            [
              7.21664,
              51.81916
            ],
            [
              7.0467,
              51.9587
            ],
            [
              6.67267,
              51.82713
            ],
            [
              6.48424,
              51.81133
            ],
            [
              6.27316,
              51.9368
            ],
            [
              6.14452,
              52.01701
            ],
            [
              6.09312,
              52.20847
            ],
            [
              6.01297,
              52.23705
            ],
            [
              5.86605,
              50.9745
            ],
            [
              5.73602,
              52.03704
            ]
          ]
        ]
      },
      "properties": {
        "type": "boundary"
      }
    }
  ]
}

Definicje

Nazwa	Opis
AdrTunnelRestrictionCodeEnum	Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych.
FeaturesItemTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.
FeatureTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest `FeatureCollection`. Aby uzyskać więcej informacji, zobacz RFC 7946.
InputRouteRangeProperties	Określa parametry, które mają być używane do obliczania wielokąta izoochrony.
MapsErrorDetail	Szczegóły błędu.
MapsErrorResponse	Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.
MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
RouteRangeAvoidEnum	Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas określania osiągalnych lokalizacji. Opcja Unikaj obsługuje wiele wartości w żądaniu. Przykład: "unikać": ["limitedAccessHighways", "tollRoads"]
RouteRangeFeatureProperties	Właściwości zakresów tras.
RouteRangeFeaturesItem	Obiekt funkcji GeoJSON, który zawiera obiekt Geometry i dodatkowe właściwości trasy.
RouteRangeOptimizeRouteEnum	Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym. Przykład: "optimizeRoute":"najkrótszy"
RouteRangePointGeometry	Określa obiekt Geometria `GeoJSON` punktu. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .
RouteRangePolygonGeometry	Określa obiekt Geometria wielokąta `GeoJSON` . Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .
RouteRangeRequest	Określa punkt początkowy obliczania zakresu. `GeoJSON` obiekt funkcji i dodatkowe właściwości. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .
RouteRangeResponse	Ten obiekt jest zwracany z pomyślnego wywołania.
RouteRangeTravelModeEnum	Określa profil przesuwu, który ma być brany pod uwagę przy obliczaniu wielokąta zakresu. Jeśli nie zostanie określona, wartość domyślna to "jazda". Przykład: "travelMode":"jazda"
RouteRangeTypeEnum	Typy funkcji dla obiektów funkcji zwróconych w odpowiedzi.
RouteRangeVehicleSpec	Określa atrybuty pojazdu, takie jak wysokość pojazdu, masa, prędkość maksymalna, rodzaj ładunku itp., które należy wziąć pod uwagę przy obliczaniu osiągalnych lokalizacji. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu. Atrybuty pojazdu są określone we właściwości vehicleSpec.
VehicleLoadTypeEnum	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 amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu.

AdrTunnelRestrictionCodeEnum

Wyliczenie

Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych.

Wartość	Opis
B	Pojazdy o kodzie B mają zakaz wjazdu na drogi z tunelami ADR kategorii B, C, D i E.
C	Pojazdy o kodzie C nie mogą wjeżdżać na drogi z tunelami kategorii C, D i E ADR
D	Pojazdy o kodzie D nie mogą wjeżdżać na drogi z tunelami ADR kategorii D i E.
E	Pojazdy o kodzie E mają zakaz wjazdu na drogi z tunelem ADR kategorii E.

FeaturesItemTypeEnum

Wyliczenie

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

Wartość	Opis
Feature	Określa typ obiektu funkcji `GeoJSON`.

FeatureTypeEnum

Wyliczenie

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

Wartość	Opis
FeatureCollection	Określa typ obiektu `GeoJSONFeatureCollection`.

InputRouteRangeProperties

Objekt

Określa parametry, które mają być używane do obliczania wielokąta izoochrony.

Nazwa	Typ	Domyślna wartość	Opis
avoid	RouteRangeAvoidEnum[]		Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas określania osiągalnych lokalizacji. Opcja Unikaj obsługuje wiele wartości w żądaniu. Przykład: "unikać": ["limitedAccessHighways", "tollRoads"]
departAt	string (date-time)		Data i godzina wyjazdu z punktu początkowego sformatowana jako wartość dateTime zdefiniowana w dokumencie RFC 3339, sekcja 5.6. Jeśli przesunięcie strefy czasowej nie zostanie określone, zostanie przyjęty czas UTC. Jeśli wartość nie `departAt` jest ustawiona, wartością domyślną jest bieżąca godzina. Przykład: "departAt": "2023-06-01T09:30:00.000-07:00"
distanceBudgetInMeters	number (float) minimum: 0 maximum: 500000		Budżet odległości określa maksymalny zasięg w metrach, jaki można przebyć od punktu początkowego. Nie można go ustawić, gdy `timeBudgetInSec` jest określony. Gdy `isSimplifiedPolygon` wartość jest fałszywa, maksymalna obsługiwana odległość wynosi 90000 metrów, w przeciwnym razie jest to 500 000 metrów. Przykład: "distanceBudgetInMeters":5000
isSimplifiedPolygon	boolean	True	Użyj tego, aby określić, czy potrzebujesz uproszczonych wielokątów, które zmniejszają liczbę wierzchołków wielokątów przy zachowaniu kształtu. Interfejs API domyślnie zwraca wielokąt o niskiej rozdzielczości.
optimizeRoute	RouteRangeOptimizeRouteEnum	fastestWithoutTraffic	Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym. Przykład: "optimizeRoute":"najkrótszy"
timeBudgetInSec	number (float) minimum: 0 maximum: 21600		Budżet czasu określa maksymalny czas w sekundach dostępny do podróży, określając, jak daleko można się posunąć w ramach tego ograniczenia czasowego od punktu początkowego. Nie można go ustawić, gdy `distanceBudgetInMeters` jest określony. Gdy `isSimplifiedPolygon` wartość jest fałszywa, maksymalny obsługiwany czas wynosi 3600 sekund, w przeciwnym razie jest to 21 600 sekund. Przykład: "timeBudgetInSec":3600
travelMode	RouteRangeTravelModeEnum	driving	Określa profil przesuwu, który ma być brany pod uwagę przy obliczaniu wielokąta zakresu. Jeśli nie zostanie określona, wartość domyślna to "jazda". Przykład: "travelMode":"jazda"
vehicleSpec	RouteRangeVehicleSpec		Określa atrybuty pojazdu, takie jak wysokość pojazdu, masa, prędkość maksymalna, rodzaj ładunku itp., które należy wziąć pod uwagę przy obliczaniu osiągalnych lokalizacji. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu. Atrybuty pojazdu są określone we właściwości vehicleSpec.

MapsErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	MapsErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

MapsErrorResponse

Objekt

Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.

Nazwa	Typ	Opis
error	MapsErrorDetail	Szczegóły błędu.

MapsInnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

RouteRangeAvoidEnum

Wyliczenie

Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas określania osiągalnych lokalizacji. Opcja Unikaj obsługuje wiele wartości w żądaniu.

Przykład: "unikać": ["limitedAccessHighways", "tollRoads"]

Wartość	Opis
limitedAccessHighways	Unika korzystania z autostrad o ograniczonym dostępie na trasie.
tollRoads	Unika korzystania z dróg płatnych na trasie.
ferries	Unika korzystania z promów na trasie.
tunnels	Unika korzystania z tuneli na trasie.
borderCrossings	Unika przekraczania granic państwowych na trasie.
lowEmissionZones	Omija strefy niskoemisyjne na trasie.
unpavedRoads	Omija na trasie drogi nieutwardzone.
carpools	Unika tras, które wymagają korzystania z carpoolingu.
carTrains	Unika pociągów samochodowych.

RouteRangeFeatureProperties

Objekt

Właściwości zakresów tras.

Nazwa	Typ	Opis
type	RouteRangeTypeEnum	Typy funkcji dla obiektów funkcji zwróconych w odpowiedzi.

RouteRangeFeaturesItem

Objekt

Obiekt funkcji GeoJSON, który zawiera obiekt Geometry i dodatkowe właściwości trasy.

Nazwa	Typ	Opis
bbox	number[] (double)	Prostokątny obszar na ziemi zdefiniowany jako obiekt pola ograniczenia. Boki prostokątów są definiowane przez wartości szerokości i długości geograficznej. Aby uzyskać więcej informacji, zobacz RFC 7946, sekcja 5. Przykład: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	RouteRangeGeometry: RouteRangePointGeometry RouteRangePolygonGeometry	Prawidłowy `GeoJSON` obiekt Geometry. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
properties	RouteRangeFeatureProperties	Właściwości zakresów tras.
type	FeaturesItemTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

RouteRangeOptimizeRouteEnum

Wyliczenie

Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym.

Przykład: "optimizeRoute":"najkrótszy"

Wartość	Opis
shortest	Trasa jest obliczana tak, aby zminimalizować odległość. Informacje o ruchu drogowym nie są używane.
fastestWithoutTraffic	Znajduje najszybszą trasę bez uwzględniania informacji o ruchu drogowym.
fastestWithTraffic	Trasa jest obliczana tak, aby zminimalizować czas na podstawie aktualnych informacji o ruchu drogowym. `Note`: Obsługiwane tylko w trybie jazdy i jazdy ciężarówki.

RouteRangePointGeometry

Objekt

Określa obiekt Geometria GeoJSON punktu. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[] (double)	`Position` to tablica liczb z co najmniej dwoma elementami. Dwa pierwsze elementy to długości geograficznej i szerokości geograficznej, dokładnie w tej kolejności. wysokości/wysokości jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
type	string: Point	Określa typ geometrii obiektu `GeoJSON` Geometry. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

RouteRangePolygonGeometry

Objekt

Określa obiekt Geometria wielokąta GeoJSON . Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[] (double)	Współrzędne typu geometrii `GeoJson Polygon`.
type	string: Polygon	Określa typ geometrii obiektu `GeoJSON` Geometry. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

RouteRangeRequest

Objekt

Określa punkt początkowy obliczania zakresu. GeoJSON obiekt funkcji i dodatkowe właściwości. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

Nazwa	Typ	Opis
geometry	RouteRangePointGeometry	Określa obiekt Geometria `GeoJSON` punktu. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .
properties	InputRouteRangeProperties	Określa parametry, które mają być używane do obliczania wielokąta izoochrony.
type	FeaturesItemTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

RouteRangeResponse

Objekt

Ten obiekt jest zwracany z pomyślnego wywołania.

Nazwa	Typ	Opis
features	RouteRangeFeaturesItem[]	`GeoJSON` obiekt funkcji, który zawiera obiekt Geometry i dodatkowe właściwości. Aby uzyskać szczegółowe informacje, zobacz RFC 7946, sekcja 3.2.
type	FeatureTypeEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest `FeatureCollection`. Aby uzyskać więcej informacji, zobacz RFC 7946.

RouteRangeTravelModeEnum

Wyliczenie

Określa profil przesuwu, który ma być brany pod uwagę przy obliczaniu wielokąta zakresu. Jeśli nie zostanie określona, wartość domyślna to "jazda".

Przykład: "travelMode":"jazda"

Wartość	Opis
driving	Profil wyznaczania trasy odpowiedni dla samochodów służy do obliczania wielokątów zasięgu.
truck	Profil routingu odpowiedni dla pojazdów użytkowych, takich jak samochody ciężarowe, służy do obliczania wielokątów zasięgu.

RouteRangeTypeEnum

Wyliczenie

Typy funkcji dla obiektów funkcji zwróconych w odpowiedzi.

Wartość	Opis
center	Typ elementu punktu środkowego reprezentuje punkt używany do obliczania poligonu zakresu.
boundary	Typ elementu granicy reprezentuje polibok zakresu.

RouteRangeVehicleSpec

Objekt

Określa atrybuty pojazdu, takie jak wysokość pojazdu, masa, prędkość maksymalna, rodzaj ładunku itp., które należy wziąć pod uwagę przy obliczaniu osiągalnych lokalizacji. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu. Atrybuty pojazdu są określone we właściwości vehicleSpec.

Nazwa	Typ	Domyślna wartość	Opis
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych.
axleCount	integer (int64)		Liczba osi w pojeździe.
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.
height	number (double) minimum: 0 maximum: 1000000	0	Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.
isVehicleCommercial	boolean	False	Czy pojazd jest używany do celów komercyjnych. Pojazdy komercyjne mogą nie być dozwolone do jazdy na niektórych drogach.
length	number (double) minimum: 0 maximum: 1000000	0	Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.
loadType	VehicleLoadTypeEnum[]		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 amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu.
maxSpeed	integer (int64) minimum: 0 maximum: 250	0	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ę.
weight	integer (int64) minimum: 0 maximum: 1000000	0	Waga pojazdu w kilogramach. Wartość 0 oznacza, że ograniczenia wagowe nie są brane pod uwagę.
width	number (double) minimum: 0 maximum: 1000000	0	Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.

VehicleLoadTypeEnum

Wyliczenie

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 amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu.

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ę

Udostępnij przez

Route - Post Route Range

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdrTunnelRestrictionCodeEnum

FeaturesItemTypeEnum

FeatureTypeEnum

InputRouteRangeProperties

MapsErrorDetail

MapsErrorResponse

MapsInnerError

RouteRangeAvoidEnum

RouteRangeFeatureProperties

RouteRangeFeaturesItem

RouteRangeOptimizeRouteEnum

RouteRangePointGeometry

RouteRangePolygonGeometry

RouteRangeRequest

RouteRangeResponse

RouteRangeTravelModeEnum

RouteRangeTypeEnum

RouteRangeVehicleSpec

VehicleLoadTypeEnum