Search - Get Geocoding Batch

Referentie

Service:: Maps

API-versie:: 2023-06-01

Gebruik om in één aanvraag een batch query's naar de Geocodering-API te verzenden.

De Get Geocoding Batch API is een HTTP-aanvraag POST waarmee batches van maximaal 100 query's in één aanvraag naar de geocoderings-API worden verzonden.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.

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

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de geocoderingsquery's gebruikt u een POST aanvraag waarbij 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 geocoderingsquery's:

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

Een batchItem-object voor geocodering kan een van de ondersteunde geocoderings-URI-parameters accepteren.

De batch moet ten minste één query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequests dat wil zeggen 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 die in de batchaanvraag zijn verzonden. 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 https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	Versienummer van Azure Maps-API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld 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-beheervlak Account-API. Als u Azure AD-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor richtlijnen.
Accept-Language		string	Taal waarin zoekresultaten moeten worden geretourneerd. Raadpleeg Ondersteunde talen voor meer informatie.

Name

Vereist

Type

Description

x-ms-client-id

string

Hiermee geeft u op welk account is bedoeld 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-beheervlak Account-API. Als u Azure AD-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor richtlijnen.

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	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure , kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot 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.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notitie

Voor deze beveiligingsdefinitie moet de x-ms-client-id header worden gebruikt om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.
De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met het gebruik van de Azure Maps Web SDK kan een toepassing op basis van configuraties worden ingesteld voor meerdere gebruiksscenario's.
Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.

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

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang van Azure Maps REST API's te gebruiken, waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature-token dat is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren 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=2023-06-01

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

Voorbeeldrespons

Statuscode:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "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
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
      }
    }
  ]
}

Definities

Name	Description
Address	Het adres van het resultaat
AdminDistricts	De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde volgorde in een land, afhankelijkheid of regio.
CalculationMethodEnum	De methode die is gebruikt om het geocodepunt te berekenen.
ConfidenceEnum	Het betrouwbaarheidsniveau dat het gecodeerde locatieresultaat een overeenkomst is. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is. Het vertrouwen van een gegecodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de geocoderingslocatie en de locatie van de gebruiker, indien opgegeven.
CountryRegion
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FeatureCollectionEnum	Het type van een FeatureCollection-object moet FeatureCollection zijn.
FeaturesItem
FeatureTypeEnum	Het type van een functie moet Functie zijn.
GeocodePoints	Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik ervan.
GeocodingBatchRequestBody	De lijst met adresgeocoderingsquery's/aanvragen die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste één query bevatten.
GeocodingBatchRequestItem	BatchQuery-object
GeocodingBatchResponse	Dit object wordt geretourneerd na een geslaagde Geocoding Batch-serviceoproep.
GeocodingBatchResponseItem
GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Intersection	Het adres van het resultaat.
MatchCodesEnum	Een of meer overeenkomende codewaarden die het geocoderingsniveau voor elke locatie in het antwoord vertegenwoordigen. 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 up-hierarchy heeft om een overeenkomst te vinden. Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van `Ambiguous` en `UpHierarchy` dat er geen geocodelocatie kon worden gevonden die overeenkomt met alle opgegeven locatiegegevens, dus moest de geocodeservice de hiërarchie opzoeken en meerdere overeenkomsten op dat niveau vinden. Een voorbeeld van een `Ambiguous` en `UpHierarchy` resultaat is wanneer u volledige adresgegevens opgeeft, maar de geocodeservice geen overeenkomst voor het adres kan vinden en in plaats daarvan informatie retourneert voor meer dan één RoadBlock-waarde. De 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 de 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 omhoog in de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, waardoor een minder nauwkeurig resultaat wordt geretourneerd. Als er bijvoorbeeld geen overeenkomst voor het aangevraagde adres kan worden gevonden, kan een overeenkomstcode van `UpHierarchy` met het entiteitstype RoadBlock worden geretourneerd.
Properties
Summary	Samenvatting voor de batchaanvraag
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 van het park opgeven waar u met een auto kunt binnenkomen en een `Display` punt een punt dat het midden van het park aangeeft.

