GetGeocodingBatch interface

Get Geocoding Batch API,POST API'sine tek bir istekte en fazla 100 sorgu gönderen bir HTTP isteğidir.

Zaman Uyumlu Toplu İş İsteği Gönderme

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 100 ile sınırlıdır.

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

Toplu İstek için POST Gövdesi

coğrafi kodlama sorguları göndermek için, istek gövdesinin POST dizisini batchItems biçimde içereceği ve json üst bilgisinin Content-Typeolarak ayarlanacağı application/json bir istek kullanırsınız. 2 coğrafi kodlama sorgu içeren örnek bir istek gövdesi aşağıda verilmişti:

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

coğrafi kodlama batchItem nesnesi,desteklenen coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Batch Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin parçası olan summary belirten bir totalRequests bileşeni ve başarıyla yürütülen sorgular successfulRequests içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

• GeocodingResponse - Sorgu başarıyla tamamlandıysa.

• Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

function post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>

Parametreler

Döndürülenler