Bagikan melalui


@azure-rest/maps-route package

Antarmuka

BatchRequest

Jenis ini mewakili isi permintaan untuk layanan Batch.

BatchRequestItem

Objek permintaan batch

BatchResultItemOutput

Item yang dikembalikan dari API Batch. Perluas dengan properti 'respons'.

BatchResultOutput

Objek ini dikembalikan dari panggilan layanan Batch yang berhasil. Perluas dengan properti 'batchItems'.

BatchResultSummaryOutput

Ringkasan hasil untuk permintaan batch

EffectiveSettingOutput

Parameter atau data efektif yang digunakan saat memanggil Route API ini.

ErrorDetailOutput

Detail kesalahan.

ErrorResponseOutput

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

GeoJsonFeature

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

GeoJsonFeatureCollection

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

GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

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

GeoJsonGeometryCollectionData
GeoJsonGeometryParent

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.

GeoJsonLineString

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

GeoJsonLineStringData
GeoJsonMultiLineString

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

GeoJsonMultiLineStringData
GeoJsonMultiPoint

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

GeoJsonMultiPointData

Data yang dimuat oleh GeoJson MultiPoint.

GeoJsonMultiPolygon

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

GeoJsonMultiPolygonData
GeoJsonObjectParent

Objek GeoJSON yang valid. Silakan lihat RFC 7946 untuk detailnya.

GeoJsonPoint

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

GeoJsonPointData

Data yang dimuat oleh GeoJson Point.

GeoJsonPolygon

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

GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Lokasi yang diwakili sebagai garis lintang dan bujur.

MapsRouteClientOptions

Parameter opsional untuk klien

RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Parameter isi postingan untuk Petunjuk rute.

RouteDirectionsBatchItemOutput

Item yang dikembalikan dari panggilan layanan Route Directions Batch.

RouteDirectionsBatchItemResponseOutput

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

RouteDirectionsBatchResultOutput

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

RouteDirectionsOutput

Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil

RouteGetRouteDirections200Response

API Get Route Directions adalah permintaan GET HTTP yang mengembalikan rute antara asal dan tujuan, melewati titik arah jika ditentukan. Rute ini 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. Untuk informasi selengkapnya, lihatModel Konsumsi .

RouteGetRouteDirectionsBatch200Response

API Get Route Directions Batch adalah permintaan GET HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan. Anda dapat memanggil API Get 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.

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:

  1. Klien mengirim permintaan GET menggunakan URL unduhan .

  2. 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

API Get Route Directions Batch adalah permintaan GET HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan. Anda dapat memanggil API Get 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.

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:

  1. Klien mengirim permintaan GET menggunakan URL unduhan .

  2. 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

API Get Route Directions adalah permintaan GET HTTP yang mengembalikan rute antara asal dan tujuan, melewati titik arah jika ditentukan. Rute ini 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. Untuk informasi selengkapnya, lihatModel Konsumsi .

RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

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.

RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

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.

RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

API Get Route Matrix adalah permintaan GET HTTP yang menghitung waktu dan jarak perjalanan untuk semua pasangan yang mungkin dalam daftar asal dan tujuan. Tidak seperti Dapatkan Petunjuk Arah Rute API, yang memberikan instruksi rute terperinci, API ini berfokus pada efisiensi dengan memberi Anda biaya (waktu perjalanan dan jarak) perutean dari setiap asal ke setiap tujuan. Untuk informasi selengkapnya, lihat praktik terbaik untuk layanan Rute Azure Maps.

Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix GET ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan GET untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

API Get Route Matrix adalah permintaan GET HTTP yang menghitung waktu dan jarak perjalanan untuk semua pasangan yang mungkin dalam daftar asal dan tujuan. Tidak seperti Dapatkan Petunjuk Arah Rute API, yang memberikan instruksi rute terperinci, API ini berfokus pada efisiensi dengan memberi Anda biaya (waktu perjalanan dan jarak) perutean dari setiap asal ke setiap tujuan. Untuk informasi selengkapnya, lihat praktik terbaik untuk layanan Rute Azure Maps.

Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix GET ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan GET untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteGetRouteRange200Response

