JavaScript

Helper methods for JavaScript. A GET request will list the index.

Example request

$ curl -i http://skylar.livingfire.de/api/javascript

Response fields

Path Type Description

_links

Object

Links to other resources
Relation Description

self

Canonical link for this resource

entityProperties

See Entity properties

ttsGreeting

See TTS greeting

ttsKanboardOverdue

See Kanboard overdue

emailKanboardShopping

See Kanboard shopping email

ttsKanboardShopping

See Kanboard shopping TTS

ttsWeather

See TTS Weather

ttsGoogleCalendar

See TTS Google Calendar

listdataGroupDimensions

See Listdata Group-Dimension Mapping

notesOfActiveFirms

See Notes of active Firms

Entity properties

A GET request will retrieve properties needed to create a new Skylar entity.

Response fields
Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/entityProperties' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 86

{"uuid":"79e8bdea-da15-4869-be5f-c31296f16c6e","logstash":"2017-07-01T22:44:25+02:00"}

TTS Greeting

A GET will trigger a TTS greeting.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/ttsGreeting' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{"status":201,"code":"005001","userMessage":"Text-To-Speech created","developerMessage":"message sent into JMS queue"}

Kanboard overdue

A GET will trigger a TTS output of all overdue kanboard tasks in Skylar.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/ttsKanboardOverdue' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{"status":201,"code":"005001","userMessage":"Text-To-Speech created","developerMessage":"message sent into JMS queue"}

Kanboard shopping TTS

A GET will trigger a TTS output with the shopping list.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/ttsKanbaordShopping' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{"status":201,"code":"005001","userMessage":"Text-To-Speech created","developerMessage":"message sent into JMS queue"}

Kanboard shopping email

A GET will trigger a Email with the shopping list.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/emailKanbaordShopping' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 95

{"status":201,"code":"004001","userMessage":"email sent OK","developerMessage":"email sent OK"}

TTS Weather

A GET will trigger a TTS output of a weather report.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/ttsWeather' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{"status":201,"code":"005001","userMessage":"Text-To-Speech created","developerMessage":"message sent into JMS queue"}

TTS Google Calendar

A GET will trigger a TTS output of a Google Calendar events overdue report.

Response fields
Path Type Description

status

Number

a HTTP status code like 201

code

String

native Skylar code like 005001 see SkylarCodeConstant.java

userMessage

String

Message shown in the user interface

developerMessage

String

Additional information for debugging
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/ttsGoogleCalendar' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{"status":201,"code":"005001","userMessage":"Text-To-Speech created","developerMessage":"message sent into JMS queue"}

Listdata Group-Dimension Mapping

A GET will retrieve a mapping of all dimensions to their coresponding groups. Group and dimension in this context mean the properties: Listdata.group and Listdata.dimension

Response fields
Path Type Description

[].group

String

group

[].dimension

String

dimension
Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/listdataGroupDimensions' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 84

[{"group":"body","dimension":"bodyWeight"},{"group":"body","dimension":"heartrate"}]

Notes of Active Firms

A GET will retrieve a array of Strings with all Note.description of Firm.active == true. The data can be uses as an overview of all notes. (activity log)

Curl request
$ curl 'http://skylar.livingfire.de/api/javascript/notesOfActiveFirms' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2

[]