Search - Get Search POI Category

Referens

Tjänst:: Maps

API-version:: 1.0

Använd för att söka efter intressanta platser efter kategori.

API:et Get Search POI Category är en HTTP-begäran GET som gör att du kan begära POI-resultat från en viss kategori. Användbart för att fråga EFTER API:er från en kategori i taget. Slutpunkten returnerar endast POI-resultat som kategoriseras som angivna. Svaret innehåller POI-information som adress, koordinatplats och klassificering.

GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}

Med valfria parametrar:

GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
api-version	query	True	string	Versionsnummer för Azure Maps API.
query	query	True	string	Poi-kategorin att söka efter (t.ex. "FLYGPLATS", "RESTAURANG"), måste vara korrekt URL-kodad. Huvudkategorier som stöds kan begäras genom att anropa API:et get Search POI Category Tree. En lista över tillgängliga kategorier finns i Azure Maps kategorier som stöds. Vi rekommenderar att du använder POI Search Category Tree API för att begära de kategorier som stöds.
brandSet	query		string[]	En kommaavgränsad lista över varumärken som kan användas för att begränsa resultatet till specifika varumärken. Objektordning spelar ingen roll. När flera varumärken tillhandahålls returneras endast resultat som tillhör (minst) en av listan. Varumärken som innehåller ett "" i deras namn bör placeras i citattecken. Användningsexempel: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Komma",Bar
btmRight	query		string	Avgränsningsrutans nedre högra position. T.ex. 37.553,-122.453
categorySet	query		integer[]	En kommaavgränsad lista över kategoriuppsättnings-ID:t som kan användas för att begränsa resultatet till specifika intressepunkter. ID-beställning spelar ingen roll. Maximalt antal `categorySet` värden som stöds per begäran är 10. När flera kategoriidentifierare tillhandahålls returneras endast API:er som tillhör (minst) en av kategorierna i den angivna listan. Listan över kategorier som stöds kan identifieras med hjälp av POI Categories API. Användningsexempel: categorySet=7315 (Search Intressepunkter från kategorin Restaurang) categorySet=7315025,7315017 (Search intressepunkter för kategorin antingen italiensk eller fransk restaurang)
connectorSet	query		ElectricVehicleConnector[]	En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elbilsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper tillhandahålls returneras endast resultat som tillhör (minst) en av de angivna listan. Tillgängliga anslutningstyper är: `StandardHouseholdCountrySpecific` - Det här är standardanslutningsapparna för hushåll för en viss region. De är alla AC enfas och standardspänning och standard amperage. Se även : Plug & sockettyper – World Standards. `IEC62196Type1` – Skriv 1 anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter den standard som först publicerade den. Används främst i kombination med en enda fas på 120 V eller upp till 240 V enfasinfrastruktur. `IEC62196Type1CCS` – Skriv 1-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström. `IEC62196Type2CableAttached` – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen. `IEC62196Type2Outlet` – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningsplatsen. `IEC62196Type2CCS` – Skriv 2-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström. `IEC62196Type3` – Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420V trefasinfrastruktur. `Chademo` - CHAdeMO-anslutningsprogram uppkallat efter en förening som bildats av Tokyo Electric Power Company och industripartners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning. `IEC60309AC1PhaseBlue` – Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för någon kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h". `IEC60309DCWhite` – Industriell vit anslutningsapp är en DC-anslutningsapp som definieras i IEC 60309-standarden. `Tesla` – Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningen. Det avser antingen Teslas egenutvecklade anslutning, som ibland kallas Tesla Port främst begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa. Användningsexempel: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet	query		string[]	Kommaavgränsad sträng med lands-/regionkoder, t.ex. FR,ES. Detta begränsar sökningen till de angivna länderna/regionerna
extendedPostalCodesFor	query		SearchIndexes[]	Index för vilka utökade postnummer ska ingå i resultaten. Tillgängliga index är: Addr = Adressintervall Geo = Geografiska områden PAD = punktadresser POI = Intressanta platser Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan index. Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa så de måste uttryckligen begäras när det behövs. Användningsexempel: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Utökat postnummer returneras som en extendedPostalCode-egenskap för en adress. Tillgängligheten är regionberoende.
language	query		string	Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds .
lat	query		number double	Latitud där resultaten ska vara partiska. T.ex. 37.337
limit	query		integer	Maximalt antal svar som ska returneras. Standard: 10, minimum: 1 och maximum: 100
lon	query		number double	Longitud där resultaten ska vara partiska. T.ex. -121,89
ofs	query		integer	Startar förskjutningen av de returnerade resultaten inom den fullständiga resultatuppsättningen. Standard: 0
openingHours	query		OperatingHoursRange	Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays
radius	query		integer	Radien i meter till för att resultaten ska begränsas till det definierade området
topLeft	query		string	Övre vänstra positionen för avgränsningsrutan. T.ex. 37.553,-122.453
typeahead	query		boolean	Boolean. Om typeahead-flaggan har angetts tolkas frågan som en partiell indata och sökningen går in i förutsägelseläge
view	query		LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

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.

