Search - Get Geocoding Batch

Referens

Tjänst:: Maps

API-version:: 2023-06-01

Använd för att skicka en batch med frågor till geokodnings-API :et i en enda begäran.

API:et Get Geocoding Batch är en HTTP-begäran POST som skickar batchar med upp till 100 frågor till geokodnings-API :et i en enda begäran.

Skicka synkron Batch-begäran

Det synkrona API:et rekommenderas för förenklade batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten beräknas och det finns ingen möjlighet att hämta resultaten senare. Det synkrona API:et returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

POST-brödtext för Batch-begäran

Om du vill skicka geokodningsfrågorna använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type rubriken anges till application/json. Här är ett exempel på en begärandetext som innehåller 2 geokodningsfrågor :

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

Ett batchItem-geokodningsobjekt kan acceptera någon av de geokodnings-URI-parametrar som stöds.

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som var en del av den ursprungliga batchbegäran, dvs successfulRequests . frågor som har körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

GeocodingResponse – Om frågan har slutförts.
Error – Om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Azure AD-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Azure AD-säkerhet i Azure Maps finns i följande artiklar .
Accept-Language		string	Språk där sökresultat ska returneras. Mer information finns i Språk som stöds .

Name

Obligatorisk

Typ

Description

x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Azure AD-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Azure AD-säkerhet i Azure Maps finns i följande artiklar .

Accept-Language

string

Språk där sökresultat ska returneras.

Mer information finns i Språk som stöds .

Begärandetext

Name	Typ	Description
batchItems	GeocodingBatchRequestItem[]	Listan över frågor som ska bearbetas.

Svar

Name	Typ	Description
200 OK	GeocodingBatchResponse	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anteckning

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.
Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer.
Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Användning av Webb-SDK för Azure Maps möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst till Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

A Geocoding Batch API call containing 2 Geocoding queries

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
Address	Resultatets adress
AdminDistricts	Indelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens indelning i ett land, beroende eller en region.
CalculationMethodEnum	Den metod som användes för att beräkna geokodpunkten.
ConfidenceEnum	Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om det anges.
CountryRegion
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FeatureCollectionEnum	Typen av ett FeatureCollection-objekt måste vara FeatureCollection.
FeaturesItem
FeatureTypeEnum	Typen av funktion måste vara Funktion.
GeocodePoints	En samling geokodningspunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning.
GeocodingBatchRequestBody	Listan över adresser med geokodningsfrågor/begäranden som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga.
GeocodingBatchRequestItem	Batch Query-objekt
GeocodingBatchResponse	Det här objektet returneras från ett lyckat Batch-tjänstanrop för geokodning.
GeocodingBatchResponseItem
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
Intersection	Resultatets adress.
MatchCodesEnum	Ett eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret. Till exempel innebär en geokodad plats med matchningskoder `Good` och `Ambiguous` att mer än en geokodsplats hittades för platsinformationen och att geokodtjänsten inte hade någon sökning uppåt-hierarki för att hitta en matchning. På samma sätt innebär en geokodad plats med matchningskoder `Ambiguous` och `UpHierarchy` att det inte gick att hitta en geokodplats som matchade all angiven platsinformation, så geokodtjänsten var tvungen att söka i upphierarkin och hitta flera matchningar på den nivån. Ett exempel på ett `Ambiguous` och-resultat `UpHierarchy` är när du anger fullständig adressinformation, men geokodstjänsten inte kan hitta en matchning för gatuadressen och i stället returnerar information för mer än ett RoadBlock-värde. Möjliga värden är: `Good`: Platsen har bara en matchning, eller så betraktas alla returnerade matcher som starka matchningar. En fråga för New York returnerar till exempel flera bra matchningar. `Ambiguous`: Platsen är en av en uppsättning möjliga matchningar. När du till exempel frågar efter gatuadressen 128 Main St., kan svaret returnera två platser för 128 North Main St. och 128 South Main St. eftersom det inte finns tillräckligt med information för att avgöra vilket alternativ som ska väljas. `UpHierarchy`: Platsen representerar en flyttning uppåt i den geografiska hierarkin. Detta inträffar när en matchning för platsbegäran inte hittades, så ett mindre exakt resultat returneras. Om det till exempel inte går att hitta en matchning för den begärda adressen kan en matchningskod `UpHierarchy` för med en RoadBlock-entitetstyp returneras.
Properties
Summary	Sammanfattning för batchbegäran
UsageTypeEnum	Den bästa användningen för geokodpunkten. Varje geokodpunkt definieras som en `Route` punkt, en `Display` punkt eller båda. Använd `Route` punkter om du skapar en väg till platsen. Använd `Display` punkter om du visar platsen på en karta. Om platsen till exempel är en park kan en `Route` punkt ange en entré till parken där du kan komma in med en bil, och en `Display` punkt kan vara en punkt som anger mitten av parken.

