Route - Post Route Directions Batch

Referensi

Layanan:: Maps

Versi API:: 1.0

Gunakan untuk mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API dalam satu permintaan asinkron.

API Post Route Directions Batch adalah permintaan POST HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan asinkron. Anda dapat memanggil API Route Directions Batch untuk berjalan secara asinkron (asinkron) atau sinkron (sinkronisasi). API asinkron memungkinkan pemanggil untuk mengumpulkan hingga kueri 700 dan menyinkronkan API hingga 100 kueri. Untuk memanggil API Post Route Directions Batch dalam permintaan sinkron, lihat Post Route Directions Batch Sync.

Kirim Permintaan Batch Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan rute yang relatif kompleks

Ini memungkinkan pengambilan hasil dalam panggilan terpisah (beberapa unduhan dimungkinkan).
API asinkron dioptimalkan untuk keandalan dan tidak diharapkan mengalami batas waktu.
Jumlah item batch dibatasi hingga 700 untuk API ini.

Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

Harap dicatat bahwa permintaan batch asinkron adalah operasi yang berjalan lama. Berikut adalah urutan operasi yang khas:

Klien mengirimkan permintaan POST Route Directions Batch ke Azure Maps.

POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

Server akan merespons dengan salah satu hal berikut:

HTTP 202 Accepted - Permintaan batch telah diterima.

HTTP Error - Ada kesalahan saat memproses permintaan Batch Anda. Ini bisa berupa 400 Bad Request atau kode status Error lainnya.
Jika permintaan batch berhasil diterima, header Location dalam respons berisi URL untuk mengunduh hasil permintaan batch. URI status ini terlihat seperti berikut:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Klien mengeluarkan permintaan GET pada URL unduhan diperoleh di Langkah 3 untuk mengunduh hasil batch.

Isi POST untuk Permintaan Batch

Untuk mengirim petunjuk arah rute kueri, Anda akan menggunakan permintaan POST di mana isi permintaan akan berisi array batchItems dalam format json dan header Content-Type akan diatur ke application/json. Berikut adalah isi permintaan sampel yang berisi 3 petunjuk arah rute kueri:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Petunjuk arah rute kueri dalam batch hanyalah URL parsial tanpa protokol, URL dasar, jalur, versi api, dan kunci langganan. Ini dapat menerima salah satu petunjuk arah rute yang didukungparameter URI. Nilai string dalam arah rute kueri harus diloloskan dengan benar (misalnya karakter " harus diloloskan dengan \ ) dan juga harus dikodekan DENGAN URL dengan benar.

API asinkron memungkinkan pemanggil untuk mengumpulkan hingga kueri 700 dan MENYinkronkan API hingga 100 kueri, dan batch harus berisi setidaknya 1 kueri.

Unduh Hasil Batch Asinkron

Untuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan GET ke titik akhir unduhan batch. URL unduhan ini dapat diperoleh dari header permintaan batch yang berhasil dan terlihat seperti berikut ini:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:

Klien mengirim permintaan GET menggunakan URL unduhan .
Server akan merespons dengan salah satu hal berikut:

HTTP 202 Accepted - Permintaan batch diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan batch berhasil diproses. Isi respons berisi semua hasil batch.

Model Respons Batch

Konten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequestsyaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item dalam batchItems berisi bidang statusCode dan response. Setiap response dalam batchItems adalah salah satu jenis berikut:

RouteDirections - Jika kueri berhasil diselesaikan.
Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.

Berikut adalah sampel Respons Batch dengan 1 berhasil dan 1 gagal hasil:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	JsonFormat	Format respons yang diinginkan. Hanya format `json` yang didukung.
api-version	query	True	string	Nomor versi Azure Maps API.

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
batchItems	BatchRequestItem[]	Daftar kueri yang akan diproses.

Respons

Nama	Jenis	Deskripsi
200 OK	RouteDirectionsBatchResult	Permintaan batch berhasil diproses. Isi respons berisi semua hasil batch.
202 Accepted		Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya. Header Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

RouteDirectionsBatchResult

Permintaan batch berhasil diproses. Isi respons berisi semua hasil batch.

202 Accepted

Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya.

Header

Location: string

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 submit a route direction batch request

Permintaan sampel

HTTP

POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Respon sampel

Kode status:: 200

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

Kode status:: 202

operation-Location: URL to download the results of the long-running batch request.

Definisi

Nama	Deskripsi
BatchRequest	Jenis ini mewakili isi permintaan untuk layanan Batch.
BatchRequestItem	Objek permintaan batch
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
GuidanceInstructionType	Jenis instruksi, misalnya, belokan atau perubahan bentuk jalan.
GuidanceManeuver	Kode yang mengidentifikasi manuver.
JsonFormat	Format respons yang diinginkan. Hanya format `json` yang didukung.
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.
Response	Hasil kueri. RouteDirections jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
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
RouteDirectionsBatchItem	Item yang dikembalikan dari panggilan layanan Route Directions Batch.
RouteDirectionsBatchResult	Objek ini dikembalikan dari panggilan layanan Route Directions Batch 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.
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.
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
SimpleCategory	Jenis insiden. Saat ini dapat berupa JAM, ROAD_WORK, ROAD_CLOSURE, atau LAINNYA. Lihat "tec" untuk informasi terperinci.
Summary	Ringkasan hasil untuk permintaan batch

BatchRequest

Jenis ini mewakili isi permintaan untuk layanan Batch.

Nama	Jenis	Deskripsi
batchItems	BatchRequestItem[]	Daftar kueri yang akan diproses.

BatchRequestItem

Objek permintaan batch

Nama	Jenis	Deskripsi
query	string	Parameter ini berisi string kueri yang digunakan untuk melakukan operasi geocoding yang tidak terstruktur. String kueri akan diteruskan verbatim ke API pencarian untuk diproses.

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.

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.

JsonFormat

Format respons yang diinginkan. Hanya format json yang didukung.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript

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

Response

Hasil kueri. RouteDirections jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.
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

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

RouteDirectionsBatchItem

Item yang dikembalikan dari panggilan layanan Route Directions Batch.

Nama	Jenis	Deskripsi
response	Response	Hasil kueri. RouteDirections jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
statusCode	integer	Kode status permintaan HTTP.

RouteDirectionsBatchResult

Objek ini dikembalikan dari panggilan layanan Route Directions Batch yang berhasil.

Nama	Jenis	Deskripsi
batchItems	RouteDirectionsBatchItem[]	Array yang berisi hasil batch.
summary	Summary	Ringkasan hasil untuk permintaan batch

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.

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.

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.

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.

Summary

Ringkasan hasil untuk permintaan batch

Nama	Jenis	Deskripsi
successfulRequests	integer	Jumlah permintaan yang berhasil dalam batch
totalRequests	integer	Jumlah total permintaan dalam batch

Bagikan melalui

Route - Post Route Directions Batch

Kirim Permintaan Batch Asinkron

Isi POST untuk Permintaan Batch

Unduh Hasil Batch Asinkron

Model Respons Batch

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Catatan

Cakupan

subscription-key

SAS Token

Contoh

Successfully submit a route direction batch request

Permintaan sampel

Respon sampel

Definisi

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Sumber Daya Tambahan: