다음을 통해 공유

SearchGetGeocodingBatchDefaultResponse interface

  • 참조
패키지:
@azure-rest/maps-search

Get Geocoding Batch API는 단일 요청에서 POST API에 최대 100개의 쿼리 일괄 처리를 보내는 HTTP 요청입니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

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

Batch 요청에 대한 POST 본문

지오코딩 쿼리를 보내려면 요청 본문에 POST 형식의 batchItems 배열이 포함되고 json 헤더가 Content-Type설정되는 application/json 요청을 사용합니다. 다음은 2개의 지오코딩 쿼리를 포함하는 샘플 요청 본문입니다.

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

지오코딩 batchItem 개체는 지원되는 지오코딩URI 매개 변수수락할 수 있습니다.

일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

Batch 응답 모델

일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 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에서 상속됨