Bagikan melalui

GetReverseGeocodingBatch interface

Paket:
@azure-rest/maps-search

Metode

post(SearchGetReverseGeocodingBatchParameters)

API Get Reverse Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Reverse Geocoding API menggunakan satu permintaan.

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/reverseGeocode:batch?api-version=2023-06-01

Isi POST untuk Permintaan Batch

Untuk mengirim kueri geocoding terbalik , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah isi permintaan sampel yang berisi 2 kueri geocoding terbalik :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Objek batchItem geocoding terbalik dapat menerima salah satu parameter geocoding terbalik yang didukungURI.

Batch harus berisi setidaknya kueri 1.

Model Respons Batch

Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu 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 adalah salah satu jenis berikut:

  • GeocodingResponse - Jika kueri berhasil diselesaikan.

  • Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.

Detail Metode

post(SearchGetReverseGeocodingBatchParameters)

API Get Reverse Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Reverse Geocoding API menggunakan satu permintaan.

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/reverseGeocode:batch?api-version=2023-06-01

Isi POST untuk Permintaan Batch

Untuk mengirim kueri geocoding terbalik , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah isi permintaan sampel yang berisi 2 kueri geocoding terbalik :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Objek batchItem geocoding terbalik dapat menerima salah satu parameter geocoding terbalik yang didukungURI.

Batch harus berisi setidaknya kueri 1.

Model Respons Batch

Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu 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 adalah salah satu jenis berikut:

  • GeocodingResponse - Jika kueri berhasil diselesaikan.

  • Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.

function post(options: SearchGetReverseGeocodingBatchParameters): StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>

Parameter

options
SearchGetReverseGeocodingBatchParameters

Mengembalikan

StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>