Search - Post Search Address Batch

Referentie

Service:: Maps

API Version:: 1.0

Gebruik om een batch query's te verzenden naar de Search Address-API in één asynchrone aanvraag.
De Post Search Address Batch API is een HTTP-aanvraag POST waarmee batches query's worden verzonden naar Search Adres-API in één synchrone API-aanroep. U kunt Search Adresbatch-API aanroepen om asynchroon (asynchroon) of synchroon (synchronisatie) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en de API synchroniseren tot 100 query's.

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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Asynchrone batchaanvraag indienen

De asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe zoekaanvragen

Hiermee kunnen resultaten in een afzonderlijke aanroep worden opgehaald (meerdere downloads zijn mogelijk).
De asynchrone API is geoptimaliseerd voor betrouwbaarheid en er wordt geen time-out verwacht.
Het aantal batch-items is beperkt tot 10.000 voor deze API.

Wanneer u een aanvraag doet met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode samen met een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat een asynchrone batchaanvraag een langdurige bewerking is. Hier volgt een typische reeks bewerkingen:

Client verzendt een Search Address Batch-aanvraag POST naar Azure Maps.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

De server reageert met een van de volgende opties:

HTTP 202 Accepted - Batch-aanvraag is geaccepteerd.

HTTP Error : er is een fout opgetreden bij het verwerken van uw Batch-aanvraag. Dit kan een 400 Bad Request of een andere Error statuscode zijn.
Als de batchaanvraag is geaccepteerd, bevat de Location header in het antwoord de URL voor het downloaden van de resultaten van de batchaanvraag. Deze status-URI ziet er als volgt uit:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Client verzendt een GET aanvraag op de download-URL die is verkregen in stap 3 om de batchresultaten te downloaden.

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de zoekadresquery'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 5 zoekadresquery's :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Een zoekadresquery in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel. Het kan elk van de ondersteunde URI-parametersvoor zoekadressen accepteren. De tekenreekswaarden in de zoekadresquery moeten op de juiste manier worden ge escaped (bijvoorbeeld " teken moet worden ge escaped met \ ) en moeten ook correct zijn gecodeerd met URL's.

Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en de API synchroniseren tot 100 query's. De batch moet ten minste één query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, verzendt u een GET aanvraag naar het eindpunt voor het downloaden van de batch. Deze download-URL kan worden verkregen uit de Location header van een geslaagde POST batchaanvraag en ziet er als volgt uit:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Dit is de gebruikelijke volgorde van bewerkingen voor het downloaden van de batchresultaten:

Client verzendt een GET aanvraag met behulp van de download-URL.
De server reageert met een van de volgende opties:

HTTP 202 Accepted - Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over een tijdje opnieuw.

HTTP 200 OK - Batch-aanvraag is verwerkt. De antwoordtekst bevat alle batchresultaten.

Batch-antwoordmodel

De inhoud van de geretourneerde gegevens is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynchrone batchaanvraag downloadt en de batch is verwerkt, bevat de hoofdtekst van het antwoord de batchreactie. Dit batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequestsdat wil zeggen query's die met succes 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 in batchItems bevat statusCode en response velden. Elk response in batchItems heeft een van de volgende typen:

SearchAddressResult - Als de query is voltooid.
Error - Als de query is mislukt. Het antwoord bevat in dit geval een code en een message .

Hier volgt een voorbeeld van een Batch-antwoord met het resultaat 2 geslaagd en 1 mislukt :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
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 Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

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

Antwoorden

Name	Type	Description
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de locatieheader om het opnieuw te proberen of de resultaten te openen. Headers Location: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Name

Type

Description

200 OK

SearchAddressBatchProcessResult

202 Accepted

Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de locatieheader om het opnieuw te proberen of de resultaten te openen.

Headers

Location: string

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met 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 resourceaccount 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

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 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.
Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere use cases.
Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de 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 zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access signature-token dat wordt 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

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Sample Request

HTTP

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Status code:: 202

Operation-Location: URL to download the results of the long-running batch request.

Definities

Name	Description
Address	Het adres van het resultaat
AddressRanges	Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.
BatchRequest	Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
BatchRequestItem	Batchaanvraagobject
BoundingBox	De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.
BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
Brand	Het merk dat is gekoppeld aan de POI
Classification	De classificatie voor de POI die wordt geretourneerd
ClassificationName	Naam voor de classificatie
DataSources	Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon-API.
Entity	Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
EntryPoint	Het toegangspunt voor de POI die wordt geretourneerd.
EntryPointType	Het type toegangspunt. De waarde kan main of minor zijn.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeographicEntityType	Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
Geometry	Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
MatchType	Typen overeenkomsten voor een omgekeerde adreszoekbewerking.
OperatingHours	Openingstijden voor een POI (Nuttige plaatsen).
OperatingHoursTime	Vertegenwoordigt een datum en tijd
OperatingHoursTimeRange	Open tijdsbereik voor een dag
PointOfInterest	Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.
PointOfInterestCategorySet	POI-categorie
QueryType	Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.
Response	Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders.
SearchAddressBatchItem	Een item dat is geretourneerd door Search Adres Batch-serviceaanroep.
SearchAddressBatchProcessResult	Dit object wordt geretourneerd na een geslaagde Search Adres Batch-serviceoproep.
SearchAddressResultItem	Resultaatobject voor een Search API-antwoord.
SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Kruisstraat
SearchSummary	Samenvattingsobject voor een Search API-antwoord.
Summary	Samenvatting van de resultaten voor de batchaanvraag

Address

Het adres van het resultaat

Name	Type	Description
boundingBox	BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
buildingNumber	string	Het nummer van het gebouw op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber.
country	string	land/regionaam
countryCode	string	Land (opmerking: dit is een code van twee letters, geen land-/regionaam.)
countryCodeISO3	string	ISO alfa-3-landcode
countrySecondarySubdivision	string	Graafschap
countrySubdivision	string	Staat of provincie
countrySubdivisionCode	string	`countrySubdivisionCode` voorafgegaan door `countryCode` ( countryCode-countrySubdivisionCode ) en het afbreekstreepje vormt de ISO 3166-2-code. Voorbeelden: TX voor Texas, SCT voor Schotland en ON voor Ontario.
countrySubdivisionName	string	De volledige naam van een eerste niveau van de land-/regiobeheerhiërarchie. Dit veld wordt alleen weergegeven als countrySubdivision in een verkorte vorm wordt weergegeven. Alleen ondersteund voor de VS, Canada en het Verenigd Koninkrijk.
countryTertiarySubdivision	string	Benoemd gebied
crossStreet	string	De naam van de straat die wordt gekruist.
extendedPostalCode	string	Uitgebreide postcode (beschikbaarheid is afhankelijk van de regio).
freeformAddress	string	Een adresregel die is opgemaakt volgens de opmaakregels van het land/de regio van herkomst van een resultaat, of, in het geval van een land/regio, de volledige land-/regionaam.
localName	string	Een adresonderdeel dat de naam van een geografisch gebied of een plaats vertegenwoordigt die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder dat het een beheereenheid is. Dit veld wordt gebruikt om de `freeformAddress` eigenschap te bouwen. `localName` vertegenwoordigt de post gemeente. Afhankelijk van de locatie is `localName` de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van een stad of stad gebruikt `localName` u in plaats van `municipality`.
municipality	string	Plaats /plaats Opmerking: `municipality` vertegenwoordigt de woongemeente. Afhankelijk van de locatie kan de `municipality` waarde afwijken van de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van de stad of stad wordt voorgesteld dat de `localName` waarde wordt gebruikt in plaats van de `municipality` waarde.
municipalitySubdivision	string	Sub-/superstad
neighbourhood	string	Een Wijk is een geografisch gelokaliseerd gebied binnen een stad of stad met onderscheidende kenmerken en sociale interacties tussen inwoners.
postalCode	string	Postcode
routeNumbers	string[]	De codes die worden gebruikt om de straat ondubbelzinnig te identificeren
street	string	De straatnaam. AFGESCHAFT, gebruikt u in plaats daarvan streetName.
streetName	string	De straatnaam.
streetNameAndNumber	string	De straatnaam en het nummer.
streetNumber	string	Het nummer van het gebouw op straat.

AddressRanges

Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.

Name	Type	Description
from	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
rangeLeft	string	Adresbereik aan de linkerkant van de straat.
rangeRight	string	Adresbereik aan de rechterkant van de straat.
to	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BatchRequest

Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.

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

BatchRequestItem

Batchaanvraagobject

Name	Type	Description
query	string	Deze parameter bevat een queryreeks die wordt gebruikt om een ongestructureerde geocoderingsbewerking uit te voeren. De queryreeks wordt exacte bewoordingen doorgegeven aan de zoek-API voor verwerking.

BoundingBox

De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.

Name	Type	Description
btmRightPoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Name	Type	Description
entity	Entity	Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
northEast	string	Noord-oosten breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters
southWest	string	Zuidwestelijke breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters

Brand

Het merk dat is gekoppeld aan de POI

Name	Type	Description
name	string	Naam van het merk

Classification

De classificatie voor de POI die wordt geretourneerd

Name	Type	Description
code	string	Code-eigenschap
names	ClassificationName[]	Namenmatrix

ClassificationName

Naam voor de classificatie

Name	Type	Description
name	string	Naameigenschap
nameLocale	string	Naamlandinstelling eigenschap

DataSources

Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon-API.

Name	Type	Description
geometry	Geometry	Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.

Entity

Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.

Name	Type	Description
position	string	Positie-entiteit

EntryPoint

Het toegangspunt voor de POI die wordt geretourneerd.

Name	Type	Description
position	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
type	EntryPointType	Het type toegangspunt. De waarde kan main of minor zijn.

EntryPointType

Het type toegangspunt. De waarde kan main of minor zijn.

Name	Type	Description
main	string
minor	string

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[]	De fout aanvullende informatie.
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.

GeographicEntityType

Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

Name	Type	Description
Country	string	land/regionaam
CountrySecondarySubdivision	string	Graafschap
CountrySubdivision	string	Staat of provincie
CountryTertiarySubdivision	string	Benoemd gebied
Municipality	string	Plaats /plaats
MunicipalitySubdivision	string	Sub-/superstad
Neighbourhood	string	Buurt
PostalCodeArea	string	Postcode

Geometry

Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.

Name	Type	Description
id	string	Geef deze door als geometryId aan de API Get Search Polygon om geometriegegevens voor dit resultaat op te halen.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name	Type	Description
lat	number	De eigenschap Breedtegraad
lon	number	De eigenschap Lengtegraad

MatchType

Typen overeenkomsten voor een omgekeerde adreszoekbewerking.

Name	Type	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Openingstijden voor een POI (Nuttige plaatsen).

Name	Type	Description
mode	string	Waarde die in de aanvraag wordt gebruikt: none of 'nextSevenDays'
timeRanges	OperatingHoursTimeRange[]	Lijst met tijdsbereiken voor de komende 7 dagen

OperatingHoursTime

Vertegenwoordigt een datum en tijd

Name	Type	Description
date	string	Vertegenwoordigt de huidige kalenderdatum in poi-tijdzone, bijvoorbeeld "2019-02-07".
hour	integer	Uren zijn in de 24-uursnotatie in de lokale tijd van een POI; mogelijke waarden zijn 0 - 23.
minute	integer	De minuten bevinden zich in de lokale tijd van een POI; mogelijke waarden zijn 0 - 59.

OperatingHoursTimeRange

Open tijdsbereik voor een dag

Name	Type	Description
endTime	OperatingHoursTime	Het punt in de komende 7 dagen wanneer een bepaalde POI wordt gesloten, of het begin van het bereik als het vóór het bereik gesloten was.
startTime	OperatingHoursTime	Het punt in de komende 7 dagen waarop een bepaalde POI wordt geopend, of het begin van het bereik als het vóór het bereik werd geopend.

PointOfInterest

Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.

Name	Type	Description
brands	Brand[]	Merken matrix. De naam van het merk voor de POI die wordt geretourneerd.
categories	string[]	Categorieënmatrix
categorySet	PointOfInterestCategorySet[]	De lijst met de meest specifieke POI-categorieën
classifications	Classification[]	Classificatiematrix
name	string	Naam van de eigenschap POI
openingHours	OperatingHours	Openingstijden voor een POI (Nuttige plaatsen).
phone	string	Eigenschap Telefoonnummer
url	string	Website-URL-eigenschap

PointOfInterestCategorySet

POI-categorie

Name	Type	Description
id	integer	Categorie-id

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Name	Type	Description
NEARBY	string	Search is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius
NON_NEAR	string	Search is wereldwijd uitgevoerd, zonder bevooroordeeld te zijn naar een bepaalde breedte- en lengtegraad, en geen gedefinieerde radius

Response

Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders.

Name	Type	Description
error	ErrorDetail	Het foutobject.
results	SearchAddressResultItem[]	Een lijst met Search API-resultaten.
summary	SearchSummary	Samenvattingsobject voor een Search API-antwoord

SearchAddressBatchItem

Een item dat is geretourneerd door Search Adres Batch-serviceaanroep.

Name	Type	Description
response	Response	Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders.
statusCode	integer	Statuscode van HTTP-aanvraag.

SearchAddressBatchProcessResult

Dit object wordt geretourneerd na een geslaagde Search Adres Batch-serviceoproep.

Name	Type	Description
batchItems	SearchAddressBatchItem[]	Matrix met de batchresultaten.
summary	Summary	Samenvatting van de resultaten voor de batchaanvraag

SearchAddressResultItem

Resultaatobject voor een Search API-antwoord.

Name	Type	Description
address	Address	Het adres van het resultaat
addressRanges	AddressRanges	Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.
dataSources	DataSources	Optionele sectie. Referentiegeometrie-id voor gebruik met de Get Search Polygon-API.
detourTime	integer	Omleidingstijd in seconden. Alleen geretourneerd voor aanroepen naar de API Search Langs route.
dist	number	Rechte lijnafstand tussen het resultaat en de geobias-locatie in meters.
entityType	GeographicEntityType	Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
entryPoints	EntryPoint[]	Matrix van entrypoints. Deze beschrijven de soorten ingangen die beschikbaar zijn op de locatie. Het type kan 'hoofd' zijn voor hoofdingangen zoals een voordeur, of een lobby, en 'minor' voor zij- en achterdeuren.
id	string	Id-eigenschap
info	string	Informatie over de oorspronkelijke gegevensbron van het resultaat. Wordt gebruikt voor ondersteuningsaanvragen.
matchType	MatchType	Informatie over het type overeenkomst. Een van de volgende: AddressPoint HouseNumberRange Straat
poi	PointOfInterest	Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.
position	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
score	number	De waarde binnen een resultatenset om de relatieve overeenkomende score tussen resultaten aan te geven. U kunt dit gebruiken om te bepalen dat resultaat x twee keer zo relevant is als resultaat y als de waarde van x 2x de waarde van y is. De waarden variëren per query en zijn alleen bedoeld als een relatieve waarde voor één resultatenset.
type	SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Kruisstraat
viewport	BoundingBox	De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.

SearchAddressResultType

Een van de volgende:

POI
Straat
Geografie
Puntadres
Adresbereik
Kruisstraat

Name	Type	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Samenvattingsobject voor een Search API-antwoord.

Name	Type	Description
fuzzyLevel	integer	Het maximale fuzzy-niveau dat is vereist om resultaten op te geven.
geoBias	LatLongPairAbbreviated	Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangschikking van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de lat- en lon-parameters in te stellen, indien beschikbaar. In andere gevallen is het puur intern.
limit	integer	Maximum aantal antwoorden dat wordt geretourneerd
numResults	integer	Het aantal resultaten in het antwoord.
offset	integer	De begin offset van de geretourneerde Resultaten binnen de volledige resultatenset.
query	string	De queryparameter die is gebruikt om deze zoekresultaten te produceren.
queryTime	integer	Tijd die is besteed aan het oplossen van de query, in milliseconden.
queryType	QueryType	Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.
totalResults	integer	Het totale aantal gevonden resultaten.

Summary

Samenvatting van de resultaten voor de batchaanvraag

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

Search - Post Search Address Batch

Synchrone batchaanvraag verzenden

Asynchrone batchaanvraag indienen

POST-hoofdtekst voor Batch-aanvraag

Asynchrone batchresultaten downloaden

Batch-antwoordmodel

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Scopes

subscription-key

SAS Token

Voorbeelden

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Sample Request

Sample Response

Definities

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Aanvullende resources