Sdílet prostřednictvím

Search - Post Search Along Route

  • Reference
Služba:
Maps
Verze rozhraní API:
1.0

Slouží k provedení přibližného hledání bídných míst na zadané trase.

Rozhraní Post Search Along Route API je požadavek HTTP POST , který umožňuje provádět přibližné hledání bídných míst na zadané trase. Toto hledání je omezeno zadáním maxDetourTime omezující míry.

K odeslání směrovacích bodů použijete POST požadavek, kde text požadavku bude obsahovat route objekt reprezentovaný jako GeoJSON LineString typ a hlavička Content-Type bude nastavena na application/json. Každý bod trasy v route souboru je reprezentován jako GeoJSON Position typ, tj. pole, kde za hodnotou zeměpisné délky následuje hodnota zeměpisné šířky a hodnota nadmořské výšky se ignoruje. Hodnota route by měla obsahovat alespoň 2 body trasy.

Je možné, že původní trasa bude změněna, některé její body mohou být přeskočeny. Pokud je trasa, která prochází nalezený bod, rychlejší než původní, detourTime hodnota v odpovědi je záporná.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
S volitelnými parametry: 
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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
 path True

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.
api-version
 query True

string

Číslo verze rozhraní API Azure Maps.
maxDetourTime
 query True

integer

Maximální doba objížďky bodu zájmu v sekundách. Maximální hodnota je 3600 sekund.
query
 query True

string

Název BZ, který se má hledat (např. "socha svobody", "starbucks", "pizza"). Musí být správně zakódovaná adresa URL.
brandSet
 query

string[]

Seznam názvů značek oddělených čárkami, který lze použít k omezení výsledku na konkrétní značky. Na pořadí položek nezáleží. Pokud je k dispozici více značek, budou vráceny pouze výsledky, které patří do (alespoň) jedné ze zadaných značek. Značky, které obsahují "," v názvu by měly být uvedeny do uvozovek.

Příklady použití:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Čárka",Pruh
categorySet
 query

integer[]

Seznam ID sad kategorií oddělených čárkami, který lze použít k omezení výsledku na konkrétní kategorie bodů zájmu. Na pořadí ID nezáleží. Maximální počet podporovaných categorySet hodnot na žádost je 10. Pokud je k dispozici více identifikátorů kategorií, budou vráceny pouze BŽS, které patří (alespoň) do jedné z kategorií ze zadaného seznamu. Seznam podporovaných kategorií je možné zjistit pomocí rozhraní API kategorií poi . Příklady použití:

  • categorySet=7315 (Search Body zájmu z kategorie Restaurace)

  • categorySet=7315025,7315017 (Search body zájmu italské nebo francouzské restaurace)
connectorSet
 query

ElectricVehicleConnector[]

Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, budou vráceny pouze výsledky, které patří do (alespoň) jednoho ze zadaného seznamu.

Dostupné typy konektorů jsou:

  • StandardHouseholdCountrySpecific - Jedná se o standardní konektory pro domácnost pro určitou oblast. Všechny jsou jednofázové ac a standardní napěťové a standardní amperáže. Viz také: Typy zásuvek & – světové standardy.
  • IEC62196Type1 - Konektor typu 1 podle definice v normě IEC 62196-2. Také se nazývá Yazaki podle původního výrobce nebo SAE J1772 podle normy, která ji poprvé publikovala. Nejčastěji se používá v kombinaci s jednofázovou infrastrukturou 120V nebo až 240V jednofázovou infrastrukturou.
  • IEC62196Type1CCS - Kombinovaný konektor typu 1 podle definice ve standardu IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type2CableAttached - Konektor typu 2 podle definice v normě IEC 62196-2. Poskytuje se jako kabel a zástrčka připojená k nabíjecímu bodu.
  • IEC62196Type2Outlet - Konektor typu 2 podle definice v normě IEC 62196-2. Poskytuje se jako zásuvka nastavená do nabíjecího bodu.
  • IEC62196Type2CCS - Kombinovaný konektor typu 2 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno v normě IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type3 - Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou.
  • Chademo - Konektor CHAdeMO pojmenovaný podle sdružení, které vytvořila Tokyo Electric Power Company a průmyslové partnery. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení.
  • IEC60309AC1PhaseBlue - Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h.
  • IEC60309DCWhite - Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309.
  • Tesla - Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že odkazuje buď na proprietární konektor Tesly, někdy označovaný jako tesla port, většinou omezený na Severní Amerika, nebo na upravený typ 2 (DC přes typ 2) v Evropě.

