Bagikan melalui

SearchGetGeocodingBatchDefaultResponse interface

Paket:
@azure-rest/maps-search

API Get Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Geocoding API dalam 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/geocode:batch?api-version=2023-06-01

Isi POST untuk Permintaan Batch

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

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Objek geocoding batchItem dapat menerima salah satu geocoding yang didukungparameter URI.

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.

Memperluas
HttpResponse

Properti

body
status

Properti yang Diwariskan

headers

Header respons HTTP.
request

Permintaan yang menghasilkan respons ini.

Detail Properti

body 

body: ErrorResponseOutput

Nilai Properti

ErrorResponseOutput

status 

status: string

Nilai Properti

string

Detail Properti yang Diwariskan

headers

Header respons HTTP.

headers: RawHttpHeaders

Nilai Properti

RawHttpHeaders

Diwariskan Dari HttpResponse.headers

request

Permintaan yang menghasilkan respons ini.

request: PipelineRequest

Nilai Properti

PipelineRequest

Diwarisi Dari HttpResponse.request