Search - Get Geocoding Batch

Service:: Maps

API-versie:: 2026-01-01

Gebruik dit diagram om een batch query's in één verzoek naar de Geocoding API te verzenden.
De Get Geocoding Batch API is een HTTP-verzoek POST dat batches van maximaal 100 query's in één verzoek naar de Geocoding API verzendt.

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={api-version}

POST-hoofdtekst voor Batch-aanvraag

Om de geocoderingsquery's te verzenden, gebruikt u een POST verzoek waarbij de aanvraagbody de batchItems array in json formaat bevat en de Content-Type header wordt ingesteld op application/json. Hier is een voorbeeld van een aanvraagbody met 2 geocoderingsquery's :

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

Een geocoding batchItem-object kan elk van de ondersteunde geocoderings-URI-parameters accepteren.

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}/geocode: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	GeocodingBatchRequestItem[]	De lijst met query's die moeten worden verwerkt.

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 Geocoding Batch API call containing 2 Geocoding queries

Voorbeeldaanvraag

HTTP

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

{
  "batchItems": [
    {
      "addressLine": "15127 NE 24th Street, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "query": "Pike Pl",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Voorbeeldrespons

Statuscode:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King County"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
              "streetName": "NE 24th St",
              "streetNumber": "15127",
              "addressLine": "15127 NE 24th St"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.138669,
                    47.630359
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.1387383,
                    47.630563
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.138669,
              47.630359
            ]
          },
          "bbox": [
            -122.14631082421619,
            47.62649628242932,
            -122.1310271757838,
            47.634221717570675
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
      }
    }
  ]
}

Definities

Name	Description
Address	Het adres van het resultaat
AddressAdminDistrictsItem	De naam van de onderverdeling in het land of de regio voor een adres.
AddressCountryRegion	Land of regio met de naam en ISO-code.
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 met de overeenkomstcode om meer volledige informatie over de overeenkomst te bepalen. 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 opgegeven.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
FeatureCollectionEnum	Hiermee geeft u het `GeoJSON` type. Het enige ondersteunde objecttype is `FeatureCollection`. Zie RFC 7946voor meer informatie.
FeaturesItem	Een feature-object.
FeaturesItemProperties	Eigenschappen van het kenmerk.
FeatureTypeEnum	Het type van een functie moet Functie zijn.
GeocodePointsItem	Een geocodepunt.
GeocodingBatchRequestBody	De lijst met adresgeocoderingsquery's/verzoeken die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.
GeocodingBatchRequestItem	BatchQuery-object
GeocodingBatchResponse	Dit object wordt geretourneerd na een geslaagde aanroep van de Geocoding Batch-service.
GeocodingBatchResponseItem	Een batch-responsitem.
GeocodingBatchResponseSummary	Samenvatting voor de batchaanvraag
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	Het adres van het resultaat.
MatchCodesEnum	Een enum dat de matchcode vertegenwoordigt.
UsageTypeEnum	Een enum dat het gebruikstype vertegenwoordigt.

Address

Object

Het adres van het resultaat

Name	Type	Description
addressLine	string	Adresregel met straatnaam en nummer
adminDistricts	AddressAdminDistrictsItem[]	De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de eerste administratieve onderverdeling, maar in sommige gevallen bevat het ook de tweede, derde of vierde orderindeling in een land, afhankelijkheid of regio.
countryRegion	AddressCountryRegion	Land of regio met de naam en ISO-code.
formattedAddress	string	Opgemaakte adreseigenschap
intersection	Intersection	Het adres van het resultaat.
locality	string	Plaats onroerend goed
neighborhood	string	Buurt eigendom
postalCode	string	Postcode eigenschap
streetName	string	De naam van de straat uit formattedAddress
streetNumber	string	Het nummer op straat, indien beschikbaar, van formattedAddress

AddressAdminDistrictsItem

Object

De naam van de onderverdeling in het land of de regio voor een adres.

