Dela via

Render - Get Copyright Caption

Tjänst:
Maps
API-version:
2024-04-01

Använd för att hämta upphovsrättsinformation som ska användas vid återgivning av en panel.
Get Copyright Caption-API:et är en HTTP GET-begäran som utformats för att hantera upphovsrättsinformation som ska användas med paneler som begärs från renderningstjänsten. Förutom en grundläggande upphovsrätt för hela kartan kan den tjäna specifika grupper av upphovsrätter för vissa länder/regioner.

Som ett alternativ till upphovsrätt för kartbegäran kan den också returnera bildtexter för att visa providerinformation på kartan.

GET {endpoint}/map/copyright/caption/{format}?api-version=2024-04-01

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

format
 path True

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller XML-.
api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

Svar

Name Typ Description
200 OK

CopyrightCaption

Begäran har slutförts.
Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Varje användare, grupp eller tjänstehuvudperson kan beviljas åtkomst via en inbyggd roll eller en anpassad roll bestående av en eller flera behörigheter för att Azure Maps REST-API:er.\n\nFör att implementera scenarier rekommenderar vi att man tittar på autentiseringskoncept. Sammanfattningsvis erbjuder denna säkerhetsdefinition en lösning för modellering av applikationer via objekt som kan åtkomstkontroll på specifika API:er och scopes.\n\n#### Anteckningar\n* Denna säkerhetsdefinition kräver användning av x-ms-client-id-headern för att ange vilken Azure Maps resurs applikationen begär åtkomst till. Detta kan hämtas från Maps management API.\n* \nAuthorization URL är specifik för den Azure publika molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. \n* \nDen Azure rollbaserade åtkomstkontrollen konfigureras från Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST API:er.\n* \nAnvändning av Azure Maps Web SDK möjliggör konfigurationsbaserad installation av en applikation för flera användningsområden.\n* För mer information om Microsofts identitetsplattform, se Microsofts identitetsplattform översikt.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Detta är en delad nyckel som provisioneras när du Skapa ett Azure Maps-konto i Azure-portalen eller med PowerShell, CLI, Azure-SDK:er eller REST API.\n\n Med denna nyckel kan vilken applikation som helst komma åt alla REST API:er. Med andra ord kan denna nyckel användas som en huvudnyckel i det konto där de utfärdas.\n\n För offentligt exponerade applikationer rekommenderar vi att använda konfidentiella klientapplikationer för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras säkert.

Typ: apiKey
I: header

SAS Token

Detta är en delad åtkomstsignaturtoken som skapas från List SAS-operationen på Azure Maps-resursen via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST-API:er.\n\n Med denna token är varje applikation auktoriserad att få åtkomst med Azure rollbaserade åtkomstkontroller och finkornig kontroll till utgångsdatum, hastighet och region(er) för användning för den specifika token. Med andra ord kan SAS-token användas för att låta applikationer kontrollera åtkomsten på ett säkrare sätt än den delade nyckeln.\n\n För offentligt exponerade applikationer är vår rekommendation att konfigurera en specifik lista över tillåtna ursprung på Map-kontots resurs för att begränsa renderingsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Exempelbegäran

GET {endpoint}/map/copyright/caption/json?api-version=2024-04-01

Exempelsvar

Statuskod:
200 
{
  "copyrightsCaption": "© 1992 - 2022 TomTom.",
  "formatVersion": "0.0.1"
}

Definitioner

Name Description
CopyrightCaption

Det här objektet returneras från ett lyckat upphovsrättsanrop
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Detaljerna om felet.
ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).
ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller XML-.

CopyrightCaption

Objekt

Det här objektet returneras från ett lyckat upphovsrättsanrop

Name Typ Description
copyrightsCaption

string

Egenskapen Copyrights Caption
formatVersion

string

Formatversionsegenskap

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).

Name Typ Description
error

ErrorDetail

Felobjektet.

ResponseFormat

Uppräkning

Önskat format för svaret. Värdet kan vara antingen json eller XML-.

Värde Description
json

JavaScript-objekt notationens datautbytesformat
xml

Det utökningsbara markupspråket