Search - Get Geocoding

Служба:: Maps

Версия API:: 2026-01-01

Используется для получения координат долготы и широты улицы, адреса или названия населенного пункта.
Get Geocoding API — это HTTP-запросGET, который возвращает координаты долготы и широты искомого местоположения.

Во многих случаях полная служба поиска может быть слишком много, например, если вы заинтересованы только в традиционном геокодирование. Поиск также можно получить только для поиска адресов. Геокодирование выполняется путем нажатия на конечную точку геокодирования только с рассматриваемым адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных над данными уровня улицы. Точки интереса (POI) не возвращаются. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, начиная от точных адресов улиц, улиц или перекрестков, а также географических регионов более высокого уровня, таких как городские центры, округа и штаты. В ответе также возвращаются подробные свойства адреса, такие как улица, почтовый индекс, муниципалитет и информация о стране или регионе.

GET {endpoint}/geocode?api-version=2026-01-01

С использованием необязательных параметров:

GET {endpoint}/geocode?api-version=2026-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Hostname сервиса Azure Maps. Используйте `https://atlas.microsoft.com` для публичного облака Azure. Чтобы определить конкретную географию Azure Maps или суверенное облако, см. Azure Maps geographic scope.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
addressLine	query		string	Официальная линия улицы адреса, относящаяся к району, как указано в свойствах населенного пункта или почтового индекса. Обычно этот элемент используется для указания адреса улицы или любого официального адреса. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict	query		string	Часть адреса по стране, например WA. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict2	query		string	Округ для структурированного адреса, например, Кинг. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict3	query		string	Именованная область для структурированного адреса. Этот параметр не следует использовать, если он `query` включен в запрос.
bbox	query		number[]	Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольника определяются значениями долготы и широты. При указании этого параметра географическая область учитывается при вычислении результатов запроса местоположения. Пример: lon1,lat1,lon2,lat2. Минимальный размер: примерно 0,00001 градуса (~0,01 метра). Максимальный размер: до полного глобального масштаба (от -180,-90 до 180,90)
coordinates	query		number[]	Точка на Земле, указанная как долгота и широта. При указании этого параметра учитывается местоположение пользователя, и полученные результаты могут быть более релевантны для пользователя. Пример: координаты &=lon,lat
countryRegion	query		string	Сигнал для результата геокодирования в код региона/страны ISO 3166-1 Alpha-2 , который указан, например, FR. Этот параметр не следует использовать, если он `query` включен в запрос.
locality	query		string	Населенный пункт адреса, например Сиэтл. Этот параметр не следует использовать, если он `query` включен в запрос.
postalCode	query		string	Часть адреса с почтовым индексом. Этот параметр не следует использовать, если он `query` включен в запрос.
query	query		string	Строка, содержащая информацию о местоположении, например адрес или название достопримечательности.
top	query		integer (int32) minimum: 1 maximum: 20	Максимальное количество возвращаемых ответов. По умолчанию: 5, минимум: 1 и максимум: 20.
view	query		string	Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

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

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

Имя

Обязательно

Тип

Описание

Accept-Language

string

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

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

x-ms-client-id

string

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

Ответы

Имя	Тип	Описание
200 OK	GeocodingResponse	Запрос выполнен успешно. Media Types: "application/geo+json", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Media Types: "application/geo+json", "application/json" Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

GeocodingResponse

Запрос выполнен успешно.

Media Types: "application/geo+json", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Media Types: "application/geo+json", "application/json"

Заголовки

x-ms-error-code: string

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

AadToken

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

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

Note

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .
Authorization URL зависит от экземпляра общедоступного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
Управление доступом на основе ролей 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

subscription-key

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

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Search detail address 15127 NE 24th Street, Redmond, WA by query

Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&query=15127 NE 24th Street Redmond WA

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&query=empire state building

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Определения