Address

Resultatets adress

Name	Typ	Description
addressLine	string	AddressLine som innehåller gatunamn och nummer
adminDistricts	AdminDistricts[]	Indelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens indelning i ett land, beroende eller en region.
countryRegion	CountryRegion
formattedAddress	string	Egenskapen Formaterad adress
intersection	Intersection	Resultatets adress.
locality	string	locality-egenskap
neighborhood	string	grannskapsegenskap
postalCode	string	Postnummeregenskap

AdminDistricts

Indelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens indelning i ett land, beroende eller en region.

Name	Typ	Description
name	string	Namnet på motsvarande adminDistrict-fält, För adminDistrict[0], kan detta vara det fullständiga namnet på delstaten, till exempel Washington, For adminDistrict[1], detta kan vara det fullständiga namnet på länet
shortName	string	Det korta namnet för motsvarande adminDistrict-fält, För adminDistrict[0], kan detta vara ett kort namn på tillståndet, till exempel WA, For adminDistrict[1], detta kan vara det korta namnet på länet

CalculationMethodEnum

Den metod som användes för att beräkna geokodpunkten.

Name	Typ	Description
Interpolation	string	Geokodpunkten matchades till en punkt på en väg med hjälp av interpolering.
InterpolationOffset	string	Geokodpunkten matchades till en punkt på en väg med hjälp av interpolering med ytterligare en förskjutning för att flytta punkten till sidan av gatan.
Parcel	string	Geokodpunkten matchades till mitten av ett paket.
Rooftop	string	Geokodpunkten matchades mot taket på en byggnad.

ConfidenceEnum

Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen.

Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om det anges.

Name Typ Description

High

Name	Typ	Description
High	string	Om konfidensen är inställd på `High`hittades en eller flera starka matchningar. Flera konfidensmatchningar `High` sorteras i rangordnad ordning efter prioritet när det är tillämpligt. Landmärken har till exempel betydelse men adresser har inte det. Om en begäran innehåller en plats eller en vy kan rangordningen ändras på lämpligt sätt. En platsfråga för "Paris" returnerar till exempel "Paris, Frankrike" och "Paris, TX" båda med `High` konfidens. "Paris, Frankrike" rankas alltid först på grund av betydelse om inte en användarplats anger att användaren befinner sig i eller mycket nära Paris, TX eller kartvyn anger att användaren söker i det området.
Low	string
Medium	string	I vissa situationer kanske den returnerade matchningen inte är på samma nivå som informationen i begäran. En begäran kan till exempel ange adressinformation och geokodstjänsten kanske bara kan matcha ett postnummer. I det här fallet, om geokodtjänsten har förtroende för att postnumret matchar data, är konfidensen inställd på `Medium` och matchningskoden är inställd `UpHierarchy` på att ange att den inte kunde matcha all information och var tvungen att söka upp-hierarkin. Om platsinformationen i frågan är tvetydig och det inte finns någon ytterligare information för att rangordna platserna (till exempel användarplats eller platsens relativa betydelse) anges konfidensen till `Medium`. En platsfråga för "148th Ave, Bellevue" kan till exempel returnera "148th Ave SE" och "148th Ave NE" båda med `Medium` konfidens. Om platsinformationen i frågan inte ger tillräckligt med information för att geokoda en specifik plats kan ett mindre exakt platsvärde returneras och konfidensen anges till `Medium`. Om en adress till exempel anges, men ingen matchning hittas för husnumret, kan geokodresultatet med en vägblocksentitetstyp returneras.