Příklady použití:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
limit
 query

integer

Maximální počet odpovědí, které budou vráceny. Výchozí hodnota je 10. Maximální hodnota je 20
openingHours
 query

OperatingHoursRange

Hodiny provozu pro poi (body zájmu) Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays
view
 query

LocalizedMapView

Parametr View (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení takových oblastí a parametr View umožňuje, aby aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified", i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak pro toto umístění správně nastavit parametr View. Případně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr View v Azure Maps musí být použit v souladu s platnými zákony, včetně těch, které se týkají mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps jsou dostupné. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Text požadavku

Name Typ Description
route

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Odpovědi

Name Typ Description
200 OK

SearchAddressResult

OK
Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámka

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map .
  • Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
  • Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
  • Použití sady Azure Maps Web SDK umožňuje nastavit aplikaci na základě konfigurace pro více případů použití.
  • Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Search for burger joints along a route

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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
    }
  ]
}

Definice

Name Description
Address

Adresa výsledku
AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres.
BoundingBox

Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení.
BoundingBoxCompassNotation

Ohraničující rámeček umístění.
Brand

Značka přidružená k poi
Classification

Klasifikace pro vrácené BŽS
ClassificationName

Název klasifikace
DataSources

Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API
ElectricVehicleConnector

Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, vrátí se pouze výsledky, které patří (alespoň) do jednoho ze zadaného seznamu.

