Search - Post Search Address Batch

Referentie

Service:: Maps

API-versie:: 1.0

Gebruik dit om een batch query's naar de API te verzenden in één asynchrone aanvraag.
De Post Search Address Batch-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar API in één synchrone API-aanroep. U kunt de Batch-API van Search Address aanroepen om asynchroon (asynchroon) of synchroon (synchronisatie) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batcheren en 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 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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Asynchrone batchaanvraag verzenden

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

Hiermee kunt u resultaten ophalen in een afzonderlijke aanroep (er zijn meerdere downloads mogelijk).
De asynchrone API is geoptimaliseerd voor betrouwbaarheid en zal naar verwachting geen time-out hebben.
Het aantal batchitems is beperkt tot 10.000 voor deze API.

Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden gedurende 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:

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

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

De server reageert op een van de volgende manieren:

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 om de resultaten van de batchaanvraag te downloaden. 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 geeft een GET aanvraag uit op de download-URL verkregen in stap 3 om de batchresultaten te downloaden.

POST-hoofdtekst voor Batch-aanvraag

Als u het zoekadres query's wilt verzenden, gebruikt u een POST aanvraag waarin de hoofdtekst van de aanvraag 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 zoekadres query'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 zoekadres query in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel te. Het kan een van de ondersteunde zoekadressenURI-parametersaccepteren. De tekenreekswaarden in het zoekadres query moeten correct worden escaped (bijvoorbeeld " teken moet worden escaped met \ ) en moet ook correct url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 10.000 query's en synchronisatie-API tot 100 query's uitvoeren. De batch moet ten minste 1 query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, geeft u een GET aanvraag uit naar het eindpunt voor batchdownload. 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}

Hier volgt de gebruikelijke reeks bewerkingen voor het downloaden van de batchresultaten:

De client verzendt een GET aanvraag met behulp van de download-URL.
De server reageert op een van de volgende manieren:

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

HTTP-200 OK - Batch-aanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit 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 in batchItems bevat statusCode- en response velden. Elke response in batchItems is van 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 2 geslaagde en 1 mislukt resultaat:

{
    "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` 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 Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

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 aanvraag. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de locatieheader om de resultaten opnieuw te proberen of te openen. Kopteksten Location: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Name

Type

Description

200 OK

SearchAddressBatchProcessResult

202 Accepted

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

Kopteksten

Location: string

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is 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 aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. 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.

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 Maps Management-API.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke 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	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: query

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

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

Voorbeeldaanvraag

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"
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Statuscode:: 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 eindlocaties van het adresbereik worden opgenomen.
BatchRequest	Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
BatchRequestItem	Batch-aanvraagobject
BoundingBox	De viewport die het resultaat bedekt dat wordt weergegeven 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 omgekeerde geocodering is dit altijd gelijk aan positie.
EntryPoint	Het ingangspunt voor de POI die wordt geretourneerd.
EntryPointType	Het type toegangspunt. De waarde kan hoofd- of kleinezijn.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeographicEntityType	Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
Geometry	Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als type == Geografie.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
LatLongPairAbbreviated	Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
MatchType	Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.
OperatingHours	Openingstijden voor een POI (nuttige plaatsen).
OperatingHoursTime	Vertegenwoordigt een datum en tijd
OperatingHoursTimeRange	Tijdsbereik voor een dag openen
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, anders ErrorResponse.
SearchAddressBatchItem	Een item dat wordt geretourneerd vanuit de aanroep van de Batch-service van het zoekadres.
SearchAddressBatchProcessResult	Dit object wordt geretourneerd door een geslaagde batch-aanroep van de Search Address Batch-service.
SearchAddressResultItem	Resultaatobject voor een antwoord van de zoek-API.
SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Cross Street
SearchSummary	Samenvattingsobject voor een antwoord van de Zoek-API.
Summary	Samenvatting van de resultaten voor de batchaanvraag

Address

Object

Het adres van het resultaat

Name	Type	Description
boundingBox	BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
buildingNumber	string	Het gebouwnummer op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber.
country	string	land-/regionaam
countryCode	string	Land (Opmerking: dit is een tweeletterige code, geen land-/regionaam.)
countryCodeISO3	string	ISO-alfa-3-landcode
countrySecondarySubdivision	string	Provincie
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 administratieve hiërarchie van landen/regio's. Dit veld wordt alleen weergegeven als countrySubdivision wordt weergegeven in een verkorte vorm. Alleen ondersteund voor DE V.S., 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 vertegenwoordigt van een geografisch gebied of een locatie die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder een beheereenheid te zijn. Dit veld wordt gebruikt om de eigenschap `freeformAddress` te bouwen. `localName` vertegenwoordigt de post gemeente. Afhankelijk van de locatie is `localName` de meest bekende naam van een stad of stad. Gebruik voor de algemeen bekende naam van een stad of stad `localName` in plaats van `municipality`.
municipality	string	Plaats/stad Opmerking: `municipality` vertegenwoordigt de woonstad. 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/Super City
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/postcode
routeNumbers	string[]	De codes die worden gebruikt om de straat ondubbelzinnig te identificeren
street	string	De straatnaam. AFGESCHAFT, gebruik in plaats daarvan streetName.
streetName	string	De straatnaam.
streetNameAndNumber	string	De straatnaam en het nummer.
streetNumber	string	Het gebouwnummer op straat.

AddressRanges

Object

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

Name	Type	Description
from	LatLongPairAbbreviated	Een locatie die wordt weergegeven als 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 breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BatchRequest

Object

Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.

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

BatchRequestItem

Object

Batch-aanvraagobject

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

BoundingBox

Object

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

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

BoundingBoxCompassNotation

Object

Het begrenzingsvak van de locatie.

Name	Type	Description
entity	Entity	Bron van entiteitstype van het begrenzingsvak. Voor omgekeerde geocodering is dit altijd gelijk aan positie.
northEast	string	Noord-oost breedtegraad, lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats
southWest	string	Zuid-west breedtegraad, lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats

Brand

Object

Het merk dat is gekoppeld aan de POI

Name	Type	Description
name	string	Naam van het merk

Classification

Object

De classificatie voor de POI die wordt geretourneerd

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

ClassificationName

Object

Naam voor de classificatie

Name	Type	Description
name	string	Naameigenschap
nameLocale	string	Eigenschap Landinstelling naam

DataSources

Object

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 type == Geografie.

Entity

Inventarisatie

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

Waarde	Description
position	Positieentiteit

EntryPoint

Object

Het ingangspunt voor de POI die wordt geretourneerd.

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

EntryPointType

Inventarisatie

Het type toegangspunt. De waarde kan hoofd- of kleinezijn.

Waarde	Description
main
minor

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.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeographicEntityType

Inventarisatie

Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

Waarde	Description
Country	land-/regionaam
CountrySecondarySubdivision	Provincie
CountrySubdivision	Staat of provincie
CountryTertiarySubdivision	Benoemd gebied
Municipality	Plaats/stad
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Buurt
PostalCodeArea	Postcode/postcode

Geometry

Object

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

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

JsonFormat

Inventarisatie

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

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten

LatLongPairAbbreviated

Object

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

Name	Type	Description
lat	number (double)	De eigenschap Breedtegraad
lon	number (double)	Eigenschap Lengtegraad

MatchType

Inventarisatie

Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.

Waarde	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Openingstijden voor een POI (nuttige plaatsen).

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

OperatingHoursTime

Object

Vertegenwoordigt een datum en tijd

Name	Type	Description
date	string	Vertegenwoordigt de huidige kalenderdatum in de TIJDZONE van NUTTIGE PLAATSEN, bijvoorbeeld '2019-02-07'.
hour	integer	Uren hebben de indeling van 24 uur in de lokale tijd van een POI; mogelijke waarden zijn 0 - 23.
minute	integer	Minuten bevinden zich in de lokale tijd van een POI; mogelijke waarden zijn 0 - 59.

OperatingHoursTimeRange

Object

Tijdsbereik voor een dag openen

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 werd gesloten.
startTime	OperatingHoursTime	Het punt in de komende 7 dagen wanneer een bepaalde POI wordt geopend, of het begin van het bereik als het vóór het bereik werd geopend.

PointOfInterest

Object

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

Name	Type	Description
brands	Brand[]	Merkenmatrix. 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	Url-eigenschap van website

PointOfInterestCategorySet

Object

POI-categorie

Name	Type	Description
id	integer	Categorie-ID

QueryType

Inventarisatie

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

Waarde	Description
NEARBY	De zoekopdracht is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius
NON_NEAR	De zoekopdracht is globaal uitgevoerd, zonder een bepaalde breedtegraad en lengtegraad te vertekenen, en geen gedefinieerde radius

Response

Object

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

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

SearchAddressBatchItem

Object

Een item dat wordt geretourneerd vanuit de aanroep van de Batch-service van het zoekadres.

Name	Type	Description
response	Response	Het resultaat van de query. SearchAddressResult als de query is voltooid, anders ErrorResponse.
statusCode	integer	Http-aanvraagstatuscode.

SearchAddressBatchProcessResult

Object

Dit object wordt geretourneerd door een geslaagde batch-aanroep van de Search Address Batch-service.

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

SearchAddressResultItem

Object

Resultaatobject voor een antwoord van de zoek-API.

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 eindlocaties 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 Search Along Route-API.
dist	number (double)	Rechte lijnafstand tussen het resultaat en de locatie van geobias in meters.
entityType	GeographicEntityType	Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
entryPoints	EntryPoint[]	Matrix met toegangspunten. 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 "secundair", 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 breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
score	number (double)	De waarde in een resultatenset om de relatieve overeenkomende score tussen de resultaten aan te geven. U kunt dit gebruiken om te bepalen dat resultaat x twee keer zo waarschijnlijk relevant is als resultaat y als de waarde van x 2x de waarde van y is. De waarden variëren tussen query's en zijn alleen bedoeld als een relatieve waarde voor één resultatenset.
type	SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Cross Street
viewport	BoundingBox	De viewport die het resultaat bedekt dat wordt weergegeven door de coördinaten linksboven en rechtsonder van de viewport.

SearchAddressResultType

Inventarisatie

Een van de volgende:

POI
Straat
Geografie
Puntadres
Adresbereik
Cross Street

Waarde	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Object

Samenvattingsobject voor een antwoord van de Zoek-API.

Name	Type	Description
fuzzyLevel	integer	Het maximale fuzzy niveau dat nodig is om resultaten te leveren.
geoBias	LatLongPairAbbreviated	Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangorde van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de parameters lat en lon in te stellen, indien beschikbaar. In andere gevallen is het puur intern.
limit	integer	Maximum aantal antwoorden dat wordt geretourneerd
numResults	integer	Aantal resultaten in het antwoord.
offset	integer	De beginverschuiving van de geretourneerde resultaten in 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

Object

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

Delen via

Search - Post Search Address Batch

Synchrone batchaanvraag verzenden

Asynchrone batchaanvraag verzenden

POST-hoofdtekst voor Batch-aanvraag

Asynchrone batchresultaten downloaden

Batch-antwoordmodel

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Bereiken

subscription-key

SAS Token

Voorbeelden

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

Voorbeeldaanvraag

Voorbeeldrespons

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