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

SearchGetReverseGeocodingBatchDefaultResponse interface

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

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

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

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

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

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

Для отправки обратного геокодирования запросов будет использоваться запрос POST, в котором текст запроса будет содержать массив batchItems в формате json, а заголовок 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 — если запрос завершился ошибкой. Ответ будет содержать 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