REST API Service Objects SERVICE

April 13, 2023 at 2:39 AM

SERVICE object

The JSON SERVICE object returns the meta-data regarding the SpringCard Companion Service.

Use Get service’s meta-data to retrieve the SERVICE object.

Object definition

Field name Type Status Description
Name string always Constant “SpringCard Companion Service”
Version string always Version of the service (release year . release month . release day . incrementing build number)
UniqueId string always Unique Identifier of the service (signature of the computer)
API string always Version of the API (“1.0” for current specification)
Platform string always The operating system the Service is running on.
Desktop systems: windows, linux or mac
Mobile systems: android or ios
In-device: freertos+lwip
Mode string always How has the Service been launched:
console: command-line mode
tray: windowed application running in system’s tray
service: background service (or daemon) mode
device: running in the SpringCard device itself
Install string always How has the Service been launched:
portable: not realy installed
user: installed within user’s profile
global: installed for all users (but not as a system service or daemon)
system: installed as a system service or daemon)
unknown: other cases
Timeout integer always The timeout (in second) to apply when invoking the service’s functions
WebSocketPort integer always The listening port of the WebSocket (0 if disabled)

Example

{
	"Name": "SpringCard Companion Service",
	"Version": "18.4.19.2346",
	"API": "1.0",
	"Platform": "windows",
	"Mode": "tray",
	"Install": "global",
	"Timeout": 10,
	"WebSocketPort": 3997
}