Address

Het adres van het resultaat

Name	Type	Description
addressLine	string	Adresregel met straatnaam en nummer
adminDistricts	AdminDistricts[]	De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde volgorde in een land, afhankelijkheid of regio.
countryRegion	CountryRegion
formattedAddress	string	Eigenschap Opgemaakt adres
intersection	Intersection	Het adres van het resultaat.
locality	string	eigenschap locality
neighborhood	string	buurteigendom
postalCode	string	Eigenschap Postcode

AdminDistricts

De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde volgorde in een land, afhankelijkheid of regio.

Name	Type	Description
name	string	De naam voor het bijbehorende adminDistrict-veld, Voor adminDistrict[0], kan dit de volledige naam van de staat zijn, zoals Washington, For adminDistrict[1], dit kan de volledige naam van de county zijn
shortName	string	De korte naam voor het bijbehorende 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

CalculationMethodEnum

De methode die is gebruikt om het geocodepunt te berekenen.

Name	Type	Description
Interpolation	string	Het geocodepunt is gekoppeld aan een punt op een weg met behulp van interpolatie.
InterpolationOffset	string	Het geocodepunt is gekoppeld aan een punt op een weg met behulp van interpolatie met een extra verschuiving om het punt naar de kant van de straat te verplaatsen.
Parcel	string	Het geocodepunt is gekoppeld aan het midden van een pakket.
Rooftop	string	Het geocodepunt is gekoppeld aan het dak van een gebouw.

ConfidenceEnum

Het betrouwbaarheidsniveau dat het gecodeerde locatieresultaat een overeenkomst is. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is.

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

Name Type Description

High

