SearchGetGeocodingBatchDefaultResponse interface

參考

套件:: @azure-rest/maps-search

Get Geocoding Batch API 是一個 HTTP POST 要求，可將最多 100 個查詢批次傳送至單一要求中的 Geocoding API。

提交同步批次要求

針對輕量型批次要求，建議使用同步 API。當服務收到要求時，它會在計算批次專案后立即回應，且稍後將不可能擷取結果。如果要求超過 60 秒，同步 API 會傳回逾時錯誤（408 回應）。批次項目的數目限制為此 API 100。

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

批次要求的 POST 本文

若要傳送 地理編碼 查詢，您將使用 POST 要求，其中要求本文會以 batchItems 格式包含 json 陣列，並將 Content-Type 標頭設定為 application/json。以下是包含 2 個 地理編碼 查詢的範例要求本文：

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

geocoding batchItem 物件可以接受任何支援的 地理編碼URI 參數。

批次至少應包含 1 查詢。

批次回應模型

批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。每個專案都是下列其中一種類型：

GeocodingResponse - 如果查詢成功完成。
Error - 如果查詢失敗。在此案例中，回應會包含 code 和 message。

Extends: HttpResponse

屬性

body
status

繼承的屬性

headers	HTTP 回應標頭。
request	產生此回應的要求。

屬性詳細資料

body

body: ErrorResponseOutput

屬性值

ErrorResponseOutput

status

status: string

屬性值

string

繼承的屬性詳細資料

headers

HTTP 回應標頭。

headers: RawHttpHeaders

屬性值

RawHttpHeaders

繼承自 HttpResponse.headers

request

產生此回應的要求。

request: PipelineRequest

屬性值

PipelineRequest

繼承自 HttpResponse.request

共用方式為