API Get Route Range (Isochrone) adalah permintaan GET HTTP yang akan menghitung sekumpulan lokasi yang dapat dicapai dari titik asal berdasarkan bahan bakar, energi, waktu, atau anggaran jarak yang ditentukan. Batas poligon (atau Isochrone) dikembalikan dalam orientasi berlawanan arah jarang serta pusat poligon yang tepat yang merupakan hasil dari titik asal.

Poligon yang dikembalikan dapat digunakan untuk pemrosesan lebih lanjut seperti Search Inside Geometry untuk mencari POI dalam isochrone yang disediakan.

RouteGetRouteRangeDefaultResponse

API Get Route Range (Isochrone) adalah permintaan GET HTTP yang akan menghitung sekumpulan lokasi yang dapat dicapai dari titik asal berdasarkan bahan bakar, energi, waktu, atau anggaran jarak yang ditentukan. Batas poligon (atau Isochrone) dikembalikan dalam orientasi berlawanan arah jarang serta pusat poligon yang tepat yang merupakan hasil dari titik asal.

Poligon yang dikembalikan dapat digunakan untuk pemrosesan lebih lanjut seperti Search Inside Geometry untuk mencari POI dalam isochrone yang disediakan.

RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia.

RouteInstructionGroupOutput

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.

RouteInstructionOutput

Sekumpulan atribut yang menjelaskan manuver, misalnya 'Belok kanan', 'Tetap kiri', 'Ambil feri', 'Ambil jalan raya', 'Tiba'.

RouteLegOutput

Deskripsi bagian dari rute, terdiri dari daftar titik. Setiap titik arah tambahan yang disediakan dalam permintaan akan menghasilkan kaki tambahan dalam rute yang dikembalikan.

RouteMatrixOutput

Objek hasil matriks

RouteMatrixQuery

Objek dengan matriks koordinat.

RouteMatrixResultOutput

Objek ini dikembalikan dari panggilan Route Matrix yang berhasil. Misalnya, jika 2 asal dan 3 tujuan disediakan, akan ada 2 array dengan masing-masing 3 elemen. Konten setiap elemen bergantung pada opsi yang disediakan dalam kueri.

RouteMatrixResultResponseOutput

Objek respons sel saat ini dalam matriks input.

RouteMatrixSummaryOutput

Objek ringkasan

RouteOptimizedWaypointOutput

Objek titik cara yang dioptimalkan.

RouteOutput
RouteRangeOutput

Rentang yang Dapat Dijangkau

RouteRangeResultOutput

Objek ini dikembalikan dari panggilan Rentang Yang Dapat Dijangkau Rute yang berhasil

RouteReportOutput

Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini.

RouteRequestRouteDirectionsBatch200Response

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:

  1. 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}
  1. 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.

  2. 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}
  1. 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:

  1. Klien mengirim permintaan GET menggunakan URL unduhan .

  2. 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

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:

  1. 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}
  1. 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.

  2. 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}
  1. 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:

  1. Klien mengirim permintaan GET menggunakan URL unduhan .

  2. 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

API Post Route Directions Batch Sync adalah permintaan POST HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan sinkron. 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 asinkron, lihat Post Route Directions Batch.

Kirim Permintaan Batch Sinkron

API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.

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

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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

API Post Route Directions Batch Sync adalah permintaan POST HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan sinkron. 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 asinkron, lihat Post Route Directions Batch.

Kirim Permintaan Batch Sinkron

API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.

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

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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

API Post Route Directions Batch Sync adalah permintaan POST HTTP yang mengirim batch kueri ke Dapatkan Petunjuk Arah Rute API menggunakan satu permintaan sinkron. 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 asinkron, lihat Post Route Directions Batch.

Kirim Permintaan Batch Sinkron

API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.

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

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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

API Post Route Matrix adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan permintaan asinkron (asinkron). Untuk membuat permintaan sinkron (sinkronisasi), lihat Post Route Matrix Sync. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Catatan

