Traffic - Get Traffic Incident Viewport

Gunakan untuk mendapatkan informasi hukum dan teknis untuk viewport.

Traffic Incident Viewport API adalah permintaan HTTP GET yang mengembalikan informasi hukum dan teknis untuk viewport yang dijelaskan dalam permintaan. Ini harus dipanggil oleh aplikasi klien setiap kali viewport berubah (misalnya, melalui zooming, menggeser, pergi ke lokasi, atau menampilkan rute). Permintaan harus berisi kotak pembatas dan tingkat zoom viewport yang informasinya diperlukan. Pengembalian akan berisi informasi versi peta, serta ID Model Lalu Lintas dan ID hak cipta saat ini. ID Model Lalu Lintas yang dikembalikan oleh Deskripsi Viewport digunakan oleh API lain untuk mengambil informasi lalu lintas terakhir untuk pemrosesan lebih lanjut.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
format
path True

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml.

api-version
query True

string

Nomor versi API Azure Maps.

boundingbox
query True

number[]

Kotak batas viewport peta dalam proyeksi EPSG900913 . diwakili boundingbox oleh dua pasangan nilai yang menjelaskan sudutnya (pasangan pertama untuk sudut kiri bawah dan kedua untuk kanan atas). Ketika titik akhir ini dipanggil secara langsung, semua nilai harus dipisahkan oleh koma (misalnya, minY,minX,maxY,maxX). Ukuran maksimum kotak pembatas yang dapat diteruskan tergantung pada tingkat pembesaran tampilan yang diminta. Lebar dan tinggi tidak boleh melebihi 4092 piksel saat dirender pada tingkat perbesar tampilan yang diberikan.

CATATAN: Kotak pembatas yang melintasi meridian 180° memerlukan perawatan khusus. Untuk kotak tersebut, nilai maksX timur akan negatif, dan dengan demikian kurang dari nilai minX barat meridian 180°. Untuk mengatasinya, nilai 40075016.6855874 harus ditambahkan ke nilai maxX yang sebenarnya sebelum diteruskan dalam permintaan.

boundingzoom
query True

integer

int32

Tingkat pembesaran tampilan peta. Digunakan untuk menentukan apakah tampilan dapat diperbesar.

overviewbox
query True

number[]

Kotak batas peta gambaran umum dalam proyeksi EPSG900913 .

Digunakan jika kotak gambaran umum/peta mini memiliki data hak cipta yang berbeda dari peta utama. Jika tidak ada peta mini, koordinat yang sama seperti boundingBox yang digunakan. Ketika titik akhir ini dipanggil secara langsung, koordinat diteruskan sebagai string tunggal yang berisi empat koordinat, dipisahkan oleh koma.

overviewzoom
query True

integer

int32

Tingkat perbesar tampilan peta gambaran umum. Jika tidak ada peta mini, gunakan tingkat zoom yang sama dengan boundingZoom.

copyright
query

boolean

Menentukan informasi hak cipta apa yang akan dikembalikan. Ketika benar, teks hak cipta dikembalikan; ketika false hanya indeks hak cipta yang dikembalikan.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-id

string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama Jenis Deskripsi
200 OK

TrafficIncidentViewport

OK

Other Status Codes

ErrorResponse

Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

  • Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Create akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

Request traffic incident information for the selected viewport

Sample Request

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

Sample Response

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

Definisi

Nama Deskripsi
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml.

TrafficIncidentViewport

Objek ini dikembalikan dari panggilan Viewport Insiden Lalu Lintas yang berhasil

TrafficState

Informasi Status Lalu Lintas

ViewpResp

Objek Respons Viewport

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml.

Nama Jenis Deskripsi
json

string

Format Pertukaran Data Notasi Objek JavaScript

xml

string

Bahasa Markup yang Dapat Diperluas

TrafficIncidentViewport

Objek ini dikembalikan dari panggilan Viewport Insiden Lalu Lintas yang berhasil

Nama Jenis Deskripsi
viewpResp

ViewpResp

Objek Respons Viewport

TrafficState

Informasi Status Lalu Lintas

Nama Jenis Deskripsi
@trafficAge

integer

Waktu yang berlalu (dalam detik) dari pembuatan ID Model Lalu Lintas.

@trafficModelId

string

ID unik yang disebut ID Model Lalu Lintas digunakan dalam panggilan ke layanan Insiden Lalu Lintas. Ini memungkinkan untuk mendapatkan informasi dari pembaruan lalu lintas tertentu. ID Model Lalu Lintas diperbarui setiap menit, dan berlaku selama dua menit sebelum waktu habis.

ViewpResp

Objek Respons Viewport

Nama Jenis Deskripsi
@maps

string

Menunjukkan nama internal penyedia data untuk data peta yang digunakan di viewport. Untuk digunakan dengan kueri dukungan.

@version

string

Menunjukkan versi perangkat lunak yang digunakan untuk menghasilkan informasi. Untuk digunakan dengan kueri dukungan.

copyrightIds

string

Ketika nilai parameter hak cipta benar, ini berisi teks lengkap informasi hak cipta yang harus ditampilkan dengan petak peta di viewport

trafficState

TrafficState

Informasi Status Lalu Lintas