Skip to content
Bruno Hautzenberger edited this page Nov 29, 2018 · 2 revisions
  • Type: systems
  • Path: /systems

System entities contain all information of the customer's system of the used API key. This means that you can only get the System of the API key you are using. You can not query for other systems.

Attributes

  • display-name - (String) Localized name of this System
  • url - (String) Url of the website of this System
  • language - (String) the default language of this System (see -> Supported Languages)
  • web-client-url - (String, optional) The url of the mobile xamoom web client. Only available if it exists.
  • is-demo - (Bool, optionalwww.mywebsite.com) Indicates if this is a demo system or not.

Relationships

  • style - (Style) The realtionship to the styling information of this system.
  • setting - (Settings) The realtionship to the settings information of this system.
  • menu - (Menu) The realtionship to the menu configuration of this system.

Queries

As mentioned you can not query for systems, but you use the query mechanism to get the system of your API key. To do so query for System, using your API key as always, without any query parameters. This will return you a list with only one system in it, which of course is the only one you have access to. This is the preferred way of doing this, because you should never rely on Ids of any entity. Always use tags ore location identifiers to query for things, or in this case use an empty query. Example GET ../systems

Example System Response

{
	"data": {
		"id": "123", 
		"type": "systems", 
		"attributes": {
			"display-name": "My awesome System!", 
			"url": "https://www.mywebsite.com", 
			"language": "de", 
			"web-client-url": "https://m.mywebsite.com",
			"is-demo": false
		}, 
		"relationships": {
			"menu": {
				"data": {
					"type": "menus", 
					"id": "123"
				}
			}, 
			"setting": {
				"data": {
					"type": "settings", 
					"id": "123"
				}
			}, 
			"style": {
				"data": {
					"type": "styles", 
					"id": "123"
				}
			}
		}
	}
}
You can’t perform that action at this time.