Search - Get Reverse Geocoding Batch

Service:: Maps

API-versie:: 2026-01-01

Gebruik deze optie om een batch query's in één aanvraag naar de Reverse Geocoding API te verzenden.
De Get Reverse Geocoding Batch-API is een HTTP-POST-aanvraag waarmee batches van maximaal 100 query's worden verzonden naar api voor reverse geocodering met één aanvraag.

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/reverseGeocode:batch?api-version={api-version}

POST-hoofdtekst voor Batch-aanvraag

Als u de omgekeerde geocodering query'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 omgekeerde geocodering query's:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Een omgekeerde geocodering batchItem-object kan een van de ondersteunde omgekeerde 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.

POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De hostnaam van de Azure Maps-service. Gebruik `https://atlas.microsoft.com` voor de Azure publieke cloud. Om een specifieke Azure Maps geografie of een soevereine cloud te targeten, zie Azure Maps geografische reikwijdte.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Specificeert welk account bedoeld is voor gebruik in combinatie met het Azure AD-beveiligingsmodel. Het vertegenwoordigt een unieke ID voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.
Accept-Language		string	Taal waarin zoekresultaten moeten worden geretourneerd. Raadpleeg ondersteunde talen voor meer informatie.

Name

Vereist

Type

Description

x-ms-client-id

string

Specificeert welk account bedoeld is voor gebruik in combinatie met het Azure AD-beveiligingsmodel. Het vertegenwoordigt een unieke ID voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.

Accept-Language

string

Taal waarin zoekresultaten moeten worden geretourneerd.

Raadpleeg ondersteunde talen voor meer informatie.

Aanvraagbody

Name	Type	Description
batchItems	ReverseGeocodingBatchRequestItem[]	De omgekeerde geocodering van zoekopdrachten om in deze batch te verwerken. Elke invoer is één onafhankelijk verzoek voor omgekeerde geocodering; De dienst geeft per query één overeenkomstige invoer terug `GeocodingBatchResponse.batchItems` , in dezelfde volgorde.

Antwoorden

Name	Type	Description
200 OK	GeocodingBatchResponse	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

GeocodingBatchResponse

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Note

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Voorbeeldaanvraag

HTTP

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