Svar

Name	Typ	Description
200 OK	SearchAddressResult	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 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

Search for ATM's within 2 miles of Times Square NY and return the top 3 results

Exempelbegäran

HTTP

GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays

Exempelsvar

Statuskod:: 200

{
  "summary": {
    "query": "atm",
    "queryType": "NON_NEAR",
    "queryTime": 28,
    "numResults": 3,
    "offset": 0,
    "totalResults": 3696,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 40.758953,
      "lon": -73.985263
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/7014613",
      "score": 2.575,
      "dist": 10.743802093311858,
      "info": "search:ta:840369001846523-US",
      "poi": {
        "name": "FISERV MASTERMONEY",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1560",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1560 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75901,
        "lon": -73.98516
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75991,
          "lon": -73.98635
        },
        "btmRightPoint": {
          "lat": 40.75811,
          "lon": -73.98397
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75902,
            "lon": -73.98522
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830011",
      "score": 2.575,
      "dist": 58.68107354501256,
      "info": "search:ta:840369011803697-US",
      "poi": {
        "name": "METABANK",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1567",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1567 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75937,
        "lon": -73.98569
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.76027,
          "lon": -73.98688
        },
        "btmRightPoint": {
          "lat": 40.75847,
          "lon": -73.9845
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75924,
            "lon": -73.98513
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830013",
      "score": 2.575,
      "dist": 55.009653221373966,
      "info": "search:ta:840369010525390-US",
      "poi": {
        "name": "ATM",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1552",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1552 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75873,
        "lon": -73.98468
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75963,
          "lon": -73.98587
        },
        "btmRightPoint": {
          "lat": 40.75783,
          "lon": -73.98349
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.7588,
            "lon": -73.98492
          }
        }
      ]
    }
  ]
}

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.
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.
ElectricVehicleConnector	En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elbilsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper tillhandahålls returneras endast resultat som tillhör (minst) en av de angivna listan. Tillgängliga anslutningstyper är: `StandardHouseholdCountrySpecific` - Det här är standardanslutningsapparna för hushåll för en viss region. De är alla AC enfas och standardspänning och standard amperage. Se även : Plug & sockettyper – World Standards. `IEC62196Type1` – Skriv 1 anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter den standard som först publicerade den. Används främst i kombination med en enda fas på 120 V eller upp till 240 V enfasinfrastruktur. `IEC62196Type1CCS` – Skriv 1-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström. `IEC62196Type2CableAttached` – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen. `IEC62196Type2Outlet` – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningsplatsen. `IEC62196Type2CCS` – Skriv 2-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström. `IEC62196Type3` – Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420V trefasinfrastruktur. `Chademo` - CHAdeMO-anslutningsprogram uppkallat efter en förening som bildats av Tokyo Electric Power Company och industripartners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning. `IEC60309AC1PhaseBlue` – Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för någon kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h". `IEC60309DCWhite` – Industriell vit anslutningsapp är en DC-anslutningsapp som definieras i IEC 60309-standarden. `Tesla` – Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningen. Det avser antingen Teslas egenutvecklade anslutning, som ibland kallas Tesla Port främst begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa. Användningsexempel: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
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.
LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.
MatchType	Matchningstyper för en sökåtgärd med omvänd adress.
OperatingHours	Öppettider för en POI (intressepunkter).
OperatingHoursRange	Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays
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.
ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
SearchAddressResult	Det här objektet returneras från ett lyckat Search-anrop.
SearchAddressResultItem	Resultatobjekt för ett Search API-svar.
SearchAddressResultType	Något av: POI Gata Geografi Punktadress Adressintervall Tvärs över gatan
SearchIndexes	Index för vilka utökade postnummer ska ingå i resultaten. Tillgängliga index är: Addr = Adressintervall Geo = Geografiska områden PAD = punktadresser POI = Intressanta platser Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan index. Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa så de måste uttryckligen begäras när det behövs. Användningsexempel: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Utökat postnummer returneras som en extendedPostalCode-egenskap för en adress. Tillgängligheten är regionberoende.
SearchSummary	Sammanfattningsobjekt för ett Search API-svar.

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

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.

