Search - Get Search POI

  • Ссылка
Service:
Maps
API Version:
1.0

Используйте для поиска точек интереса по имени.

API Points of Interest (POI) Search — это HTTP-запрос GET , который позволяет запрашивать результаты POI по имени. Он также поддерживает дополнительные параметры запроса, такие как язык и фильтрация результатов по интересующей области, определяемой страной или регионом или ограничивающим полем. Конечная точка вернет только результаты POI, соответствующие строке запроса. Ответ включает сведения о poI, такие как адрес, расположение координат и категория.

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

Параметры URI

Имя В Обязательно Тип Описание
format
 path True

ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.
api-version
 query True

string

Номер версии API Azure Maps
query
 query True

string

Имя POI для поиска (например, "статуя свободы", "starbucks") должно быть правильно закодировано в URL-адресе.
brandSet
 query

string[]

Разделенный запятыми список торговых марок, который можно использовать для ограничения результата определенными брендами. Порядок элементов не имеет значения. При указании нескольких торговых марок возвращаются только результаты, принадлежащие (по крайней мере) одному из предоставленных списков. Торговые марки, содержащие "," в их названии должны быть заключены в кавычки.

Примеры использования

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Запятая",Строка
btmRight
 query

string

Нижняя правая позиция ограничивающего прямоугольника. Например, 37,553,-122,453
categorySet
 query

integer[]

Разделенный запятыми список идентификаторов наборов категорий, который можно использовать для ограничения результата определенными категориями точек интереса. Порядок идентификации не имеет значения. Максимальное количество значений, поддерживаемых categorySet для каждого запроса, — 10. При указании нескольких идентификаторов категорий возвращаются только pois, которые относятся к (по крайней мере) одной из категорий из указанного списка. Список поддерживаемых категорий можно найти с помощью API категорий POI . Примеры использования

  • categorySet=7315 (Поиск Достопримечательности из категории Ресторан)

  • categorySet=7315025,7315017 (Поиск Достопримечательности категории Итальянский или Французский ресторан)
connectorSet
 query

ElectricVehicleConnector[]

Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков.

Доступные типы соединителей:

  • StandardHouseholdCountrySpecific — Это стандартные соединители для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем. См. также: Вилка & типов сокетов — мировые стандарты.
  • IEC62196Type1 - Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В.
  • IEC62196Type1CCS — Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type2CableAttached - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки.
  • IEC62196Type2Outlet - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки.
  • IEC62196Type2CCS — Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type3 - Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В.
  • Chademo - Соединитель CHAdeMO, названный в честь ассоциации, созданной Токийской электрической компанией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока.
  • IEC60309AC1PhaseBlue - Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h".
  • IEC60309DCWhite - Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309.
  • Tesla - Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе.

Примеры использования

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet
 query

string[]

Разделенная запятыми строка кодов стран и регионов, например FR,ES. При этом поиск будет ограничен указанными странами или регионами.
extendedPostalCodesFor
 query

PointOfInterestExtendedPostalCodes[]

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

POI = точки интереса

Чтобы отключить расширенные почтовые индексы, значение должно быть POI или None .

По умолчанию включены расширенные почтовые индексы.

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
language
 query

string

Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию.

Дополнительные сведения см. в разделе Поддерживаемые языки .
lat
 query

number

double

Широта, где результаты должны быть смещены. Например, 37,337
limit
 query

integer

Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100
lon
 query

number

double

Долгота, где результаты должны быть смещены. Например, -121,89
ofs
 query

integer

Начальная смещение возвращаемых результатов в полном результирующем наборе. Значение по умолчанию: 0
openingHours
 query

OperatingHoursRange

Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если значение не прошло, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays
radius
 query

integer

Радиус в метрах до для ограничения результатов определенной областью
topLeft
 query

string

Верхняя левая позиция ограничивающего прямоугольника. Например, 37,553,-122,453
typeahead
 query

boolean

Логическое. Если установлен флаг typeahead, запрос будет интерпретирован как частичные входные данные, а поиск перейдет в прогнозный режим.
view
 query

LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя Тип Описание
200 OK

SearchAddressResult

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечание

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами .
  • объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
  • Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
  • Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

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

Scopes

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

Sample Request

GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays

Sample Response

Status code:
200 
{
  "summary": {
    "query": "juice bars",
    "queryType": "NON_NEAR",
    "queryTime": 36,
    "numResults": 5,
    "offset": 0,
    "totalResults": 12,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.606038,
      "lon": -122.333345
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/9223158",
      "score": 5.664,
      "dist": 667.2710170950347,
      "info": "search:ta:840539001755244-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-6240804",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "400",
        "streetName": "Pine St",
        "municipalitySubdivision": "Seattle, Central Business District",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98101",
        "extendedPostalCode": "981011628",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "400 Pine St, Seattle, WA 98101",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61138,
        "lon": -122.3374
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61228,
          "lon": -122.33873
        },
        "btmRightPoint": {
          "lat": 47.61048,
          "lon": -122.33607
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61134,
            "lon": -122.33737
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9222534",
      "score": 5.663,
      "dist": 1101.6849025777728,
      "info": "search:ta:840539001760125-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-4533785",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "315",
        "streetName": "E Pine St",
        "municipalitySubdivision": "Seattle, Broadway",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98122",
        "extendedPostalCode": "9812200",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "315 E Pine St, Seattle, WA 98122",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61518,
        "lon": -122.32768
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61608,
          "lon": -122.32901
        },
        "btmRightPoint": {
          "lat": 47.61428,
          "lon": -122.32635
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61523,
            "lon": -122.32768
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9133689",
      "score": 5.659,
      "dist": 2649.8700791555398,
      "info": "search:ta:840539001339220-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-2820651",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "604",
        "streetName": "1st Ave N",
        "municipalitySubdivision": "Seattle, Lower Queen Anne",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98109",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "604 1st Ave N, Seattle, WA 98109",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6247,
        "lon": -122.35533
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6256,
          "lon": -122.35666
        },
        "btmRightPoint": {
          "lat": 47.6238,
          "lon": -122.354
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6247,
            "lon": -122.3554
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9131285",
      "score": 5.646,
      "dist": 5097.757019046541,
      "info": "search:ta:840539001743255-US",
      "poi": {
        "name": "Custom Smoothie & Sports Nutrition",
        "phone": "+(1)-(206)-5475522",
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.customsmoothie.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "462",
        "streetName": "N 34th St",
        "municipalitySubdivision": "Seattle, Fremont",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981038600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "462 N 34th St, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.65016,
        "lon": -122.35182
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.65106,
          "lon": -122.35315
        },
        "btmRightPoint": {
          "lat": 47.64926,
          "lon": -122.35049
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.64991,
            "lon": -122.3519
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9228250",
      "score": 5.637,
      "dist": 6235.798481758295,
      "info": "search:ta:840531000416784-US",
      "poi": {
        "name": "Jamba Juice",
        "phone": "+(1)-(206)-6322060",
        "brands": [
          {
            "name": "Jamba Juice"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.jambajuice.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "4555",
        "streetName": "Stone Way N",
        "municipalitySubdivision": "Wallingford, Seattle",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981036600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.66179,
        "lon": -122.34233
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.66269,
          "lon": -122.34367
        },
        "btmRightPoint": {
          "lat": 47.66089,
          "lon": -122.34099
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.66188,
            "lon": -122.34211
          }
        }
      ]
    }
  ]
}

Определения

Имя Описание
Address

Адрес результата
AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
BoundingBox

Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра.
BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.
Brand

Торговая марка, связанная с POI
Classification

Классификация возвращаемого POI
ClassificationName

Имя классификации
DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API получения Поиск polygon.
ElectricVehicleConnector

Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков.

Доступные типы соединителей:

  • StandardHouseholdCountrySpecific — Это стандартные соединители для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем. См. также: Вилка & типов сокетов — мировые стандарты.
  • IEC62196Type1 - Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В.
  • IEC62196Type1CCS — Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type2CableAttached - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки.
  • IEC62196Type2Outlet - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки.
  • IEC62196Type2CCS — Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type3 - Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В.
  • Chademo - Соединитель CHAdeMO, названный в честь ассоциации, созданной Токийской электрической компанией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока.
  • IEC60309AC1PhaseBlue - Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h".
  • IEC60309DCWhite - Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309.
  • Tesla - Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе.

Примеры использования

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
EntryPoint

Точка входа для возвращаемого poI.
EntryPointType

Тип точки входа. Значение может быть main или дополнительным.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.
LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .
MatchType

Типы совпадений для операции обратного поиска адресов.
OperatingHours

Часы работы для POI (точки интереса).
OperatingHoursRange

Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если значение не прошло, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays
OperatingHoursTime

Представляет дату и время.
OperatingHoursTimeRange

Диапазон времени открытия в день
PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
PointOfInterestCategorySet

Категория POI
PointOfInterestExtendedPostalCodes

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

POI = точки интереса

Чтобы отключить расширенные почтовые индексы, значение должно быть POI или None .

По умолчанию включены расширенные почтовые индексы.

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.
ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.
SearchAddressResult

Этот объект возвращается из успешных вызовов Поиск.
SearchAddressResultItem

Результирующий объект для ответа API Поиск.
SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
SearchSummary

Объект Summary для ответа API Поиск.

Address

Адрес результата

Имя Тип Описание
boundingBox

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.
buildingNumber

string

Номер здания на улице. НЕ РЕКОМЕНДУЕТСЯ, используйте streetNumber.
country

string

название страны или региона
countryCode

string

Страна (примечание. Это двухбуквенный код, а не название страны или региона.)
countryCodeISO3

string

Код страны ISO alpha-3
countrySecondarySubdivision

string

Округ
countrySubdivision

string

Область, республика, край
countrySubdivisionCode

string

countrySubdivisionCode с префиксом countryCode ( countryCode-countrySubdivisionCode ), а дефис формирует код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио.
countrySubdivisionName

string

Полное имя первого уровня административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлено в сокращенной форме. Поддерживается только для США, Канады и Соединенного Королевства.
countryTertiarySubdivision

string

Именованной области
crossStreet

string

Название пересекаемой улицы.
extendedPostalCode

string

Расширенный почтовый индекс (доступность зависит от региона).
freeformAddress

string

Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата или в случае страны или региона, его полного названия страны или региона.
localName

string

Компонент адреса, представляющий имя географической области или местности, которая группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для сборки freeformAddress свойства . localName представляет почтовый муниципалитет. В зависимости от расположения — localName это общеизвестное название города или города. Для общеизвестного названия города или города используйте localName вместо municipality.
municipality

string

Город или город
Примечание. municipality Представляет жилой муниципалитет. В зависимости от расположения municipality значение может отличаться от общего имени города или города. Для общего имени города или города рекомендуется localName использовать значение вместо municipality значения.
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

Район — это географически локализованная территория в пределах города или города с отличительными характеристиками и социальными взаимодействиями между жителями.
postalCode

string

Почтовый индекс / почтовый индекс
routeNumbers

string[]

Коды, используемые для однозначной идентификации улицы
street

string

Название улицы. Не рекомендуется, вместо этого используйте streetName.
streetName

string

Название улицы.
streetNameAndNumber

string

Название и номер улицы.
streetNumber

string

Номер здания на улице.

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.

Имя Тип Описание
from

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
rangeLeft

string

Диапазон адресов в левой части улицы.
rangeRight

string

Диапазон адресов на правой стороне улицы.
to

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBox

Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра.

Имя Тип Описание
btmRightPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Имя Тип Описание
entity

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
northEast

string

Северо-восточная широта,долгота координаты ограничивающего прямоугольника в виде поплавков с раздели-запятыми
southWest

string

Широта юго-запада, координата долготы ограничивающего прямоугольника в виде поплавков с разделимы-запятыми

Brand

Торговая марка, связанная с POI

Имя Тип Описание
name

string

Название торговой марки

Classification

Классификация возвращаемого POI

Имя Тип Описание
code

string

Свойство Code
names

ClassificationName[]

Массив имен

ClassificationName

Имя классификации

Имя Тип Описание
name

string

Name - свойство
nameLocale

string

Имя свойства Locale

DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API получения Поиск polygon.

Имя Тип Описание
geometry

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

ElectricVehicleConnector

Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков.

Доступные типы соединителей:

  • StandardHouseholdCountrySpecific — Это стандартные соединители для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем. См. также: Вилка & типов сокетов — мировые стандарты.
  • IEC62196Type1 - Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В.
  • IEC62196Type1CCS — Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type2CableAttached - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки.
  • IEC62196Type2Outlet - Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки.
  • IEC62196Type2CCS — Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
  • IEC62196Type3 - Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В.
  • Chademo - Соединитель CHAdeMO, названный в честь ассоциации, созданной Токийской электрической компанией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока.
  • IEC60309AC1PhaseBlue - Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h".
  • IEC60309DCWhite - Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309.
  • Tesla - Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе.

Примеры использования

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Имя Тип Описание
Chademo

string

Соединитель CHAdeMO назван в честь ассоциации, созданной Токийской электрической электростанцией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока.
IEC60309AC1PhaseBlue

string

Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h".
IEC60309DCWhite

string

Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309.
IEC62196Type1

string

Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В.
IEC62196Type1CCS

string

Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
IEC62196Type2CCS

string

Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку.
IEC62196Type2CableAttached

string

Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки
IEC62196Type2Outlet

string

Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки.
IEC62196Type3

string

Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В.
StandardHouseholdCountrySpecific

string

Это стандартные соединители для домашних хозяйств для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем.

См. также: Типы сокетов plug & — мировые стандарты
Tesla

string

Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе.

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

Имя Тип Описание
position

string

Сущность Position

EntryPoint

Точка входа для возвращаемого poI.

Имя Тип Описание
position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
type

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

Имя Тип Описание
main

string

minor

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.

Имя Тип Описание
Country

string

название страны или региона
CountrySecondarySubdivision

string

Округ
CountrySubdivision

string

Область, республика, край
CountryTertiarySubdivision

string

Именованной области
Municipality

string

Город или город
MunicipalitySubdivision

string

Sub / Super City
Neighbourhood

string

Районе
PostalCodeArea

string

Почтовый индекс/ почтовый индекс

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Имя Тип Описание
id

string

Передайте его как geometryId в API получения Поиск многоугольников, чтобы получить геометрическую информацию для этого результата.

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

Имя Тип Описание
lat

number

Свойство Latitude
lon

number

Свойство Longitude

LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

Имя Тип Описание
AE

string

Объединенные Арабские Эмираты (арабское представление)
AR

string

Аргентина (аргентинское представление)
Auto

string

Данные карт возвращаются с учетом IP-адреса запроса.
BH

string

Бахрейн (арабское представление)
IN

string

Индия (индийское представление)
IQ

string

Ирак (арабское представление)
JO

string

Иордан (арабское представление)
KW

string

Кувейт (арабское представление)
LB

string

Ливан (арабское представление)
MA

string

Марокко (марокканское представление)
OM

string

Оман (арабское представление)
PK

string

Пакистан (пакистанское представление)
PS

string

Палестинская Автономия (арабское представление)
QA

string

Катар (арабское представление)
SA

string

Саудовская Аравия (арабское представление)
SY

string

Сирия (арабское представление)
Unified

string

Унифицированное представление (прочие)
YE

string

Йемен (арабское представление)

MatchType

Типы совпадений для операции обратного поиска адресов.

Имя Тип Описание
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Часы работы для POI (точки интереса).

Имя Тип Описание
mode

string

Значение, используемое в запросе: none или "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Список диапазонов времени на следующие 7 дней

OperatingHoursRange

Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если значение не прошло, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays

Имя Тип Описание
nextSevenDays

string

Показывает часы работы на следующую неделю, начиная с текущего дня по местному времени POI.

OperatingHoursTime

Представляет дату и время.

Имя Тип Описание
date

string

Представляет текущую дату календаря в часовом поясе POI, например 2019-02-07.
hour

integer

Часы находятся в формате 24 часов по местному времени poI; Возможные значения: от 0 до 23.
minute

integer

Минуты относятся к местному времени poI; Возможные значения: от 0 до 59.

OperatingHoursTimeRange

Диапазон времени открытия в день

Имя Тип Описание
endTime

OperatingHoursTime

Точка в диапазоне ближайших 7 дней при закрытии заданного poI или начало диапазона, если он был закрыт до диапазона.
startTime

OperatingHoursTime

Точка в диапазоне ближайших 7 дней, когда открывается данный poI, или начало диапазона, если он был открыт до диапазона.

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

Имя Тип Описание
brands

Brand[]

Массив торговых марок. Имя торговой марки для возвращаемого poI.
categories

string[]

Массив категорий
categorySet

PointOfInterestCategorySet[]

Список наиболее конкретных категорий POI
classifications

Classification[]

Массив классификации
name

string

Имя свойства POI
openingHours

OperatingHours

Часы работы для POI (достопримечательностей).
phone

string

Свойство номера телефона
url

string

Свойство URL-адреса веб-сайта

PointOfInterestCategorySet

Категория POI

Имя Тип Описание
id

integer

Идентификатор категории

PointOfInterestExtendedPostalCodes

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

POI = точки интереса

Чтобы отключить расширенные почтовые индексы, значение должно быть POI или None .

По умолчанию включены расширенные почтовые индексы.

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.

Имя Тип Описание
None

string

POI

string

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Имя Тип Описание
NEARBY

string

Поиск выполнено вокруг определенной широты и долготы с заданным радиусом
NON_NEAR

string

Поиск выполнялась глобально без смещения к определенной широте и долготе без определенного радиуса

ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.

Имя Тип Описание
json

string

Формат обмена данными нотации объектов JavaScript
xml

string

Язык расширяемой разметки

SearchAddressResult

Этот объект возвращается из успешных вызовов Поиск.

Имя Тип Описание
results

SearchAddressResultItem[]

Список результатов Поиск API.
summary

SearchSummary

Объект Summary для ответа API Поиск

SearchAddressResultItem

Результирующий объект для ответа API Поиск.

Имя Тип Описание
address

Address

Адрес результата
addressRanges

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
dataSources

DataSources

Необязательный раздел. Идентификатор геометрии ссылки для использования с API получения Поиск Polygon.
detourTime

integer

Время объезда в секундах. Возвращается только для вызовов API Поиск Вдоль маршрута.
dist

number

Расстояние по прямой линии между результатом и расположением геобия в метрах.
entityType

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
entryPoints

EntryPoint[]

Массив точек входа. Они описывают типы входов, доступных на месте. Тип может быть "main" для main входов, таких как входная дверь или вестибюль, и "незначительный" для боковых и задних дверей.
id

string

Свойство Id
info

string

Сведения об исходном источнике данных result. Используется для запросов в службу поддержки.
matchType

MatchType

Сведения о типе соответствия.

Одно из двух значений:

  • Адресная точка
  • HouseNumberRange
  • Улица
poi

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
score

number

Значение в результирующем наборе, указывающее относительную оценку сопоставления между результатами. С его помощью можно определить, что результат x в два раза выше, чем результат y, если значение x равно 2x значению y. Значения различаются в разных запросах и предназначены только как относительное значение для одного результирующих наборов.
type

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
viewport

BoundingBox

Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
Имя Тип Описание
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

Объект Summary для ответа API Поиск.

Имя Тип Описание
fuzzyLevel

integer

Максимальный уровень нечеткости, необходимый для предоставления результатов.
geoBias

LatLongPairAbbreviated

Указание того, что внутренняя поисковая система применила геопространственный смещение для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, задав параметры lat и lon, если они доступны. В других случаях она является чисто внутренней.
limit

integer

Максимальное число возвращаемых ответов
numResults

integer

Количество результатов в ответе.
offset

integer

Начальная смещение возвращаемых результатов в полном результирующем наборе.
query

string

Параметр запроса, который использовался для получения этих результатов поиска.
queryTime

integer

Время, затраченное на разрешение запроса, в миллисекундах.
queryType

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.
totalResults

integer

Общее число найденных результатов.