Route - Post Route Directions

Referensi

Layanan:: Maps

Versi API:: 1.0

Gunakan untuk menghitung rute antara asal dan tujuan tertentu, melewati titik arah tertentu.

API Post Route Directions 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 hari.

Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi giliran demi belokan 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}

Dengan parameter opsional:

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&sectionType={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}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

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 Azure Maps API.
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.
accelerationEfficiency	query		number double	Menentukan efisiensi konversi energi kimia yang disimpan dalam bahan bakar ke energi kinetik ketika kendaraan mempercepat (yaitu KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed diperoleh dengan mengonversi bahan bakar yang dikonsumsi ke energi kimia menggunakan fuelEnergyDensityInMJoulesPerLiter. Harus dipasangkan dengandecelerationEfficiency . Rentang nilai yang diizinkan adalah 0,0 hingga 1/decelerationEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,33, untuk Model Listrik : 0,66
alternativeType	query		AlternativeRouteType	Mengontrol optimalitas, sehubungan dengan kriteria perencanaan yang diberikan, dari alternatif yang dihitung dibandingkan dengan rute referensi.
arriveAt	query		string date-time	Tanggal dan waktu kedatangan di titik tujuan yang diformat sebagai nilai `dateTime` seperti yang didefinisikan dalam RFC 3339, bagian 5,6, dengan offset zona waktu opsional. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik tujuan. Contoh: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Parameter `arriveAt` tidak dapat digunakan bersama dengan `departAt`, `minDeviationDistance` atau `minDeviationTime`.
auxiliaryPowerInkW	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
auxiliaryPowerInLitersPerHour	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		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 sudahUsedRoads tidak boleh digunakan.
computeBestOrder	query		boolean	Urutan ulang titik arah rute menggunakan algoritma heuristik cepat untuk mengurangi panjang rute. Menghasilkan hasil terbaik ketika 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 memperhitungkan asal, 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 tidak ada.
computeTravelTimeFor	query		ComputeTravelTime	Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Menentukan komponen konsumsi yang bergantung pada kecepatan. Disediakan sebagai daftar pasangan kecepatan/tingkat konsumsi yang tidak diurutkan. Daftar mendefinisikan titik pada kurva konsumsi. Tingkat konsumsi untuk kecepatan yang tidak ada dalam daftar ditemukan sebagai berikut: dengan interpolasi linier, jika kecepatan yang diberikan terletak di antara dua kecepatan dalam daftar dengan ekstrapolasi linier jika tidak, dengan asumsi konstanta (ΔConsumption/ΔSpeed) ditentukan oleh dua titik terdekat dalam daftar 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 terpenultimate. 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 Electric.
constantSpeedConsumptionInLitersPerHundredkm	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 mendefinisikan titik pada kurva konsumsi. Tingkat konsumsi untuk kecepatan yang tidak ada dalam daftar ditemukan sebagai berikut: dengan interpolasi linier, jika kecepatan yang diberikan terletak di antara dua kecepatan dalam daftar dengan ekstrapolasi linier jika tidak, dengan asumsi konstanta (ΔConsumption/ΔSpeed) ditentukan oleh dua titik terdekat dalam daftar 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 terpenultimate. 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.
currentChargeInkWh	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
currentFuelInLiters	query		number double	Menentukan pasokan bahan bakar saat ini dalam liter. Nilai Masuk Akal : 55
decelerationEfficiency	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 bahan bakar EnergyDensityInMJoulesPerLiter. Harus dipasangkan dengan accelerationEfficiency. Rentang nilai yang diizinkan adalah 0,0 hingga 1/accelerationEfficiency. Nilai Masuk Akal : untuk Model Pembakaran : 0,83, untuk Model Listrik : 0,91
departAt	query		string date-time	Tanggal dan waktu keberangkatan dari titik asal yang diformat sebagai nilai `dateTime` seperti yang didefinisikan dalam RFC 3339, bagian 5,6, dengan offset zona waktu opsional. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik asal. Nilai default: sekarang Nilai lain: `dateTime` Contoh: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 Parameter `departAt` tidak dapat digunakan bersama dengan `arriveAt`.
downhillEfficiency	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 bahan bakar EnergyDensityInMJoulesPerLiter. Harus dipasangkan denganuphillEfficiency . Rentang nilai yang diizinkan adalah 0,0 hingga 1/uphillEfficiency. Nilai Masuk Akal : untuk Combustion Model : 0,51, untuk Electric Model : 0,73
fuelEnergyDensityInMJoulesPerLiter	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 parameter Efisiensiditetapkan. Nilai Masuk Akal : 34.2
hilliness	query		InclineLevel	Tingkat perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan `routeType`=thrilling.
instructionsType	query		RouteInstructionsType	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 instructionsType=coded. Nilai yang diizinkan adalah (subset dari) tag bahasa IETF yang dijelaskan
maxAlternatives	query		integer	Jumlah rute alternatif yang diinginkan untuk dihitung. Default: 0, minimum: 0 dan maksimum: 5
maxChargeInkWh	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
minDeviationDistance	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 menyusun ulang rute. Parameter minDeviationDistance tidak dapat digunakan bersama dengan arriveAt
minDeviationTime	query		integer	Semua rute alternatif yang dikembalikan akan mengikuti rute referensi (lihat bagian POST Requests) dari titik asal permintaan calculateRoute untuk setidaknya jumlah detik ini. Hanya dapat digunakan saat menyusun 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: Titik asal calculateRoute Request harus berada di (atau sangat dekat) rute referensi input. Jika ini tidak terjadi, kesalahan akan dikembalikan. Namun, titik asal tidak perlu berada di awal rute referensi input (dapat dianggap sebagai posisi kendaraan saat ini pada rute referensi). Rute referensi, yang dikembalikan sebagai rute pertama dalam calculateRoute Response, akan dimulai pada titik asal yang ditentukan dalam calculateRoute Request. Bagian awal rute referensi input hingga titik asal akan dikecualikan dari Respons. Nilai minDeviationDistance dan minDeviationTime menentukan seberapa jauh rute alternatif akan dijamin untuk mengikuti rute referensi dari titik asal dan seterusnya. Rute harus menggunakan departAt. vehicleHeading diabaikan.
report	query		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.
routeRepresentation	query		RouteRepresentationForBestOrder	Menentukan representasi kumpulan rute yang disediakan sebagai respons.
routeType	query		RouteType	Jenis rute yang diminta.
sectionType	query		SectionType[]	Menentukan jenis bagian mana yang dilaporkan dalam respons rute. Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType mengacu pada input travelMode. Secara default travelMode diatur ke mobil
traffic	query		boolean	Nilai yang mungkin: true - Pertimbangkan semua informasi lalu lintas yang tersedia selama perutean false - Abaikan data lalu lintas saat ini selama perutean. Perhatikan bahwa meskipun data lalu lintas saat ini diabaikan selama perutean, efek lalu lintas historis pada kecepatan jalan yang efektif masih dimasukkan.
travelMode	query		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 bus mode perjalanan, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.
uphillEfficiency	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 ke 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
vehicleAxleWeight	query		integer	Berat per sumbu kendaraan dalam kg. Nilai 0 berarti bahwa pembatasan berat per sumbu tidak dipertimbangkan.
vehicleCommercial	query		boolean	Apakah kendaraan digunakan untuk tujuan komersial. Kendaraan komersial mungkin tidak diizinkan untuk berkendara di beberapa jalan.
vehicleEngineType	query		VehicleEngineType	Jenis mesin kendaraan. Ketika Model Konsumsi terperinci ditentukan, model tersebut harus konsisten dengan nilai vehicleEngineType.
vehicleHeading	query		integer	Arah menuju kendaraan dalam derajat mulai dari utara sejati dan melanjutkan ke arah searah jajaran jajaran. Utara adalah 0 derajat, timur adalah 90 derajat, selatan adalah 180 derajat, barat adalah 270 derajat. Kemungkinan nilai 0-359
vehicleHeight	query		number double	Tinggi kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan tinggi tidak dipertimbangkan.
vehicleLength	query		number double	Panjang kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan panjang tidak dipertimbangkan.
vehicleLoadType	query		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 lainnya. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.
vehicleMaxSpeed	query		integer	Kecepatan maksimum kendaraan dalam km/jam. Kecepatan maksimum di profil kendaraan digunakan untuk memeriksa apakah kendaraan diizinkan di jalan raya. Nilai 0 berarti bahwa nilai yang sesuai untuk kendaraan akan ditentukan dan diterapkan selama perencanaan rute. Nilai bukan nol dapat ditimpa selama perencanaan rute. Misalnya, arus lalu lintas saat ini adalah 60 km/jam. Jika kecepatan maksimum kendaraan diatur ke 50 km/jam, mesin perutean akan mempertimbangkan 60 km/jam karena ini adalah situasi saat ini. Jika kecepatan maksimum kendaraan disediakan sebagai 80 km/jam tetapi arus lalu lintas saat ini adalah 60 km/jam, maka mesin perutean akan kembali menggunakan 60 km/jam.
vehicleWeight	query		integer	Berat kendaraan dalam kilogram. Ini wajib jika salah satu parameter *Efisiensi ditetapkan. Ini harus benar-benar positif ketika digunakan dalam konteks Model Konsumsi. Pembatasan berat dipertimbangkan. Jika tidak ada Model Konsumsi terperinci yang ditentukan dan nilai vehicleWeight bukan nol, maka pembatasan berat dipertimbangkan. Dalam semua kasus lain, parameter ini diabaikan. Nilai Masuk Akal : untuk Model Pembakaran : 1600, untuk Model Listrik : 1900
vehicleWidth	query		number double	Lebar kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan lebar tidak dipertimbangkan.
windingness	query		WindingnessLevel	Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan `routeType`=thrilling.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun sarana manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Isi Permintaan

Nama	Jenis	Deskripsi
allowVignette	string[]	Ini adalah daftar kode negara 3 karakter, ISO 3166-1, alpha-3 dari 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	GeoJsonMultiPolygon	MultiPolygon GeoJSON 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 3 karakter, ISO 3166-1, alpha-3 negara/wilayah di mana semua jalan tol dengan vignette 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	GeoJsonGeometryCollection	Kumpulan 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. Urutan titik pendukung yang disediakan digunakan sebagai input untuk rekonstruksi rute. Rute alternatif dihitung antara titik asal dan tujuan yang ditentukan di lokasi parameter jalur dasar. Jika minDeviationDistance dan minDeviationTime diatur ke nol, titik asal dan tujuan ini masing-masing diharapkan berada di (atau sangat dekat) awal dan akhir rute referensi. Lokasi perantara (titik arah) tidak didukung saat menggunakan <supportingPoints>. Rute referensi mungkin berisi insiden lalu lintas jenis ROAD_CLOSURE, yang diabaikan untuk perhitungan waktu perjalanan rute referensi dan penundaan lalu lintas. Silakan merujuk ke Poin Pendukung untuk detailnya.

Respons

Nama	Jenis	Deskripsi
200 OK	RouteDirections	OKE
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Microsoft Entra OAuth 2.0 Flows. Saat dipasangkan dengan akses berbasis peran Azure kontrol dapat digunakan untuk mengontrol akses ke REST API Azure Maps. 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 ke REST API Azure Maps.

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

Catatan

Definisi keamanan ini mengharuskan penggunaan header x-ms-client-id untuk menunjukkan sumber daya Azure Maps mana yang diminta 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 ID Microsoft Entra. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft 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 .

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Microsoft 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 dikeluarkan.

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

Jenis: apiKey
Dalam: 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 Microsoft 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 butir halus ke kedaluwarsa, laju, 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 penyajian dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Permintaan sampel

HTTP

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
          ]
        ]
      ]
    ]
  }
}