string

Om konfidensen är inställd på Highhittades en eller flera starka matchningar. Flera konfidensmatchningar High sorteras i rangordnad ordning efter prioritet när det är tillämpligt. Landmärken har till exempel betydelse men adresser har inte det.

Om en begäran innehåller en plats eller en vy kan rangordningen ändras på lämpligt sätt. En platsfråga för "Paris" returnerar till exempel "Paris, Frankrike" och "Paris, TX" båda med High konfidens. "Paris, Frankrike" rankas alltid först på grund av betydelse om inte en användarplats anger att användaren befinner sig i eller mycket nära Paris, TX eller kartvyn anger att användaren söker i det området.

Low

string

Medium

string

I vissa situationer kanske den returnerade matchningen inte är på samma nivå som informationen i begäran. En begäran kan till exempel ange adressinformation och geokodstjänsten kanske bara kan matcha ett postnummer. I det här fallet, om geokodtjänsten har förtroende för att postnumret matchar data, är konfidensen inställd på Medium och matchningskoden är inställd UpHierarchy på att ange att den inte kunde matcha all information och var tvungen att söka upp-hierarkin.

Om platsinformationen i frågan är tvetydig och det inte finns någon ytterligare information för att rangordna platserna (till exempel användarplats eller platsens relativa betydelse) anges konfidensen till Medium. En platsfråga för "148th Ave, Bellevue" kan till exempel returnera "148th Ave SE" och "148th Ave NE" båda med Medium konfidens.

Om platsinformationen i frågan inte ger tillräckligt med information för att geokoda en specifik plats kan ett mindre exakt platsvärde returneras och konfidensen anges till Medium. Om en adress till exempel anges, men ingen matchning hittas för husnumret, kan geokodresultatet med en vägblocksentitetstyp returneras.

CountryRegion

Name	Typ	Description
ISO	string	ISO för land/region
name	string	namn på land/region

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FeatureCollectionEnum

Typen av ett FeatureCollection-objekt måste vara FeatureCollection.

Name	Typ	Description
FeatureCollection	string

FeaturesItem

Name	Typ	Description
bbox	number[]	Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946 .
geometry	GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
id	string	ID för funktionen returneras
properties	Properties
type	FeatureTypeEnum	Typen av funktion måste vara Funktion.

FeatureTypeEnum

Typen av funktion måste vara Funktion.

Name	Typ	Description
Feature	string

GeocodePoints

En samling geokodningspunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning.

Name	Typ	Description
calculationMethod	CalculationMethodEnum	Den metod som användes för att beräkna geokodpunkten.
geometry	GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
usageTypes	UsageTypeEnum[]	Den bästa användningen för geokodpunkten. Varje geokodpunkt definieras som en `Route` punkt, en `Display` punkt eller båda. Använd `Route` punkter om du skapar en väg till platsen. Använd `Display` punkter om du visar platsen på en karta. Om platsen till exempel är en park kan en `Route` punkt ange en entré till parken där du kan komma in med en bil, och en `Display` punkt kan vara en punkt som anger mitten av parken.

GeocodingBatchRequestBody

Listan över adresser med geokodningsfrågor/begäranden som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga.

Name	Typ	Description
batchItems	GeocodingBatchRequestItem[]	Listan över frågor som ska bearbetas.

GeocodingBatchRequestItem

Batch Query-objekt

