Search - Post Search Address Batch

Service:

Maps

API Version:

1.0

Använd för att skicka en batch med frågor till SEARCH-adress-API:et i en enda asynkron begäran.
API:et Post Search Address Batch är en HTTP-begäran POST som skickar batchar med frågor till Search-adress-API:et i ett enda synkront API-anrop. Du kan anropa batch-API:et för Search-adress för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med api:et async kan anroparen batcha upp till 10 000 frågor och synkronisera API:et upp till 100 frågor.

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla 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. Synkront API 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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Skicka asynkron Batch-begäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer av relativt komplexa sökbegäranden

• Det gör det möjligt att hämta resultat i ett separat anrop (flera nedladdningar är möjliga).
• Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte överskrida tidsgränsen.
• Antalet batchobjekt är begränsat till 10 000 för det här API:et.

När du gör en begäran med hjälp av en async-begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. De asynkrona svaren lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

Observera att en asynkron batchbegäran är en tidskrävande åtgärd. Här är en typisk sekvens med åtgärder:

1. Klienten skickar en batchbegäran Search address POST till Azure Maps.

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

2. Servern svarar med något av följande:

   HTTP 202 Accepted – Batch-begäran har accepterats.

   HTTP Error – Det uppstod ett fel vid bearbetning av Batch-begäran. Detta kan antingen vara en 400 Bad Request eller någon annan Error statuskod.

3. Om batchbegäran godkändes Location innehåller rubriken i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:n ser ut så här:

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

4. Klienten utfärdar en GET begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned batchresultatet.

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

Om du vill skicka sökadressfrågor 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 5 sökadressfrågor :

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

