GetGeocodingBatch interface

واجهة برمجة تطبيقات Get Geocoding Batch هي طلب POST HTTP يرسل دفعات تصل إلى 100 استعلامات إلى Geocoding API في طلب واحد.

إرسال طلب دفعي متزامن

يوصى باستخدام واجهة برمجة التطبيقات المتزامنة لطلبات الدفعات الخفيفة. عندما تتلقى الخدمة طلبا، سوف تستجيب بمجرد حساب عناصر الدفعة ولن تكون هناك إمكانية لاسترداد النتائج لاحقا. سترجع واجهة برمجة التطبيقات المتزامنة خطأ مهلة (استجابة 408) إذا استغرق الطلب أكثر من 60 ثانية. يقتصر عدد عناصر الدفعات على 100 لواجهة برمجة التطبيقات هذه.

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

نص POST لطلب الدفعة

لإرسال استعلامات الترميز الجغرافي ستستخدم طلب حيث سيحتوي نص الطلب على صفيف بتنسيق وسيتم تعيين عنوان إلى . فيما يلي نموذج نص طلب يحتوي على استعلامات ترميز جغرافي :

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

يمكن أن يقبل كائن الترميز الجغرافي batchItem أيا من معلمات URIالترميز الجغرافي المدعومة.

يجب أن تحتوي الدفعة على استعلام على الأقل.

نموذج استجابة الدفعة

تحتوي استجابة الدفعة على مكون summary يشير إلى totalRequests التي كانت جزءا من طلب الدفعة الأصلي successfulRequests أي الاستعلامات التي تم تنفيذها بنجاح. تتضمن استجابة الدفعة أيضا صفيف batchItems يحتوي على استجابة لكل استعلام في طلب الدفعة. سيحتوي batchItems على النتائج بنفس الترتيب الذي تم إرسال الاستعلامات الأصلية به في طلب الدفعة. كل عنصر من أحد الأنواع التالية:

• GeocodingResponse - إذا اكتمل الاستعلام بنجاح.

• Error - إذا فشل الاستعلام. ستحتوي الاستجابة على codemessage في هذه الحالة.

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

المعلمات

المرتجعات