Имя	Описание
Address	Адрес геокодированного или автозаполнения предполагаемого местоположения, разобранный в структурированные поля. Редкость нормальна: заполнены только поля, которые предоставляет решённая сущность. Например `streetName` , и `streetNumber` отображаются только для адресов на уровне улицы и `intersection` только для результатов дорожных перекрёстков.
AddressAdminDistrictsItem	Административное подразделение, содержащее адрес. Например, штат, провинция или округ. Возвращается как одна запись в родительском `Address.adminDistricts` массиве, где записи упорядочены от самых крупных к мельчайшим.
AddressCountryRegion	Страна или регион, содержащий адрес, идентифицируется по отображённому именю и коду страны ISO 3166-1 Alpha-2. Любое поле может быть опущено в конкретном ответе.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	Метод, используемый для вычисления точки геокода.
ConfidenceEnum	Уровень уверенности, что результат географического расположения соответствует. Используйте это значение вместе с кодами совпадения, чтобы получить более полную информацию о матче. Достоверность геокодированного места основана на множестве факторов, включая относительную важность геокодированного местоположения и местоположение пользователя, если оно указано.
FeatureCollectionEnum	Тип объекта, `GeoJSON` используемый в основе успешных ответов при операциях прямого геокодирования, обратного геокодирования и автозаполнения (включая их пакетные варианты). Единственное значение — `FeatureCollection`, как определено в RFC 7946. `Get Polygon` является единственным исключением: его корень ответа — `GeoJSON Feature`это , см. `FeatureTypeEnum`.
FeaturesItem	Одна запись в `features` массиве `GeocodingResponse`, соответствующая `GeoJSON Feature` форме объекта. Представляет одну геокодированную точку: структурированные данные на `properties`, репрезентативную координату на `geometry`, и необязательный ограничивающий квадрат на `bbox`.
FeaturesItemProperties	Полезная `properties` нагрузка объекта в `GeocodingResponse`. Несёт индикаторы типа сущности и качества соответствия для геокодированного местоположения, его проанализированных адресных компонентов и одной или нескольких точек геокода, закрепляющих местоположение с определёнными координатами.
FeatureTypeEnum	Тип `GeoJSON` объекта для `Feature` объектов. Помечает каждую запись внутри `features` массива `FeatureCollection` ответа (геокодирование, обратное геокодирование, автодополнение) и появляется в корне `Get Polygon` ответа. Единственное значение — `Feature`, как определено в RFC 7946.
GeocodePointsItem	Одна точка геокода для местоположения: координата плюс метаданные, описывающие, как была вычислена точка (`calculationMethod`) и для чего она лучше всего подходит (`usageTypes`). Одна функция обычно возвращает отдельные `Display` и `Route` указывают, чтобы звонящие могли выбрать ту, которая подходит для задачи.
GeocodingResponse	Тело успешного ответа возвращалось по `Get Geocoding` и `Get Reverse Geocoding`, а форма успеха на каждой партии передавалась внутрь `GeocodingBatchResponse.batchItems`. Кодируется как , `GeoJSON FeatureCollection` чей `features` массив содержит по `Feature` одному на каждое геокодированное место.
GeoJsonObjectType	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
Intersection	Детали перекрёстка для адреса, определяемого как дорожное пересечение — угол, где встречаются две или более названных улиц. Заполняется только тогда, когда разрешённая сущность — ; `RoadIntersection`родительский `Address.intersection` элемент в противном случае опускается.
MatchCodesEnum	Значение кода соответствия, указывающее, как сервис геокодирования дал конкретный результат местоположения. Поле `matchCodes` на признаке — это массив этих значений; объедините их с `confidence` и `type` для оценки качества совпадения.
UsageTypeEnum	Предполагаемое использование точки геокода. Геокодовая точка, возвращаемая сервисом, несёт один или несколько типов использования, которые указывают, как клиентское приложение должно потреблять эту точку: например, отображение местоположения на карте против маршрутизации транспортного средства к ней.

Address

Объект

Адрес геокодированного или автозаполнения предполагаемого местоположения, разобранный в структурированные поля. Редкость нормальна: заполнены только поля, которые предоставляет решённая сущность. Например streetName , и streetNumber отображаются только для адресов на уровне улицы и intersection только для результатов дорожных перекрёстков.