En sökadressfråga i en batch är bara en partiell URL utan protokoll, bas-URL, sökväg, API-version och prenumerationsnyckel. Den kan acceptera någon av de sökadress-URI-parametrar som stöds. Strängvärdena i sökadressfrågan måste vara korrekt undantagna (t.ex. " tecken ska vara undantagna med \ ) och det bör också vara korrekt URL-kodat.

Med api:et async kan anroparen batcha upp till 10 000 frågor och synkronisera API:et upp till 100 frågor, och batchen bör innehålla minst 1 fråga.

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat skickar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från rubriken för Location en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

2. Servern svarar med något av följande:

   HTTP 202 Accepted – Batch-begäran godkändes men bearbetas fortfarande. Försök igen om en stund.

   HTTP 200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkronisering och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests vilka som ingick i 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 i batchItems innehåller statusCode och response fält. Varje response in batchItems är av någon av följande typer:

• SearchAddressResult – Om frågan har slutförts.

• Error – Om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett batchsvar med 2 lyckade och 1 misslyckade resultat:

{
    "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-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast json format stöds.
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 Microsoft Entra ID säkerhetsmodell. Det 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 Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

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

Svar

Name	Typ	Description
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Stöds endast för asynkron begäran. Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i platsrubriken för att försöka igen eller komma åt resultatet. Headers Location: string
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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto 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 för att Azure Maps REST-API:er.

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 ha å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 som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.
• Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
• Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
• Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
• Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

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.

Definitioner

Name	Description
Address	Resultatets adress
AddressRanges	Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
BatchRequest	Den här typen representerar begärandetexten för Batch-tjänsten.
BatchRequestItem	Batch-begärandeobjekt
BoundingBox	Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen.
BoundingBoxCompassNotation	Platsens avgränsningsruta.
Brand	Det varumärke som är associerat med POI
Classification	Klassificeringen för den intressepunkt som returneras
ClassificationName	Namn på klassificeringen
DataSources	Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.
Entity	Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
EntryPoint	Startpunkten för den POI som returneras.
EntryPointType	Typ av startpunkt. Värdet kan vara antingen huvudvärde eller mindre.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeographicEntityType	Geografi entitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
Geometry	Information om resultatets geometriska form. Endast tillgänglig om du skriver == Geografi.
JsonFormat	Önskat format för svaret. Endast json format stöds.
LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
MatchType	Matchningstyper för en sökåtgärd med omvänd adress.
OperatingHours	Öppettider för en POI (intressepunkter).
OperatingHoursTime	Representerar ett datum och en tid
OperatingHoursTimeRange	Öppet tidsintervall för en dag
PointOfInterest	Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
PointOfInterestCategorySet	POI-kategori
QueryType	Typen av fråga som returneras: NEARBY eller NON_NEAR.
Response	Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars.
SearchAddressBatchItem	Ett objekt som returneras från Search Batch-adresstjänstanrop.
SearchAddressBatchProcessResult	Det här objektet returneras från ett lyckat Search Batch-tjänstanrop för adress.
SearchAddressResultItem	Resultatobjekt för ett Search API-svar.
SearchAddressResultType	Något av: POI Gata Geografi Punktadress Adressintervall Tvärs över gatan
SearchSummary	Sammanfattningsobjekt för ett Search API-svar.
Summary	Sammanfattning av resultatet för batchbegäran

Address

Resultatets adress

Name	Typ	Description
boundingBox	BoundingBoxCompassNotation	Platsens avgränsningsruta.
buildingNumber	string	Byggnadens nummer på gatan. INAKTUELL, använd streetNumber i stället.
country	string	land/regionnamn
countryCode	string	Land (Obs! Det här är en kod med två bokstäver, inte ett namn på land/region.)
countryCodeISO3	string	ISO alfa-3 landskod
countrySecondarySubdivision	string	Län
countrySubdivision	string	Delstat eller provins
countrySubdivisionCode	string	countrySubdivisionCode prefixet av countryCode ( countryCode-countrySubdivisionCode ) och bindestrecket utgör ISO 3166-2-koden. Exempel: TX för Texas, SCT för Skottland och ON för Ontario.
countrySubdivisionName	string	Det fullständiga namnet på en första nivå i den administrativa hierarkin för land/region. Det här fältet visas endast om countrySubdivision visas i ett förkortat formulär. Stöds endast för USA, Kanada och Storbritannien.
countryTertiarySubdivision	string	Namngivet område
crossStreet	string	Namnet på gatan som korsas.
extendedPostalCode	string	Utökat postnummer (tillgängligheten är beroende av regionen).
freeformAddress	string	En adressrad formaterad enligt formateringsreglerna för ett resultats ursprungsland/region, eller för ett land/en region, dess fullständiga namn på land/region.
localName	string	En adresskomponent som representerar namnet på ett geografiskt område eller en lokal plats som grupperar flera adresserbara objekt i adresseringssyfte, utan att vara en administrativ enhet. Det här fältet används för att skapa freeformAddress egenskapen. localName representerar postkommunen. Beroende på platsen localName är det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på en stad eller stad använder du localName i stället för municipality.
municipality	string	Stad/Stad Obs! municipality representerar bostadskommunen. Beroende på plats municipality kan värdet skilja sig från det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på staden eller staden föreslås att localName värdet ska användas i stället för municipality värdet.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Ett grannskap är ett geografiskt lokaliserat område inom en stad eller stad med särpräglade egenskaper och sociala interaktioner mellan invånare.
postalCode	string	Postnummer/postnummer
routeNumbers	string[]	De koder som används för att entydigt identifiera gatan
street	string	Gatunamnet. INAKTUELL, använd streetName i stället.
streetName	string	Gatunamnet.
streetNameAndNumber	string	Gatunamnet och numret.
streetNumber	string	Byggnadens nummer på gatan.

AddressRanges

Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.

Name	Typ	Description
from	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
rangeLeft	string	Adressintervall till vänster på gatan.
rangeRight	string	Adressintervall på höger sida av gatan.
to	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

BatchRequest

Den här typen representerar begärandetexten för Batch-tjänsten.

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

BatchRequestItem

Batch-begärandeobjekt

Name	Typ	Description
query	string	Den här parametern innehåller en frågesträng som används för att utföra en ostrukturerad geokodningsåtgärd. Frågesträngen skickas ordagrant till sök-API:et för bearbetning.

BoundingBox

Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen.

Name	Typ	Description
btmRightPoint	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

BoundingBoxCompassNotation

Platsens avgränsningsruta.

Name	Typ	Description
entity	Entity	Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
northEast	string	Nordostlig latitud, longitudkoordinat för avgränsningslådan som kommaavgränsade flyttal
southWest	string	Sydvästlig latitud, longitudkoordinat för avgränsningslådan som kommaavgränsade flyttal

Brand

Det varumärke som är associerat med POI

Name	Typ	Description
name	string	Namnet på varumärket

Classification

Klassificeringen för den intressepunkt som returneras

Name	Typ	Description
code	string	Kodegenskap
names	ClassificationName[]	Namnmatris

ClassificationName

Namn på klassificeringen

Name	Typ	Description
name	string	Namnegenskap
nameLocale	string	Namn på språkegenskap

DataSources

Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.

Name	Typ	Description
geometry	Geometry	Information om resultatets geometriska form. Endast tillgänglig om du skriver == Geografi.

Entity

Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.

Name	Typ	Description
position	string	Position entitet

EntryPoint

Startpunkten för den POI som returneras.

Name	Typ	Description
position	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
type	EntryPointType	Typ av startpunkt. Värdet kan vara antingen huvudvärde eller mindre.

EntryPointType

Typ av startpunkt. Värdet kan vara antingen huvudvärde eller mindre.

Name	Typ	Description
main	string
minor	string

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.

GeographicEntityType

Geografi entitetstyp. Presentera endast när entityType begärdes och är tillgängligt.

Name	Typ	Description
Country	string	land/regionnamn
CountrySecondarySubdivision	string	Län
CountrySubdivision	string	Delstat eller provins
CountryTertiarySubdivision	string	Namngivet område
Municipality	string	Stad/Stad
MunicipalitySubdivision	string	Sub/Super City
Neighbourhood	string	Grannskapet
PostalCodeArea	string	Postnummer/postnummer

Geometry

Information om resultatets geometriska form. Endast tillgänglig om du skriver == Geografi.

Name	Typ	Description
id	string	Skicka detta som geometryId till API:et Get Search Polygon för att hämta geometriinformation för det här resultatet.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

Name	Typ	Description
lat	number	Latitude-egenskap
lon	number	Longitudegenskap

MatchType

Matchningstyper för en sökåtgärd med omvänd adress.

Name	Typ	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Öppettider för en POI (intressepunkter).

Name	Typ	Description
mode	string	Värde som används i begäran: none eller "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista över tidsintervall för de kommande 7 dagarna

OperatingHoursTime

Representerar ett datum och en tid

Name	Typ	Description
date	string	Representerar aktuellt kalenderdatum i POI-tidszonen, t.ex. "2019-02-07".
hour	integer	Timmar är i 24-timmarsformat i den lokala tiden för en POI; möjliga värden är 0–23.
minute	integer	Minuter är i den lokala tiden för en POI; möjliga värden är 0–59.

OperatingHoursTimeRange

Öppet tidsintervall för en dag

Name	Typ	Description
endTime	OperatingHoursTime	Punkten under de kommande 7 dagarna sträcker sig när en viss POI stängs eller början av intervallet om den stängdes före intervallet.
startTime	OperatingHoursTime	Punkten under de kommande 7 dagarna sträcker sig när en viss POI öppnas, eller början av intervallet om den öppnades före intervallet.

PointOfInterest

Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.

Name	Typ	Description
brands	Brand[]	Matris för varumärken. Namnet på varumärket för den POI som returneras.
categories	string[]	Matris för kategorier
categorySet	PointOfInterestCategorySet[]	Listan över de mest specifika POI-kategorierna
classifications	Classification[]	Klassificeringsmatris
name	string	Namn på egenskapen POI
openingHours	OperatingHours	Öppettider för en POI (intressepunkter).
phone	string	Telefonnummeregenskap
url	string	Webbplats-URL-egenskap

PointOfInterestCategorySet

POI-kategori

Name	Typ	Description
id	integer	Kategori-ID

QueryType

Typen av fråga som returneras: NEARBY eller NON_NEAR.

Name	Typ	Description
NEARBY	string	Search utfördes runt en viss latitud och longitud med en definierad radie
NON_NEAR	string	Search utfördes globalt, utan bias till en viss latitud och longitud, och ingen definierad radie

Response

Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars.

Name	Typ	Description
error	ErrorDetail	Felobjektet.
results	SearchAddressResultItem[]	En lista över Search API-resultat.
summary	SearchSummary	Sammanfattningsobjekt för ett Search API-svar

SearchAddressBatchItem

Ett objekt som returneras från Search Batch-adresstjänstanrop.

Name	Typ	Description
response	Response	Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars.
statusCode	integer	Statuskod för HTTP-begäran.

SearchAddressBatchProcessResult

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

Name	Typ	Description
batchItems	SearchAddressBatchItem[]	Matris som innehåller batchresultatet.
summary	Summary	Sammanfattning av resultatet för batchbegäran

SearchAddressResultItem

Resultatobjekt för ett Search API-svar.

Name	Typ	Description
address	Address	Resultatets adress
addressRanges	AddressRanges	Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
dataSources	DataSources	Valfritt avsnitt. Referensgeometri-ID för användning med API:et Get Search Polygon.
detourTime	integer	Omvägstid i sekunder. Returneras endast för anrop till API:et Search Längs vägen.
dist	number	Rät linjeavstånd mellan resultatet och geobias plats i meter.
entityType	GeographicEntityType	Geografi entitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
entryPoints	EntryPoint[]	Matris med EntryPoints. De beskriver de typer av ingångar som är tillgängliga på platsen. Typen kan vara "main" för huvudentréer som en ytterdörr, eller en lobby, och "mindre", för sido- och bakdörrar.
id	string	ID-egenskap
info	string	Information om den ursprungliga datakällan för resultatet. Används för supportbegäranden.
matchType	MatchType	Information om typen av matchning. Något av: AddressPoint HouseNumberRange Gata
poi	PointOfInterest	Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
position	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
score	number	Värdet i en resultatuppsättning som anger den relativa matchningspoängen mellan resultaten. Du kan använda detta för att fastställa att resultat x är dubbelt så sannolikt att vara lika relevant som resultat y om värdet för x är 2x värdet för y. Värdena varierar mellan frågor och är endast avsedda som ett relativt värde för en resultatuppsättning.
type	SearchAddressResultType	Något av: POI Gata Geografi Punktadress Adressintervall Tvärs över gatan
viewport	BoundingBox	Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen.

SearchAddressResultType

Något av:

• POI
• Gata
• Geografi
• Punktadress
• Adressintervall
• Tvärs över gatan

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

SearchSummary

Sammanfattningsobjekt för ett Search API-svar.

Name	Typ	Description
fuzzyLevel	integer	Den maximala fuzzy-nivå som krävs för att ge resultat.
geoBias	LatLongPairAbbreviated	Indikation när den interna sökmotorn har tillämpat en geospatial bias för att förbättra resultatrankningen. I vissa metoder kan detta påverkas genom att ange lat- och lon-parametrarna där de är tillgängliga. I andra fall är det rent internt.
limit	integer	Maximalt antal svar som ska returneras
numResults	integer	Antal resultat i svaret.
offset	integer	Startförskjutningen för de returnerade resultaten inom den fullständiga resultatuppsättningen.
query	string	Frågeparametern som användes för att skapa dessa sökresultat.
queryTime	integer	Tid som ägnas åt att lösa frågan i millisekunder.
queryType	QueryType	Typen av fråga som returneras: NEARBY eller NON_NEAR.
totalResults	integer	Det totala antalet resultat som hittades.

Summary

Sammanfattning av resultatet för batchbegäran

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