Поделиться через

GetGeocodingBatch interface

  • Ссылка
Пакет:
@azure-rest/maps-search

Методы

post(SearchGetGeocodingBatchParameters)

API Get Geocoding Batch — это HTTP-запрос POST, который отправляет пакеты до 100 запросов в API геокод ирования в одном запросе.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

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

Текст POST для пакетного запроса

Для отправки запросов геокодирования используется запрос , в котором текст запроса будет содержать массив в формате , а заголовок будет иметь значение . Ниже приведен пример текста запроса, содержащего 2 геокодирования запросов:

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

Объект геокодирования batchItem может принимать любой из поддерживаемых параметров геокодированияURI.

Пакет должен содержать по крайней мере 1 запроса.

Модель пакетного ответа

Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • GeocodingResponse. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

Сведения о методе

post(SearchGetGeocodingBatchParameters)

API Get Geocoding Batch — это HTTP-запрос POST, который отправляет пакеты до 100 запросов в API геокод ирования в одном запросе.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

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

Текст POST для пакетного запроса

Для отправки запросов геокодирования используется запрос , в котором текст запроса будет содержать массив в формате , а заголовок будет иметь значение . Ниже приведен пример текста запроса, содержащего 2 геокодирования запросов:

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

Объект геокодирования batchItem может принимать любой из поддерживаемых параметров геокодированияURI.

Пакет должен содержать по крайней мере 1 запроса.

Модель пакетного ответа

Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • GeocodingResponse. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

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

Параметры

options
SearchGetGeocodingBatchParameters

Возвращаемое значение

StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>