ElectricVehicleConnector

En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elbilsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper tillhandahålls returneras endast resultat som tillhör (minst) en av de angivna listan.

Tillgängliga anslutningstyper är:

StandardHouseholdCountrySpecific - Det här är standardanslutningsapparna för hushåll för en viss region. De är alla AC enfas och standardspänning och standard amperage. Se även : Plug & sockettyper – World Standards.
IEC62196Type1 – Skriv 1 anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter den standard som först publicerade den. Används främst i kombination med en enda fas på 120 V eller upp till 240 V enfasinfrastruktur.
IEC62196Type1CCS – Skriv 1-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström.
IEC62196Type2CableAttached – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen.
IEC62196Type2Outlet – Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningsplatsen.
IEC62196Type2CCS – Skriv 2-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström.
IEC62196Type3 – Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420V trefasinfrastruktur.
Chademo - CHAdeMO-anslutningsprogram uppkallat efter en förening som bildats av Tokyo Electric Power Company och industripartners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning.
IEC60309AC1PhaseBlue – Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för någon kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h".
IEC60309DCWhite – Industriell vit anslutningsapp är en DC-anslutningsapp som definieras i IEC 60309-standarden.
Tesla – Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningen. Det avser antingen Teslas egenutvecklade anslutning, som ibland kallas Tesla Port främst begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa.

Användningsexempel:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Name	Typ	Description
Chademo	string	CHAdeMO-anslutningsprogrammet är uppkallat efter en förening som bildats av Tokyo Electric Power Company och industriella partners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning.
IEC60309AC1PhaseBlue	string	Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för någon kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h".
IEC60309DCWhite	string	Industriell vit anslutningsapp är en DC-anslutning som definieras i IEC 60309-standarden.
IEC62196Type1	string	Skriv 1-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter den standard som först publicerade den. Används främst i kombination med en enda fas på 120 V eller upp till 240 V enfasinfrastruktur.
IEC62196Type1CCS	string	Skriv 1-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström.
IEC62196Type2CCS	string	Skriv 2-baserad kombinationsanslutning enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med ytterligare två direktströmskontakter (DC) för att tillåta snabb laddning av likström.
IEC62196Type2CableAttached	string	Skriv 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen
IEC62196Type2Outlet	string	Skriv 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningsplatsen.
IEC62196Type3	string	Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420V trefasinfrastruktur.
StandardHouseholdCountrySpecific	string	Det här är standardanslutningsapparna för hushåll för en viss region. De är alla AC enfas och standardspänning och standard amperage. Se även : Plug & sockettyper – World Standards
Tesla	string	Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningen. Det avser antingen Teslas egenutvecklade anslutning, som ibland kallas Tesla Port främst begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa.

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.

LatLongPairAbbreviated

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

Name	Typ	Description
lat	number	Latitude-egenskap
lon	number	Longitudegenskap

LocalizedMapView

Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN.

Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

Name	Typ	Description
AE	string	Förenade Arabemiraten (arabisk vy)
AR	string	Argentina (argentinsk vy)
Auto	string	Returnera kartdata baserat på IP-adressen för begäran.
BH	string	Bahrain (arabisk vy)
IN	string	Indien (indisk vy)
IQ	string	Irak (arabisk vy)
JO	string	Jordanien (arabisk vy)
KW	string	Kuwait (arabisk vy)
LB	string	Libanon (arabisk vy)
MA	string	Marocko (marockansk vy)
OM	string	Oman (arabisk vy)
PK	string	Pakistan (pakistansk vy)
PS	string	Palestinska myndigheten (arabisk vy)
QA	string	Qatar (arabisk vy)
SA	string	Saudiarabien (arabisk vy)
SY	string	Syrien (arabisk vy)
Unified	string	Enhetlig vy (andra)
YE	string	Jemen (arabisk vy)

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

OperatingHoursRange

Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays

Name	Typ	Description
nextSevenDays	string	Visar drifttimmarna för nästa vecka, med början den aktuella dagen i den lokala tiden för POI.

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

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation
xml	string	Utökningsbart markeringsspråk

SearchAddressResult

Det här objektet returneras från ett lyckat Search-anrop.

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

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

SearchIndexes

Index för vilka utökade postnummer ska ingå i resultaten.

Tillgängliga index är:

Addr = Adressintervall

Geo = Geografiska områden

PAD = punktadresser

POI = Intressanta platser

Str = Gator

XStr = Korsgator (korsningar)

Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan index.

Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa så de måste uttryckligen begäras när det behövs.