Имя	Тип	Описание
addressLine	string	Первая строка адреса, обычно название и номер улицы. Например: `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	Административные подразделения, содержащие адрес, упорядочены от самого грубого к лучшему. Первая запись обычно относится к подразделению первого порядка (например, в штате США или канадской провинции); Последующие записи охватывают более тонкие подразделения, где их определяет страна, зависимость или регион (например, округ с индексом 1).
countryRegion	AddressCountryRegion	Страна или регион, содержащий адрес, с его отображаемым именем и кодом страны ISO 3166-1 Alpha-2.
formattedAddress	string	Полный адрес отображался как одна строка, читаемая человеком, с компонентами, объединёнными в соответствии с конвенциями страны или региона адреса. Пример: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	Детали пересекающихся улиц для адреса, заполняются, когда разрешаемая сущность — a `RoadIntersection` (например, угол двух названных улиц).
locality	string	Местность, в которую находится адрес: обычно город, посёлок или деревня. Например: `"Redmond"`.
neighborhood	string	Названный район внутри местности, когда он идентифицирован.
postalCode	string	Почтовый индекс адреса, когда он определен. Пример: `"98052"`.
streetName	string	Компонент названия улицы в адресе, когда решённая сущность является адресом на уровне улицы. Пример: `"NE 24th St"`.
streetNumber	string	Номер дома или здания на улице, когда решённое лицо — адрес на уровне улицы. Пример: `"15127"`.

AddressAdminDistrictsItem

Объект

Административное подразделение, содержащее адрес. Например, штат, провинция или округ. Возвращается как одна запись в родительском Address.adminDistricts массиве, где записи упорядочены от самых крупных к мельчайшим.

Имя	Тип	Описание
name	string	Полное название района. Например, `"Washington"` для штата США или `"King County"` округа.
shortName	string	Короткая или сокращённая форма названия подразделения, когда оно определено. Например, `"WA"` для штата США. Более тонкие подразделения часто не имеют чётко выраженной короткой формы, в этом случае `shortName` повторения `name` (например `"King County"`, ).

AddressCountryRegion

Объект

Страна или регион, содержащий адрес, идентифицируется по отображённому именю и коду страны ISO 3166-1 Alpha-2. Любое поле может быть опущено в конкретном ответе.

Имя	Тип	Описание
ISO	string	Код страны ISO 3166-1 Alpha-2 для страны или региона. Например, `"US"` для США или `"GB"` для Великобритании.
name	string	Отображаемое название страны или региона. Например: `"США"`.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

CalculationMethodEnum

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

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

Значение	Описание
Interpolation	Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции.
InterpolationOffset	Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции с дополнительным смещением для смещения точки в сторону улицы.
Parcel	Точка геокодирования была сопоставлена с центром участка.
Rooftop	Точка геокодирования была сопоставлена с крышей здания.

ConfidenceEnum

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

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

Достоверность геокодированного места основана на множестве факторов, включая относительную важность геокодированного местоположения и местоположение пользователя, если оно указано.

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

High

Значение	Описание
High	Если достоверность установлена на `High`, найдено одно или несколько сильных совпадений. Множественные `High` совпадения с достоверностью сортируются в порядке ранжирования по важности, если это применимо. Например, достопримечательности имеют значение, а адреса — нет. Если запрос содержит местоположение или вид, рейтинг может измениться соответственно. Например, запрос по локации «Paris» с уверенностью возвращает и «Paris, France», и «Paris, TX `High` ». «Paris, France» всегда занимает первое место по важности, если только местоположение пользователя не указывает, что пользователь находится в Париже, Техас, или если только вид карты не указывает, что пользователь ищет в этой области.
Medium	В некоторых ситуациях возвращенное совпадение может не совпадать с информацией, предоставленной в запросе. Например, в запросе может быть указана адресная информация, а служба геокодирования может сопоставить только почтовый индекс. В этом случае, если сервис геокода уверен, что почтовый индекс совпадает с данными, уверенность устанавливается на `Medium` , и код соответствия указывает `UpHierarchy` на то, что сервис не смог сопоставить всю информацию и был вынужден искать по иерархии вверх. Если информация о расположении в запросе неоднозначна и нет дополнительных сведений для ранжирования местоположений (например, местоположения пользователя или относительная важность расположения), достоверность устанавливается в значение `Medium`. Например, запрос по локации «148th Ave, Bellevue» может с уверенностью вернуть и «148th Ave SE», и «148th Ave NE `Medium` ». Если информация о местоположении в запросе не предоставляет достаточной информации для геокодирования конкретного местоположения, может быть возвращено менее точное значение местоположения, а достоверность устанавливается в `Medium`. Например, если адрес указан, но не найдено совпадение номера дома, результат геокода с `RoadBlock` типом объекта может быть вернут.
Low	Низкая уверенность в матче.

Если достоверность установлена на High, найдено одно или несколько сильных совпадений. Множественные High совпадения с достоверностью сортируются в порядке ранжирования по важности, если это применимо. Например, достопримечательности имеют значение, а адреса — нет.

Если запрос содержит местоположение или вид, рейтинг может измениться соответственно. Например, запрос по локации «Paris» с уверенностью возвращает и «Paris, France», и «Paris, TX High ». «Paris, France» всегда занимает первое место по важности, если только местоположение пользователя не указывает, что пользователь находится в Париже, Техас, или если только вид карты не указывает, что пользователь ищет в этой области.

Medium

В некоторых ситуациях возвращенное совпадение может не совпадать с информацией, предоставленной в запросе. Например, в запросе может быть указана адресная информация, а служба геокодирования может сопоставить только почтовый индекс. В этом случае, если сервис геокода уверен, что почтовый индекс совпадает с данными, уверенность устанавливается на Medium , и код соответствия указывает UpHierarchy на то, что сервис не смог сопоставить всю информацию и был вынужден искать по иерархии вверх.

Если информация о расположении в запросе неоднозначна и нет дополнительных сведений для ранжирования местоположений (например, местоположения пользователя или относительная важность расположения), достоверность устанавливается в значение Medium. Например, запрос по локации «148th Ave, Bellevue» может с уверенностью вернуть и «148th Ave SE», и «148th Ave NE Medium ».

Если информация о местоположении в запросе не предоставляет достаточной информации для геокодирования конкретного местоположения, может быть возвращено менее точное значение местоположения, а достоверность устанавливается в Medium. Например, если адрес указан, но не найдено совпадение номера дома, результат геокода с RoadBlock типом объекта может быть вернут.

Low

Низкая уверенность в матче.

FeatureCollectionEnum

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

Тип объекта, GeoJSON используемый в основе успешных ответов при операциях прямого геокодирования, обратного геокодирования и автозаполнения (включая их пакетные варианты). Единственное значение — FeatureCollection, как определено в RFC 7946. Get Polygon является единственным исключением: его корень ответа — GeoJSON Featureэто , см. FeatureTypeEnum.

Значение	Описание
FeatureCollection	Тип `GeoJSON FeatureCollection` объекта. Появляется как корень каждого успешного геокодирования, обратного геокодирования и ответного тела автозаполнения. `Get Polygon` вместо этого использует `Feature` корень.

FeaturesItem

Объект

Одна запись в features массиве GeocodingResponse, соответствующая GeoJSON Feature форме объекта. Представляет одну геокодированную точку: структурированные данные на properties, репрезентативную координату на geometry, и необязательный ограничивающий квадрат на bbox.

Имя	Тип	Описание
bbox	number[] (double)	Самый маленький прямоугольник, выровненный по осям, содержащий геометрию объекта, в порядке WGS 84 по долготе/широте. Закодировано согласно `[westLon, southLat, eastLon, northLat]`RFC 7946, раздел 5.
geometry	GeoJsonPoint	Первичная `GeoJSON Point` — это геокодированное местоположение, с координатами в порядке долготы/широты WGS 84.
id	string	Опциональный идентификатор, присваиваемый сервисом, для этой функции, когда он доступен.
properties	FeaturesItemProperties	Структурированные данные о геокодированном месте, включая тип сущности, индикаторы качества соответствия, компоненты адреса и одну или несколько точек геокода.
type	FeatureTypeEnum	Тип `GeoJSON` объекта. Всегда `Feature`, как определено в RFC 7946.

FeaturesItemProperties

Объект

Полезная properties нагрузка объекта в GeocodingResponse. Несёт индикаторы типа сущности и качества соответствия для геокодированного местоположения, его проанализированных адресных компонентов и одной или нескольких точек геокода, закрепляющих местоположение с определёнными координатами.

Имя	Тип	Описание
address	Address	Адрес геокодированного местоположения, разбитый по структурированным полям, таким как местность, почтовый индекс, страна/регион и (если доступно) название и номер улицы.
confidence	ConfidenceEnum	Насколько сильно геокодированное местоположение соответствует запросу? Используйте вместе `matchCodes` для полного представления о качестве матча. См. `ConfidenceEnum` список ценностей и факторы, влияющие на рейтинг.
geocodePoints	GeocodePointsItem[]	Одна или несколько точек геокода для местоположения, каждая из которых отмечена, как она была получена (`calculationMethod`) и для чего она лучше всего подходит (`usageTypes`). Например, `Display` для визуального размещения на карте или `Route` для использования в качестве навигационного пункта назначения.
matchCodes	MatchCodesEnum[]	Как сервис геокодирования дал такой результат относительно запроса: прямое совпадение по запрашиваемой специфичности (`Good`), один из нескольких кандидатов (`Ambiguous`), или запасной вариант на менее точный уровень географической иерархии (`UpHierarchy`). Может присутствовать несколько значений. Например, `Ambiguous` плюсовая `UpHierarchy` пара означает, что сервис не смог соответствовать запрошенной конкретности и нашёл несколько совпадений на более грубом уровне. См. `MatchCodesEnum` описания по значениям; комбинировать с `confidence` для полной картины качества совпадения.
type	string	Тип объекта, к которому было разрешено геокодированное местоположение. Один из: , , , `RoadIntersectionNeighborhoodPopulatedPlace`, , `Postcode1`, `AdminDivision1AdminDivision2`, или `CountryRegion`. `RoadBlockAddress`

FeatureTypeEnum

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

Тип GeoJSON объекта для Feature объектов. Помечает каждую запись внутри features массива FeatureCollection ответа (геокодирование, обратное геокодирование, автодополнение) и появляется в корне Get Polygon ответа. Единственное значение — Feature, как определено в RFC 7946.

Значение	Описание
Feature	Тип `GeoJSON Feature` объекта. Появляется на каждой особенности внутри `FeatureCollection` ответа и в корень `Get Polygon` ответа.

GeocodePointsItem

Объект

Одна точка геокода для местоположения: координата плюс метаданные, описывающие, как была вычислена точка (calculationMethod) и для чего она лучше всего подходит (usageTypes). Одна функция обычно возвращает отдельные Display и Route указывают, чтобы звонящие могли выбрать ту, которая подходит для задачи.

Имя	Тип	Описание
calculationMethod	CalculationMethodEnum	Как вычислялась эта точка. Например, прикреплён к крыше здания или интерполирован вдоль центральной линии дороги. См. `CalculationMethodEnum` список ценностей.
geometry	GeoJsonPoint	Координата этого геокода указывает на `GeoJSON Point`, с значениями WGS 84 в порядке долготы/широты.
usageTypes	UsageTypeEnum[]	Для того, для чего лучше всего подходит геокодовая точка: `Display` для визуального размещения на карте или `Route` как пункт назначения маршрута. Точка может нести и то, и другое. См. `UsageTypeEnum` детали по значениям, включая то, как каждое из них расположено для признаков с нетривиальным объёмом.

GeocodingResponse

Объект

Тело успешного ответа возвращалось по Get Geocoding и Get Reverse Geocoding, а форма успеха на каждой партии передавалась внутрь GeocodingBatchResponse.batchItems. Кодируется как , GeoJSON FeatureCollection чей features массив содержит по Feature одному на каждое геокодированное место.

Имя	Тип	Описание
features	FeaturesItem[]	Массив `GeoJSON Feature` объектов, возвращаемых запросом. Каждый `Feature` представляет собой одно геокодированное место: его адресные компоненты, индикаторы качества соответствия и точки геокода отображаются через `properties`, а основная координата — через `geometry`.
nextLink	string	Содержит URL для получения следующей страницы результатов, если ответ пагинирован. Это полезно, когда ответ слишком велик, чтобы его можно было вернуть за один вызов, позволяя пользователям перемещаться по нескольким страницам с результатами.
type	FeatureCollectionEnum	Тип `GeoJSON` объекта успешного `Get Geocoding` или `Get Reverse Geocoding` ответного тела. Всегда `FeatureCollection`, как определено в RFC 7946.

GeoJsonObjectType

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

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Значение	Описание
Point	`GeoJSON Point` геометрии.
MultiPoint	`GeoJSON MultiPoint` геометрии.
LineString	`GeoJSON LineString` геометрии.
MultiLineString	`GeoJSON MultiLineString` геометрии.
Polygon	`GeoJSON Polygon` геометрии.
MultiPolygon	`GeoJSON MultiPolygon` геометрии.
GeometryCollection	`GeoJSON GeometryCollection` геометрии.
Feature	Объект `GeoJSON Feature`.
FeatureCollection	Объект `GeoJSON FeatureCollection`.

GeoJsonPoint

Объект

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
bbox	number[] (double)	Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946.
coordinates	number[] (double)	`Position` — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type	string: Point	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Intersection

Объект

Детали перекрёстка для адреса, определяемого как дорожное пересечение — угол, где встречаются две или более названных улиц. Заполняется только тогда, когда разрешённая сущность — ; RoadIntersectionродительский Address.intersection элемент в противном случае опускается.

Имя	Тип	Описание
baseStreet	string	Главная улица перекрёстка — обычно улица, к которой указывает номер адреса.
displayName	string	Понятное человеком название перекрёстка, которое объединяет перекрёстки, например `"5th Avenue & Main Street"`.
intersectionType	string	Краткая маркировка, описывающая форму пересечения. Например, отличие перекрёстка на уровне от пересечения по уровням, такого как мост или эстакада.
secondaryStreet1	string	Первая перекрёстная улица, которая сходится `baseStreet` на перекрёстке.
secondaryStreet2	string	Второй перекрёсток на перекрёстке, когда один из них присутствует. Населено только на пересечениях трёх и более улиц.

MatchCodesEnum

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

Значение кода соответствия, указывающее, как сервис геокодирования дал конкретный результат местоположения. Поле matchCodes на признаке — это массив этих значений; объедините их с confidence и type для оценки качества совпадения.

Значение	Описание
Good	Сервис геокодирования произвел этот кандидат без расширения запроса: результат совпадает с запросом с запрошенной конкретностью.
Ambiguous	Местоположение — одно из множества возможных совпадений. Например, при запросе по адресу улицы «128 Main St.» ответ может вернуть два адреса для «128 North Main St.» и «128 South Main St.», потому что информации недостаточно для выбора.
UpHierarchy	Местоположение символизирует подъём по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат.

UsageTypeEnum

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

Предполагаемое использование точки геокода. Геокодовая точка, возвращаемая сервисом, несёт один или несколько типов использования, которые указывают, как клиентское приложение должно потреблять эту точку: например, отображение местоположения на карте против маршрутизации транспортного средства к ней.

Значение	Описание
Display	Точка геокода подходит для отображения местоположения на карте. Для объектов с нетривиальными масштабами (например, парк или здание) `Display` точка обычно находится рядом с визуальным центром объекта.
Route	Точка геокода подходит для назначения маршрута. Для объектов с нетривиальными масштабами (например, парк или здание) `Route` точка обычно расположена у входа, доступного для автомобилей, а не в визуальном центре.