Name	Typ	Standardvärde	Description
addressLine	string		Den officiella gaturaden för en adress i förhållande till området, enligt vad som anges av egenskaperna locality eller postalCode. Typisk användning av det här elementet är att ange en gatuadress eller en officiell adress. Om frågan anges bör du inte använda den här parametern.
adminDistrict	string		Landets del av indelningen av en adress, till exempel WA. Om frågan anges bör du inte använda den här parametern.
adminDistrict2	string		Länet för den strukturerade adressen, till exempel King. Om frågan anges bör du inte använda den här parametern.
adminDistrict3	string		Det namngivna området för den strukturerade adressen. Om frågan anges bör du inte använda den här parametern.
bbox	number[]		Ett rektangulärt område på jorden definierat som ett avgränsningsfältsobjekt. Rektanglarnas sidor definieras av longitud- och latitudvärden. Mer information finns i Plats- och områdestyper. När du anger den här parametern beaktas det geografiska området när du beräknar resultatet av en platsfråga. Exempel: [lon1, lat1, lon2, lat2]
coordinates	number[]		En punkt på jorden som anges som longitud och latitud. När du anger den här parametern beaktas användarens plats och de resultat som returneras kan vara mer relevanta för användaren. Exempel: [lon, lat]
countryRegion	string		Signal för geokodningsresultatet till en ISO 3166-1 Alpha-2-region/landskod som anges, t.ex. FR./ Om frågan anges bör du inte använda den här parametern.
locality	string		Lokalitetsdelen av en adress, till exempel Seattle. Om frågan anges bör du inte använda den här parametern.
optionalId	string		ID för begäran som visas i motsvarande batchItem
postalCode	string		Postnummerdelen av en adress. Om frågan anges bör du inte använda den här parametern.
query	string		En sträng som innehåller information om en plats, till exempel en adress eller ett landmärkesnamn.
top	integer	5	Maximalt antal svar som ska returneras. Standard: 5, minimum: 1 och maximum: 20.
view	string	auto	En sträng som anger en ISO 3166-1 Alpha-2-region/landskod. Detta ändrar geopolitiska omtvistade kantlinjer och etiketter så att de överensstämmer med den angivna användarregionen.

GeocodingBatchResponse

Det här objektet returneras från ett lyckat Batch-tjänstanrop för geokodning.

Name	Typ	Description
batchItems	GeocodingBatchResponseItem[]	Matris som innehåller batchresultatet.
nextLink	string	är länken till nästa sida i de funktioner som returneras. Om det är den sista sidan, nej det här fältet.
summary	Summary	Sammanfattning för batchbegäran

GeocodingBatchResponseItem

Name	Typ	Description
error	ErrorDetail	Felinformationen.
features	FeaturesItem[]
nextLink	string	är länken till nästa sida i de funktioner som returneras. Om det är den sista sidan, nej det här fältet.
optionalId	string	id för batchItem som skulle vara samma som ID:t i begäran
type	FeatureCollectionEnum	Typen av ett FeatureCollection-objekt måste vara FeatureCollection.

GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
bbox	number[]	Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946 .
coordinates	number[]	A `Position` är en matris med tal med två eller flera element. De två första elementen är longitud och latitud, exakt i den ordningen. Höjd/höjd är ett valfritt tredje element. Mer information finns i RFC 7946 .
type	string: Point	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Intersection

Resultatets adress.

Name	Typ	Description
baseStreet	string	Primär gata för platsen.
displayName	string	Fullständigt namn på skärningspunkten.
intersectionType	string	Typ av skärningspunkt.
secondaryStreet1	string	Den första korsar gatan.
secondaryStreet2	string	Om någon, den andra korsar gatan.

MatchCodesEnum

Ett eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret.

Till exempel innebär en geokodad plats med matchningskoder Good och Ambiguous att mer än en geokodsplats hittades för platsinformationen och att geokodtjänsten inte hade någon sökning uppåt-hierarki för att hitta en matchning.

På samma sätt innebär en geokodad plats med matchningskoder Ambiguous och UpHierarchy att det inte gick att hitta en geokodplats som matchade all angiven platsinformation, så geokodtjänsten var tvungen att söka i upphierarkin och hitta flera matchningar på den nivån. Ett exempel på ett Ambiguous och-resultat UpHierarchy är när du anger fullständig adressinformation, men geokodstjänsten inte kan hitta en matchning för gatuadressen och i stället returnerar information för mer än ett RoadBlock-värde.

