Dela via

Search - Post Search Address Reverse Batch

  • Referens
Tjänst:
Maps
API-version:
1.0

Använd för att skicka en batch med frågor till Search adressens omvända API i en enda asynkron begäran.

API:et Post Search Address Reverse Batch är en HTTP-begäran POST som skickar batchar med frågor till Search Adress omvänd API i ett enda asynkront API-anrop. Du kan anropa Post Search Address Reverse Batch API 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/reverse/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 Search begäran om omvänd batchadress POST till Azure Maps.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. 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.

  2. 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/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 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 omvända 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å begärandetext som innehåller 5 omvända sökadressfrågor :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

En omvänd 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 omvända URI-parametrarna för sökadresser som stöds. Strängvärdena i sökadressens omvända fråga 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/reverse/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:

  • SearchAddressReverseResponse – 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": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "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/reverse/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

ReverseSearchAddressBatchProcessResult

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.

Sidhuvuden

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.

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

Typ: apiKey
I: 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.

Typ: apiKey
I: header

Exempel

A Reverse Geocoding Batch API call containing 5 Reverse Geocoding API queries

Exempelbegäran

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

{
  "batchItems": [
    {
      "query": "?query=48.858561,2.294911"
    },
    {
      "query": "?query=47.639765,-122.127896&radius=5000&limit=2"
    },
    {
      "query": "?query=47.621028,-122.348170"
    }
  ]
}

Exempelsvar

Statuskod:
200 
{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}
Statuskod:
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

Geografientitetstyp. Finns bara 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 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

Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR.
Response

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

Ett objekt som returneras från tjänstanropet Search Address Reverse Batch.
ReverseSearchAddressBatchProcessResult

Det här objektet returneras från ett lyckat Search anrop till tjänsten Reverse Batch.
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

Den ytterligare informationen.
type

string

Ytterligare informationstyp.

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

Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.

Name Typ Description
Country

string

namn på land/region
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 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

Den typ av fråga som returneras: NÄRLIGGANDE 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

ReverseSearchAddressBatchItem

Ett objekt som returneras från tjänstanropet Search Address Reverse Batch.

Name Typ Description
response

Response

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

integer

Statuskod för HTTP-begäran.

ReverseSearchAddressBatchProcessResult

Det här objektet returneras från ett lyckat Search anrop till tjänsten Reverse Batch.

Name Typ Description
batchItems

ReverseSearchAddressBatchItem[]

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

Detour tid i sekunder. Returneras endast för anrop till API:et Search Along Route.
dist

number

Rät linjeavstånd mellan resultatet och geobias plats i meter.
entityType

GeographicEntityType

Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.
entryPoints

EntryPoint[]

Matris med EntryPoints. De beskriver de typer av ingångar som finns på platsen. Typen kan vara "huvud" 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 supportförfrågningar.
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 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 resultatet x är dubbelt så sannolikt att vara så 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ådet som täcker resultatet som representeras av koordinaterna längst upp till vänster och längst ned till höger i visningsområdet.

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 tillhandahålla 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 det är tillgängligt. 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 i 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

Den typ av fråga som returneras: NÄRLIGGANDE 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