Name	Type	Description
name	string	De naam voor het corresponderende adminDistrict veld, Voor adminDistrict[0], kan dit de volledige naam van de staat, zoals Washington, For adminDistrict[1], dit kan de volledige naam van de provincie zijn
shortName	string	De korte naam voor het corresponderende adminDistrict-veld, Voor adminDistrict[0], kan dit een korte naam van de staat zijn, zoals WA, For adminDistrict[1], dit kan de korte naam van de provincie zijn

AddressCountryRegion

Object

Land of regio met de naam en ISO-code.

Name	Type	Description
ISO	string	ISO van land/regio
name	string	naam van land/regio

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 met de overeenkomstcode om meer volledige informatie over de overeenkomst te bepalen.

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 opgegeven.

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 weergave bevat, kan de rangschikking op de juiste manier worden gewijzigd. Een locatiequery voor 'Parijs' retourneert bijvoorbeeld 'Parijs, Frankrijk' en 'Parijs, TX', beide met `High` vertrouwen. 'Parijs, Frankrijk' wordt altijd op de eerste plaats gezet vanwege belangrijkheid, tenzij de locatie van een gebruiker aangeeft dat de gebruiker zich in of zeer dicht bij Parijs, 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. Als de geocodeservice in dit geval zeker weet dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op `Medium` en wordt de vergelijkingscode ingesteld op `UpHierarchy` om aan te geven dat deze niet alle informatie kon matchen en in de hogere 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 locatiequery voor '148th Ave, Bellevue' kan bijvoorbeeld '148th Ave SE' en '148th Ave NE' beide met `Medium` vertrouwen retourneren. 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 er bijvoorbeeld een adres is opgegeven, maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het geocoderesultaat met een Roadblock-entiteitstype worden geretourneerd.
Low	Low

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 weergave bevat, kan de rangschikking op de juiste manier worden gewijzigd. Een locatiequery voor 'Parijs' retourneert bijvoorbeeld 'Parijs, Frankrijk' en 'Parijs, TX', beide met High vertrouwen. 'Parijs, Frankrijk' wordt altijd op de eerste plaats gezet vanwege belangrijkheid, tenzij de locatie van een gebruiker aangeeft dat de gebruiker zich in of zeer dicht bij Parijs, 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. Als de geocodeservice in dit geval zeker weet dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op Medium en wordt de vergelijkingscode ingesteld op UpHierarchy om aan te geven dat deze niet alle informatie kon matchen en in de hogere 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 locatiequery voor '148th Ave, Bellevue' kan bijvoorbeeld '148th Ave SE' en '148th Ave NE' beide met Medium vertrouwen retourneren.

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 er bijvoorbeeld een adres is opgegeven, maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het geocoderesultaat met een Roadblock-entiteitstype worden geretourneerd.

Low

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

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is FeatureCollection. Zie RFC 7946voor meer informatie.

Waarde	Description
FeatureCollection	Hiermee geeft u het `GeoJSONFeatureCollection` objecttype.

FeaturesItem

Object

Een feature-object.

Name	Type	Description
bbox	number[] (double)	Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie.
geometry	GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
id	string	Id voor geretourneerde functie
properties	FeaturesItemProperties	Eigenschappen van het kenmerk.
type	FeatureTypeEnum	Het type van een functie moet Functie zijn.

FeaturesItemProperties

Object

Eigenschappen van het kenmerk.

