Dela via

Search - Post Search Along Route

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

Använd för att utföra en fuzzy-sökning efter URI:er längs en angiven väg.

API:et Post Search Along Route är en HTTP-begäran POST som gör att du kan utföra en fuzzy-sökning efter API:er längs en angiven väg. Den här sökningen begränsas genom att ange det begränsande måttet maxDetourTime .

Om du vill skicka routningspunkterna använder du en POST begäran där begärandetexten route innehåller objektet som representeras som en GeoJSON LineString typ och Content-Type rubriken anges till application/json. Varje routningspunkt i route representeras som en GeoJSON Position typ, dvs. en matris där longitudvärdet följs av latitudvärdet och höjdvärdet ignoreras. route Ska innehålla minst 2 routningspunkter.

Det är möjligt att den ursprungliga vägen ändras, vissa av dess punkter kan hoppas över. Om vägen som passerar genom den hittade punkten är snabbare än den ursprungliga detourTime är värdet i svaret negativt.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
Med valfria parametrar: 
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&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.
maxDetourTime
 query True

integer

Maximal omvägstid för den intressanta punkten i sekunder. Maxvärdet är 3 600 sekunder
query
 query True

string

POI-namnet att söka efter (t.ex. "frihetsgudinnan", "starbucks", "pizza"). Måste vara korrekt URL-kodad.
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
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
limit
 query

integer

Maximalt antal svar som ska returneras. Standardvärdet är 10. Maxvärdet är 20
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
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. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

Name Typ Description
route

GeoJsonLineString

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

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 en 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 få åtkomstkontroll för specifika API:er och omfång.

Anteckning

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.
  • Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
  • 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 burger joints along a route

Exempelbegäran

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Exempelsvar

Statuskod:
200 
{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

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å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.
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 elfordonsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper anges returneras endast resultat som tillhör (minst) en av de angivna listan.

Tillgängliga anslutningstyper är:

  • StandardHouseholdCountrySpecific - Dessa är standardanslutningar för hushåll för en viss region. De är alla AC enda fas och standarden Spä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 standarden som först publicerade den. Används främst i kombination med 120V enkel fas eller upp till 240V enfasinfrastruktur.
  • IEC62196Type1CCS – Skriv 1 baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
  • 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å laddningspunkten.
  • IEC62196Type2CCS – Skriv 2-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
  • IEC62196Type3 – Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Även kallad Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420 V infrastruktur med tre faser.
  • 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 en 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-anslutningsappen. Det avser antingen Teslas egenutvecklade anslutningsapp, som ibland kallas Tesla Port mestadels 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 INTRESSEPUNKT 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.
GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .
Geometry

Information om resultatets geometriska form. Endast tillgängligt 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 användarnas plats och sedan ange 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 (orienteringspunkter).
OperatingHoursRange

Drifttimmar för en POI (orienteringspunkter). Tillgängligheten för drifttimmar varierar beroende på vilka data som är tillgängliga. Om det inte skickas 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
SearchAlongRouteRequest

Den här typen representerar begärandetexten för tjänsten Search Längs vägen.
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

namn på land/region
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 bara om countrySubdivision presenteras i ett förkortat format. 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, om det gäller 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 lokalitet 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

Ort/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å orten föreslår vi att localName värdet används i stället för värdet municipality .
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

En stadsdel är ett geografiskt lokaliserat område inom en stad eller stad med särskiljande egenskaper och sociala interaktioner mellan invånarna.
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 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 latitud och longitud med kortnamnen "lat" & "lon".

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.

Name Typ Description
btmRightPoint

LatLongPairAbbreviated

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

LatLongPairAbbreviated

En plats som representeras som 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änsningsrutan som kommaavgränsade flyttal
southWest

string

Sydvästlig latitud, longitudkoordinat för avgränsningsrutan 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åkvariantegenskap

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ängligt om du skriver == Geografi.

ElectricVehicleConnector

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

Tillgängliga anslutningstyper är:

  • StandardHouseholdCountrySpecific - Dessa är standardanslutningar för hushåll för en viss region. De är alla AC enda fas och standarden Spä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 standarden som först publicerade den. Används främst i kombination med 120V enkel fas eller upp till 240V enfasinfrastruktur.
  • IEC62196Type1CCS – Skriv 1 baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
  • 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å laddningspunkten.
  • IEC62196Type2CCS – Skriv 2-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
  • IEC62196Type3 – Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Även kallad Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420 V infrastruktur med tre faser.
  • 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 en 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-anslutningsappen. Det avser antingen Teslas egenutvecklade anslutningsapp, som ibland kallas Tesla Port mestadels 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-anslutningsprogram uppkallat efter en association 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

string

Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för en 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-anslutningsapp 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 standarden som först publicerade den. Används främst i kombination med 120V enkel fas eller upp till 240V enfasinfrastruktur.
IEC62196Type1CCS

string

Skriv 1-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
IEC62196Type2CCS

string

Skriv 2-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc.
IEC62196Type2CableAttached

string

Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen
IEC62196Type2Outlet

string

Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningspunkten.
IEC62196Type3

string

Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Även kallad Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420 V infrastruktur med tre faser.
StandardHouseholdCountrySpecific

string

Dessa är standardanslutningar för hushåll för en viss region. De är alla AC enda fas och standarden Spänning och standard Amperage.

Se även : Plug & sockettyper – World Standards
Tesla

string

Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningsappen. Det avser antingen Teslas egenutvecklade anslutningsapp, som ibland kallas Tesla Port mestadels 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

Placeringsentitet

EntryPoint

Startpunkten för den INTRESSEPUNKT som returneras.

Name Typ Description
position

LatLongPairAbbreviated

En plats som representeras som 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

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

GeoJsonLineString

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

Name Typ Description
coordinates

number[]

Koordinater för GeoJson LineString geometrin.
type string:

LineString

Anger GeoJSON typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Geometry

Information om resultatets geometriska form. Endast tillgängligt 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 användarnas plats och sedan ange 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 (orienteringspunkter).

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 POI (orienteringspunkter). Tillgängligheten för drifttimmar varierar beroende på vilka data som är tillgängliga. Om det inte skickas returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays

Name Typ Description
nextSevenDays

string

Visar drifttimmarna för nästa vecka, som börjar med den aktuella dagen i den lokala tiden för IP-platsen.

OperatingHoursTime

Representerar ett datum och en tid

Name Typ Description
date

string

Representerar aktuellt kalenderdatum i tidszonen POI, t.ex. "2019-02-07".
hour

integer

Timmarna ä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 inom de följande 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 inom de följande 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

SearchAlongRouteRequest

Den här typen representerar begärandetexten för tjänsten Search Längs vägen.

Name Typ Description
route

GeoJsonLineString

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

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.