SearchGetGeocodingBatchDefaultResponse interface

Pakket:

@azure-rest/maps-search

Batch-API voor geocodering

Van toepassing op: zie prijscategorieën .

De Geocoderingsbatch-API verzendt batches query's naar Geocoderings-API met slechts één API-aanroep. Met de API kan de aanroeper maximaal 100 query's batcheren.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

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

POST-hoofdtekst voor Batch-aanvraag

Als u de geocoderingsquery's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 geocodering query's:

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

Een geocodering batchItem-object kan een van de ondersteunde geocoderingURI-parametersaccepteren.

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item heeft een van de volgende typen:

• GeocodingResponse: als de query is voltooid.

• Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Uitbreiding

HttpResponse

Eigenschappen

body
status

Overgenomen eigenschappen

headers	De HTTP-antwoordheaders.
request	De aanvraag die dit antwoord heeft gegenereerd.

Eigenschapdetails

body

body: ErrorResponseOutput

Waarde van eigenschap

ErrorResponseOutput

status

status: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

headers

De HTTP-antwoordheaders.

headers: RawHttpHeaders

Waarde van eigenschap

RawHttpHeaders

overgenomen van HttpResponse.headers

request

De aanvraag die dit antwoord heeft gegenereerd.

request: PipelineRequest

Waarde van eigenschap

PipelineRequest

overgenomen van HttpResponse.request