{
  "batchItems": [
    {
      "coordinates": [
        -122.138681,
        47.630358
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        47.630358,
        -122.138681
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Voorbeeldrespons

Statuscode:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "Medium",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "name": "Washington",
                  "shortName": "WA"
                },
                {
                  "name": "King County",
                  "shortName": "King Co."
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
              "streetName": "152nd Ave NE",
              "streetNumber": "2267",
              "addressLine": "2267 152nd Ave NE"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "Bad Request",
        "message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
      },
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Definities

Name	Description
Address	Het adres van een geocodeerde of autocomplete-voorgestelde locatie, ontleed in gestructureerde velden. Schaarsheid is normaal: alleen de velden die de opgeloste entiteit levert worden ingevuld. Bijvoorbeeld, `streetName` en `streetNumber` verschijnen alleen voor adressen op straatniveau, en `intersection` alleen voor resultaten bij kruispunten.
AddressAdminDistrictsItem	Een administratieve onderverdeling die een adres bevat. Bijvoorbeeld een staat, provincie of county. Teruggegeven als één item in de ouderarray `Address.adminDistricts` , waarbij de entries gerangschikt zijn van grofst tot fijnst.
AddressCountryRegion	Het land of de regio waarin het adres staat, geïdentificeerd door de weergavenaam en de ISO 3166-1 Alpha-2 landcode. Beide velden kunnen in een gegeven antwoord worden weggelaten.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	De methode die is gebruikt voor het berekenen van het geocodepunt.
ConfidenceEnum	Het betrouwbaarheidsniveau dat het geocodeerde locatieresultaat een overeenkomst is. Gebruik deze waarde samen met de matchcodes om meer volledige informatie over de match te verkrijgen. Het vertrouwen van een geocodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de geocodeerde locatie en de locatie van de gebruiker, indien gespecificeerd.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
FeatureCollectionEnum	Het `GeoJSON` objecttype dat wordt gebruikt als basis van succesvolle antwoorden van de forward geocoding, reverse geocoding en autocomplete operaties (inclusief hun batchvarianten). De enige waarde is `FeatureCollection`, zoals gedefinieerd in RFC 7946. `Get Polygon` is de enige uitzondering: de responswortel is een `GeoJSON Feature`, zie `FeatureTypeEnum`.
FeaturesItem	Een enkele invoer in de `features` array van een `GeocodingResponse`, die conformeert de `GeoJSON Feature` objectvorm. Stelt één geocodeerde locatie voor: gestructureerde data op `properties`, een representatieve coördinaat op `geometry`, en een optioneel begrenzingsvak op `bbox`.
FeaturesItemProperties	De `properties` payload van een feature in een `GeocodingResponse`. Draagt de indicatoren voor entiteitstype en match-kwaliteit voor de geocodeerde locatie, de geanalyseerde adrescomponenten en één of meer geocodepunten die de locatie aan specifieke coördinaten koppelen.
FeatureTypeEnum	Het `GeoJSON` objecttype voor `Feature` objecten. Tagt elke invoer binnen de `features` array van een `FeatureCollection` respons (geocodering, reverse geocoding, autocomplete) en verschijnt aan de wortel van de `Get Polygon` respons. De enige waarde is `Feature`, zoals gedefinieerd in RFC 7946.
GeocodePointsItem	Eén geocodepunt voor een locatie: een coördinaat plus metadata die beschrijft hoe het punt is berekend (`calculationMethod`) en waarvoor het het beste geschikt is (`usageTypes`). Een enkele functie geeft meestal een aparte `Display` functie terug zodat `Route` bellers degene kunnen kiezen die bij de taak past.
GeocodingBatchResponse	Het succesvolle responslichaam werd teruggegeven door `Get Geocoding Batch`. Draagt een `summary` weergave van hoeveel van de ingediende queries zijn geslaagd plus een `batchItems` array met één responsvermelding per query in het verzoek, in dezelfde volgorde als de request-array `batchItems` .
GeocodingBatchResponseItem	Een enkele invoer binnen `GeocodingBatchResponse.batchItems`, met het resultaat van een van de zoekopdrachten uit de overeenkomstige `GeocodingBatchRequestBody.batchItems` invoer. Succesvolle zoekopdrachten verschijnen hier `features` in dezelfde vorm als `GeocodingResponse`; mislukte zoekopdrachten brengen diagnostische informatie naar boven via `error` in plaats daarvan. Precies één van `features` of `error` wordt per vermelding ingevuld.
GeocodingBatchResponseSummary	Draagt aggregatietellingen voor een `Get Geocoding Batch` antwoord: de grootte van de ingediende batch en hoeveel van de zoekopdrachten succesvol zijn verwerkt. Gebruikt als het type .`GeocodingBatchResponse.summary`
GeoJsonObjectType	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.
GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
Intersection	Kruispuntgegevens voor een adres worden vastgesteld als een wegkruising — de hoek waar twee of meer benoemde straten samenkomen. Alleen gevuld wanneer de opgeloste entiteit een `RoadIntersection`is; de ouder `Address.intersection` wordt verder weggelaten.
MatchCodesEnum	Een matchcodewaarde die aangeeft hoe de geocoderingsdienst een bepaald locatieresultaat heeft geproduceerd. Het `matchCodes` veld op een kenmerk is een array van deze waarden; combineer ze met `confidence` en `type` om de matchkwaliteit te evalueren.
ResultTypeEnum	Een entiteitstype dat door de `Get Reverse Geocoding Batch` operatie wordt teruggegeven. Wordt als één of meer waarden in het per-batch-itemveld `resultTypes` gegeven om de respons voor dat item te beperken tot specifieke soorten locaties; wanneer het veld wordt weggelaten, komen alle entiteitstypen in aanmerking. Wanneer entiteiten van meer dan één type overeenkomen met een coördinaat, wordt alleen de meest specifieke teruggegeven. Van meest specifiek naar minst specifiek: , , , , `Postcode1`, `AdminDivision1`, `AdminDivision2`, , `CountryRegion`. `PopulatedPlaceNeighborhoodAddress`
ReverseGeocodingBatchRequestBody	Het verzoekorgaan voor de `Get Reverse Geocoding Batch` operatie. Draagt één of meer individuele reverse-geocoderingsqueries — tussen 1 en 100, inclusief — die de dienst verwerkt als één oproep en teruggeeft als een parallelle `batchItems` array op `GeocodingBatchResponse`.
ReverseGeocodingBatchRequestItem	Eén omgekeerde geocodering binnen een `ReverseGeocodingBatchRequestBody.batchItems` array. Elk item is een onafhankelijke reverse-geocodering verzoek, gelijk aan een enkele aanroep naar `Get Reverse Geocoding`, uitgedrukt als velden in plaats van URL-queryparameters. Specificeer de locatie om te reverse-geocoderen via `coordinates`; vernauw optioneel de entiteitstypen via `resultTypes` en de geopolitieke weergave via `view`.
UsageTypeEnum	Het bedoelde gebruik voor een geocodepunt. Een geocodepunt dat door de service wordt teruggestuurd, draagt één of meer gebruikstypen die aangeven hoe een clientapplicatie het punt moet gebruiken: bijvoorbeeld het weergeven van de locatie op een kaart versus het sturen van een voertuig ernaartoe.

Address

Object

Het adres van een geocodeerde of autocomplete-voorgestelde locatie, ontleed in gestructureerde velden. Schaarsheid is normaal: alleen de velden die de opgeloste entiteit levert worden ingevuld. Bijvoorbeeld, streetName en streetNumber verschijnen alleen voor adressen op straatniveau, en intersection alleen voor resultaten bij kruispunten.

Name	Type	Description
addressLine	string	De eerste regel van het adres, meestal de straatnaam en het nummer. Bijvoorbeeld: `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	De administratieve onderverdelingen die het adres bevatten, geordend van grofst tot mooist. De eerste vermelding is meestal de eerste-orde onderverdeling (zoals een Amerikaanse staat of een Canadese provincie); Latere vermeldingen behandelen fijnere indelingen waar het land, de afhankelijkheid of regio deze definieert (zoals een county op Index 1).
countryRegion	AddressCountryRegion	Het land of de regio waarin het adres staat, met de weergavenaam en de ISO 3166-1 Alpha-2 landcode.
formattedAddress	string	Het volledige adres wordt weergegeven als een enkele, door mensen leesbare reeks weergegeven, waarbij de componenten zijn samengevoegd volgens de conventies van het land of de regio van het adres. Voorbeeld: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	De details van de kruisende straat voor het adres, ingevuld wanneer de opgeloste entiteit een `RoadIntersection` is (zoals de hoek van twee benoemde straten).
locality	string	De locatie waar het adres valt: meestal een stad, dorp of dorp. Bijvoorbeeld: `"Redmond"`.
neighborhood	string	De genoemde wijk binnen de plaats, wanneer er één wordt geïdentificeerd.
postalCode	string	De postcode van het adres, wanneer die wordt gedefinieerd. Voorbeeld: `"98052"`.
streetName	string	Het straatnaamonderdeel van het adres, wanneer de opgeloste entiteit een straatniveau adres is. Voorbeeld: `"NE 24th St"`.
streetNumber	string	Het huis- of gebouwnummer op straat, wanneer de opgeloste entiteit een adres op straatniveau is. Voorbeeld: `"15127"`.

AddressAdminDistrictsItem

Object

Een administratieve onderverdeling die een adres bevat. Bijvoorbeeld een staat, provincie of county. Teruggegeven als één item in de ouderarray Address.adminDistricts , waarbij de entries gerangschikt zijn van grofst tot fijnst.

Name	Type	Description
name	string	De volledige naam van de wijk. Bijvoorbeeld `"Washington"` voor een Amerikaanse staat, of `"King County"` voor een county.
shortName	string	De korte of afgekorte vorm van de onderverdelingsnaam, wanneer die wordt gedefinieerd. Bijvoorbeeld `"WA"` voor een Amerikaanse staat. Fijnere onderverdelingen hebben vaak geen duidelijke korte vorm, in welk geval `shortName` herhaalde ( `name` zoals `"King County"`).

AddressCountryRegion

Object

Het land of de regio waarin het adres staat, geïdentificeerd door de weergavenaam en de ISO 3166-1 Alpha-2 landcode. Beide velden kunnen in een gegeven antwoord worden weggelaten.

Name	Type	Description
ISO	string	De ISO 3166-1 Alpha-2 landcode voor het land of de regio. Bijvoorbeeld `"US"` voor de Verenigde Staten, of `"GB"` voor het Verenigd Koninkrijk.
name	string	De weergavenaam van het land of de regio. Bijvoorbeeld: `"Verenigde Staten"`.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CalculationMethodEnum

Opsomming

De methode die is gebruikt voor het berekenen van het geocodepunt.

Waarde	Description
Interpolation	Het geocodepunt werd met behulp van interpolatie gekoppeld aan een punt op een weg.
InterpolationOffset	Het geocodepunt werd gekoppeld aan een punt op een weg met behulp van interpolatie met een extra offset om het punt naar de kant van de straat te verschuiven.
Parcel	Het geocodepunt werd afgestemd op het midden van een perceel.
Rooftop	Het geocodepunt werd gekoppeld aan het dak van een gebouw.

ConfidenceEnum

Opsomming

Het betrouwbaarheidsniveau dat het geocodeerde locatieresultaat een overeenkomst is. Gebruik deze waarde samen met de matchcodes om meer volledige informatie over de match te verkrijgen.

Het vertrouwen van een geocodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de geocodeerde locatie en de locatie van de gebruiker, indien gespecificeerd.

Waarde Description

High

Waarde	Description
High	Als het vertrouwen is ingesteld op `High`, zijn er één of meerdere sterke matches gevonden. Meerdere `High` vertrouwensovereenkomsten worden gesorteerd in gerangschikte volgorde op belangrijkheid, indien van toepassing. Oriëntatiepunten zijn bijvoorbeeld belangrijk, maar adressen niet. Als een verzoek een locatie of een uitzicht bevat, kan de rangorde dienovereenkomstig veranderen. Bijvoorbeeld, een locatiezoekopdracht voor "Paris" geeft zowel "Paris, Frankrijk" als "Paris, TX" met `High` vertrouwen terug. "Paris, Frankrijk" wordt altijd op de eerste plaats geplaatst vanwege belangrijkheid, tenzij een gebruikerslocatie aangeeft dat de gebruiker zich in of zeer dicht bij Paris, TX bevindt, of de kaartweergave aangeeft dat de gebruiker in dat gebied zoekt.
Medium	In sommige situaties is het mogelijk dat de geretourneerde match niet op hetzelfde niveau is als de informatie die in het verzoek is verstrekt. In een verzoek kunnen bijvoorbeeld adresgegevens worden gespecificeerd en kan de geocode-service alleen een postcode koppelen. In dit geval, als de geocode-dienst erop vertrouwen heeft dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op `Medium` en de matchcode op `UpHierarchy` om aan te geven dat de dienst niet alle informatie kon overeenkomen en in de hiërarchie moest zoeken. Als de locatiegegevens in de query dubbelzinnig zijn en er geen aanvullende informatie is om de locaties te rangschikken (zoals de locatie van de gebruiker of het relatieve belang van de locatie), wordt de betrouwbaarheid ingesteld op `Medium`. Een locatiezoekopdracht voor "148th Ave, Bellevue" kan bijvoorbeeld zowel "148th Ave SE" als "148th Ave NE" met vertrouwen `Medium` teruggeven. Als de locatiegegevens in de query niet voldoende informatie bevatten om een specifieke locatie te geocoderen, kan een minder nauwkeurige locatiewaarde worden geretourneerd en wordt de betrouwbaarheid ingesteld op `Medium`. Als bijvoorbeeld een adres wordt opgegeven maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het geocoderesultaat met een `RoadBlock` entiteitstype worden teruggegeven.
Low	Weinig vertrouwen in de wedstrijd.

Als het vertrouwen is ingesteld op High, zijn er één of meerdere sterke matches gevonden. Meerdere High vertrouwensovereenkomsten worden gesorteerd in gerangschikte volgorde op belangrijkheid, indien van toepassing. Oriëntatiepunten zijn bijvoorbeeld belangrijk, maar adressen niet.

Als een verzoek een locatie of een uitzicht bevat, kan de rangorde dienovereenkomstig veranderen. Bijvoorbeeld, een locatiezoekopdracht voor "Paris" geeft zowel "Paris, Frankrijk" als "Paris, TX" met High vertrouwen terug. "Paris, Frankrijk" wordt altijd op de eerste plaats geplaatst vanwege belangrijkheid, tenzij een gebruikerslocatie aangeeft dat de gebruiker zich in of zeer dicht bij Paris, TX bevindt, of de kaartweergave aangeeft dat de gebruiker in dat gebied zoekt.

Medium

In sommige situaties is het mogelijk dat de geretourneerde match niet op hetzelfde niveau is als de informatie die in het verzoek is verstrekt. In een verzoek kunnen bijvoorbeeld adresgegevens worden gespecificeerd en kan de geocode-service alleen een postcode koppelen. In dit geval, als de geocode-dienst erop vertrouwen heeft dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op Medium en de matchcode op UpHierarchy om aan te geven dat de dienst niet alle informatie kon overeenkomen en in de hiërarchie moest zoeken.

Als de locatiegegevens in de query dubbelzinnig zijn en er geen aanvullende informatie is om de locaties te rangschikken (zoals de locatie van de gebruiker of het relatieve belang van de locatie), wordt de betrouwbaarheid ingesteld op Medium. Een locatiezoekopdracht voor "148th Ave, Bellevue" kan bijvoorbeeld zowel "148th Ave SE" als "148th Ave NE" met vertrouwen Medium teruggeven.

Als de locatiegegevens in de query niet voldoende informatie bevatten om een specifieke locatie te geocoderen, kan een minder nauwkeurige locatiewaarde worden geretourneerd en wordt de betrouwbaarheid ingesteld op Medium. Als bijvoorbeeld een adres wordt opgegeven maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het geocoderesultaat met een RoadBlock entiteitstype worden teruggegeven.

Low

Weinig vertrouwen in de wedstrijd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

FeatureCollectionEnum

Opsomming

Het GeoJSON objecttype dat wordt gebruikt als basis van succesvolle antwoorden van de forward geocoding, reverse geocoding en autocomplete operaties (inclusief hun batchvarianten). De enige waarde is FeatureCollection, zoals gedefinieerd in RFC 7946. Get Polygon is de enige uitzondering: de responswortel is een GeoJSON Feature, zie FeatureTypeEnum.

Waarde	Description
FeatureCollection	Het `GeoJSON FeatureCollection` objecttype. Verschijnt als de basis van elk succesvol geocodering, reverse geocoding en autocomplete responslichaam. `Get Polygon` gebruikt in plaats daarvan een `Feature` wortel.

FeaturesItem

Object

Een enkele invoer in de features array van een GeocodingResponse, die conformeert de GeoJSON Feature objectvorm. Stelt één geocodeerde locatie voor: gestructureerde data op properties, een representatieve coördinaat op geometry, en een optioneel begrenzingsvak op bbox.

Name	Type	Description
bbox	number[] (double)	De kleinste as-uitgelijnde rechthoek die de geometrie van het kenmerk bevat, in WGS 84 lengtegraad/breedte-volgorde. Gecodeerd volgens `[westLon, southLat, eastLon, northLat]`RFC 7946, Sectie 5.
geometry	GeoJsonPoint	De primaire `GeoJSON Point` vertegenwoordigt de geogecodeerde locatie, met coördinaten in WGS 84 lengte- en breedtegradenorde.
id	string	Een optionele service-toegewezen identificatie voor de functie, wanneer die beschikbaar is.
properties	FeaturesItemProperties	Gestructureerde gegevens over de geocodeerde locatie, inclusief het entiteitstype, match-kwaliteitsindicatoren, adrescomponenten en één of meer geocodepunten.
type	FeatureTypeEnum	Het `GeoJSON` objecttype. Altijd `Feature`, zoals gedefinieerd in RFC 7946.

FeaturesItemProperties

Object

De properties payload van een feature in een GeocodingResponse. Draagt de indicatoren voor entiteitstype en match-kwaliteit voor de geocodeerde locatie, de geanalyseerde adrescomponenten en één of meer geocodepunten die de locatie aan specifieke coördinaten koppelen.

Name	Type	Description
address	Address	Het adres van de geocodeerde locatie, ontleed in gestructureerde velden zoals locatie, postcode, land/regio, en (indien beschikbaar) straatnaam en -nummer.
confidence	ConfidenceEnum	Hoe sterk de geocodeerde locatie overeenkomt met het verzoek. Gebruik deze `matchCodes` voor een compleet beeld van de matchkwaliteit. Zie `ConfidenceEnum` de waardelijst en de factoren die de beoordeling beïnvloeden.
geocodePoints	GeocodePointsItem[]	Een of meer geocodepunten voor de locatie, elk gemarkeerd met hoe het is afgeleid (`calculationMethod`) en waarvoor het het beste geschikt is (`usageTypes`). Bijvoorbeeld `Display` voor visuele plaatsing op een kaart, of `Route` voor gebruik als navigatiebestemming.
matchCodes	MatchCodesEnum[]	Hoe de geocoderingsdienst dit resultaat produceerde ten opzichte van de query: een directe match bij de gevraagde specificiteit (`Good`), een van meerdere kandidaten (`Ambiguous`), of een terugval op een minder precies niveau van de geografische hiërarchie (`UpHierarchy`). Meerdere waarden kunnen aanwezig zijn. Bijvoorbeeld, een `Ambiguous` pluscombinatie `UpHierarchy` geeft aan dat de dienst niet aan de gevraagde specificiteit kon voldoen en meerdere matches op een grover niveau vond. Zie `MatchCodesEnum` voor beschrijvingen per waarde; combineer met `confidence` voor een compleet beeld van de matchkwaliteit.
type	string	Het entiteitstype waarop de geocodeerde locatie is opgelost. Eén van: `Address`, `RoadBlock`, , `NeighborhoodRoadIntersection`, `PopulatedPlaceAdminDivision2Postcode1AdminDivision1`, , of .`CountryRegion`

FeatureTypeEnum

Opsomming

Het GeoJSON objecttype voor Feature objecten. Tagt elke invoer binnen de features array van een FeatureCollection respons (geocodering, reverse geocoding, autocomplete) en verschijnt aan de wortel van de Get Polygon respons. De enige waarde is Feature, zoals gedefinieerd in RFC 7946.

Waarde	Description
Feature	Het `GeoJSON Feature` objecttype. Verschijnt op elke Feature binnen een `FeatureCollection` respons, en aan de wortel van de `Get Polygon` respons.

GeocodePointsItem

Object

Eén geocodepunt voor een locatie: een coördinaat plus metadata die beschrijft hoe het punt is berekend (calculationMethod) en waarvoor het het beste geschikt is (usageTypes). Een enkele functie geeft meestal een aparte Display functie terug zodat Route bellers degene kunnen kiezen die bij de taak past.

Name	Type	Description
calculationMethod	CalculationMethodEnum	Hoe het punt werd berekend. Bijvoorbeeld, vastgeklikt op het dak van een gebouw of geïnterpoleerd langs een wegmiddenlijn. Zie `CalculationMethodEnum` voor de waardelijst.
geometry	GeoJsonPoint	De coördinaat van dit geocodepunt is een `GeoJSON Point`, met waarden in WGS 84 lengte- en breedtegradenorde.
usageTypes	UsageTypeEnum[]	Waar het geocodepunt het beste voor geschikt is — `Display` voor visuele plaatsing op een kaart, of `Route` als routebestemming. Een punt kan beide punten dragen. Zie `UsageTypeEnum` voor de details per waarde, inclusief hoe elk is gepositioneerd voor features met niet-triviale omvang.

GeocodingBatchResponse

Object

Het succesvolle responslichaam werd teruggegeven door Get Geocoding Batch. Draagt een summary weergave van hoeveel van de ingediende queries zijn geslaagd plus een batchItems array met één responsvermelding per query in het verzoek, in dezelfde volgorde als de request-array batchItems .

Name	Type	Description
batchItems	GeocodingBatchResponseItem[]	De resultaten per query van de batch. Elke invoer komt positioneel overeen met de verzoekvermelding op dezelfde array-index in `GeocodingBatchRequestBody.batchItems`. Vermeldingen met `error` ingevulde vertegenwoordigen zoekopdrachten die mislukten; vermeldingen met `features` ingevulde vertegenwoordigen zoekopdrachten die zijn geslaagd.
nextLink	string	Bevat de URL om de volgende pagina met resultaten op te halen als het antwoord gepagineerd is. Dit is handig wanneer het antwoord te groot is om in één oproep te worden beantwoord, waardoor gebruikers door meerdere pagina's met resultaten kunnen navigeren.
summary	GeocodingBatchResponseSummary	De totale tellingen voor de batch als geheel, het totaal aantal ingediende queries en hoeveel daarvan succesvol zijn afgerond.

GeocodingBatchResponseItem

Object

Een enkele invoer binnen GeocodingBatchResponse.batchItems, met het resultaat van een van de zoekopdrachten uit de overeenkomstige GeocodingBatchRequestBody.batchItems invoer. Succesvolle zoekopdrachten verschijnen hier features in dezelfde vorm als GeocodingResponse; mislukte zoekopdrachten brengen diagnostische informatie naar boven via error in plaats daarvan. Precies één van features of error wordt per vermelding ingevuld.

Name	Type	Description
error	ErrorDetail	Diagnostische informatie voor een query die binnen de batch faalde, het per-entry foutpad vult het succespad op `features`aan. Alleen bevolkt wanneer de ingang mislukte; zie `ErrorDetail` voor de per-foutvorm.
features	FeaturesItem[]	De array van `GeoJSON Feature` objecten geocodeert voor de query van deze batch-invoer. Elk `Feature` vertegenwoordigt een enkele geogecodeerde locatie met details die worden blootgelegd via `properties` en de primaire coördinaat via `geometry`. Alleen bevolkt wanneer de inzending slaagde.
nextLink	string	Bevat de URL om de volgende pagina met resultaten op te halen als het antwoord gepagineerd is. Dit is handig wanneer het antwoord te groot is om in één oproep te worden beantwoord, waardoor gebruikers door meerdere pagina's met resultaten kunnen navigeren.
optionalId	string	De door de beller verstrekte identificatiecode weerklonk van de overeenkomstige `GeocodingBatchRequestItem.optionalId`. Alleen gevuld wanneer de verzoekvermelding er een aanleverde. Nuttig voor de correlatie aan applicatiezijde wanneer de arraypositie niet voldoende is.
type	FeatureCollectionEnum	Het `GeoJSON` objecttype van het succeslichaam van deze ingang. Altijd `FeatureCollection`, zoals gedefinieerd in RFC 7946. Alleen bevolkt wanneer de inzending slaagde.

GeocodingBatchResponseSummary

Object

Draagt aggregatietellingen voor een Get Geocoding Batch antwoord: de grootte van de ingediende batch en hoeveel van de zoekopdrachten succesvol zijn verwerkt. Gebruikt als het type .GeocodingBatchResponse.summary

Name	Type	Description
successfulRequests	integer (int32)	Het aantal zoekopdrachten in de batch dat succesvol is verwerkt — die waarvan de responsvermelding in `GeocodingBatchResponse.batchItems` bevat `features` in plaats van `error`.
totalRequests	integer (int32)	Het totale aantal ingediende zoekopdrachten in de batch. Trek `successfulRequests` af om het aantal zoekopdrachten af te leiden dat faalde.

GeoJsonObjectType

Opsomming

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Waarde	Description
Point	`GeoJSON Point` geometrie.
MultiPoint	`GeoJSON MultiPoint` geometrie.
LineString	`GeoJSON LineString` geometrie.
MultiLineString	`GeoJSON MultiLineString` geometrie.
Polygon	`GeoJSON Polygon` geometrie.
MultiPolygon	`GeoJSON MultiPolygon` geometrie.
GeometryCollection	`GeoJSON GeometryCollection` geometrie.
Feature	`GeoJSON Feature` object.
FeatureCollection	`GeoJSON FeatureCollection` object.

GeoJsonPoint

Object

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
bbox	number[] (double)	Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie.
coordinates	number[] (double)	Een `Position` is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/Hoogte- is een optioneel derde element. Raadpleeg RFC 7946- voor meer informatie.
type	string: Point	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Intersection

Object

Kruispuntgegevens voor een adres worden vastgesteld als een wegkruising — de hoek waar twee of meer benoemde straten samenkomen. Alleen gevuld wanneer de opgeloste entiteit een RoadIntersectionis; de ouder Address.intersection wordt verder weggelaten.

Name	Type	Description
baseStreet	string	De hoofdstraat van het kruispunt — meestal de straat waar het adresnummer naar verwijst.
displayName	string	Een door mensen leesbare naam voor het kruispunt dat de kruisingen combineert, zoals `"5th Avenue & Main Street"`.
intersectionType	string	Een kort label dat de vorm van de kruising beschrijft. Bijvoorbeeld het onderscheiden van een gelijkvloerse kruising van een gelijkvloerse oversteek zoals een brug of viaduct.
secondaryStreet1	string	De eerste kruisstraat die samenkomt `baseStreet` bij de kruising.
secondaryStreet2	string	De tweede kruisstraat bij het kruispunt, wanneer er een aanwezig is. Bevolkt alleen bij kruispunten van drie of meer straten.

MatchCodesEnum

Opsomming

Een matchcodewaarde die aangeeft hoe de geocoderingsdienst een bepaald locatieresultaat heeft geproduceerd. Het matchCodes veld op een kenmerk is een array van deze waarden; combineer ze met confidence en type om de matchkwaliteit te evalueren.

Waarde	Description
Good	De geocoderingsdienst produceerde deze kandidaat zonder de zoekopdracht te verbreden: het resultaat komt overeen met de zoekopdracht op de specificiteit die werd gevraagd.
Ambiguous	De locatie is een van een reeks mogelijke matches. Bijvoorbeeld, bij het zoeken naar het straatadres "128 Main St.", kan het antwoord twee locaties teruggeven voor "128 North Main St." en "128 South Main St." omdat er niet genoeg informatie is om te bepalen welke optie gekozen moet worden.
UpHierarchy	De locatie vertegenwoordigt een stap omhoog in de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, zodat er een minder nauwkeurig resultaat wordt geretourneerd.

ResultTypeEnum

Opsomming

Een entiteitstype dat door de Get Reverse Geocoding Batch operatie wordt teruggegeven. Wordt als één of meer waarden in het per-batch-itemveld resultTypes gegeven om de respons voor dat item te beperken tot specifieke soorten locaties; wanneer het veld wordt weggelaten, komen alle entiteitstypen in aanmerking. Wanneer entiteiten van meer dan één type overeenkomen met een coördinaat, wordt alleen de meest specifieke teruggegeven. Van meest specifiek naar minst specifiek: , , , , Postcode1, AdminDivision1, AdminDivision2, , CountryRegion. PopulatedPlaceNeighborhoodAddress

Waarde	Description
Address	Een specifiek straatadres.
Neighborhood	Een lokaal erkend gebied binnen een bevolkte plek, vaak met informele of cultureel gedefinieerde grenzen.
PopulatedPlace	Een geconcentreerd gebied van menselijke nederzettingen, zoals een stad, dorp of dorp.
Postcode1	De kleinste postcodecategorie, zoals een postcode.
AdminDivision1	Eerste administratieve niveau binnen het land/de regio, zoals een staat of een provincie.
AdminDivision2	Tweede administratief niveau binnen het land/de regio, zoals een county.
CountryRegion	Een land of regio.

ReverseGeocodingBatchRequestBody

Object

Het verzoekorgaan voor de Get Reverse Geocoding Batch operatie. Draagt één of meer individuele reverse-geocoderingsqueries — tussen 1 en 100, inclusief — die de dienst verwerkt als één oproep en teruggeeft als een parallelle batchItems array op GeocodingBatchResponse.

Name	Type	Description
batchItems	ReverseGeocodingBatchRequestItem[]	De omgekeerde geocodering van zoekopdrachten om in deze batch te verwerken. Elke invoer is één onafhankelijk verzoek voor omgekeerde geocodering; De dienst geeft per query één overeenkomstige invoer terug `GeocodingBatchResponse.batchItems` , in dezelfde volgorde.

ReverseGeocodingBatchRequestItem

Object

Eén omgekeerde geocodering binnen een ReverseGeocodingBatchRequestBody.batchItems array. Elk item is een onafhankelijke reverse-geocodering verzoek, gelijk aan een enkele aanroep naar Get Reverse Geocoding, uitgedrukt als velden in plaats van URL-queryparameters. Specificeer de locatie om te reverse-geocoderen via coordinates; vernauw optioneel de entiteitstypen via resultTypes en de geopolitieke weergave via view.

Name	Type	Description
coordinates	number[] (double)	De locatie om omgekeerd geocode te doen, gecodeerd als `[longitude, latitude]` in WGS 84-volgorde. Bijvoorbeeld `[-122.138681, 47.630358]` voor een punt in Redmond, Washington.
optionalId	string	Een optionele door de beller geleverde identificatie weerkaatste op de bijbehorende responsinvoer als `GeocodingBatchResponseItem.optionalId`. Nuttig om antwoorden op verzoeken te correleren via een stabiele applicatie-side identifier in plaats van alleen te vertrouwen op arraypositie.
resultTypes	ResultTypeEnum[]	Beperkt de reactie tot specifieke soorten locaties. Wanneer deze worden weggelaten, komen alle entiteitstypen in aanmerking. Zie `ResultTypeEnum` voor de waardelijst en het meest specifieke winstselectiegedrag wanneer entiteiten van meerdere typen overeenkomen.
view	string	Een ISO 3166-1 Alpha-2 regio/landcode die de regio identificeert waarvan het geopolitieke standpunt moet worden toegepast op betwiste grenzen en labels in de reactie. Zie Ondersteunde Weergaven voor de beschikbare waarden.

UsageTypeEnum

Opsomming

Het bedoelde gebruik voor een geocodepunt. Een geocodepunt dat door de service wordt teruggestuurd, draagt één of meer gebruikstypen die aangeven hoe een clientapplicatie het punt moet gebruiken: bijvoorbeeld het weergeven van de locatie op een kaart versus het sturen van een voertuig ernaartoe.

Waarde	Description
Display	Het geocodepunt is geschikt om de locatie op een kaart weer te geven. Voor een kenmerk met niet-triviale omvang (zoals een park of gebouw) ligt het `Display` punt meestal dicht bij het visuele centrum van het object.
Route	Het geocodepunt is geschikt als bestemming van een route. Voor een kenmerk met niet-triviale omvang (zoals een park of gebouw) wordt het `Route` punt meestal geplaatst bij een voertuigtoegankelijke ingang in plaats van in het visuele centrum.