Maps SDK for Web

tt.services.copyrightsCaption

New version copyrightsCaptionV2

The new copyrightsCaptionV2 service was introduced. We highly recommend using the new V2 version.

Old version

  • The copyrightsCaption service has been deprecated.
  • This service will be withdrawn following a 12 months deprecation period.
  • The planned withdrawal period is June of 2022.
  • Following withdrawal, requests to this service may receive an HTTP 404 error in response.

The copyright caption service implementation provides a caption that is supposed to be displayed on a link that provides the full copyright notice. The response is not changed often.

This service is supposed to be called once when user has the map displayed for the first time.

Response

The response from the service is an object containing "copyrightsCaption", e.g.:

{
  "formatVersion": "0.0.1",
  "copyrightsCaption": "© 1992 - 2021 TomTom."
}

The response is also extended with getTrackingId() method, which returns the Tracking-ID associated with the request.

This text ("© 1992 - 2021 TomTom.") has to be displayed as a copyrights prompt when using TomTom services. The caption should be clickable. User should be presented with the full copyrights notice when the caption is clicked. Full copyright notice can be retrieved from the Copyrights service.

Constructor

tt.services.copyrightsCaption([options], [additionalOptions])

Example
tt.services.copyrightsCaption({
  key: <Your API key>
 }).then(function(response) {
  console.log(response);
});
Parameters
Name Description
options
Object
default:None
additionalOptions
Object
default:None 		Additional options to be passed to the service.
additionalOptions.abortSignal
Object
default:None 		Signal created with abortController.
Use AbortController to cancel requests in progress.
Example
var abortController = new AbortController();
var options = {};
tt.services.calculateRoute(options, { abortSignal: abortController.signal })
    .then(function(response) { console.log(response) });
    .catch(function(error) {
        if (abortController.signal.aborted === true) {
            console.log('Request aborted.');
        }
    });
abortController.abort();
options.key
String
default:None 		A valid API Key for the requested service.
Key is required to make use of the given service. It can be issued in the Developer Portal.
options.protocol
"http" | "https"
default:"https" 		The protocol type to be used in the calls.
Represents the type of protocol used to perform a service call.
options.trackingId
String
default:uuid 		Sets value of "Tracking-ID" header.
Specifies an identifier for the request. If not set by the user, UUID is generated for each call.
  • It can be used to trace a call.
  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
  • An example of the format that matches this regular expression is UUID: (e.g. 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122.
  • If specified, it is replicated in the Tracking-ID Response header.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.