Dostupné typy konektorů:

  • StandardHouseholdCountrySpecific - Jedná se o standardní konektory pro domácnost pro určitou oblast. Všechny jsou střídavý jednofázový a standardní Napěťový a standardní Amperage. Viz také: Typy zásuvek & zásuvky – světové standardy.
  • IEC62196Type1 - Konektor typu 1 podle definice ve standardu IEC 62196-2. Také se nazývá Yazaki po původním výrobci nebo SAE J1772 po standardu, který ho poprvé publikoval. Nejčastěji se používá v kombinaci s 120V jednofázovou nebo až 240V jednofázovou infrastrukturou.
  • IEC62196Type1CCS - Kombinovaný konektor typu 1 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type2CableAttached - Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako kabel a zástrčka připojená k nabíjecímu bodu.
  • IEC62196Type2Outlet - Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako zásuvka nastavená do nabíjecího bodu.
  • IEC62196Type2CCS - Kombinovaný konektor typu 2 podle definice ve standardu IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno ve standardu IEC 62196-2 – se dvěma dodatečnými kontakty stejnosměrný proud (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type3 - Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou.
  • Chademo - Konektor CHAdeMO pojmenovaný podle asociace, kterou vytvořila Tokyo Electric Power Company a průmysloví partneři. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení.
  • IEC60309AC1PhaseBlue - Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h.
  • IEC60309DCWhite - Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309.
  • Tesla - Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že se odkazuje buď na proprietární konektor Tesly, někdy označovaný jako Tesla Port, většinou omezený na Severní Amerika, nebo upravený typ 2 (DC nad typem 2) v Evropě.

Příklady použití:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.
EntryPoint

Vstupní bod pro vrácené BŽ.
EntryPointType

Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě
ErrorResponse

Chybová odpověď
GeographicEntityType

Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.
GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Geometry

Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.
LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
LocalizedMapView

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.
MatchType

Typy shody pro operaci zpětného vyhledávání adres
OperatingHours

Otevírací doba pro poi (body zájmu)
OperatingHoursRange

Provozní doba pro bod zájmu (Body zájmu). Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays
OperatingHoursTime

Představuje datum a čas.
OperatingHoursTimeRange

Otevřený časový rozsah pro den
PointOfInterest

Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace
PointOfInterestCategorySet

Kategorie POI
QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.
ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.
SearchAddressResult

Tento objekt je vrácen z úspěšných volání Search.
SearchAddressResultItem

Objekt Result pro odpověď rozhraní API Search.
SearchAddressResultType

Jedna z těchto možností:

  • POI
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
SearchAlongRouteRequest

Tento typ představuje text požadavku pro službu Search Along Route.
SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search.

Address

Adresa výsledku

Name Typ Description
boundingBox

BoundingBoxCompassNotation

Ohraničující rámeček umístění.
buildingNumber

string

Číslo budovy na ulici. ZASTARALÉ, použijte místo toho streetNumber.
country

string

název země/oblasti
countryCode

string

Země (Poznámka: Toto je dvoumísmenný kód, nikoli název země/oblasti.)
countryCodeISO3

string

Kód země ISO alfa-3
countrySecondarySubdivision

string

County
countrySubdivision

string

Země/region nebo kraj
countrySubdivisionCode

string

countrySubdivisionCode s předponou countryCode ( countryCode-countrySubdivisionCode ) a spojovník tvoří kód ISO 3166-2. Příklady: TX pro Texas, SCT pro Skotsko a ON pro Ontario.
countrySubdivisionName

string

Úplný název první úrovně hierarchie správy země/oblasti. Toto pole se zobrazí pouze v případě, že se countrySubdivision zobrazí ve zkrácené podobě. Podporováno pouze pro USA, Kanadu a Spojené království.
countryTertiarySubdivision

string

Pojmenovaná oblast
crossStreet

string

Název překračované ulice.
extendedPostalCode

string

Rozšířené PSČ (dostupnost závisí na oblasti).
freeformAddress

string

Řádek adresy formátovaný podle pravidel formátování země/oblasti původu výsledku nebo v případě země/oblasti úplný název země/oblasti.
localName

string

Komponenta adresy, která představuje název zeměpisné oblasti nebo lokality, která seskupuje více adresovatelných objektů pro účely adresování, aniž by to byla jednotka pro správu. Toto pole slouží k sestavení freeformAddress vlastnosti. localName zastupuje poštovní obec. V závislosti na umístění localName je běžně známý název města nebo města. Pro běžně známý název města nebo města použijte localName místo municipality.
municipality

string

Město / město
Poznámka: municipality představuje obytnou obec. V závislosti na umístění municipality se hodnota může lišit od běžně známého názvu města nebo města. Pro běžně známý název města se doporučuje localName místo hodnoty použít municipality hodnotu.
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

Sousedství je geograficky lokalizovaná oblast v rámci města nebo města s výraznými charakteristikami a sociálními interakcemi mezi obyvateli.
postalCode

string

PSČ
routeNumbers

string[]

Kódy používané k jednoznačné identifikaci ulice
street

string

Název ulice. ZASTARALÉ, použijte místo toho streetName.
streetName

string

Název ulice.
streetNameAndNumber

string

Název ulice a číslo.
streetNumber

string

Číslo budovy na ulici.

AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres.

Name Typ Description
from

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
rangeLeft

string

Rozsah adres na levé straně ulice.
rangeRight

string

Rozsah adres na pravé straně ulice.
to

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

BoundingBox

Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení.

Name Typ Description
btmRightPoint

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

BoundingBoxCompassNotation

Ohraničující rámeček umístění.

Name Typ Description
entity

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.
northEast

string

Severní a východní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako čárkami oddělené floaty
southWest

string

Jihovýchodní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako plovoucí čárky oddělené čárkami

Brand

Značka přidružená k poi

Name Typ Description
name

string

Název značky

Classification

Klasifikace pro vrácené BŽS

Name Typ Description
code

string

Vlastnost kódu
names

ClassificationName[]

Pole Názvů

ClassificationName

Název klasifikace

Name Typ Description
name

string

Name – vlastnost
nameLocale

string

Vlastnost Name Locale

DataSources

Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API

Name Typ Description
geometry

Geometry

Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.

ElectricVehicleConnector

Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, vrátí se pouze výsledky, které patří (alespoň) do jednoho ze zadaného seznamu.

Dostupné typy konektorů:

  • StandardHouseholdCountrySpecific - Jedná se o standardní konektory pro domácnost pro určitou oblast. Všechny jsou střídavý jednofázový a standardní Napěťový a standardní Amperage. Viz také: Typy zásuvek & zásuvky – světové standardy.
  • IEC62196Type1 - Konektor typu 1 podle definice ve standardu IEC 62196-2. Také se nazývá Yazaki po původním výrobci nebo SAE J1772 po standardu, který ho poprvé publikoval. Nejčastěji se používá v kombinaci s 120V jednofázovou nebo až 240V jednofázovou infrastrukturou.
  • IEC62196Type1CCS - Kombinovaný konektor typu 1 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type2CableAttached - Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako kabel a zástrčka připojená k nabíjecímu bodu.
  • IEC62196Type2Outlet - Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako zásuvka nastavená do nabíjecího bodu.
  • IEC62196Type2CCS - Kombinovaný konektor typu 2 podle definice ve standardu IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno ve standardu IEC 62196-2 – se dvěma dodatečnými kontakty stejnosměrný proud (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
  • IEC62196Type3 - Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou.
  • Chademo - Konektor CHAdeMO pojmenovaný podle asociace, kterou vytvořila Tokyo Electric Power Company a průmysloví partneři. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení.
  • IEC60309AC1PhaseBlue - Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h.
  • IEC60309DCWhite - Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309.
  • Tesla - Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že se odkazuje buď na proprietární konektor Tesly, někdy označovaný jako Tesla Port, většinou omezený na Severní Amerika, nebo upravený typ 2 (DC nad typem 2) v Evropě.

Příklady použití:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Name Typ Description
Chademo

string

Konektor CHAdeMO pojmenovaný podle asociace, kterou vytvořila společnost Tokyo Electric Power Company a průmysloví partneři. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení.
IEC60309AC1PhaseBlue

string

Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h.
IEC60309DCWhite

string

Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309.
IEC62196Type1

string

Konektor typu 1 podle definice v normě IEC 62196-2. Také se nazývá Yazaki po původním výrobci nebo SAE J1772 po standardu, který ho poprvé publikoval. Nejčastěji se používá v kombinaci s 120V jednofázovou nebo až 240V jednofázovou infrastrukturou.
IEC62196Type1CCS

string

Kombinovaný konektor založený na typu 1 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
IEC62196Type2CCS

string

Kombinovaný konektor založený na typu 2 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno ve standardu IEC 62196-2 – se dvěma dodatečnými kontakty stejnosměrný proud (DC), které umožňují rychlé nabíjení stejnosměrným proudem.
IEC62196Type2CableAttached

string

Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako kabel a zástrčka připojená k nabíjecímu bodu
IEC62196Type2Outlet

string

Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako zásuvka nastavená do nabíjecího bodu.
IEC62196Type3

string

Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou.
StandardHouseholdCountrySpecific

string

Jedná se o standardní konektory domácnosti pro určitou oblast. Všechny jsou střídavý jednofázový a standardní Napěťový a standardní Amperage.

Viz také: Typy zásuvek & zásuvky – světové standardy
Tesla

string

Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že se odkazuje buď na proprietární konektor Tesly, někdy označovaný jako Tesla Port, většinou omezený na Severní Amerika, nebo upravený typ 2 (DC nad typem 2) v Evropě.

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.

Name Typ Description
position

string

Pozice entity

EntryPoint

Vstupní bod pro vrácené BŽ.

Name Typ Description
position

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
type

EntryPointType

Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.

EntryPointType

Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.

Name Typ Description
main

string

minor

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva
target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

GeographicEntityType

Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.

Name Typ Description
Country

string

název země/oblasti
CountrySecondarySubdivision

string

County
CountrySubdivision

string

Země/region nebo kraj
CountryTertiarySubdivision

string

Pojmenovaná oblast
Municipality

string

Město / město
MunicipalitySubdivision

string

Sub / Super City
Neighbourhood

string

Sousedství
PostalCodeArea

string

PSČ

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

GeoJson LineString Souřadnice geometrie.
type string:

LineString

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Geometry

Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.

Name Typ Description
id

string

Předejte ho jako geometryId rozhraní Get Search Polygon API, abyste získali informace o geometrii pro tento výsledek.

LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

Name Typ Description
lat

number

Vlastnost Zeměpisná šířka
lon

number

Zeměpisná délka – vlastnost

LocalizedMapView

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Name Typ Description
AE

string

Spojené arabské emiráty (arabské zobrazení)
AR

string

Argentina (argentinský pohled)
Auto

string

Vrátí mapová data na základě IP adresy požadavku.
BH

string

Bahrajn (arabské zobrazení)
IN

string

Indie (indické zobrazení)
IQ

string

Irák (arabské zobrazení)
JO

string

Jordánsko (arabské zobrazení)
KW

string

Kuvajt (arabské zobrazení)
LB

string

Libanon (arabské zobrazení)
MA

string

Maroko (marocké zobrazení)
OM

string

Omán (arabské zobrazení)
PK

string

Pákistán (pákistánské zobrazení)
PS

string

Palestinská samospráva (arabské zobrazení)
QA

string

Katar (arabské zobrazení)
SA

string

Saúdská Arábie (arabské zobrazení)
SY

string

Sýrie (arabské zobrazení)
Unified

string

Sjednocené zobrazení (ostatní)
YE

string

Jemen (arabské zobrazení)

MatchType

Typy shody pro operaci zpětného vyhledávání adres

Name Typ Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Otevírací doba pro poi (body zájmu)

Name Typ Description
mode

string

Hodnota použitá v požadavku: none nebo "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Seznam časových rozsahů pro příštích 7 dnů

OperatingHoursRange

Provozní doba pro bod zájmu (Body zájmu). Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays

Name Typ Description
nextSevenDays

string

Zobrazuje hodiny operace pro další týden počínaje aktuálním dnem v místním čase poi.

OperatingHoursTime

Představuje datum a čas.

Name Typ Description
date

string

Představuje aktuální kalendářní datum v časovém pásmu BZ, například "2019-02-07".
hour

integer

Hodiny jsou v místním čase poi ve formátu 24 hodin; možné hodnoty jsou 0 až 23.
minute

integer

Minuty jsou v místním čase poi; možné hodnoty jsou 0 až 59.

OperatingHoursTimeRange

Otevřený časový rozsah pro den

Name Typ Description
endTime

OperatingHoursTime

Bod v rozsahu příštích 7 dnů, kdy je dané poi uzavřeno, nebo začátek rozsahu, pokud byl uzavřen před rozsahem.
startTime

OperatingHoursTime

Bod v rozsahu příštích 7 dnů, kdy se dané poi otevírá, nebo začátek rozsahu, pokud byl otevřen před rozsahem.

PointOfInterest

Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace

Name Typ Description
brands

Brand[]

Pole značek. Název značky pro vrácené poi.
categories

string[]

Pole kategorií
categorySet

PointOfInterestCategorySet[]

Seznam nejkonsekvnějších kategorií poi
classifications

Classification[]

Pole klasifikace
name

string

Název vlastnosti POI
openingHours

OperatingHours

Otevírací doba pro bod zájmu (Body zájmu).
phone

string

Vlastnost Telefonní číslo
url

string

Vlastnost Adresa URL webu

PointOfInterestCategorySet

Kategorie POI

Name Typ Description
id

integer

ID kategorie

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.

Name Typ Description
NEARBY

string

Search byla provedena kolem určité zeměpisné šířky a délky s definovaným poloměrem.
NON_NEAR

string

Search byla provedena globálně, bez zkreslení na určitou zeměpisnou šířku a délku a bez definovaného poloměru.

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

Name Typ Description
json

string

Formát výměny dat zápisu objektů JavaScriptu
xml

string

The Extensible Markup Language

SearchAddressResult

Tento objekt je vrácen z úspěšných volání Search.

Name Typ Description
results

SearchAddressResultItem[]

Seznam výsledků rozhraní API Search.
summary

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search

SearchAddressResultItem

Objekt Result pro odpověď rozhraní API Search.

Name Typ Description
address

Address

Adresa výsledku
addressRanges

AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuty souřadnice počátečního a koncového umístění rozsahu adres.
dataSources

DataSources

Volitelný oddíl. REFERENČNÍ ID geometrie pro použití s rozhraním Get Search Polygon API.
detourTime

integer

Čas objížďky v sekundách. Vráceno pouze pro volání rozhraní API Search Along Route.
dist

number

Přímá vzdálenost mezi výsledkem a umístěním geobias v metrech.
entityType

GeographicEntityType

Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.
entryPoints

EntryPoint[]

Pole vstupních bodů. Ty popisují typy vchodů, které jsou k dispozici na místě. Typ může být "hlavní" pro hlavní vchody, jako jsou přední dveře nebo vstupní halu, a "vedlejší" pro boční a zadní dveře.
id

string

Vlastnost Id
info

string

Informace o původním zdroji dat výsledku. Používá se pro žádosti o podporu.
matchType

MatchType

Informace o typu shody.

Jedna z těchto možností:

  • AddressPoint
  • HouseNumberRange
  • Ulice
poi

PointOfInterest

Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace
position

LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
score

number

Hodnota v sadě výsledků k označení relativního skóre shody mezi výsledky. Tuto možnost můžete použít k určení, že výsledek x bude dvakrát tak relevantní jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se v jednotlivých dotazech liší a jsou míněné pouze jako relativní hodnota pro jednu sadu výsledků dotazu.
type

SearchAddressResultType

Jedna z těchto možností:

  • POI
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
viewport

BoundingBox

Zobrazení, které pokrývá výsledek představovaný souřadnicemi levého horního a pravého dolního rohu oblasti.

SearchAddressResultType

Jedna z těchto možností:

  • POI
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
Name Typ Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchAlongRouteRequest

Tento typ představuje text požadavku pro službu Search Along Route.

Name Typ Description
route

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search.

Name Typ Description
fuzzyLevel

integer

Maximální přibližná úroveň požadovaná k poskytnutí výsledků.
geoBias

LatLongPairAbbreviated

Označení, kdy interní vyhledávací web použil geoprostorové předsudky ke zlepšení hodnocení výsledků. V některých metodách to může být ovlivněno nastavením parametrů lat a lon tam, kde jsou k dispozici. V ostatních případech je čistě interní.
limit

integer

Maximální počet odpovědí, které budou vráceny
numResults

integer

Počet výsledků v odpovědi
offset

integer

Počáteční posun vrácených výsledků v rámci celé sady výsledků.
query

string

Parametr dotazu, který byl použit k vytvoření těchto výsledků hledání.
queryTime

integer

Doba strávená překladem dotazu v milisekundách
queryType

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.
totalResults

integer

Celkový počet nalezených výsledků