Search - Post Search Inside Geometry

Umožňuje provádět vyhledávání volných formulářů v ještě jedné geometrii.

Rozhraní Post Search Inside Geometry API is a HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON Geometrycan be represented as aGeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>TheFeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectioncan contain a max of 50GeoJSON Featureobjects. Eachobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>AFeature Featureobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>AFeature Funkceobject for the Circle geometry is composed of a _center_ represented using aGeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sampleFeature Geometryrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>TheGeometrycan be represented as aGeoJSON GeometryCollection GeometryCollectioncan contain a max of 50object. This is the recommended option if the geometry contains a list of Polygons only. TheGeoJSON Polygon Geometry GeoJSON Polygonobjects. Eachobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>TheGeometrycan be represented as aGeoJSON Polygon Polygonobject. This is the recommended option if the geometry contains a single Polygon. Theobject can have a max of 50 coordinates. Please see the Examples section below for a sampleMnohoúhelníkové znázornění.

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&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.

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.

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)

extendedPostalCodesFor
query

SearchIndexes[]

Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků.

Dostupné indexy jsou:

Addr = Rozsahy adres

Geo = Geografická oblast

PAD = adresy bodů

POI = body zájmu

Str = Ulice

XStr = Křížové ulice (průsečíky)

Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy.

Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.

idxSet
query

SearchIndexes[]

Seznam indexů oddělených čárkami, který by měl být použit pro vyhledávání. Na pořadí položek nezáleží. Dostupné indexy jsou: Addr = Interpolace rozsahu adres, Geo = Zeměpisné oblasti, PAD = Point Addresses, POI = Points of Interest, Str = Streets, Xstr = Cross Streets (průsečíky).

language
query

string

Jazyk, ve kterém se mají vracet výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk.

Podrobnosti najdete v části Podporované jazyky .

limit
query

integer

Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100

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
geometry GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Platný GeoJSON objekt. 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Příklady

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

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

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

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

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

Odpověď na chybu

GeographicEntityType

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

GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonLineString

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

GeoJsonMultiLineString

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

GeoJsonMultiPoint

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

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonPoint

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

GeoJsonPolygon

Platný GeoJSON Polygon 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 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í.

MatchType

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

OperatingHours

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

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

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 výsledku pro odpověď rozhraní API Search.

SearchAddressResultType

Jedna z těchto možností:

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

Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků.

Dostupné indexy jsou:

Addr = Rozsahy adres

Geo = Geografická oblast

PAD = adresy bodů

POI = body zájmu

Str = Ulice

XStr = Křížové ulice (průsečíky)

Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy.

Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.

SearchInsideGeometryRequest

Tento typ představuje text požadavku pro službu Search Inside Geometry.

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, ne název země/oblasti.)

countryCodeISO3

string

ISO alfa-3 kód země

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 je countrySubdivision prezentováno 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 geografické 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.

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

Odpověď na chybu

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Č

GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
featureType

string

Typ funkce. Hodnota závisí na datovém modelu, do který je aktuální funkce součástí. Některé datové modely můžou mít prázdnou hodnotu.

geometry GeoJsonGeometry:
  • GeoJsonGeometryCollection
  • GeoJsonLineString
  • GeoJsonMultiLineString
  • GeoJsonMultiPoint
  • GeoJsonMultiPolygon
  • GeoJsonPoint
  • GeoJsonPolygon

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

id

string

Identifikátor funkce.

type string:

Feature

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.

GeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
features

GeoJsonFeature[]

Obsahuje seznam platných GeoJSON Feature objektů.

type string:

FeatureCollection

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.

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
type

GeoJsonObjectType

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.

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
geometries GeoJsonGeometry[]:
  • GeoJsonGeometryCollection[]
  • GeoJsonLineString[]
  • GeoJsonMultiLineString[]
  • GeoJsonMultiPoint[]
  • GeoJsonMultiPolygon[]
  • GeoJsonPoint[]
  • GeoJsonPolygon[]

Obsahuje seznam platných GeoJSON objektů geometrie. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).

type string:

GeometryCollection

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.

GeoJsonLineString

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

Name Typ Description
coordinates

number[]

Souřadnice GeoJson LineString 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.

GeoJsonMultiLineString

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

Name Typ Description
coordinates

number[]

Souřadnice GeoJson MultiLineString geometrie.

type string:

MultiLineString

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.

GeoJsonMultiPoint

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

Name Typ Description
coordinates

number[]

Souřadnice GeoJson MultiPoint geometrie.

type string:

MultiPoint

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.

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Obsahuje seznam platných GeoJSON Polygon objektů. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).

type string:

MultiPolygon

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.

GeoJsonPoint

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

Name Typ Description
coordinates

number[]

A Position je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisná délka a zeměpisná šířka, přesně v daném pořadí. Třetí volitelný prvek je nadmořská výška/nadmořská výška. Podrobnosti najdete v dokumentu RFC 7946 .

type string:

Point

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.

GeoJsonPolygon

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

Name Typ Description
coordinates

number[]

Souřadnice typu GeoJson Polygon geometrie.

type string:

Polygon

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

Name Typ Description
AE

string

Spojené arabské emiráty (zobrazení v arabštině)

AR

string

Argentina (argentinské zobrazení)

Auto

string

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

BH

string

Bahrajn (zobrazení v arabštině)

IN

string

Indie (indické zobrazení)

IQ

string

Irák (zobrazení v arabštině)

JO

string

Jordánsko (arabské zobrazení)

KW

string

Kuvajt (zobrazení v arabštině)

LB

string

Libanon (zobrazení arabštiny)

MA

string

Maroko (marocké zobrazení)

OM

string

Omán (zobrazení arabštiny)

PK

string

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

PS

string

Palestinská samospráva (zobrazení v arabštině)

QA

string

Katar (zobrazení v arabštině)

SA

string

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

SY

string

Sýrie (zobrazení arabštiny)

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

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

Name Typ Description
nextSevenDays

string

Zobrazuje provozní hodiny pro příští 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 v zápisu objektů JavaScriptu

xml

string

Rozšiřitelný jazyk značek

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 výsledku 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ů označující relativní 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

SearchIndexes

Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků.

Dostupné indexy jsou:

Addr = Rozsahy adres

Geo = Geografická oblast

PAD = adresy bodů

POI = body zájmu

Str = Ulice

XStr = Křížové ulice (průsečíky)

Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy.

Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.

Name Typ Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchInsideGeometryRequest

Tento typ představuje text požadavku pro službu Search Inside Geometry.

Name Typ Description
geometry GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Platný GeoJSON objekt. Podrobnosti najdete v dokumentu RFC 7946 .

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search

Name Typ Description
fuzzyLevel

integer

Maximální úroveň přibližnosti vyžadovaná k poskytnutí výsledků

geoBias

LatLongPairAbbreviated

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

limit

integer

Maximální počet odpovědí, které se vrátí

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ÍZKO nebo NON_NEAR.

totalResults

integer

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