Render V2 - Get Copyright From Bounding Box

Ссылка

Service:: Maps

API Version:: 2.1

Область применения: см. ценовые категории.

Возвращает сведения об авторских правах для заданного ограничивающего прямоугольника. Запросы ограничивающего прямоугольного поля должны указывать координаты минимальной и максимальной долготы и широты (EPSG-3857)

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=2.1&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}

With optional parameters:

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=2.1&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}&text={text}

Параметры URI

Name	In	Required	Type	Description
format	path	True	ResponseFormat	Требуемый формат ответа. Значением может быть json или xml.
api-version	query	True	string	Номер версии API Azure Maps Текущая версия — 2.1
maxcoordinates	query	True	array	Максимальные координаты (северо-восточная точка) ограничивающего прямоугольного поля в системе координат широты долготы. Например, 52,41064,4,84228
mincoordinates	query	True	array	Минимальные координаты (юго-западная точка) ограничивающего прямоугольного поля в системе координат широты долготы. Например, 52,41064,4,84228
text	query		IncludeText	Да/нет значения, чтобы исключить текстовые данные из ответа. В ответ будут только изображения и названия стран.

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

Name	Required	Type	Description
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Azure AD безопасности в Azure Maps см. в следующих статьях.

Ответы

Name	Type	Description
200 OK	Copyright	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какой Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Карты.

Это Authorization URL зависит от экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

SuccessfulBoundingBoxCopyrightRequest

Sample Request

HTTP

GET https://atlas.microsoft.com/map/copyright/bounding/json?api-version=2.1&mincoordinates=52.41064,4.84228&maxcoordinates=52.41072,4.84239&text=yes

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.1",
  "generalCopyrights": [
    "© 1992 – 2016 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.",
    "Data Source © 2016 TomTom",
    "based on"
  ],
  "regions": [
    {
      "copyrights": [
        "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2016."
      ],
      "country": {
        "ISO3": "NLD",
        "label": "Netherlands"
      }
    }
  ]
}

Определения

Copyright	Этот объект возвращается из успешного запроса на авторские права
Country	Свойство Country
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IncludeText	Да/нет значения, чтобы исключить текстовые данные из ответа. В ответ будут только изображения и названия стран.
RegionCopyrights
ResponseFormat	Требуемый формат ответа. Значением может быть json или xml.

Copyright

Этот объект возвращается из успешного запроса на авторские права

Name	Type	Description
formatVersion	string	Свойство Format Version
generalCopyrights	string[]	Общий массив авторских прав
regions	RegionCopyrights[]	Массив регионов

Country

Свойство Country

Name	Type	Description
ISO3	string	Свойство ISO3
label	string	Свойство Label

ErrorAdditionalInfo

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

Name	Type	Description
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

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

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

ErrorResponse

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

Name	Type	Description
error	ErrorDetail	Объект ошибки.

IncludeText

Да/нет значения, чтобы исключить текстовые данные из ответа. В ответ будут только изображения и названия стран.

Name	Type	Description
no	string	Исключите текстовые данные из ответа. В ответ будут только изображения и названия стран.
yes	string	Включите все текстовые данные в ответ.

RegionCopyrights

Name	Type	Description
copyrights	string[]	Массив авторских прав
country	Country	Свойство Country

ResponseFormat

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

Name	Type	Description
json	string	Формат обмена данными нотации объектов JavaScript
xml	string	Расширяемый язык разметки