Semua asal dan tujuan harus terkandung dalam kotak pembatas 400 km x 400 km yang selaras dengan sumbu. Jika tidak, beberapa sel matriks akan diselesaikan sebagai OUT_OF_REGION.

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

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

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

API Post Route Matrix adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan permintaan asinkron (asinkron). Untuk membuat permintaan sinkron (sinkronisasi), lihat Post Route Matrix Sync. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Catatan

Semua asal dan tujuan harus terkandung dalam kotak pembatas 400 km x 400 km yang selaras dengan sumbu. Jika tidak, beberapa sel matriks akan diselesaikan sebagai OUT_OF_REGION.

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

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

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

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

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteRequestRouteMatrixSync408Response

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

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

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

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

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. 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. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

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

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

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

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Bagian rute berisi informasi tambahan tentang bagian rute. Setiap bagian berisi setidaknya elemen startPointIndex, endPointIndex, dan sectionType.

RouteSectionTecCauseOutput

Penyebab peristiwa lalu lintas. Dapat berisi elemen mainCauseCode dan subCauseCode. Dapat digunakan untuk menentukan ikonografi dan deskripsi.

RouteSectionTecOutput

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

RouteSummaryOutput

Objek ringkasan

Routes
SimplePollerLike

Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang.

Alias Jenis

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.

GeoJsonObject

Objek GeoJSON yang valid. Silakan lihat RFC 7946 untuk detailnya.

MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Fungsi

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Buat badan permintaan batch dari sekelompok permintaan arah rute.

default(AzureKeyCredential, ClientOptions)

Membuat instans MapsRouteClient dari kunci langganan.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Membuat instans MapsRoute dari Azure Identity TokenCredential.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Membuat instans MapsRoute dari Azure Identity AzureSASCredential.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Fungsi pembantu yang membangun objek Poller untuk membantu polling operasi yang berjalan lama.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Ubah array [Lintang, Garis Bujur] menjadi string dalam format berikut: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Detail Fungsi

buildMultiCollection(string[], string)

function buildMultiCollection(items: string[], parameterName: string): string

Parameter

items

string[]

parameterName

string

Mengembalikan

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Buat badan permintaan batch dari sekelompok permintaan arah rute.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parameter

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Objek parameter kueri untuk permintaan arah rute

Mengembalikan

Permintaan batch yang terdiri.

default(AzureKeyCredential, ClientOptions)

Membuat instans MapsRouteClient dari kunci langganan.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Parameter

credential
AzureKeyCredential

Instans AzureKeyCredential yang digunakan untuk mengautentikasi permintaan ke layanan

options
ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Rute

Mengembalikan

default(TokenCredential, string, ClientOptions)

Membuat instans MapsRoute dari Azure Identity TokenCredential.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Parameter

credential
TokenCredential

Instans TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan

mapsAccountClientId

string

Id klien Azure Maps dari sumber daya peta tertentu

options
ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Rute

Mengembalikan

default(AzureSASCredential, ClientOptions)

Membuat instans MapsRoute dari Azure Identity AzureSASCredential.

Contoh

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Parameter

credential
AzureSASCredential

Instans AzureSASCredential yang digunakan untuk mengautentikasi permintaan ke layanan

options
ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Rute

Mengembalikan

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Fungsi pembantu yang membangun objek Poller untuk membantu polling operasi yang berjalan lama.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameter

client
Client

Klien yang digunakan untuk mengirim permintaan untuk mendapatkan halaman tambahan.

initialResponse

TResult

Respons awal.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opsi untuk mengatur status resume atau interval polling kustom.

Mengembalikan

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Objek poller untuk polling pembaruan status operasi dan akhirnya mendapatkan respons akhir.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parameter

Mengembalikan

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parameter

Mengembalikan

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parameter

Mengembalikan

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parameter

Mengembalikan

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parameter

Mengembalikan

response

toColonDelimitedLatLonString(LatLon[])

Ubah array [Lintang, Garis Bujur] menjadi string dalam format berikut: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parameter

coordinates

LatLon[]

Array pasangan Lintang/Bujur untuk diubah.

Mengembalikan

string

String yang diubah.