Respon sampel

Kode status:: 200

{
  "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
AlternativeRouteType	Mengontrol optimalitas, sehubungan dengan kriteria perencanaan yang diberikan, dari alternatif yang dihitung dibandingkan dengan rute referensi.
ComputeTravelTime	Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.
DelayMagnitude	Besarnya penundaan yang disebabkan oleh insiden tersebut. Nilai-nilai ini sesuai dengan nilai bidang respons ty dari Dapatkan API Detail Insiden Lalu Lintas.
DrivingSide	Menunjukkan tangan kiri vs. sisi kanan mengemudi di titik manuver.
EffectiveSetting	Parameter atau data efektif yang digunakan saat memanggil Route API ini.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GeoJsonGeometry	Objek geometri `GeoJSON` yang valid. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonGeometryCollection	Jenis objek `GeoJSON GeometryCollection` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonLineString	Jenis geometri `GeoJSON LineString` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiLineString	Jenis geometri `GeoJSON MultiLineString` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiPoint	Jenis geometri `GeoJSON MultiPoint` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiPolygon	Jenis objek `GeoJSON MultiPolygon` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonPoint	Jenis geometri `GeoJSON Point` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonPolygon	Jenis geometri `GeoJSON Polygon` yang valid. Silakan lihat RFC 7946 untuk detailnya.
GuidanceInstructionType	Jenis instruksi, misalnya, belokan atau perubahan bentuk jalan.
GuidanceManeuver	Kode yang mengidentifikasi manuver.
InclineLevel	Tingkat perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan `routeType`=thrilling.
JunctionType	Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasukkan dan meninggalkan bundaran.
LatLongPair	Lokasi yang diwakili 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.
ResponseFormat	Format respons yang diinginkan. Nilai dapat berupa json atau xml .
ResponseSectionType	Jenis bagian respons rute yang dilaporkan
ResponseTravelMode	Mode perjalanan untuk rute terhitung. Nilai akan diatur ke `other` jika mode transportasi yang diminta tidak dimungkinkan di bagian ini
Route
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 sudahUsedRoads tidak boleh digunakan.
RouteDirectionParameters	Parameter isi postingan untuk Petunjuk rute.
RouteDirections	Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil
RouteGuidance	Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia.
RouteInstruction	Sekumpulan atribut yang menjelaskan manuver, misalnya 'Belok kanan', 'Tetap kiri', 'Ambil feri', 'Ambil jalan raya', 'Tiba'.
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 jika tersedia.
RouteInstructionsType	Jika ditentukan, instruksi panduan akan dikembalikan. Perhatikan bahwa parameter instructionsType tidak dapat digunakan bersama dengan routeRepresentation=none.
RouteLeg	Deskripsi bagian dari rute, terdiri dari daftar titik. Setiap titik arah tambahan yang disediakan dalam permintaan akan menghasilkan kaki tambahan dalam rute yang dikembalikan.
RouteLegSummary	Objek ringkasan untuk bagian rute.
RouteOptimizedWaypoint	Objek titik cara yang dioptimalkan.
RouteReport	Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini.
RouteRepresentationForBestOrder	Menentukan representasi kumpulan rute yang disediakan sebagai respons.
RouteSection	Bagian rute berisi informasi tambahan tentang bagian rute. Setiap bagian berisi setidaknya elemen `startPointIndex`, `endPointIndex`, dan `sectionType`.
RouteSectionTec	Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC. Dapat berisi effectCode dan menyebabkan elemen.
RouteSectionTecCause	Penyebab peristiwa lalu lintas. Dapat berisi elemen mainCauseCode dan subCauseCode. Dapat digunakan untuk menentukan ikonografi dan deskripsi.
RouteSummary	Objek ringkasan
RouteType	Jenis rute yang diminta.
SectionType	Menentukan jenis bagian mana yang dilaporkan dalam respons rute. Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType mengacu pada input travelMode. Secara default travelMode diatur ke mobil
SimpleCategory	Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau LAINNYA. Lihat "tec" untuk informasi terperinci.
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 bus mode perjalanan, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.
VehicleEngineType	Jenis mesin kendaraan. Ketika Model Konsumsi terperinci ditentukan, model tersebut harus konsisten dengan nilai vehicleEngineType.
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 lainnya. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.
WindingnessLevel	Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan `routeType`=thrilling.

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	Kembalikan 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 Dapatkan API Detail Insiden Lalu Lintas.

Nama	Jenis	Deskripsi
0	string	Diketahui.
1	string	Kecil.
2	string	Moderat.
3	string	Mayor.
4	string	Tidak ditentukan, 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	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.

GeoJsonGeometry

Objek geometri GeoJSON yang valid. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
type	GeoJsonObjectType	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometryCollection

Jenis objek GeoJSON GeometryCollection yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Berisi daftar objek geometri `GeoJSON` yang valid. Catatan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: GeometryCollection	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonLineString

Jenis geometri GeoJSON LineString yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat untuk geometri `GeoJson LineString`.
type	string: LineString	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiLineString

Jenis geometri GeoJSON MultiLineString yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat untuk geometri `GeoJson MultiLineString`.
type	string: MultiLineString	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat untuk geometri `GeoJson MultiPoint`.
type	string: MultiPoint	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPolygon

Jenis objek GeoJSON MultiPolygon yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Berisi daftar objek `GeoJSON Polygon` yang valid. Catatan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: MultiPolygon	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPoint

Jenis geometri GeoJSON Point yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	`Position` adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah bujur dan garis lintang, tepatnya dalam urutan tersebut. Altitude/Elevation adalah elemen ketiga opsional. Silakan lihat RFC 7946 untuk detailnya.
type	string: Point	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPolygon

Jenis geometri GeoJSON Polygon yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat untuk jenis geometri `GeoJson Polygon`.
type	string: Polygon	Menentukan jenis `GeoJSON`. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GuidanceInstructionType

Jenis instruksi, misalnya, belokan atau perubahan 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	Belok.

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	Berangkat.
ENTER_FREEWAY	string	Ambil jalan bebas hambatan.
ENTER_HIGHWAY	string	Ambil jalan raya.
ENTER_MOTORWAY	string	Ambil jalan raya.
ENTRANCE_RAMP	string	Ambil jalannya.
FOLLOW	string	Mengikuti.
KEEP_LEFT	string	Terus ke kiri.
KEEP_RIGHT	string	Pertahankan ke kanan.
MAKE_UTURN	string	Membuat U-turn.
MOTORWAY_EXIT_LEFT	string	Ambil pintu keluar kiri.
MOTORWAY_EXIT_RIGHT	string	Ambil pintu keluar yang tepat.
ROUNDABOUT_BACK	string	Berkeliling bundaran.
ROUNDABOUT_CROSS	string	Seberangi bundaran.
ROUNDABOUT_LEFT	string	Di bundaran ambil pintu 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. Ada 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 perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.

Nama	Jenis	Deskripsi
high	string	tinggi
low	string	rendah
normal	string	biasa

JunctionType

Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasukkan dan meninggalkan bundaran.

Nama	Jenis	Deskripsi
BIFURCATION	string	bifurcation
REGULAR	string	biasa
ROUNDABOUT	string	Bundaran

LatLongPair

Lokasi yang diwakili 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	Format Pertukaran Data Notasi Objek JavaScript
xml	string	Bahasa Markup yang Dapat Diperluas

ResponseSectionType

Jenis bagian respons rute yang dilaporkan

Nama	Jenis	Deskripsi
CARPOOL	string	Bagian dari 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 mana rute berada.
FERRY	string	Bagian dari rute yang merupakan feri.
MOTORWAY	string	Bagian dari rute yang merupakan jalan raya.
PEDESTRIAN	string	Bagian dari rute yang hanya cocok untuk pejalan kaki.
TOLL_ROAD	string	Bagian dari rute yang mengharuskan tol dibayarkan.
TOLL_VIGNETTE	string	Bagian dari rute yang memerlukan vignette tol untuk hadir.
TRAFFIC	string	Bagian rute yang berisi informasi lalu lintas.
TRAVEL_MODE	string	Bagian dalam kaitannya dengan parameter permintaan `travelMode`.
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	RouteGuidance	Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia.
legs	RouteLeg[]	Array kaki
sections	RouteSection[]	Array bagian
summary	RouteSummary	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 sudahUsedRoads tidak boleh digunakan.

Nama	Jenis	Deskripsi
alreadyUsedRoads	string	Menghindari penggunaan jalan yang sama beberapa kali. Paling berguna bersama dengan `routeType`=mendebarkan.
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 dari 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	GeoJsonMultiPolygon	MultiPolygon GeoJSON 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 3 karakter, ISO 3166-1, alpha-3 negara/wilayah di mana semua jalan tol dengan vignette 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	GeoJsonGeometryCollection	Kumpulan 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. Urutan titik pendukung yang disediakan digunakan sebagai input untuk rekonstruksi rute. Rute alternatif dihitung antara titik asal dan tujuan yang ditentukan di lokasi parameter jalur dasar. Jika minDeviationDistance dan minDeviationTime diatur ke nol, titik asal dan tujuan ini masing-masing diharapkan berada di (atau sangat dekat) awal dan akhir rute referensi. Lokasi perantara (titik arah) tidak didukung saat menggunakan <supportingPoints>. Rute referensi mungkin berisi insiden lalu lintas jenis ROAD_CLOSURE, yang diabaikan untuk perhitungan waktu perjalanan rute referensi dan penundaan lalu lintas. Silakan merujuk ke Poin Pendukung untuk detailnya.

RouteDirections

Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil

Nama	Jenis	Deskripsi
formatVersion	string	Properti Format Versi
optimizedWaypoints	RouteOptimizedWaypoint[]	Urutan titik arah yang dioptimalkan. Ini menunjukkan indeks dari urutan titik arah yang disediakan pengguna untuk daftar asli dan dioptimalkan. Misalnya, respons: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` berarti bahwa urutan aslinya adalah [0, 1, 2] dan urutan yang dioptimalkan adalah [1, 2, 0]. Karena indeks dimulai dengan 0 yang asli adalah "pertama, kedua, ketiga" sedangkan yang dioptimalkan adalah "kedua, ketiga, pertama".
report	RouteReport	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	RouteInstructionGroup[]	Mengelompokkan urutan elemen instruksi yang terkait satu sama lain.
instructions	RouteInstruction[]	Daftar instruksi yang menjelaskan manuver.

RouteInstruction

Sekumpulan 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 menjadi satu instruksi sehingga lebih mudah diikuti. Jika demikian, bendera possibleCombineWithNext akan benar. Misalnya: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` 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: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	Kode negara 3 karakter ISO 3166-1 alpha-3. Misalnya AS.
drivingSide	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	GuidanceInstructionType	Jenis instruksi, misalnya, belokan atau perubahan bentuk jalan.
junctionType	JunctionType	Jenis persimpangan tempat manuver berlangsung. Untuk bundaran yang lebih besar, dua instruksi terpisah dihasilkan untuk memasukkan dan meninggalkan bundaran.
maneuver	GuidanceManeuver	Kode yang mengidentifikasi manuver.
message	string	Pesan yang dapat dibaca manusia untuk manuver.
point	LatLongPair	Lokasi yang diwakili sebagai garis lintang dan bujur.
pointIndex	integer	Indeks titik dalam daftar "titik" polilin 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	integer	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: 180 = U-turn [-179, -1] = Belok kiri 0 = Lurus pada (giliran '0 derajat') [1, 179] = Belok kanan Jika junctionType menunjukkan instruksi bifurcation: <0 - tetap kiri >0 - tetap kanan

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 jika tersedia.

Nama	Jenis	Deskripsi
firstInstructionIndex	integer	Indeks instruksi pertama dalam instruksi dan milik grup ini.
groupLengthInMeters	integer	Panjang grup.
groupMessage	string	Ringkasan pesan 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

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 instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Contoh pesan 'Belok kiri' yang ditandai: `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Mengembalikan data instruksi mentah dengan pesan yang dapat dibaca manusia dalam teks biasa.

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 instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Contoh pesan 'Belok kiri' yang ditandai:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

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 dalam rute yang dikembalikan.

Nama	Jenis	Deskripsi
points	LatLongPair[]	Array titik
summary	RouteLegSummary	Objek ringkasan untuk bagian rute.

RouteLegSummary

Objek ringkasan untuk bagian rute.

Nama	Jenis	Deskripsi
arrivalTime	string	Perkiraan waktu kedatangan untuk rute atau kaki. Waktu dalam UTC.
batteryConsumptionInkWh	number	Perkiraan konsumsi energi listrik dalam jam kilowatt (kWh) menggunakan Model Konsumsi Listrik. Disertakan jika vehicleEngineType diatur ke listrik dan konstantaSpeedConsumptionInkWhPerHundredkm ditentukan. Nilai bateraiConsumptionInkWh mencakup energi listrik yang disembuhkan dan karenanya bisa 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 atau currentChargeInkWh tidak ditentukan, pemulihan yang tidak dibatasi diasumsikan dalam perhitungan konsumsi.
departureTime	string	Perkiraan waktu keberangkatan untuk rute atau kaki. Waktu dalam UTC.
fuelConsumptionInLiters	number	Perkiraan konsumsi bahan bakar dalam liter menggunakan Model Konsumsi Pembakaran. Disertakan jika vehicleEngineType diatur ke pembakaran dan constantSpeedConsumptionInLitersPerHundredkm ditentukan. Nilainya akan non-negatif.
historicTrafficTravelTimeInSeconds	integer	Perkiraan 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 mendatang, 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 arah yang disediakan oleh pengguna.

RouteReport

Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini.

Nama	Jenis	Deskripsi
effectiveSettings	EffectiveSetting[]	Parameter atau data efektif yang digunakan saat memanggil Route API ini.

RouteRepresentationForBestOrder

Menentukan representasi kumpulan rute yang disediakan sebagai respons.

Nama	Jenis	Deskripsi
none	string	Hanya mencakup indeks titik arah yang dioptimalkan tetapi tidak menyertakan geometri rute dalam respons. Nilai parameter ini hanya dapat digunakan bersama dengan computeBestOrder=true.
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	DelayMagnitude	Besarnya penundaan yang disebabkan oleh insiden tersebut. Nilai-nilai ini sesuai dengan nilai bidang respons ty dari Dapatkan API Detail Insiden Lalu Lintas.
sectionType	ResponseSectionType	Jenis bagian respons rute yang dilaporkan
simpleCategory	SimpleCategory	Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau LAINNYA. Lihat "tec" untuk informasi terperinci.
startPointIndex	integer	Indeks titik pertama (offset 0) di rute tempat bagian ini berlaku.
tec	RouteSectionTec	Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC. Dapat berisi effectCode dan menyebabkan elemen.
travelMode	ResponseTravelMode	Mode perjalanan untuk rute terhitung. Nilai akan diatur ke `other` jika mode transportasi yang diminta tidak dimungkinkan di bagian ini

RouteSectionTec

Detail peristiwa lalu lintas, menggunakan definisi dalam standar TPEG2-TEC. Dapat berisi effectCode dan menyebabkan elemen.

Nama	Jenis	Deskripsi
causes	RouteSectionTecCause[]	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 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	Subkala peristiwa lalu lintas. Berisi nilai dalam tabel sub penyebab yang ditentukan oleh mainCauseCode, seperti yang didefinisikan dalam standar TPEG2-TEC.

RouteSummary

Objek ringkasan

Nama	Jenis	Deskripsi
arrivalTime	string	Perkiraan waktu kedatangan untuk rute atau kaki. Waktu dalam UTC.
departureTime	string	Perkiraan waktu keberangkatan untuk rute atau kaki. Waktu dalam 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 mendatang, 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 berdasarkan jarak.
thrilling	string	Termasuk jalan yang menarik atau menantang dan menggunakan jalan raya sesedi 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 `routeType`=mendebarkan

SectionType

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType 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 dari 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 permintaan `travelMode`.
tunnel	string	Bagian dari rute yang merupakan terowongan.
urban	string	Bagian dari rute yang terletak di daerah perkotaan.

SimpleCategory

Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau LAINNYA. Lihat "tec" untuk informasi terperinci.

Nama	Jenis	Deskripsi
JAM	string	Lalu lintas macet.
OTHER	string	Lain.
ROAD_CLOSURE	string	Penutupan jalan.
ROAD_WORK	string	Pekerjaan jalanan.

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 bus mode perjalanan, 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 lainnya. 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	Pengoksidasi
USHazmatClass6	string	Racun
USHazmatClass7	string	Radioaktif
USHazmatClass8	string	Korelif
USHazmatClass9	string	Miscellaneous
otherHazmatExplosive	string	Bahan peledak
otherHazmatGeneral	string	Miscellaneous
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	biasa

Bagikan melalui

Route - Post Route Directions

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Catatan

Cakupan

subscription-key

SAS Token

Contoh

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Permintaan sampel

Respon sampel

Definisi

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirectionParameters

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Sumber Daya Tambahan: