Search - Post Search Fuzzy Batch Sync

Служба:: Maps

Версия API:: 1.0

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

API Post Search Fuzzy Batch — это HTTP-запрос POST , который отправляет пакеты запросов к Search Fuzzy API в одном синхронном вызове. Вы можете вызывать API Post Search Fuzzy Batch для асинхронного (асинхронного) или синхронного (синхронного). Асинхронный API позволяет вызывающему абоненту пакетировать до 10 000 запросов и синхронизировать API до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных поисковых запросов

Это позволяет получить результаты в отдельном вызове (возможно несколько скачивание).
Асинхронный API оптимизирован для надежности и не должен выполняться во время ожидания.
Количество пакетных элементов для этого API ограничено 10 000 .

При выполнении запроса с помощью асинхронного запроса служба возвращает код ответа 202 по URL-адресу перенаправления в поле "Расположение" заголовка ответа. Этот URL-адрес следует периодически проверять до тех пор, пока не будут доступны данные ответа или сведения об ошибках. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если используется после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос является длительной операцией. Ниже приведена типичная последовательность операций:

Клиент отправляет запрос на нечеткий пакет POST поиска в Azure Maps.

POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}

Сервер ответит на одно из следующих действий:

HTTP 202 Accepted — пакетный запрос был принят.

HTTP Error . Произошла ошибка при обработке запроса пакетной службы. Это может быть либо 400 Bad Request, либо любой другой код состояния Error.
Если пакетный запрос был принят успешно, заголовок Location в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Клиент выдает запрос GET на URL-адрес скачивания , полученный на шаге 3, чтобы скачать результаты пакета.

Текст POST для пакетного запроса

Для отправки поисковых нечетких запросов вы будете использовать запрос, POST в котором тело запроса будет содержать batchItems массив в json формате, а заголовок Content-Type будет установлен в application/json. Вот пример тела запроса, содержащего 5 поисковых нечетких запросов:

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Поисковый нечеткий запрос в пакете — это просто частичный URL без протокола, базового URL, пути, api-версии и ключа подписки. Он может принимать любой из поддерживаемых параметров URIдля поиска с нечеткими различиями. Строковые значения в поисковом запросе должны быть правильно экранированы (например, символ « должен быть экранирован с помощью \ ), а также он должен быть правильно закодирован URL.

Асинхронный API позволяет вызывающему объекту пакетировать до 10 000 запросов и синхронизировать API до 100 запросов, при этом пакет должен содержать как минимум 1 запрос.

Скачивание асинхронных результатов пакетной службы

Чтобы скачать асинхронные результаты пакетной службы, вы получите запрос GET на конечную точку загрузки пакетной службы. Этот URL-адрес скачивания можно получить из заголовка Location успешного запроса POST пакетного запроса и выглядит следующим образом:

https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Ниже приведена типичная последовательность операций для скачивания результатов пакетной службы:

Клиент отправляет запрос GET с помощью URL-адреса скачивания.
Сервер ответит на одно из следующих действий:

HTTP-202 Accepted — пакетный запрос был принят, но по-прежнему обрабатывается. Повторите попытку в течение некоторого времени.

HTTP 200 OK — пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если пакет завершил обработку, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequestsто есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент в batchItems содержит поля statusCode и response. Каждый response в batchItems имеет один из следующих типов:

SearchAddressResult. Если запрос выполнен успешно.
Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

Вот пример пакетного ответа с 2 успешными и 1 неудачным результатом:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для учетной записи Azure Maps можно получить с помощью API учетной записи плоскости управления Azure Maps. Дополнительные сведения об использовании безопасности Microsoft Entra ID в Azure Maps см. в статье Управление проверкой подлинности в Azure Maps.

Текст запроса

Имя	Тип	Описание
batchItems	BatchRequestItem[]	Список запросов для обработки.

Ответы

Имя	Тип	Описание
200 OK	SearchAddressBatchProcessResult	ХОРОШО
Other Status Codes	ErrorResponse	Время ожидания: запрос занимает больше времени, чем максимальное время, определенное в API.
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Замечание

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

A Sync Search Fuzzy Batch API call containing 5 Search Fuzzy API queries

Образец запроса

HTTP

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
    },
    {
      "query": "?query=Statue Of Liberty&limit=2"
    },
    {
      "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
    }
  ]
}

Пример ответа

Код состояния:: 200

{
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "atm",
          "queryType": "NON_NEAR",
          "queryTime": 5,
          "numResults": 5,
          "offset": 0,
          "totalResults": 262,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/3656546",
            "score": 2.671,
            "dist": 1336.1815386162032,
            "info": "search:ta:840539002005905-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "14808",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63229,
              "lon": -122.14232
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63319,
                "lon": -122.14365
              },
              "btmRightPoint": {
                "lat": 47.63139,
                "lon": -122.14099
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63154,
                  "lon": -122.1423
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/8673325",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840539002022072-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "Northeast 24Th Street",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736315",
            "score": 2.671,
            "dist": 864.7591776519859,
            "info": "search:ta:840539002187855-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15521",
              "streetName": "Bel Red Rd",
              "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
              "municipality": "Redmond, Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525501",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63259,
              "lon": -122.1328
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63349,
                "lon": -122.13413
              },
              "btmRightPoint": {
                "lat": 47.63169,
                "lon": -122.13147
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63255,
                  "lon": -122.13275
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/3656412",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001998867-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736876",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001396789-US",
            "poi": {
              "name": "US Bank ATM",
              "phone": "+(1)-(800)-8722657",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "url": "www.usbank.com",
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "statue of liberty",
          "queryType": "NON_NEAR",
          "queryTime": 37,
          "numResults": 2,
          "offset": 0,
          "totalResults": 18,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/9189660",
            "score": 6.942,
            "info": "search:ta:840369001174316-US",
            "poi": {
              "name": "Statue of Liberty",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "monument"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "municipalitySubdivision": "New York",
              "municipality": "New York",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10004",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "New York, NY 10004",
              "localName": "New York",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.68955,
              "lon": -74.04483
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.69045,
                "lon": -74.04602
              },
              "btmRightPoint": {
                "lat": 40.68865,
                "lon": -74.04364
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.69001,
                  "lon": -74.04683
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/3264566",
            "score": 6.942,
            "info": "search:ta:840019000670588-US",
            "poi": {
              "name": "Statue of Liberty",
              "phone": "+(1)-(205)-9700251",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "url": "www.1bsa.org",
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "516",
              "streetName": "Liberty Pkwy",
              "municipalitySubdivision": "Vestavia Hills",
              "municipality": "Vestavia Hills, Birmingham",
              "countrySecondarySubdivision": "Jefferson",
              "countryTertiarySubdivision": "Leeds",
              "countrySubdivisionCode": "AL",
              "postalCode": "35242",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
              "localName": "Vestavia Hills",
              "countrySubdivisionName": "Alabama"
            },
            "position": {
              "lat": 33.48234,
              "lon": -86.70719
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 33.48324,
                "lon": -86.70827
              },
              "btmRightPoint": {
                "lat": 33.48144,
                "lon": -86.70611
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 33.48129,
                  "lon": -86.7065
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "starbucks",
          "queryType": "NON_NEAR",
          "queryTime": 35,
          "numResults": 10,
          "offset": 0,
          "totalResults": 17,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/153678",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840531000006554-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8695816",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152316",
            "score": 2.67,
            "dist": 2315.294397491255,
            "info": "search:ta:840539000484552-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-6436471",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15097",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15600",
              "streetName": "NE 8th St",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98008",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61896,
              "lon": -122.12945
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61986,
                "lon": -122.13078
              },
              "btmRightPoint": {
                "lat": 47.61806,
                "lon": -122.12812
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.619,
                  "lon": -122.12945
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167545",
            "score": 2.67,
            "dist": 1979.2222952267998,
            "info": "search:ta:840539001950429-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-7470690",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1350",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62212,
              "lon": -122.13179
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62302,
                "lon": -122.13312
              },
              "btmRightPoint": {
                "lat": 47.62122,
                "lon": -122.13046
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62213,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168519",
            "score": 2.67,
            "dist": 2490.3337046455963,
            "info": "search:ta:840539001015090-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-4556500",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "https://www.starbucks.com/store-locator/store/15901",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1645",
              "streetName": "140th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98005",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62626,
              "lon": -122.15487
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62716,
                "lon": -122.1562
              },
              "btmRightPoint": {
                "lat": 47.62536,
                "lon": -122.15354
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62645,
                  "lon": -122.15446
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.62579,
                  "lon": -122.15377
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152428",
            "score": 2.668,
            "dist": 3529.7080738812224,
            "info": "search:ta:840539001033722-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-3789496",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "180",
              "streetName": "148th Ave SE",
              "municipalitySubdivision": "West Lake Hills, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.60901,
              "lon": -122.14
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.60991,
                "lon": -122.14133
              },
              "btmRightPoint": {
                "lat": 47.60811,
                "lon": -122.13867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.60901,
                  "lon": -122.14008
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167147",
            "score": 2.668,
            "dist": 3479.393294615887,
            "info": "search:ta:840539000326896-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8619198",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7425",
              "streetName": "166th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526288",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67055,
              "lon": -122.12001
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67145,
                "lon": -122.12135
              },
              "btmRightPoint": {
                "lat": 47.66965,
                "lon": -122.11867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67069,
                  "lon": -122.11889
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153695",
            "score": 2.667,
            "dist": 3622.441074618729,
            "info": "search:ta:840531000006551-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8822881",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15022",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7625",
              "streetName": "170th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980520910",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67086,
              "lon": -122.11392
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67176,
                "lon": -122.11526
              },
              "btmRightPoint": {
                "lat": 47.66996,
                "lon": -122.11258
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67073,
                  "lon": -122.1135
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167420",
            "score": 2.667,
            "dist": 3818.293513029088,
            "info": "search:ta:840539000640782-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8853323",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "17246",
              "streetName": "Redmond Way",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980524403",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67174,
              "lon": -122.10976
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67264,
                "lon": -122.1111
              },
              "btmRightPoint": {
                "lat": 47.67084,
                "lon": -122.10842
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.6706,
                  "lon": -122.11026
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153686",
            "score": 2.666,
            "dist": 4009.922205147074,
            "info": "search:ta:840531000006548-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8859590",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15738",
              "streetName": "Redmond Way Pad 3 Redmond Center",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980523873",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67583,
              "lon": -122.12877
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67673,
                "lon": -122.13011
              },
              "btmRightPoint": {
                "lat": 47.67493,
                "lon": -122.12743
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.67456,
                  "lon": -122.12887
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.67668,
                  "lon": -122.12829
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168511",
            "score": 2.666,
            "dist": 3987.80992387863,
            "info": "search:ta:840531000006669-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8818265",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "6617",
              "streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
              "municipalitySubdivision": "Kirkland, Bridle Trails",
              "municipality": "Kirkland",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98033",
              "extendedPostalCode": "980338234",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
              "localName": "Kirkland",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.66514,
              "lon": -122.16599
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.66604,
                "lon": -122.16733
              },
              "btmRightPoint": {
                "lat": 47.66424,
                "lon": -122.16465
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.666,
                  "lon": -122.16669
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.66553,
                  "lon": -122.16405
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  }
}

Код состояния:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Определения

Имя	Описание
Address	Адрес результата.
AddressRanges	Описывает диапазон адресов на обеих сторонах улицы для результата поиска. Включены координаты для начальных и конечных расположений диапазона адресов.
BatchRequest	Этот тип представляет текст запроса для пакетной службы.
BatchRequestItem	Объект пакетного запроса
BoundingBox	Окно просмотра, охватывающее результат, представленный координатами верхнего и нижнего справа от окна просмотра.
BoundingBoxCompassNotation	Ограничивающий прямоугольник расположения.
Brand	Бренд, связанный с POI
Classification	Классификация возвращаемого POI
ClassificationName	Имя классификации
DataSources	Необязательный раздел. Идентификаторы ссылок для использования с API get Search Polygon.
Entity	Источник типа сущности ограничивающего поля. Для обратного геокодирования это всегда равно позиции.
EntryPoint	Точка входа для возвращаемого poI.
EntryPointType	Тип точки входа. Значение может быть либо основной, либо дополнительных.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeographicEntityType	Тип сущности Geography. Присутствует только в том случае, если entityType был запрошен и доступен.
Geometry	Сведения о геометрической форме результата. Только если тип == Geography.
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".
MatchType	Типы совпадений для операции поиска обратного адреса.
OperatingHours	Часы работы для POI (точки интереса).
OperatingHoursTime	Представляет дату и время
OperatingHoursTimeRange	Диапазон времени открытия в течение дня
PointOfInterest	Сведения о возвращаемом POI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
PointOfInterestCategorySet	Категория POI
QueryType	Тип возвращаемого запроса: NEARBY или NON_NEAR. Важно: Это свойство устарело и может быть опущено в ответе.
Response	Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse в противном случае.
SearchAddressBatchItem	Элемент, возвращенный в результате вызова пакетной службы поиска адреса.
SearchAddressBatchProcessResult	Этот объект возвращается в результате успешного вызова службы пакетного поиска адреса.
SearchAddressResultItem	Результирующий объект для ответа API поиска.
SearchAddressResultType	Одно из: ПОИ Улица География Точечный адрес Диапазон адресов Перекресток
SearchSummary	Сводный объект для ответа API поиска.
Summary	Сводка результатов для пакетного запроса

Address

Объект

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

Имя	Тип	Описание
boundingBox	BoundingBoxCompassNotation	Определяет ограничивающий прямоугольник для местоположения. Это свойство возвращается только API-интерфейсами обратного поиска адреса. Все остальные API поиска возвращают свойство `viewportSearchAddressResultItem` объекта.
buildingNumber	string	Номер здания на улице. Важно: Это свойство является устаревшим. Вместо этого используйте `streetNumber`.
country	string	Название страны/региона.
countryCode	string	Двухбуквенный алфавитный код, определённый стандартом ISO 3166-1 Alpha-2 для обозначения страны/региона и зависимых территорий.
countryCodeISO3	string	Трёхбуквенный алфавитный код, определённый стандартом ISO 3166-1 Alpha-3 для обозначения страны/региона и зависимых территорий.
countrySecondarySubdivision	string	Административное деление второго уровня внутри страны/региона. Он обозначает подразделение, расположенное ниже основного подразделения, например, штата или провинции, но выше меньших единиц, таких как муниципалитеты или районы. Примеры включают округ в Соединённых Штатах и округ в Соединённом Королевстве.
countrySubdivision	string	Основное административное деление внутри страны, например, государство, провинция. Он используется для обозначения подразделения первого уровня ниже национального уровня.
countrySubdivisionCode	string	`countrySubdivisionCode` префиксом `countryCode` (countryCode-countrySubdivisionCode) и дефисом формирует код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио. Это свойство недоступно в `Get Search Nearby` API.`Get Search POI`
countrySubdivisionName	string	Представляет полное название административного подразделения первого уровня (например, штат, провинция или регион) внутри страны или региона. Это свойство включено только в том случае, когда значение `countrySubdivision` указано в сокращённой форме. В настоящее время поддерживается в США, Канаде и Великобритании.
countryTertiarySubdivision	string	Административное деление третьего уровня внутри страны/региона. Он обеспечивает ещё более тонкую детализацию, чем вторичное подразделение (например, округ или округ). Примеры включают муниципалитеты, такие как город, посёлок, деревня, боро или тауншип, а также районы — меньшую, неформальную географическую зону в пределах муниципалитета, такие как Капитолий-Хилл, Грин-Лейк и Уоллингфорд в Сиэтле.
crossStreet	string	Имя улицы, пересекаемой. Это свойство доступно только в `Get Search Address Reverse Cross Street` API.
extendedPostalCode	string	Расширенный почтовый индекс означает формат почтового индекса, который выходит за рамки стандартного набора цифр для повышения точности определения местоположения. Он часто используется в системах, таких как код U.S. ZIP+4 или аналогичных расширенных форматах в других странах и регионах. Доступность зависит от региона. Недоступно в `Get Search Address Reverse Cross Street` API.
freeformAddress	string	Строка адреса, отформатированная согласно правилам форматирования страны/региона происхождения результата, или, в случае страны/региона, полного названия страны/региона.
localName	string	Компонент адреса, представляющий имя географической области или локальности, которая группирует несколько адресных объектов для решения задач, не являясь административной единицей. Это поле используется для создания свойства `freeformAddress`. `localName` представляет почтовый муниципалитет. В зависимости от расположения, `localName` является общим именем города или города. Для известного имени города или города используйте `localName` вместо `municipality`.
municipality	string	Город / город Примечание. `municipality` представляет жилой муниципалитет. В зависимости от расположения значение `municipality` может отличаться от общего имени города или города. Для общеизвестного названия города или посёлка рекомендуется `localName` использовать значение вместо значения.`municipality`
municipalitySubdivision	string	Подразделение в пределах муниципалитета. Он представляет собой меньшую административную или географическую единицу внутри города, посёлка или другого муниципального образования.
neighbourhood	string	Район является географически локализованным районом в городе или городе с отличительными характеристиками и социальным взаимодействием между жителями.
postalCode	string	К адресу добавляется серия цифр или букв (или обеих), чтобы помочь определить конкретную географическую область. Почтовый индекс — это американская версия почтового индекса, другие страны и регионы используют другие форматы, такие как Postcode, PIN Code и PLZ.
routeNumbers	string[]	Коды использовались для однозначной идентификации улицы. Доступно только для API обратного поиска адреса.
street	string	Имя улицы. Важно: Это свойство является устаревшим. Вместо этого используйте `streetName`.
streetName	string	Имя улицы.
streetNameAndNumber	string	Имя и номер улицы. Доступно только для API обратного поиска адреса.
streetNumber	string	Номер здания на улице. Недоступно в `Get Search Address Reverse Cross Street` API.

AddressRanges

Объект

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

Имя	Тип	Описание
from	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".
rangeLeft	string	Диапазон адресов слева от улицы.
rangeRight	string	Диапазон адресов справа от улицы.
to	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".

BatchRequest

Объект

Этот тип представляет текст запроса для пакетной службы.

Имя	Тип	Описание
batchItems	BatchRequestItem[]	Список запросов для обработки.

BatchRequestItem

Объект

Объект пакетного запроса

Имя	Тип	Описание
query	string	Этот параметр содержит строку запроса, используемую для выполнения неструктурированной операции геокодирования. Строка запроса будет передана в API поиска для обработки.

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	Свойство имени
nameLocale	string	Свойство Name Locale

DataSources

Объект

Необязательный раздел. Идентификаторы ссылок для использования с API get Search Polygon.

Имя	Тип	Описание
geometry	Geometry	Сведения о геометрической форме результата. Только если тип == Geography.

Entity

Перечисление

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

Значение	Описание
position	Позиция сущности

EntryPoint

Объект

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

Имя	Тип	Описание
position	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".
type	EntryPointType	Тип точки входа. Значение может быть либо основной, либо дополнительных.

EntryPointType

Перечисление

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

Значение	Описание
main
minor

ErrorAdditionalInfo

Объект

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GeographicEntityType

Перечисление

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

Значение	Описание
Country	имя страны или региона
CountrySubdivision	Штат или провинция
CountrySecondarySubdivision	Округ
CountryTertiarySubdivision	Именованной области
Municipality	Город / город
MunicipalitySubdivision	Саб / Супер Сити
Neighbourhood	Округа
PostalCodeArea	Почтовый индекс / почтовый индекс

Geometry

Объект

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

Имя	Тип	Описание
id	string	Передайте этот код в качестве geometryId в получить api поиска polygon, чтобы получить данные геометрии для этого результата.

JsonFormat

Перечисление

Требуемый формат ответа. Поддерживается только json формат.

Значение	Описание
json	формат обмена данными для объектов JavaScript

LatLongPairAbbreviated

Объект

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

Имя	Тип	Описание
lat	number (double)	Свойство Latitude
lon	number (double)	Свойство Долготы

MatchType

Перечисление

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

Значение	Описание
AddressPoint
HouseNumberRange
Street

OperatingHours

Объект

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

Имя	Тип	Описание
mode	string	Значение, используемое в запросе: none или nextSevenDays
timeRanges	OperatingHoursTimeRange[]	Список диапазонов времени в течение следующих 7 дней

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	Идентификатор категории

QueryType

Перечисление

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

Важно: Это свойство устарело и может быть опущено в ответе.

Значение	Описание
NEARBY	Поиск проводился на определённой широте и долготе с определённым радиусом.
NON_NEAR	Поиск был выполнен глобально, без предвзятости к определенной широте и долготе, и никакого определенного радиуса

Response

Объект

Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse в противном случае.

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.
results	SearchAddressResultItem[]	Список результатов API поиска.
summary	SearchSummary	Сводный объект для ответа API поиска

SearchAddressBatchItem

Объект

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

Имя	Тип	Описание
response	Response	Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse в противном случае.
statusCode	integer	Код состояния HTTP-запроса.

SearchAddressBatchProcessResult

Объект

Этот объект возвращается в результате успешного вызова службы пакетного поиска адреса.

Имя	Тип	Описание
batchItems	SearchAddressBatchItem[]	Массив, содержащий результаты пакетной службы.
summary	Summary	Сводка результатов для пакетного запроса

SearchAddressResultItem

Объект

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

Имя	Тип	Описание
address	Address	Адрес результата.
addressRanges	AddressRanges	Описывает диапазон адресов на обеих сторонах улицы для результата поиска. Включены координаты для начальных и конечных расположений диапазона адресов.
dataSources	DataSources	Необязательный раздел. Ссылочный идентификатор геометрии для использования с API получения многоуголь ника поиска.
detourTime	integer	Время отступа в секундах. Возвращается только для вызовов API поиска по маршруту.
dist	number (double)	Расстояние между результатом и геобиями в метрах.
entityType	GeographicEntityType	Тип сущности Geography. Присутствует только в том случае, если entityType был запрошен и доступен.
entryPoints	EntryPoint[]	Массив Записных точек. Они описывают типы входов, доступных в расположении. Тип может быть "main" для главных входов, таких как передние двери, или лобби, и "незначительный", для боковой и задней двери.
id	string	Свойство Id
info	string	Сведения о исходном источнике данных результата. Используется для запросов на поддержку.
matchType	MatchType	Сведения о типе соответствия. Одно из: Адресная точка Диапазон номеровДома Улица
poi	PointOfInterest	Сведения о возвращаемом POI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
position	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".
score	number (double)	Значение в результирующем наборе, указывающее относительную оценку сопоставления между результатами. Это можно использовать для определения того, что результирующий x будет в два раза выше, чем результат y, если значение x равно 2x значению y. Значения различаются между запросами и предназначены только в качестве относительного значения для одного результирующий набор. Важно: Это свойство устарело и может быть опущено в ответе.
type	SearchAddressResultType	Одно из: ПОИ Улица География Точечный адрес Диапазон адресов Перекресток
viewport	BoundingBox	Окно просмотра, охватывающее результат, представленный координатами верхнего и нижнего справа от окна просмотра.

SearchAddressResultType

Перечисление

Одно из:

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

Значение	Описание
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

Объект

Сводный объект для ответа API поиска.

Имя	Тип	Описание
fuzzyLevel	integer	Максимальный нечеткий уровень, необходимый для предоставления результатов.
geoBias	LatLongPairAbbreviated	Указывает, когда внутренняя поисковая система применила геопространственный предвзятость для улучшения ранжирования результатов. В некоторых методах это может повлиять, задав параметры lat и lon, где они доступны. В других случаях это чисто внутренний.
limit	integer	Максимальное количество возвращаемых ответов
numResults	integer	Количество результатов в ответе.
offset	integer	Начальная смещение возвращаемых результатов в полном наборе результатов.
query	string	Параметр запроса, используемый для создания этих результатов поиска.
queryTime	integer	Время, затраченное на разрешение запроса в миллисекундах.
queryType	QueryType	Тип возвращаемого запроса: NEARBY или NON_NEAR. Важно: Это свойство устарело и может быть опущено в ответе.
totalResults	integer	Общее количество найденных результатов.

Summary

Объект

Сводка результатов для пакетного запроса

Имя	Тип	Описание
successfulRequests	integer	Количество успешных запросов в пакете
totalRequests	integer	Общее количество запросов в пакете