Route - Post Route Directions
Gunakan untuk menghitung rute antara asal dan tujuan tertentu, melewati titik arah tertentu.
Post Route Directions
API adalah permintaan HTTP POST
yang mengembalikan rute antara asal dan tujuan, melewati titik arah jika ditentukan. Rute akan memperhitungkan faktor-faktor seperti lalu lintas saat ini dan kecepatan jalan yang khas pada hari yang diminta dalam seminggu dan waktu dalam sehari.
Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi putar dengan giliran juga tersedia, tergantung pada opsi yang dipilih.
Layanan perutean menyediakan serangkaian parameter untuk deskripsi terperinci tentang Model Konsumsi khusus kendaraan. Silakan periksa Model Konsumsi untuk penjelasan terperinci tentang konsep dan parameter yang terlibat.
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings§ionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
query
|
query | True |
string |
Koordinat di mana rute dihitung, dibatasi oleh titik dua. Diperlukan minimal dua koordinat. Yang pertama adalah asal dan yang terakhir adalah tujuan rute. Koordinat opsional di antara bertindak sebagai WayPoints dalam rute. Anda dapat meneruskan hingga 150 WayPoints. |
acceleration
|
query |
number double |
Menentukan efisiensi konversi energi kimia yang disimpan dalam bahan bakar ke energi kinetik ketika kendaraan berakselerasi (yaitu KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed diperoleh dengan mengonversi bahan bakar yang dikonsumsi menjadi energi kimia menggunakan fuelEnergyDensityInMJoulesPerLiter. Harus dipasangkan dengan decelerationEfficiency. Rentang nilai yang diizinkan adalah 0,0 hingga 1/decelerationEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,33, untuk Model Listrik : 0,66 |
|
alternative
|
query |
Mengontrol optimalitas, sehubungan dengan kriteria perencanaan yang diberikan, dari alternatif yang dihitung dibandingkan dengan rute referensi. |
||
arrive
|
query |
string date-time |
Tanggal dan waktu kedatangan di titik tujuan yang diformat sebagai nilai seperti yang Contoh:
Parameter |
|
auxiliary
|
query |
number double |
Menentukan jumlah daya yang digunakan untuk mempertahankan sistem tambahan, dalam kilowatt (kW). Ini dapat digunakan untuk menentukan konsumsi karena perangkat dan sistem seperti sistem AC, radio, pemanasan, dll. Nilai Masuk Akal : 1.7 |
|
auxiliary
|
query |
number double |
Menentukan jumlah bahan bakar yang dikonsumsi untuk mempertahankan sistem tambahan kendaraan, dalam liter per jam. Ini dapat digunakan untuk menentukan konsumsi karena perangkat dan sistem seperti sistem AC, radio, pemanasan, dll. Nilai Masuk Akal : 0,2 |
|
avoid
|
query |
Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai yang sudah DigunakanRoads tidak boleh digunakan. |
||
compute
|
query |
boolean |
Urutan ulang titik arah rute menggunakan algoritma heuristik cepat untuk mengurangi panjang rute. Menghasilkan hasil terbaik saat digunakan bersama dengan routeType terpendek. Perhatikan bahwa asal dan tujuan dikecualikan dari indeks titik arah yang dioptimalkan. Untuk menyertakan asal dan tujuan dalam respons, tingkatkan semua indeks sebesar 1 untuk mempertanggungjawabkan asalnya, lalu tambahkan tujuan sebagai indeks akhir. Nilai yang mungkin benar atau salah. True menghitung urutan yang lebih baik jika memungkinkan, tetapi tidak diizinkan untuk digunakan bersama dengan nilai maxAlternatives yang lebih besar dari 0 atau bersama dengan titik arah lingkaran. False akan menggunakan lokasi dalam urutan yang diberikan dan tidak diizinkan untuk digunakan bersama dengan routeRepresentation none. |
|
compute
|
query |
Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default. |
||
constant
|
query |
string |
Menentukan komponen konsumsi yang bergantung pada kecepatan. Disediakan sebagai daftar pasangan kecepatan/tingkat konsumsi yang tidak diurutkan. Daftar ini mendefinisikan titik pada kurva konsumsi. Tingkat konsumsi untuk kecepatan yang tidak ada dalam daftar ditemukan sebagai berikut:
Daftar harus berisi antara 1 dan 25 poin (inklusif), dan mungkin tidak berisi titik duplikat untuk kecepatan yang sama. Jika hanya berisi satu titik, maka tingkat konsumsi titik tersebut digunakan tanpa pemrosesan lebih lanjut. Konsumsi yang ditentukan untuk kecepatan terbesar harus lebih besar dari atau sama dengan kecepatan terbesar terpenulis. Ini memastikan bahwa ekstrapolasi tidak menyebabkan tingkat konsumsi negatif. Demikian pula, nilai konsumsi yang ditentukan untuk dua kecepatan terkecil dalam daftar tidak dapat menyebabkan tingkat konsumsi negatif untuk kecepatan yang lebih kecil. Rentang yang valid untuk nilai konsumsi (dinyatakan dalam kWh/100km) adalah antara 0,01 dan 100000,0. Nilai Masuk Akal : 50,8.2:130,21.3 Parameter ini diperlukan untuk model konsumsi Listrik. |
|
constant
|
query |
string |
Menentukan komponen konsumsi yang bergantung pada kecepatan. Disediakan sebagai daftar yang tidak diurutkan dari pasangan kecepatan yang dibatasi titik dua & tingkat konsumsi. Daftar ini mendefinisikan titik pada kurva konsumsi. Tingkat konsumsi untuk kecepatan yang tidak ada dalam daftar ditemukan sebagai berikut:
Daftar harus berisi antara 1 dan 25 poin (inklusif), dan mungkin tidak berisi titik duplikat untuk kecepatan yang sama. Jika hanya berisi satu titik, maka tingkat konsumsi titik tersebut digunakan tanpa pemrosesan lebih lanjut. Konsumsi yang ditentukan untuk kecepatan terbesar harus lebih besar dari atau sama dengan kecepatan terbesar terpenulis. Ini memastikan bahwa ekstrapolasi tidak menyebabkan tingkat konsumsi negatif. Demikian pula, nilai konsumsi yang ditentukan untuk dua kecepatan terkecil dalam daftar tidak dapat menyebabkan tingkat konsumsi negatif untuk kecepatan yang lebih kecil. Rentang yang valid untuk nilai konsumsi (dinyatakan dalam l/100km) adalah antara 0,01 dan 100000,0. Nilai Masuk Akal : 50,6.3:130,11.5 Catatan : Parameter ini diperlukan untuk Model Konsumsi Pembakaran. |
|
current
|
query |
number double |
Menentukan pasokan energi listrik saat ini dalam jam kilowatt (kWh). Parameter ini ada bersama dengan parameter maxChargeInkWh . Rentang nilai yang diizinkan adalah 0,0 hingga maxChargeInkWh. Nilai Masuk Akal : 43 |
|
current
|
query |
number double |
Menentukan pasokan bahan bakar saat ini dalam liter. Nilai Masuk Akal : 55 |
|
deceleration
|
query |
number double |
Menentukan efisiensi konversi energi kinetik untuk menghemat (tidak dikonsumsi) bahan bakar ketika kendaraan turun (yaitu ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved diperoleh dengan mengonversi bahan bakar yang disimpan (tidak dikonsumsi) ke energi menggunakan fuelEnergyDensityInMJoulesPerLiter. Harus dipasangkan dengan accelerationEfficiency. Rentang nilai yang diizinkan adalah 0,0 hingga 1/akselerasiEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,83, untuk Model Listrik : 0,91 |
|
depart
|
query |
string date-time |
Tanggal dan waktu keberangkatan dari titik asal yang diformat sebagai nilai seperti yang
Contoh:
Parameter |
|
downhill
|
query |
number double |
Menentukan efisiensi konversi energi potensial untuk menghemat (tidak dikonsumsi) bahan bakar ketika kendaraan kehilangan elevasi (yaitu ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved diperoleh dengan mengonversi bahan bakar yang disimpan (tidak dikonsumsi) ke energi menggunakan fuelEnergyDensityInMJoulesPerLiter. Harus dipasangkan dengan uphillEfficiency. Rentang nilai yang diizinkan adalah 0,0 hingga 1/uphillEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,51, untuk Model Listrik : 0,73 |
|
fuel
|
query |
number double |
Menentukan jumlah energi kimia yang disimpan dalam satu liter bahan bakar dalam megajoule (MJ). Ini digunakan bersama dengan parameter *Efisiensi untuk konversi antara energi yang disimpan atau dikonsumsi dan bahan bakar. Misalnya, kepadatan energi adalah 34,2 MJ/l untuk bensin, dan 35,8 MJ/l untuk bahan bakar Diesel. Parameter ini diperlukan jika ada parameter *Efisiensi yang diatur. Nilai Masuk Akal : 34,2 |
|
hilliness
|
query |
Tingkat kebukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan |
||
instructions
|
query |
Jika ditentukan, instruksi panduan akan dikembalikan. Perhatikan bahwa parameter instructionsType tidak dapat digunakan bersama dengan routeRepresentation=none |
||
language
|
query |
string |
Parameter bahasa menentukan bahasa pesan panduan. Ini tidak mempengaruhi kata benda yang tepat (nama jalan, plaza, dll.) Ini tidak berpengaruh ketika instruksiType=dikodekan. Nilai yang diizinkan adalah (subset dari) tag bahasa IETF yang dijelaskan |
|
max
|
query |
integer |
Jumlah rute alternatif yang diinginkan untuk dihitung. Default: 0, minimum: 0 dan maksimum: 5 |
|
max
|
query |
number double |
Menentukan pasokan energi listrik maksimum dalam jam kilowatt (kWh) yang dapat disimpan dalam baterai kendaraan. Parameter ini ada bersama dengan parameter currentChargeInkWh . Nilai minimum harus lebih besar dari atau sama dengan currentChargeInkWh. Nilai Masuk Akal : 85 |
|
min
|
query |
integer |
Semua rute alternatif yang dikembalikan akan mengikuti rute referensi (lihat bagian POST Requests) dari titik asal permintaan calculateRoute untuk setidaknya jumlah meter ini. Hanya dapat digunakan saat merekonstruksi rute. Parameter minDeviationDistance tidak dapat digunakan bersama dengan arriveAt |
|
min
|
query |
integer |
Semua rute alternatif yang dikembalikan akan mengikuti rute referensi (lihat bagian Permintaan POST) dari titik asal permintaan calculateRoute setidaknya selama jumlah detik ini. Hanya dapat digunakan saat mengkonstruksi ulang rute. Parameter minDeviationTime tidak dapat digunakan bersama dengan arriveAt. Nilai defaultnya adalah 0. Pengaturan )minDeviationTime_ ke nilai yang lebih besar dari nol memiliki konsekuensi berikut:
|
|
report
|
query |
Menentukan data mana yang harus dilaporkan untuk tujuan diagnosis. Satu-satunya nilai yang mungkin adalah effectiveSettings. Melaporkan parameter atau data efektif yang digunakan saat memanggil API. Dalam kasus parameter default, default akan tercermin di mana parameter tidak ditentukan oleh pemanggil. |
||
route
|
query |
Menentukan representasi kumpulan rute yang disediakan sebagai respons. Nilai parameter ini hanya dapat digunakan bersama dengan computeBestOrder=true. |
||
route
|
query |
Jenis rute yang diminta. |
||
section
|
query |
Menentukan jenis bagian mana yang dilaporkan dalam respons rute. |
||
traffic
|
query |
boolean |
Nilai yang memungkinkan:
|
|
travel
|
query |
Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa mode perjalanan bus, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area. |
||
uphill
|
query |
number double |
Menentukan efisiensi konversi energi kimia yang disimpan dalam bahan bakar ke energi potensial ketika kendaraan mendapatkan elevasi (yaitu PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed diperoleh dengan mengonversi bahan bakar yang dikonsumsi menjadi energi kimia menggunakan fuelEnergyDensityInMJoulesPerLiter. Harus dipasangkan dengan downhillEfficiency. Rentang nilai yang diizinkan adalah 0,0 hingga 1/downhillEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,27, untuk Model Listrik : 0,74 |
|
vehicle
|
query |
integer |
Berat per as roda kendaraan dalam kg. Nilai 0 berarti bahwa pembatasan berat per sumbu tidak dipertimbangkan. |
|
vehicle
|
query |
boolean |
Apakah kendaraan digunakan untuk tujuan komersial. Kendaraan komersial mungkin tidak diizinkan untuk mengemudi di beberapa jalan. |
|
vehicle
|
query |
Jenis mesin kendaraan. Ketika Model Konsumsi terperinci ditentukan, model tersebut harus konsisten dengan nilai vehicleEngineType. |
||
vehicle
|
query |
integer |
Arah menuju kendaraan dalam derajat mulai dari utara benar dan melanjutkan ke arah searah jarang. Utara adalah 0 derajat, timur adalah 90 derajat, selatan adalah 180 derajat, barat adalah 270 derajat. Kemungkinan nilai 0-359 |
|
vehicle
|
query |
number double |
Tinggi kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan tinggi tidak dipertimbangkan. |
|
vehicle
|
query |
number double |
Panjang kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan panjang tidak dipertimbangkan. |
|
vehicle
|
query |
Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lain. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck. |
||
vehicle
|
query |
integer |
Kecepatan maksimum kendaraan dalam km/jam. Kecepatan maksimal di profil kendaraan digunakan untuk memeriksa apakah kendaraan diizinkan di jalan tol.
|
|
vehicle
|
query |
integer |
Berat kendaraan dalam kilogram.
Nilai Masuk Akal : untuk Model Pembakaran : 1600, untuk Model Listrik : 1900 |
|
vehicle
|
query |
number double |
Lebar kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan lebar tidak dipertimbangkan. |
|
windingness
|
query |
Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan |
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. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
allowVignette |
string[] |
Ini adalah daftar kode negara/wilayah 3 karakter, ISO 3166-1, alpha-3 di mana jalan tol dengan sketsa diizinkan, misalnya "AUS,CHE". Menentukan allowVignette dengan beberapa negara/wilayah X setara dengan menentukan avoidVignette dengan semua negara/wilayah tetapi X. Menentukan allowVignette dengan daftar kosong sama dengan menghindari semua jalan tol dengan sketsa. Catatan: Ini adalah kesalahan untuk menentukan avoidVignette dan allowVignette. |
avoidAreas |
GeoJSON MultiPolygon yang mewakili daftar area yang harus dihindari. Hanya poligon persegi panjang yang didukung. Ukuran maksimum persegi panjang adalah sekitar 160x160 km. Jumlah maksimum area yang dihindari adalah 10. Ini tidak dapat melintasi meridian ke-180. Harus antara -80 dan +80 derajat lintang. |
|
avoidVignette |
string[] |
Ini adalah daftar kode negara/wilayah 3 karakter, ISO 3166-1, alpha-3 di mana semua jalan tol dengan sketsa harus dihindari, misalnya "AUS,CHE". Jalan tol dengan sketsa di negara/wilayah yang tidak ada dalam daftar tidak terpengaruh. Catatan: Ini adalah kesalahan untuk menentukan avoidVignette dan allowVignette. |
supportingPoints |
Koleksi Geometri GeoJSON yang mewakili urutan koordinat yang digunakan sebagai input untuk rekonstruksi rute dan untuk menghitung nol atau lebih rute alternatif ke rute referensi ini.
|
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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.
- Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.
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
Successfully retrieve a route between an origin and a destination with additional parameters in the body
Sample Request
POST https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
{
"supportingPoints": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Point",
"coordinates": [
13.42936,
52.5093
]
},
{
"type": "Point",
"coordinates": [
13.42859,
52.50844
]
}
]
},
"avoidVignette": [
"AUS",
"CHE"
],
"avoidAreas": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
-122.39456176757811,
47.489368981370724
],
[
-122.00454711914061,
47.489368981370724
],
[
-122.00454711914061,
47.65151268066222
],
[
-122.39456176757811,
47.65151268066222
],
[
-122.39456176757811,
47.489368981370724
]
]
],
[
[
[
100,
0
],
[
101,
0
],
[
101,
1
],
[
100,
1
],
[
100,
0
]
]
]
]
}
}
Sample Response
{
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"points": [
{
"latitude": 52.50931,
"longitude": 13.42937
},
{
"latitude": 52.50904,
"longitude": 13.42912
},
{
"latitude": 52.50894,
"longitude": 13.42904
},
{
"latitude": 52.50867,
"longitude": 13.42879
},
{
"latitude": 52.5084,
"longitude": 13.42857
},
{
"latitude": 52.50791,
"longitude": 13.42824
},
{
"latitude": 52.50757,
"longitude": 13.42772
},
{
"latitude": 52.50735,
"longitude": 13.42823
},
{
"latitude": 52.5073,
"longitude": 13.42836
},
{
"latitude": 52.50573,
"longitude": 13.43194
},
{
"latitude": 52.50512,
"longitude": 13.43336
},
{
"latitude": 52.50464,
"longitude": 13.43451
},
{
"latitude": 52.5045,
"longitude": 13.43481
},
{
"latitude": 52.50443,
"longitude": 13.43498
},
{
"latitude": 52.50343,
"longitude": 13.43737
},
{
"latitude": 52.50274,
"longitude": 13.43872
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 15,
"sectionType": "TRAVEL_MODE",
"travelMode": "car"
}
]
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Alternative |
Mengontrol optimalitas, sehubungan dengan kriteria perencanaan yang diberikan, dari alternatif yang dihitung dibandingkan dengan rute referensi. |
Compute |
Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default. |
Delay |
Besarnya penundaan yang disebabkan oleh insiden tersebut. Nilai-nilai ini sesuai dengan nilai bidang respons ty dari Get Traffic Incident Detail API. |
Driving |
Menunjukkan tangan kiri vs. sisi kanan mengemudi di titik manuver. |
Effective |
Parameter atau data efektif yang digunakan saat memanggil Route API ini. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Geo |
Objek geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Guidance |
Jenis instruksi, misalnya, belok atau ubah bentuk jalan. |
Guidance |
Kode yang mengidentifikasi manuver. |
Incline |
Tingkat kebukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan |
Junction |
Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasuki dan meninggalkan bundaran. |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur. |
Report |
Menentukan data mana yang harus dilaporkan untuk tujuan diagnosis. Satu-satunya nilai yang mungkin adalah effectiveSettings. Melaporkan parameter atau data efektif yang digunakan saat memanggil API. Dalam kasus parameter default, default akan tercermin di mana parameter tidak ditentukan oleh pemanggil. |
Response |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
Response |
Jenis bagian respons rute yang dilaporkan |
Response |
Mode perjalanan untuk rute terhitung. Nilai akan diatur ke |
Route | |
Route |
Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai yang sudah DigunakanRoads tidak boleh digunakan. |
Route |
Parameter isi postingan untuk Petunjuk rute. |
Route |
Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil |
Route |
Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia. |
Route |
Satu set atribut yang menjelaskan manuver, misalnya 'Belok kanan', 'Tetap kiri', 'Ambil feri', 'Ambil jalan raya', 'Tiba'. |
Route |
Mengelompokkan urutan elemen instruksi yang terkait satu sama lain. Rentang urutan dibatasi dengan firstInstructionIndex dan lastInstructionIndex. Ketika pesan teks yang dapat dibaca manusia diminta untuk panduan (instructionType=text atau tagged), maka instructionGroup memiliki pesan ringkasan yang dikembalikan saat tersedia. |
Route |
Jika ditentukan, instruksi panduan akan dikembalikan. Perhatikan bahwa parameter instructionsType tidak dapat digunakan bersama dengan routeRepresentation=none |
Route |
Deskripsi bagian dari rute, terdiri dari daftar titik. Setiap titik arah tambahan yang disediakan dalam permintaan akan menghasilkan kaki tambahan di rute yang dikembalikan. |
Route |
Objek ringkasan untuk bagian rute. |
Route |
Objek titik cara yang dioptimalkan. |
Route |
Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini. |
Route |
Menentukan representasi kumpulan rute yang disediakan sebagai respons. Nilai parameter ini hanya dapat digunakan bersama dengan computeBestOrder=true. |
Route |
Bagian rute berisi informasi tambahan tentang bagian rute. Setiap bagian berisi setidaknya elemen |
Route |
Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC . Dapat berisi effectCode dan menyebabkan elemen. |
Route |
Penyebab peristiwa lalu lintas. Dapat berisi elemen mainCauseCode dan subCauseCode. Dapat digunakan untuk menentukan ikonografi dan deskripsi. |
Route |
Objek ringkasan |
Route |
Jenis rute yang diminta. |
Section |
Menentukan jenis bagian mana yang dilaporkan dalam respons rute. |
Simple |
Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau OTHER. Lihat "tec" untuk informasi terperinci. |
Travel |
Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa mode perjalanan bus, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area. |
Vehicle |
Jenis mesin kendaraan. Ketika Model Konsumsi terperinci ditentukan, model tersebut harus konsisten dengan nilai vehicleEngineType. |
Vehicle |
Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lain. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck. |
Windingness |
Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan |
AlternativeRouteType
Mengontrol optimalitas, sehubungan dengan kriteria perencanaan yang diberikan, dari alternatif yang dihitung dibandingkan dengan rute referensi.
Nama | Jenis | Deskripsi |
---|---|---|
anyRoute |
string |
Izinkan rute alternatif apa pun dikembalikan terlepas dari bagaimana perbandingannya dengan rute referensi dalam hal optimalitas. |
betterRoute |
string |
Mengembalikan rute alternatif hanya jika lebih baik daripada rute referensi sesuai dengan kriteria perencanaan yang diberikan. |
ComputeTravelTime
Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.
Nama | Jenis | Deskripsi |
---|---|---|
all |
string |
Menghitung waktu perjalanan untuk semua jenis informasi lalu lintas dan menentukan semua hasil di bidang noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds dan liveTrafficIncidentsTravelTimeInSeconds yang disertakan dalam ringkasan dalam respons rute. |
none |
string |
Tidak menghitung waktu perjalanan tambahan. |
DelayMagnitude
Besarnya penundaan yang disebabkan oleh insiden tersebut. Nilai-nilai ini sesuai dengan nilai bidang respons ty dari Get Traffic Incident Detail API.
Nama | Jenis | Deskripsi |
---|---|---|
0 |
string |
Tidak dikenal. |
1 |
string |
Kecil. |
2 |
string |
Sedang. |
3 |
string |
Utama. |
4 |
string |
Tidak terdefinisi, digunakan untuk penutupan jalan dan penundaan lain yang tidak terbatas. |
DrivingSide
Menunjukkan tangan kiri vs. sisi kanan mengemudi di titik manuver.
Nama | Jenis | Deskripsi |
---|---|---|
LEFT |
string |
Sisi kiri. |
RIGHT |
string |
Sisi kanan. |
EffectiveSetting
Parameter atau data efektif yang digunakan saat memanggil Route API ini.
Nama | Jenis | Deskripsi |
---|---|---|
key |
string |
Nama parameter yang digunakan. |
value |
string |
Nilai parameter yang digunakan. |
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
GeoJsonGeometry
Objek geometri yang valid GeoJSON
. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
type |
Geo |
Menentukan jenis. |
GeoJsonGeometryCollection
Jenis objek yang valid GeoJSON GeometryCollection
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
geometries | GeoJsonGeometry[]: |
Berisi daftar objek geometri yang valid |
type |
string:
Geometry |
Menentukan jenis. |
GeoJsonLineString
Jenis geometri yang valid GeoJSON LineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Line |
Menentukan jenis. |
GeoJsonMultiLineString
Jenis geometri yang valid GeoJSON MultiLineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenis. |
GeoJsonMultiPoint
Jenis geometri yang valid GeoJSON MultiPoint
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenis. |
GeoJsonMultiPolygon
Jenis objek yang valid GeoJSON MultiPolygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Berisi daftar objek yang valid |
type |
string:
Multi |
Menentukan jenis. |
GeoJsonPoint
Jenis geometri yang valid GeoJSON Point
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
|
type |
string:
Point |
Menentukan jenis. |
GeoJsonPolygon
Jenis geometri yang valid GeoJSON Polygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Polygon |
Menentukan jenisnya |
GuidanceInstructionType
Jenis instruksi, misalnya, belok atau ubah bentuk jalan.
Nama | Jenis | Deskripsi |
---|---|---|
DIRECTION_INFO |
string |
Informasi arah. |
LOCATION_ARRIVAL |
string |
Lokasi kedatangan. |
LOCATION_DEPARTURE |
string |
Lokasi keberangkatan. |
LOCATION_WAYPOINT |
string |
Lokasi titik arah. |
ROAD_CHANGE |
string |
Perubahan Jalan. |
TURN |
string |
Gilirannya. |
GuidanceManeuver
Kode yang mengidentifikasi manuver.
Nama | Jenis | Deskripsi |
---|---|---|
ARRIVE |
string |
Anda telah tiba. |
ARRIVE_LEFT |
string |
Anda telah tiba. Tujuan Anda ada di sebelah kiri. |
ARRIVE_RIGHT |
string |
Anda telah tiba. Tujuan Anda ada di sebelah kanan. |
BEAR_LEFT |
string |
Beruang kiri. |
BEAR_RIGHT |
string |
Beruang kanan. |
DEPART |
string |
Meninggalkan. |
ENTER_FREEWAY |
string |
Ambil jalan bebas hambatan. |
ENTER_HIGHWAY |
string |
Ambil jalan raya. |
ENTER_MOTORWAY |
string |
Ambil jalan raya. |
ENTRANCE_RAMP |
string |
Ambil jalan. |
FOLLOW |
string |
Mengikuti. |
KEEP_LEFT |
string |
Tetap ke kiri. |
KEEP_RIGHT |
string |
Tetap di kanan. |
MAKE_UTURN |
string |
Membuat U-turn. |
MOTORWAY_EXIT_LEFT |
string |
Ambil pintu keluar kiri. |
MOTORWAY_EXIT_RIGHT |
string |
Lewat pintu keluar yang tepat. |
ROUNDABOUT_BACK |
string |
Berkeliling bundaran. |
ROUNDABOUT_CROSS |
string |
Seberangi bundaran. |
ROUNDABOUT_LEFT |
string |
Di bundaran ambil jalan keluar di sebelah kiri. |
ROUNDABOUT_RIGHT |
string |
Di bundaran ambil jalan keluar di sebelah kanan. |
SHARP_LEFT |
string |
Belok kiri tajam. |
SHARP_RIGHT |
string |
Belok kanan tajam. |
STRAIGHT |
string |
Terus lurus. |
SWITCH_MAIN_ROAD |
string |
Beralih ke jalan utama. |
SWITCH_PARALLEL_ROAD |
string |
Beralih ke jalan paralel. |
TAKE_EXIT |
string |
Ambil jalan keluar. |
TAKE_FERRY |
string |
Naik feri. |
TRY_MAKE_UTURN |
string |
Cobalah untuk membuat U-turn. |
TURN_LEFT |
string |
Belok Kiri. |
TURN_RIGHT |
string |
Belok Kanan. |
WAYPOINT_LEFT |
string |
Anda telah mencapai titik arah. Itu di sebelah kiri. |
WAYPOINT_REACHED |
string |
Anda telah mencapai titik arah. |
WAYPOINT_RIGHT |
string |
Anda telah mencapai titik arah. Ada di sebelah kanan. |
InclineLevel
Tingkat kebukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType
=thrilling.
Nama | Jenis | Deskripsi |
---|---|---|
high |
string |
tinggi |
low |
string |
rendah |
normal |
string |
normal |
JunctionType
Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasuki dan meninggalkan bundaran.
Nama | Jenis | Deskripsi |
---|---|---|
BIFURCATION |
string |
bifurcation |
REGULAR |
string |
Biasa |
ROUNDABOUT |
string |
Bundaran |
LatLongPair
Lokasi yang direpresentasikan sebagai garis lintang dan bujur.
Nama | Jenis | Deskripsi |
---|---|---|
latitude |
number |
Properti garis lintang |
longitude |
number |
Properti garis bujur |
Report
Menentukan data mana yang harus dilaporkan untuk tujuan diagnosis. Satu-satunya nilai yang mungkin adalah effectiveSettings. Melaporkan parameter atau data efektif yang digunakan saat memanggil API. Dalam kasus parameter default, default akan tercermin di mana parameter tidak ditentukan oleh pemanggil.
Nama | Jenis | Deskripsi |
---|---|---|
effectiveSettings |
string |
Melaporkan parameter atau data efektif yang digunakan saat memanggil API. |
ResponseFormat
Format respons yang diinginkan. Nilai dapat berupa json atau xml.
Nama | Jenis | Deskripsi |
---|---|---|
json |
string |
|
xml |
string |
ResponseSectionType
Jenis bagian respons rute yang dilaporkan
Nama | Jenis | Deskripsi |
---|---|---|
CARPOOL |
string |
Bagian rute yang memerlukan penggunaan jalur carpool (HOV/High Occupancy Vehicle). |
CAR_TRAIN |
string |
Bagian dari rute yang merupakan mobil atau kereta api. |
COUNTRY |
string |
Bagian yang menunjukkan negara/wilayah tempat rute berada. |
FERRY |
string |
Bagian dari rute yang merupakan feri. |
MOTORWAY |
string |
Bagian rute yang merupakan jalan raya. |
PEDESTRIAN |
string |
Bagian rute yang hanya cocok untuk pejalan kaki. |
TOLL_ROAD |
string |
Bagian dari rute yang mengharuskan tol dibayarkan. |
TOLL_VIGNETTE |
string |
Bagian dari rute yang mengharuskan adanya sketsa tol. |
TRAFFIC |
string |
Bagian rute yang berisi informasi lalu lintas. |
TRAVEL_MODE |
string |
Bagian sehubungan dengan parameter |
TUNNEL |
string |
Bagian dari rute yang merupakan terowongan. |
URBAN |
string |
Bagian dari rute yang terletak di daerah perkotaan. |
ResponseTravelMode
Mode perjalanan untuk rute terhitung. Nilai akan diatur ke other
jika mode transportasi yang diminta tidak dimungkinkan di bagian ini
Nama | Jenis | Deskripsi |
---|---|---|
bicycle |
string |
Rute yang dikembalikan dioptimalkan untuk sepeda, termasuk penggunaan jalur sepeda. |
bus |
string |
Rute yang dikembalikan dioptimalkan untuk bus, termasuk penggunaan jalur bus saja. Fungsionalitas BETA. |
car |
string |
Rute yang dikembalikan dioptimalkan untuk mobil. |
motorcycle |
string |
Rute yang dikembalikan dioptimalkan untuk sepeda motor. Fungsionalitas BETA. |
other |
string |
Mode transportasi yang diberikan tidak dimungkinkan di bagian ini |
pedestrian |
string |
Rute yang dikembalikan dioptimalkan untuk pejalan kaki, termasuk penggunaan trotoar. |
taxi |
string |
Rute yang dikembalikan dioptimalkan untuk taksi. Fungsionalitas BETA. |
truck |
string |
Rute yang dikembalikan dioptimalkan untuk kendaraan komersial, seperti untuk truk. |
van |
string |
Rute yang dikembalikan dioptimalkan untuk van. Fungsionalitas BETA. |
Route
Nama | Jenis | Deskripsi |
---|---|---|
guidance |
Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia. |
|
legs |
Route |
Array kaki |
sections |
Array bagian |
|
summary |
Objek ringkasan |
RouteAvoidType
Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai yang sudah DigunakanRoads tidak boleh digunakan.
Nama | Jenis | Deskripsi |
---|---|---|
alreadyUsedRoads |
string |
Menghindari penggunaan jalan yang sama beberapa kali. Paling berguna bersama dengan |
borderCrossings |
string |
Menghindari persimpangan batas dalam perhitungan rute. |
carpools |
string |
Menghindari rute yang memerlukan penggunaan jalur carpool (HOV/High Occupancy Vehicle). |
ferries |
string |
Menghindari feri |
motorways |
string |
Menghindari jalan raya |
tollRoads |
string |
Menghindari jalan tol. |
unpavedRoads |
string |
Menghindari jalan yang belum diaspal |
RouteDirectionParameters
Parameter isi postingan untuk Petunjuk rute.
Nama | Jenis | Deskripsi |
---|---|---|
allowVignette |
string[] |
Ini adalah daftar kode negara 3 karakter, ISO 3166-1, alpha-3 negara negara/wilayah di mana jalan tol dengan sketsa diizinkan, misalnya "AUS,CHE". Menentukan allowVignette dengan beberapa negara/wilayah X setara dengan menentukan avoidVignette dengan semua negara/wilayah tetapi X. Menentukan allowVignette dengan daftar kosong sama dengan menghindari semua jalan tol dengan vignette. Catatan: Ini adalah kesalahan untuk menentukan avoidVignette dan allowVignette. |
avoidAreas |
GeoJSON MultiPolygon yang mewakili daftar area yang harus dihindari. Hanya poligon persegi panjang yang didukung. Ukuran maksimum persegi panjang adalah sekitar 160x160 km. Jumlah maksimum area yang dihindari adalah 10. Tak bisa melintasi meridian ke-180. Harus antara -80 dan +80 derajat lintang. |
|
avoidVignette |
string[] |
Ini adalah daftar kode negara 3 karakter, ISO 3166-1, alpha-3 dari negara/wilayah di mana semua jalan tol dengan sketsa harus dihindari, misalnya "AUS,CHE". Jalan tol dengan vignette di negara/wilayah yang tidak ada dalam daftar tidak terpengaruh. Catatan: Ini adalah kesalahan untuk menentukan avoidVignette dan allowVignette. |
supportingPoints |
Koleksi Geometri GeoJSON yang mewakili urutan koordinat yang digunakan sebagai input untuk rekonstruksi rute dan untuk menghitung nol atau lebih rute alternatif ke rute referensi ini.
|
RouteDirections
Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil
Nama | Jenis | Deskripsi |
---|---|---|
formatVersion |
string |
Properti Format Versi |
optimizedWaypoints |
Urutan titik arah yang dioptimalkan. Ini menunjukkan indeks dari urutan titik arah yang disediakan pengguna untuk daftar asli dan dioptimalkan. Misalnya, respons:
berarti bahwa urutan aslinya adalah [0, 1, 2] dan urutan yang dioptimalkan adalah [1, 2, 0]. Karena indeks dimulai oleh 0 yang asli adalah "pertama, kedua, ketiga" sementara yang dioptimalkan adalah "kedua, ketiga, pertama". |
|
report |
Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini. |
|
routes |
Route[] |
Array rute |
RouteGuidance
Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia.
Nama | Jenis | Deskripsi |
---|---|---|
instructionGroups |
Mengelompokkan urutan elemen instruksi yang terkait satu sama lain. |
|
instructions |
Daftar instruksi yang menjelaskan manuver. |
RouteInstruction
Satu set atribut yang menjelaskan manuver, misalnya 'Belok kanan', 'Tetap kiri', 'Ambil feri', 'Ambil jalan raya', 'Tiba'.
Nama | Jenis | Deskripsi |
---|---|---|
combinedMessage |
string |
Pesan yang dapat dibaca manusia untuk manuver yang dikombinasikan dengan pesan dari instruksi berikutnya. Terkadang dimungkinkan untuk menggabungkan dua instruksi berturut-turut ke dalam satu instruksi sehingga lebih mudah diikuti. Jika demikian, bendera possibleCombineWithNext akan benar. Contohnya:
Bendera possibleCombineWithNext pada instruksi 10 adalah benar. Ini menunjukkan kepada klien panduan berkode bahwa itu dapat dikombinasikan dengan instruksi 11. Instruksi akan digabungkan secara otomatis untuk klien yang meminta panduan yang dapat dibaca manusia. Bidang combinedMessage berisi pesan gabungan:
|
countryCode |
string |
Kode negara ISO 3166-1 alpha-3 3 karakter. Misalnya AS. |
drivingSide |
Menunjukkan tangan kiri vs. sisi kanan mengemudi di titik manuver. |
|
exitNumber |
string |
Jumlah pintu keluar jalan raya yang diambil oleh manuver saat ini. Jika keluar memiliki beberapa nomor keluar, mereka akan dipisahkan oleh "," dan mungkin dikumpulkan oleh "-", misalnya, "10, 13-15". |
instructionType |
Jenis instruksi, misalnya, belok atau ubah bentuk jalan. |
|
junctionType |
Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasuki dan meninggalkan bundaran. |
|
maneuver |
Kode yang mengidentifikasi manuver. |
|
message |
string |
Pesan yang dapat dibaca manusia untuk manuver. |
point |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur. |
|
pointIndex |
integer |
Indeks titik dalam daftar "titik" poliline yang sesuai dengan titik instruksi. |
possibleCombineWithNext |
boolean |
Dimungkinkan untuk menggabungkan instruksi secara opsional dengan yang berikutnya. Ini dapat digunakan untuk membangun pesan seperti "Belok kiri lalu belok kanan". |
roadNumbers |
string[] |
Nomor jalan segmen jalan signifikan berikutnya setelah manuver, atau jalan yang akan diikuti. Contoh: ["E34", "N205"] |
roundaboutExitNumber |
string |
Ini menunjukkan pintu keluar mana yang akan diambil di bundaran. |
routeOffsetInMeters |
integer |
Jarak dari awal rute ke titik instruksi. |
signpostText |
string |
Teks pada signpost yang paling relevan dengan manuver, atau ke arah yang harus diikuti. |
stateCode |
string |
Subdivisi (misalnya, negara bagian) negara, yang diwakili oleh bagian kedua dari kode ISO 3166-2 . Ini hanya tersedia untuk beberapa negara/wilayah seperti AS, Kanada, dan Meksiko. |
street |
string |
Nama jalan segmen jalan signifikan berikutnya setelah manuver, atau jalan yang harus diikuti. |
travelTimeInSeconds |
integer |
Estimasi waktu perjalanan hingga titik yang sesuai dengan routeOffsetInMeters. |
turnAngleInDecimalDegrees |
integer |
Menunjukkan arah instruksi. Jika junctionType menunjukkan instruksi giliran:
Jika junctionType menunjukkan instruksi bifurcation:
|
RouteInstructionGroup
Mengelompokkan urutan elemen instruksi yang terkait satu sama lain. Rentang urutan dibatasi dengan firstInstructionIndex dan lastInstructionIndex. Ketika pesan teks yang dapat dibaca manusia diminta untuk panduan (instructionType=text atau tagged), maka instructionGroup memiliki pesan ringkasan yang dikembalikan saat tersedia.
Nama | Jenis | Deskripsi |
---|---|---|
firstInstructionIndex |
integer |
Indeks instruksi pertama dalam instruksi dan milik grup ini. |
groupLengthInMeters |
integer |
Panjang grup. |
groupMessage |
string |
Pesan ringkasan saat pesan teks yang dapat dibaca manusia diminta untuk panduan (instructionType=text atau tagged). |
lastInstructionIndex |
integer |
Indeks instruksi terakhir dalam instruksi dan milik grup ini. |
RouteInstructionsType
Jika ditentukan, instruksi panduan akan dikembalikan. Perhatikan bahwa parameter instructionsType tidak dapat digunakan bersama dengan routeRepresentation=none
Nama | Jenis | Deskripsi |
---|---|---|
coded |
string |
Mengembalikan data instruksi mentah tanpa pesan yang dapat dibaca manusia. |
tagged |
string |
Mengembalikan data instruksi mentah dengan pesan yang dapat dibaca manusia yang ditandai untuk mengizinkan pemformatan. Pesan yang dapat dibaca manusia dibangun dari elemen yang diidentifikasi berulang. Ini ditandai untuk memungkinkan aplikasi klien memformatnya dengan benar. Komponen pesan berikut ditandai ketika instruksiType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Contoh pesan 'Belok kiri' yang ditandai:
|
text |
string |
Mengembalikan data instruksi mentah dengan pesan yang dapat dibaca manusia dalam teks biasa. |
RouteLeg
Deskripsi bagian dari rute, terdiri dari daftar titik. Setiap titik arah tambahan yang disediakan dalam permintaan akan menghasilkan kaki tambahan di rute yang dikembalikan.
Nama | Jenis | Deskripsi |
---|---|---|
points |
Array titik |
|
summary |
Objek ringkasan untuk bagian rute. |
RouteLegSummary
Objek ringkasan untuk bagian rute.
Nama | Jenis | Deskripsi |
---|---|---|
arrivalTime |
string |
Perkiraan waktu kedatangan untuk rute atau kaki. Waktunya ada di UTC. |
batteryConsumptionInkWh |
number |
Estimasi konsumsi energi listrik dalam jam kilowatt (kWh) menggunakan Model Konsumsi Listrik. Disertakan jika vehicleEngineType diatur ke listrik dan constantSpeedConsumptionInkWhPerHundredkm ditentukan. Nilai bateraiConsumptionInkWh mencakup energi listrik yang disembuhkan dan karenanya dapat menjadi negatif (yang menunjukkan mendapatkan energi). Jika maxChargeInkWh dan currentChargeInkWh ditentukan, pemulihan akan dibatasi untuk memastikan bahwa tingkat pengisian daya baterai tidak pernah melebihi maxChargeInkWh. Jika maxChargeInkWh maupun currentChargeInkWh tidak ditentukan, pemulihan yang tidak dibatasi diasumsikan dalam perhitungan konsumsi. |
departureTime |
string |
Perkiraan waktu keberangkatan untuk rute atau kaki. Waktunya ada di UTC. |
fuelConsumptionInLiters |
number |
Estimasi konsumsi bahan bakar dalam liter menggunakan Model Konsumsi Pembakaran. Disertakan jika vehicleEngineType diatur ke pembakaran dan constantSpeedConsumptionInLitersPerHundredkm ditentukan. Nilainya tidak akan negatif. |
historicTrafficTravelTimeInSeconds |
integer |
Estimasi waktu perjalanan dihitung menggunakan data lalu lintas historis yang bergantung pada waktu. Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri. |
lengthInMeters |
integer |
Properti Panjang Dalam Meter |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Estimasi waktu perjalanan dihitung menggunakan data kecepatan real time. Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri. |
noTrafficTravelTimeInSeconds |
integer |
Perkiraan waktu perjalanan dihitung seolah-olah tidak ada keterlambatan pada rute karena kondisi lalu lintas (misalnya kemacetan). Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri. |
trafficDelayInSeconds |
integer |
Estimasi keterlambatan dalam detik yang disebabkan oleh insiden real-time sesuai dengan informasi lalu lintas. Untuk rute yang direncanakan dengan waktu keberangkatan di masa depan, penundaan selalu 0. Untuk mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas, parameter computeTravelTimeFor=all perlu ditambahkan. |
travelTimeInSeconds |
integer |
Perkiraan waktu perjalanan dalam detik properti yang mencakup keterlambatan karena lalu lintas real time. Perhatikan bahwa bahkan ketika traffic=false travelTimeInSeconds masih menyertakan penundaan karena lalu lintas. Jika DepartAt di masa mendatang, waktu perjalanan dihitung menggunakan data lalu lintas historis yang bergantung pada waktu. |
RouteOptimizedWaypoint
Objek titik cara yang dioptimalkan.
Nama | Jenis | Deskripsi |
---|---|---|
optimizedIndex |
integer |
Indeks titik cara yang dioptimalkan dari sistem. |
providedIndex |
integer |
Indeks titik way yang disediakan oleh pengguna. |
RouteReport
Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini.
Nama | Jenis | Deskripsi |
---|---|---|
effectiveSettings |
Parameter atau data efektif yang digunakan saat memanggil Route API ini. |
RouteRepresentationForBestOrder
Menentukan representasi kumpulan rute yang disediakan sebagai respons. Nilai parameter ini hanya dapat digunakan bersama dengan computeBestOrder=true.
Nama | Jenis | Deskripsi |
---|---|---|
none |
string |
Hanya menyertakan indeks titik arah yang dioptimalkan tetapi tidak menyertakan geometri rute dalam respons. |
polyline |
string |
Menyertakan geometri rute dalam respons. |
summaryOnly |
string |
Ringkasan sesuai poliline tetapi tidak termasuk elemen geometri titik untuk rute dalam respons. |
RouteSection
Bagian rute berisi informasi tambahan tentang bagian rute. Setiap bagian berisi setidaknya elemen startPointIndex
, , endPointIndex
dan sectionType
.
Nama | Jenis | Deskripsi |
---|---|---|
delayInSeconds |
integer |
Keterlambatan dalam detik yang disebabkan oleh insiden tersebut. |
effectiveSpeedInKmh |
integer |
Kecepatan efektif insiden dalam km / jam, rata-rata selama seluruh panjangnya. |
endPointIndex |
integer |
Indeks titik terakhir (offset 0) di rute tempat bagian ini berlaku. |
magnitudeOfDelay |
Besarnya penundaan yang disebabkan oleh insiden tersebut. Nilai-nilai ini sesuai dengan nilai bidang respons ty dari Get Traffic Incident Detail API. |
|
sectionType |
Jenis bagian respons rute yang dilaporkan |
|
simpleCategory |
Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau OTHER. Lihat "tec" untuk informasi terperinci. |
|
startPointIndex |
integer |
Indeks titik pertama (offset 0) di rute tempat bagian ini berlaku. |
tec |
Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC . Dapat berisi effectCode dan menyebabkan elemen. |
|
travelMode |
Mode perjalanan untuk rute terhitung. Nilai akan diatur ke |
RouteSectionTec
Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC . Dapat berisi effectCode dan menyebabkan elemen.
Nama | Jenis | Deskripsi |
---|---|---|
causes |
Penyebab array |
|
effectCode |
integer |
Efeknya pada arus lalu lintas. Berisi nilai dalam tabel tec001:EffectCode, seperti yang ditentukan dalam standar TPEG2-TEC . Dapat digunakan untuk mengodekan warna peristiwa lalu lintas sesuai dengan tingkat keparahan. |
RouteSectionTecCause
Penyebab peristiwa lalu lintas. Dapat berisi elemen mainCauseCode dan subCauseCode. Dapat digunakan untuk menentukan ikonografi dan deskripsi.
Nama | Jenis | Deskripsi |
---|---|---|
mainCauseCode |
integer |
Penyebab utama peristiwa lalu lintas. Berisi nilai dalam tabel tec002:CauseCode, seperti yang ditentukan dalam standar TPEG2-TEC . |
subCauseCode |
integer |
Subcause peristiwa lalu lintas. Berisi nilai dalam tabel sub penyebab yang ditentukan oleh mainCauseCode, seperti yang ditentukan dalam standar TPEG2-TEC . |
RouteSummary
Objek ringkasan
Nama | Jenis | Deskripsi |
---|---|---|
arrivalTime |
string |
Perkiraan waktu kedatangan untuk rute atau kaki. Waktunya ada di UTC. |
departureTime |
string |
Perkiraan waktu keberangkatan untuk rute atau kaki. Waktunya ada di UTC. |
lengthInMeters |
integer |
Properti Panjang Dalam Meter |
trafficDelayInSeconds |
integer |
Estimasi keterlambatan dalam detik yang disebabkan oleh insiden real-time sesuai dengan informasi lalu lintas. Untuk rute yang direncanakan dengan waktu keberangkatan di masa depan, penundaan selalu 0. Untuk mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas, parameter computeTravelTimeFor=all perlu ditambahkan. |
travelTimeInSeconds |
integer |
Perkiraan waktu perjalanan dalam detik properti yang mencakup keterlambatan karena lalu lintas real time. Perhatikan bahwa bahkan ketika traffic=false travelTimeInSeconds masih menyertakan penundaan karena lalu lintas. Jika DepartAt di masa mendatang, waktu perjalanan dihitung menggunakan data lalu lintas historis yang bergantung pada waktu. |
RouteType
Jenis rute yang diminta.
Nama | Jenis | Deskripsi |
---|---|---|
eco |
string |
Rute yang diseimbangkan oleh ekonomi dan kecepatan. |
fastest |
string |
Rute tercepat. |
shortest |
string |
Rute terpendek menurut jarak. |
thrilling |
string |
Termasuk jalan yang menarik atau menantang dan menggunakan jalan tol sesedikat mungkin. Anda dapat memilih tingkat belokan yang disertakan dan juga tingkat kebukitan. Lihat parameter hilliness dan windingness untuk cara mengatur ini. Ada batas 900 km pada rute yang direncanakan dengan |
SectionType
Menentukan jenis bagian mana yang dilaporkan dalam respons rute.
Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Beberapa jenis dapat digunakan. SectionType default mengacu pada input travelMode. Secara default travelMode diatur ke mobil
Nama | Jenis | Deskripsi |
---|---|---|
carTrain |
string |
Bagian dari rute yang merupakan mobil atau kereta api. |
carpool |
string |
Bagian dari rute yang memerlukan penggunaan jalur carpool (HOV/High Occupancy Vehicle). |
country |
string |
Bagian yang menunjukkan negara/wilayah mana rute berada. |
ferry |
string |
Bagian dari rute yang merupakan feri. |
motorway |
string |
Bagian dari rute yang merupakan jalan raya. |
pedestrian |
string |
Bagian rute yang hanya cocok untuk pejalan kaki. |
tollRoad |
string |
Bagian dari rute yang mengharuskan tol dibayar. |
tollVignette |
string |
Bagian dari rute yang memerlukan vignette tol untuk hadir. |
traffic |
string |
Bagian rute yang berisi informasi lalu lintas. |
travelMode |
string |
Bagian dalam kaitannya dengan parameter |
tunnel |
string |
Bagian dari rute yang merupakan terowongan. |
urban |
string |
Bagian dari rute yang terletak di dalam daerah perkotaan. |
SimpleCategory
Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau OTHER. Lihat "tec" untuk informasi terperinci.
Nama | Jenis | Deskripsi |
---|---|---|
JAM |
string |
Kemacetan lalu lintas. |
OTHER |
string |
Lainnya. |
ROAD_CLOSURE |
string |
Penutupan jalan. |
ROAD_WORK |
string |
Pekerjaan jalan. |
TravelMode
Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa mode perjalanan bus, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.
Nama | Jenis | Deskripsi |
---|---|---|
bicycle |
string |
Rute yang dikembalikan dioptimalkan untuk sepeda, termasuk penggunaan jalur sepeda. |
bus |
string |
Rute yang dikembalikan dioptimalkan untuk bus, termasuk penggunaan jalur bus saja. Fungsionalitas BETA. |
car |
string |
Rute yang dikembalikan dioptimalkan untuk mobil. |
motorcycle |
string |
Rute yang dikembalikan dioptimalkan untuk sepeda motor. Fungsionalitas BETA. |
pedestrian |
string |
Rute yang dikembalikan dioptimalkan untuk pejalan kaki, termasuk penggunaan trotoar. |
taxi |
string |
Rute yang dikembalikan dioptimalkan untuk taksi. Fungsionalitas BETA. |
truck |
string |
Rute yang dikembalikan dioptimalkan untuk kendaraan komersial, seperti untuk truk. |
van |
string |
Rute yang dikembalikan dioptimalkan untuk van. Fungsionalitas BETA. |
VehicleEngineType
Jenis mesin kendaraan. Ketika Model Konsumsi terperinci ditentukan, model tersebut harus konsisten dengan nilai vehicleEngineType.
Nama | Jenis | Deskripsi |
---|---|---|
combustion |
string |
Mesin pembakaran internal. |
electric |
string |
Mesin listrik. |
VehicleLoadType
Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lain. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.
Nama | Jenis | Deskripsi |
---|---|---|
USHazmatClass1 |
string |
Bahan peledak |
USHazmatClass2 |
string |
Gas terkompresi |
USHazmatClass3 |
string |
Cairan mudah terbakar |
USHazmatClass4 |
string |
Padatan yang mudah terbakar |
USHazmatClass5 |
string |
Oksidator |
USHazmatClass6 |
string |
Racun |
USHazmatClass7 |
string |
Radioaktif |
USHazmatClass8 |
string |
Korosif |
USHazmatClass9 |
string |
Lain-lain |
otherHazmatExplosive |
string |
Bahan peledak |
otherHazmatGeneral |
string |
Lain-lain |
otherHazmatHarmfulToWater |
string |
Berbahaya bagi air |
WindingnessLevel
Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType
=thrilling.
Nama | Jenis | Deskripsi |
---|---|---|
high |
string |
tinggi |
low |
string |
rendah |
normal |
string |
normal |