Name	Type	Description
High	string	Als de betrouwbaarheid is ingesteld op `High`, zijn een of meer sterke overeenkomsten gevonden. Meerdere `High` betrouwbaarheidsovereenkomsten worden, indien van toepassing, gesorteerd op urgentie. Oriëntatiepunten zijn bijvoorbeeld belangrijk, maar adressen niet. Als een aanvraag 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 als eerste gerangschikt vanwege het belang, tenzij een gebruikerslocatie aangeeft dat de gebruiker zich in of zeer dicht bij Parijs, TX bevindt of de kaartweergave aangeeft dat de gebruiker in dat gebied zoekt.
Low	string
Medium	string	In sommige situaties is de geretourneerde overeenkomst mogelijk niet hetzelfde niveau als de informatie in de aanvraag. Een aanvraag kan bijvoorbeeld adresgegevens opgeven en de geocodeservice kan mogelijk alleen overeenkomen met een postcode. Als de geocodeservice er in dit geval zeker van is dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op `Medium` en wordt de overeenkomstcode ingesteld op `UpHierarchy` om aan te geven dat deze niet alle informatie kan vinden en moet worden gezocht in de hiërarchie. 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` betrouwbaarheid retourneren. Als de locatiegegevens in de query niet voldoende informatie bieden 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 wordt opgegeven, maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het resultaat van de geocode met het entiteitstype Roadblock worden geretourneerd.

string

Als de betrouwbaarheid is ingesteld op High, zijn een of meer sterke overeenkomsten gevonden. Meerdere High betrouwbaarheidsovereenkomsten worden, indien van toepassing, gesorteerd op urgentie. Oriëntatiepunten zijn bijvoorbeeld belangrijk, maar adressen niet.

Als een aanvraag 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 als eerste gerangschikt vanwege het belang, tenzij een gebruikerslocatie aangeeft dat de gebruiker zich in of zeer dicht bij Parijs, TX bevindt of de kaartweergave aangeeft dat de gebruiker in dat gebied zoekt.

Low

string

Medium

string

In sommige situaties is de geretourneerde overeenkomst mogelijk niet hetzelfde niveau als de informatie in de aanvraag. Een aanvraag kan bijvoorbeeld adresgegevens opgeven en de geocodeservice kan mogelijk alleen overeenkomen met een postcode. Als de geocodeservice er in dit geval zeker van is dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op Medium en wordt de overeenkomstcode ingesteld op UpHierarchy om aan te geven dat deze niet alle informatie kan vinden en moet worden gezocht in de hiërarchie.

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 betrouwbaarheid retourneren.

Als de locatiegegevens in de query niet voldoende informatie bieden 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 wordt opgegeven, maar er geen overeenkomst wordt gevonden voor het huisnummer, kan het resultaat van de geocode met het entiteitstype Roadblock worden geretourneerd.

CountryRegion

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

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

De foutdetails.

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

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FeatureCollectionEnum

Het type van een FeatureCollection-object moet FeatureCollection zijn.

Name	Type	Description
FeatureCollection	string

FeaturesItem

Name	Type	Description
bbox	number[]	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	Properties
type	FeatureTypeEnum	Het type van een functie moet Functie zijn.

FeatureTypeEnum

Het type van een functie moet Functie zijn.

Name	Type	Description
Feature	string

GeocodePoints

Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik ervan.

Name	Type	Description
calculationMethod	CalculationMethodEnum	De methode die is gebruikt om het geocodepunt te berekenen.
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 van het park opgeven waar u met een auto kunt binnenkomen en een `Display` punt een punt dat het midden van het park aangeeft.

GeocodingBatchRequestBody

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

Name	Type	Description
batchItems	GeocodingBatchRequestItem[]	De lijst met te verwerken query's.

GeocodingBatchRequestItem

BatchQuery-object

Name	Type	Default value	Description
addressLine	string		De officiële straatregel van een adres ten opzichte van het gebied, zoals opgegeven door de eigenschappen van de plaats, of postcode. Dit element wordt doorgaans gebruikt om een adres of een officieel adres op te geven. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
adminDistrict	string		Het onderverdelingsgedeelte van het land van een adres, zoals WA. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
adminDistrict2	string		De provincie voor het gestructureerde adres, zoals King. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
adminDistrict3	string		Het benoemde gebied voor het gestructureerde adres. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
bbox	number[]		Een rechthoekig gebied op de aarde dat is gedefinieerd als een begrenzingsvakobject. De zijden van de rechthoeken worden gedefinieerd door lengte- en breedtegraadwaarden. 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[]		Een punt op de aarde dat is opgegeven als een lengtegraad en breedtegraad. Wanneer u deze parameter opgeeft, wordt rekening gehouden met de locatie van de gebruiker en zijn de geretourneerde resultaten mogelijk relevanter voor de gebruiker. Voorbeeld: [lon, lat]
countryRegion	string		Signaal voor het geocoderingsresultaat naar een ISO 3166-1 Alpha-2-regio-/landcode die is opgegeven, bijvoorbeeld FR./ Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
locality	string		Het plaatsgedeelte van een adres, zoals Seattle. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
optionalId	string		id van de aanvraag die wordt weergegeven in de bijbehorende batchItem
postalCode	string		Het postcodegedeelte van een adres. Als de query wordt opgegeven, mag deze parameter niet worden gebruikt.
query	string		Een tekenreeks die informatie bevat over een locatie, zoals een adres of oriëntatiepuntnaam.
top	integer	5	Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 5, minimaal: 1 en maximum: 20.
view	string	auto	Een tekenreeks die een ISO 3166-1 Alpha-2-regio-/landcode aangeeft. Hierdoor worden geopolitieke betwiste grenzen en labels gewijzigd, zodat deze overeenkomen met de opgegeven gebruikersregio.

GeocodingBatchResponse

Dit object wordt geretourneerd na een geslaagde Geocoding Batch-serviceoproep.

Name	Type	Description
batchItems	GeocodingBatchResponseItem[]	Matrix met de batchresultaten.
nextLink	string	De is de koppeling naar de volgende pagina van de geretourneerde functies. Als het de laatste pagina is, geen dit veld.
summary	Summary	Samenvatting voor de batchaanvraag

GeocodingBatchResponseItem

Name	Type	Description
error	ErrorDetail	De foutdetails.
features	FeaturesItem[]
nextLink	string	De is de koppeling naar de volgende pagina van de geretourneerde functies. Als het de laatste pagina is, geen dit veld.
optionalId	string	id van de batchItem die gelijk is aan de id in de aanvraag
type	FeatureCollectionEnum	Het type van een FeatureCollection-object moet FeatureCollection zijn.

GeoJsonPoint

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

Name	Type	Description
bbox	number[]	Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie.
coordinates	number[]	A `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 op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Intersection

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 kruisende straat.
secondaryStreet2	string	Indien van toepassing, de tweede kruisende straat.