Name	Type	Description
address	Address	Het adres van het resultaat
confidence	ConfidenceEnum	Het betrouwbaarheidsniveau dat het geocodeerde locatieresultaat een overeenkomst is. Gebruik deze waarde met de overeenkomstcode om meer volledige informatie over de overeenkomst te bepalen. 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 opgegeven.
geocodePoints	GeocodePointsItem[]	Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik.
matchCodes	MatchCodesEnum[]	Een of meer overeenkomende codewaarden die het geocoderingsniveau vertegenwoordigen voor elke locatie in het antwoord. Een geocodeerde locatie met overeenkomende codes van `Good` en `Ambiguous` betekent bijvoorbeeld dat er meer dan één geocodelocatie is gevonden voor de locatiegegevens en dat de geocodeservice geen zoekhiërarchie heeft om een overeenkomst te vinden. Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van `Ambiguous` en `UpHierarchy` dat een geocodelocatie niet kan worden gevonden die overeenkomt met alle opgegeven locatiegegevens, dus de geocodeservice moest zoeken naar een hiërarchie en meerdere overeenkomsten op dat niveau moest vinden. Een voorbeeld van een `Ambiguous` en `UpHierarchy` resultaat is wanneer u volledige adresgegevens opgeeft, maar de geocodeservice kan geen overeenkomst vinden voor het adres en retourneert in plaats daarvan informatie voor meer dan één roadblock-waarde. Mogelijke waarden zijn: `Good`: de locatie heeft slechts één overeenkomst of alle geretourneerde overeenkomsten worden beschouwd als sterke overeenkomsten. Een query voor New York retourneert bijvoorbeeld verschillende goede overeenkomsten. `Ambiguous`: De locatie is een van een set mogelijke overeenkomsten. Wanneer u bijvoorbeeld een query uitvoert op het adres 128 Main St., kan het antwoord twee locaties retourneren voor 128 North Main St. en 128 South Main St. omdat er onvoldoende informatie is om te bepalen welke optie u moet kiezen. `UpHierarchy`: De locatie vertegenwoordigt een verplaatsing naar de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, zodat er een minder nauwkeurig resultaat wordt geretourneerd. Als een overeenkomst voor het aangevraagde adres bijvoorbeeld niet kan worden gevonden, kan er een overeenkomstcode van `UpHierarchy` met het entiteitstype RoadBlock worden geretourneerd.
type	string	Eén van: * Adres * Wegblokkade * Wegkruising * Buurt * Bewoonde Plaats * Postcode1 * AdminDivisie1 * AdminDivisie2 * LandRegio

FeatureTypeEnum

Opsomming

Het type van een functie moet Functie zijn.

Waarde	Description
Feature	Hiermee geeft u het objecttype `GeoJSON` Functie.

GeocodePointsItem

Object

Een geocodepunt.

Name	Type	Description
calculationMethod	CalculationMethodEnum	De methode die is gebruikt voor het berekenen van het geocodepunt.
geometry	GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
usageTypes	UsageTypeEnum[]	Het beste gebruik voor het geocodepunt. Elk geocodepunt wordt gedefinieerd als een `Route` punt, een `Display` punt of beide. Gebruik `Route` punten als u een route naar de locatie maakt. Gebruik `Display` punten als u de locatie op een kaart weergeeft. Als de locatie bijvoorbeeld een park is, kan een `Route` punt een ingang opgeven voor het park waar u kunt binnenkomen met een auto, en een `Display` punt kan een punt zijn dat het centrum van het park aangeeft.

GeocodingBatchRequestBody

Object

De lijst met adresgeocoderingsquery's/verzoeken die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.

Name	Type	Description
batchItems	GeocodingBatchRequestItem[]	De lijst met query's die moeten worden verwerkt.

GeocodingBatchRequestItem

Object

BatchQuery-object

