Skip to content
Vladyslav edited this page Apr 5, 2021 · 4 revisions
  • Type: settings
  • Path: /settings

Settings entities contain all settings for this system. You can only get the Settings of the System of the API key you are using. You can not query for Settings, just get yours by id. The id of your Settings can be found in the relationships of your System. Do never hardcode this id, always get the system using your API key and get all ids you need from there.

Attributes

  • languages - (List, String) All available languages on this system.
  • app-id-google-play - (String, optional) The id of an App in Google Play Store associated with this System. Use this to show a link to the App.
  • app-id-itunes - (String, optional) The id of an App in App Store associated with this System. Use this to show a link to the App.
  • google-tagmanager-id - (String, optional) The Google Tag Manager id of associated with this System. Use this to integrate GTM in your frontend.
  • is-social-sharing-active - (Bool) Indicates if the Social Sharing feature is activated. If this is set to true, show a button to share this content via Social Networks and do not forget to check if this contet has a * * social-sharing-url specified, because if this is the case you have to share this url instead of the one of this content.
  • is-cookie-warning-enabled - (Bool) If this is set to true, show a valid cookie warning banner.
  • is-language-switcher-enabled - (Bool) If this is set to true, show a language switcher for the user.
  • is-event-package-active - (Bool) If this is set to true, show event package meta data if available.
  • is-recommendations-active - (Bool) Indicates if the Recommendations feature is activated. If this is true, query for recommendations (see -> Content) and show them here.
  • is-forms-active - (Bool) If this is set to true, show elevation graph.
  • forms-base-url - (String) URL host for contentblock 15.

Example Settings Response

{
	"data": {
		"id": "305", 
		"type": "styles", 
		"attributes": {
			"foreground-color": "#222222",
			"background-color": "#fbfbfb", 
			"highlight-color": "#0e98cd", 
			"chrome-header-color": "#ffee00", 
			"icon": "data:image/png;base64, ...",
			"map-pin": "data:image/png;base64, ..."
		}
	}
}