Render - Get Copyright Caption

Gilt für die Tarife S0 und S1.

Die Copyrights-API dient zum Bereitstellen von Copyrightinformationen für den Renderkacheldienst. Zusätzlich zum grundlegenden Copyright für die gesamte Karte stellt die API bestimmte Urheberrechtsgruppen für einige Länder bereit.

Als Alternative zu Den Copyrights für Kartenanforderungen können Untertitel für die Anzeige der Kartenanbieterinformationen auf der Karte empfangen werden.

GET https://atlas.microsoft.com/map/copyright/caption/{format}?api-version=1.0
GET https://atlas.microsoft.com/map/copyright/caption/{format}?subscription-key={subscription-key}&api-version=1.0

URI-Parameter

Name In Required Type Description
format
path True

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

api-version
query True
  • string

Versionsnummer der Azure Maps-API. Die aktuelle Version ist 1.0.

subscription-key
query
  • string

Einer der Azure Maps Schlüssel, die von einem Azure-Zuordnungskonto bereitgestellt werden. Ausführliche Informationen zum Verwalten der Authentifizierung finden Sie in diesem Artikel.

Anforderungsheader

Name Required Type Description
x-ms-client-id
  • string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus Azure Maps Konto-API der Verwaltungsebene abgerufen werden. Informationen zur Verwendung Azure AD Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name Type Description
200 OK

OK

Media Types: "application/json", "application/xml"

400 Bad Request

Ungültige Anforderung: Mindestens ein Parameter wurde falsch angegeben oder schließen sich gegenseitig aus.

Media Types: "application/json", "application/xml"

401 Unauthorized

Der Zugriff wurde aufgrund eines ungültigen Abonnementschlüssels oder eines ungültigen Azure Active Directory Bearertokens verweigert. Stellen Sie sicher, dass Sie einen gültigen Schlüssel für ein aktives Azure-Abonnement und eine Maps-Ressource angeben. Überprüfen Sie andernfalls den WWW-Authenticate-Header auf Fehlercode und beschreibung des bereitgestellten AAD-Bearertokens.

Media Types: "application/json", "application/xml"

Headers

  • WWW-Authenticate: string
403 Forbidden

Berechtigungs-, Kapazitäts- oder Authentifizierungsprobleme.

Media Types: "application/json", "application/xml"

404 Not Found

Nicht gefunden: Die angeforderte Ressource wurde nicht gefunden, aber sie ist in Zukunft möglicherweise wieder verfügbar.

Media Types: "application/json", "application/xml"

500 Internal Server Error

Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten. Versuchen Sie es später noch mal.

Media Types: "application/json", "application/xml"

Sicherheit

azure_auth

Dies sind die Azure Active Directory OAuth2-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder untergeordnete Ressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus mindestens einer Berechtigung für Azure Maps REST-APIs besteht.

Um Szenarien zu implementieren, empfehlen wir die Anzeige von Authentifizierungskonzepten. Zusammenfassend stellt diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte bereit, die zugriffssteuerungsfähig für bestimmte APIs und Bereiche sind.

Hinweis

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id -Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-APIerworben werden.
  • Authorization URList spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
  • Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
  • Derzeit werden Azure Active Directory v1.0-Token unterstützt.

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird. Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Anders ausgedrückt: Diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden. Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

Beispiele

GetCopyrightCaption

Sample Request

GET https://atlas.microsoft.com/map/copyright/caption/json?subscription-key=[subscription-key]&api-version=1.0

Sample Response

{
  "formatVersion": "0.0.1",
  "copyrightsCaption": "© 1992 - 2017 TomTom."
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitionen

CopyrightCaptionResult

Dieses Objekt wird von einem erfolgreichen Copyright Caption-Aufruf zurückgegeben.

ODataError

Dieses Objekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

ODataErrorResponse

Dieses Antwortobjekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

TextFormat

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

CopyrightCaptionResult

Dieses Objekt wird von einem erfolgreichen Copyright Caption-Aufruf zurückgegeben.

Name Type Description
copyrightsCaption
  • string

Copyrights Caption-Eigenschaft

formatVersion
  • string

FormatVersion-Eigenschaft

ODataError

Dieses Objekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

Name Type Description
code
  • string

Der ODataError-Code.

details

Dieses Objekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

message
  • string

Sofern verfügbar eine lesbare Beschreibung des Fehlers.

target
  • string

Falls verfügbar, verursacht das Ziel den Fehler.

ODataErrorResponse

Dieses Antwortobjekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

Name Type Description
error

Dieses Objekt wird zurückgegeben, wenn in der Karten-API ein Fehler auftritt.

TextFormat

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

Name Type Description
json
  • string

Das JavaScript Object Notation-Datenaustauschformat

xml
  • string

Die Extensible Markup Language