Name	Type	Default value	Description
addressLine	string		De officiële straatlijn van een adres ten opzichte van het gebied, zoals gespecificeerd door de eigenschappen van de plaats of postcode. Typisch gebruik van dit element is het verstrekken van een straatadres of een officieel adres. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
adminDistrict	string		Het landonderverdelingsgedeelte van een adres, zoals WA. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
adminDistrict2	string		De provincie voor het gestructureerde adres, zoals King. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
adminDistrict3	string		Het benoemde gebied voor het gestructureerde adres. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
bbox	number[] (double)		Een rechthoekig gebied op de aarde gedefinieerd als een begrenzingsvakobject. De zijden van de rechthoeken worden bepaald door lengte- en breedtegraden. Zie Locatie- en gebiedstypen voor meer informatie. Wanneer u deze parameter opgeeft, wordt het geografische gebied in aanmerking genomen bij het berekenen van de resultaten van een locatiequery. Voorbeeld: [lon1, lat1, lon2, lat2]
coordinates	number[] (double)		Een punt op de aarde gespecificeerd als een lengte- en breedtegraad. Wanneer u deze parameter opgeeft, wordt rekening gehouden met de locatie van de gebruiker en kunnen de geretourneerde resultaten relevanter zijn voor de gebruiker. Voorbeeld: [lon, lat]
countryRegion	string		Signaal voor het geocoderingsresultaat naar een ISO 3166-1 Alpha-2 regio-/landcode die is opgegeven, bijv. FR. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
locality	string		Het lokale gedeelte van een adres, zoals Seattle. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
optionalId	string		id van het verzoek dat zou worden weergegeven in de bijbehorende batchItem
postalCode	string		Het postcodegedeelte van een adres. Deze parameter mag niet worden gebruikt wanneer de `query` parameter is opgenomen in de aanvraag.
query	string		Een tekenreeks die informatie bevat over een locatie, zoals een adres of de naam van een oriëntatiepunt.
top	integer (int32) minimum: 1 maximum: 20	5	Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 5, minimum: 1 en maximum: 20.
view	string	auto	Een tekenreeks die een ISO 3166-1 Alpha-2 regio-/landcode opgeeft. Hierdoor worden geopolitieke grenzen en labels gewijzigd zodat deze overeenkomen met de opgegeven gebruikersregio.

GeocodingBatchResponse

Object

Dit object wordt geretourneerd na een geslaagde aanroep van de Geocoding Batch-service.

Name	Type	Description
batchItems	GeocodingBatchResponseItem[]	Matrix met de batchresultaten.
nextLink	string	Dit is de koppeling naar de volgende pagina van de geretourneerde functies. Als dit de laatste pagina is, is dit veld niet mogelijk.
summary	GeocodingBatchResponseSummary	Samenvatting voor de batchaanvraag

GeocodingBatchResponseItem

Object

Een batch-responsitem.

Name	Type	Description
error	ErrorDetail	De foutdetails.
features	FeaturesItem[]	Een reeks functies kwam terug uit de query.
nextLink	string	Dit is de koppeling naar de volgende pagina van de geretourneerde functies. Als dit de laatste pagina is, is dit veld niet mogelijk.
optionalId	string	id van het batchItem dat hetzelfde zou zijn als de id in de aanvraag
type	FeatureCollectionEnum	Hiermee geeft u het `GeoJSON` type. Het enige ondersteunde objecttype is `FeatureCollection`. Zie RFC 7946voor meer informatie.

GeocodingBatchResponseSummary

Object

Samenvatting voor de batchaanvraag

Name	Type	Description
successfulRequests	integer (int32)	Aantal geslaagde aanvragen in de batch
totalRequests	integer (int32)	Totaal aantal aanvragen in de batch

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

Het adres van het resultaat.

Name	Type	Description
baseStreet	string	Primaire straat voor de locatie.
displayName	string	Volledige naam van het snijpunt.
intersectionType	string	Type snijpunt.
secondaryStreet1	string	De eerste kruising straat.
secondaryStreet2	string	Indien aanwezig, de tweede kruisingsstraat.

MatchCodesEnum

Opsomming

Een enum dat de matchcode vertegenwoordigt.

Waarde	Description
Good	Goed
Ambiguous	Dubbelzinnig
UpHierarchy	UpHierarchy

UsageTypeEnum

Opsomming

Een enum dat het gebruikstype vertegenwoordigt.

Waarde	Description
Display	Beeldscherm
Route	Route