共用方式為


GetReverseGeocodingBatch interface

方法

post(SearchGetReverseGeocodingBatchParameters)

Get Reverse Geocoding Batch API 是 HTTP POST 要求,會使用單一要求,將最多 100 個 查詢批次傳送至 反向地理編碼 API。

提交同步批次要求

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

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

批次要求的 POST 本文

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

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

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

批次至少應包含 1 查詢

批次回應模型

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

  • GeocodingResponse - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中,回應會包含 codemessage

方法詳細資料

post(SearchGetReverseGeocodingBatchParameters)

Get Reverse Geocoding Batch API 是 HTTP POST 要求,會使用單一要求,將最多 100 個 查詢批次傳送至 反向地理編碼 API。

提交同步批次要求

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

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

批次要求的 POST 本文

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

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

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

批次至少應包含 1 查詢

批次回應模型

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

  • GeocodingResponse - 如果查詢成功完成。

  • Error - 如果查詢失敗。 在此案例中,回應會包含 codemessage

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

參數

傳回