MatchCodesEnum

Een of meer overeenkomende codewaarden die het geocoderingsniveau voor elke locatie in het antwoord vertegenwoordigen.

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 up-hierarchy heeft om een overeenkomst te vinden.

Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van Ambiguous en UpHierarchy dat er geen geocodelocatie kon worden gevonden die overeenkomt met alle opgegeven locatiegegevens, dus moest de geocodeservice de hiërarchie opzoeken en meerdere overeenkomsten op dat niveau vinden. Een voorbeeld van een Ambiguous en UpHierarchy resultaat is wanneer u volledige adresgegevens opgeeft, maar de geocodeservice geen overeenkomst voor het adres kan vinden en in plaats daarvan informatie retourneert voor meer dan één RoadBlock-waarde.

De 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 de 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 omhoog in de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, waardoor een minder nauwkeurig resultaat wordt geretourneerd. Als er bijvoorbeeld geen overeenkomst voor het aangevraagde adres kan worden gevonden, kan een overeenkomstcode van UpHierarchy met het entiteitstype RoadBlock worden geretourneerd.

Name	Type	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Name	Type	Description
address	Address	Het adres van het resultaat
confidence	ConfidenceEnum	Het betrouwbaarheidsniveau dat het resultaat van de gegecodeerde locatie overeenkomt. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is. Het vertrouwen van een gegecodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de gegecodeerde locatie en de locatie van de gebruiker, indien opgegeven.
geocodePoints	GeocodePoints[]	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 voor elke locatie in het antwoord vertegenwoordigen. Een geocodeerde locatie met overeenkomende codes van `Good` en `Ambiguous` betekent bijvoorbeeld dat er meer dan één geocodelocatie is gevonden voor de locatie-informatie 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 er geen geocodelocatie kon worden gevonden die overeenkomt met alle opgegeven locatiegegevens. Daarom moest de geocodeservice de hiërarchie opzoeken en meerdere overeenkomsten op dat niveau vinden. Een voorbeeld van een `Ambiguous` en `UpHierarchy` resultaat is wanneer u volledige adresgegevens opgeeft, maar de geocodeservice geen overeenkomst voor het adres kan vinden en in plaats daarvan informatie retourneert voor meer dan één RoadBlock-waarde. De 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 de 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 omhoog in de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, waardoor een minder nauwkeurig resultaat wordt geretourneerd. Als er bijvoorbeeld geen overeenkomst voor het aangevraagde adres kan worden gevonden, kan een overeenkomstcode van `UpHierarchy` met het entiteitstype RoadBlock worden geretourneerd.
type	string	Een van de volgende: Adres Wegversperring RoadIntersection Buurt PopulatedPlace Postcode1 AdminDivision1 AdminDivision2 CountryRegion

Summary

Samenvatting voor de batchaanvraag

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

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 van het park opgeven waar u met een auto kunt binnenkomen en een Display punt een punt dat het midden van het park aangeeft.

Name	Type	Description
Display	string
Route	string

Delen via

Search - Get Geocoding Batch

Synchrone batchaanvraag verzenden

POST-hoofdtekst voor Batch-aanvraag

Batch-antwoordmodel

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Bereiken

subscription-key

SAS Token

Voorbeelden

A Geocoding Batch API call containing 2 Geocoding queries

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

Aanvullende resources