Möjliga värden är:

Good: Platsen har bara en matchning, eller så betraktas alla returnerade matcher som starka matchningar. En fråga för New York returnerar till exempel flera bra matchningar.

Ambiguous: Platsen är en av en uppsättning möjliga matchningar. När du till exempel frågar efter gatuadressen 128 Main St., kan svaret returnera två platser för 128 North Main St. och 128 South Main St. eftersom det inte finns tillräckligt med information för att avgöra vilket alternativ som ska väljas.

UpHierarchy: Platsen representerar en flyttning uppåt i den geografiska hierarkin. Detta inträffar när en matchning för platsbegäran inte hittades, så ett mindre exakt resultat returneras. Om det till exempel inte går att hitta en matchning för den begärda adressen kan en matchningskod UpHierarchy för med en RoadBlock-entitetstyp returneras.

Name	Typ	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Name	Typ	Description
address	Address	Resultatets adress
confidence	ConfidenceEnum	Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om så anges.
geocodePoints	GeocodePoints[]	En samling geokodpunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning.
matchCodes	MatchCodesEnum[]	En eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret. Till exempel innebär en geokodad plats med matchningskoder `Good` för och `Ambiguous` att mer än en geokodsplats hittades för platsinformationen och att geocode-tjänsten inte hade någon sökning i hierarkin för att hitta en matchning. På samma sätt innebär en geokodad plats med matchningskoder `Ambiguous` och `UpHierarchy` att det inte gick att hitta en geokodplats som matchade all angiven platsinformation, så geocode-tjänsten var tvungen att söka i hierarkin och hitta flera matchningar på den nivån. Ett exempel på en `Ambiguous` och `UpHierarchy` ett resultat är när du anger fullständig adressinformation, men geocode-tjänsten inte kan hitta en matchning för gatuadressen och i stället returnerar information för mer än ett RoadBlock-värde. Möjliga värden är: `Good`: Platsen har bara en matchning eller alla returnerade matchningar anses vara starka matchningar. En fråga för New York returnerar till exempel flera bra matchningar. `Ambiguous`: Platsen är en av en uppsättning möjliga matchningar. När du till exempel frågar efter gatuadressen 128 Main St., kan svaret returnera två platser för 128 North Main St. och 128 South Main St. eftersom det inte finns tillräckligt med information för att avgöra vilket alternativ som ska väljas. `UpHierarchy`: Platsen representerar en flytt uppåt i den geografiska hierarkin. Detta inträffar när en matchning för platsbegäran inte hittades, så ett mindre exakt resultat returneras. Om det till exempel inte går att hitta en matchning för den begärda adressen kan en matchningskod `UpHierarchy` för med en RoadBlock-entitetstyp returneras.
type	string	Något av: Adress Vägspärr RoadIntersection Grannskap PopulatedPlace Postnummer1 AdminDivision1 AdminDivision2 CountryRegion

Summary

Sammanfattning för batchbegäran

Name	Typ	Description
successfulRequests	integer	Antal lyckade begäranden i batchen
totalRequests	integer	Totalt antal begäranden i batchen

UsageTypeEnum

Den bästa användningen för geokodpunkten. Varje geokodpunkt definieras som en Route punkt, en Display punkt eller båda. Använd Route punkter om du skapar en väg till platsen. Använd Display punkter om du visar platsen på en karta. Om platsen till exempel är en park kan en Route punkt ange en entré till parken där du kan komma in med en bil, och en Display punkt kan vara en punkt som anger mitten av parken.

Name	Typ	Description
Display	string
Route	string

Dela via

Search - Get Geocoding Batch

Skicka synkron Batch-begäran

POST-brödtext för Batch-begäran

Batch-svarsmodell

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

AADToken

Omfattningar

subscription-key

SAS Token

Exempel

A Geocoding Batch API call containing 2 Geocoding queries

Exempelbegäran

Exempelsvar

Definitioner

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

Ytterligare resurser