Traffic - Get Traffic Incident Viewport

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Użyj polecenia , aby uzyskać informacje prawne i techniczne dotyczące widoku.

Interfejs Traffic Incident Viewport API to żądanie HTTP GET , które zwraca informacje prawne i techniczne dotyczące widoku opisanego w żądaniu. Powinna być wywoływana przez aplikacje klienckie za każdym razem, gdy widok zmieni się (na przykład przez powiększanie, przesuwanie, przechodzenie do lokalizacji lub wyświetlanie trasy). Żądanie powinno zawierać pole ograniczenia i poziom powiększenia widoku, którego informacje są potrzebne. Zwrot będzie zawierać informacje o wersji mapy, a także bieżący identyfikator modelu ruchu i identyfikatory praw autorskich. Identyfikator modelu ruchu zwrócony przez opis widoku jest używany przez inne interfejsy API do pobierania informacji o ostatnim ruchu w celu dalszego przetwarzania.

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
boundingbox	query	True	number[]	Pole ograniczenia widoku mapy w projekcji EPSG900913 . Element `boundingbox` jest reprezentowany przez dwie pary wartości opisujące jego rogi (pierwsza para dla lewego dolnego rogu i druga dla prawego górnego rogu). Gdy ten punkt końcowy jest wywoływany bezpośrednio, wszystkie wartości powinny być rozdzielone przecinkami (np. minY,minX,maxY,maxX,maxX). Maksymalny rozmiar pola ograniczenia, który można przekazać, zależy od żądanego poziomu powiększenia. Szerokość i wysokość nie mogą przekraczać 4092 pikseli podczas renderowania na danym poziomie powiększenia. UWAGA: Pola ograniczenia, które przekraczają 180° opakowania, wymagają specjalnego traktowania. W przypadku takich pól wartość maxX wschodniej będzie ujemna, a tym samym mniejsza niż wartość minX na zachód od 180°. Aby rozwiązać ten problem, przed przekazaniem żądania wartość 40075016.6855874 należy dodać do wartości true maxX .
boundingzoom	query	True	integer int32	Poziom powiększenia widoku mapy. Służy do określania, czy widok można powiększyć.
overviewbox	query	True	number[]	Pole ograniczenia mapy przeglądu w projekcji EPSG900913 . Używane w przypadku, gdy pole przeglądu/minimapa ma inne dane dotyczące praw autorskich niż mapa główna. Jeśli nie ma minimapy, te same współrzędne, które `boundingBox` są używane. Gdy ten punkt końcowy jest wywoływany bezpośrednio, współrzędne są przekazywane jako pojedynczy ciąg zawierający cztery współrzędne oddzielone przecinkami.
overviewzoom	query	True	integer int32	Poziom powiększenia mapy przeglądu. Jeśli nie ma minimapy, użyj tego samego poziomu powiększenia co ograniczenieZoom.
copyright	query		boolean	Określa, jakie informacje o prawach autorskich mają być zwracane. Gdy zostanie zwrócony tekst prawa autorskiego; gdy zwracany jest tylko fałszywy indeks praw autorskich.

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.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	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

Request traffic incident information for the selected viewport

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

Przykładowa odpowiedź

Kod stanu:: 200

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
TrafficIncidentViewport	Ten obiekt jest zwracany z pomyślnego wywołania widoku zdarzeń ruchu
TrafficState	Informacje o stanie ruchu
ViewpResp	Obiekt Odpowiedzi w widoku

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	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	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	ErrorDetail	Obiekt błędu.

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript
xml	string	Rozszerzalny język znaczników

TrafficIncidentViewport

Ten obiekt jest zwracany z pomyślnego wywołania widoku zdarzeń ruchu

Nazwa	Typ	Opis
viewpResp	ViewpResp	Obiekt Odpowiedzi w widoku

TrafficState

Informacje o stanie ruchu

Nazwa	Typ	Opis
@trafficAge	integer	Upłynął czas (w sekundach) z utworzenia identyfikatora modelu ruchu.
@trafficModelId	string	Unikatowy identyfikator o nazwie Traffic Model ID jest używany w wywołaniach usług zdarzeń ruchu. Umożliwia uzyskanie informacji z określonych aktualizacji ruchu. Identyfikator modelu ruchu jest aktualizowany co minutę i jest ważny przez dwie minuty przed upływem limitu czasu.

ViewpResp

Obiekt Odpowiedzi w widoku

Nazwa	Typ	Opis
@maps	string	Wskazuje wewnętrzne nazwy dostawcy danych dla danych mapy używanych w widoku. Do użytku z zapytaniami pomocy technicznej.
@version	string	Wskazuje wersję oprogramowania używaną do generowania informacji. Do użytku z zapytaniami pomocy technicznej.
copyrightIds	string	Gdy wartość parametru copyright jest prawdziwa, zawiera pełny tekst informacji o prawach autorskich, które muszą być wyświetlane z kafelkami w widokuportu
trafficState	TrafficState	Informacje o stanie ruchu

Udostępnij za pośrednictwem