/api/
. The content of the POST is JSON and contains a minimum of two parameters.SYSTEM
OR MODULE
system
is used for core system functions such as logging users in and performing system setup as well as managing notifications. module
is used when sending a request to any of the default modules or to any user modules. The value is set to the module with which you are trying to communicate. For example, "system": "notifications"
or "module": "RandomRoll"
.ACTION
"action": "listNotifications"
or "action": "getRandomRollRolls"
.{"system": "notifications", "action": "listNotifications"}
will return a list of all of the current unread notifications (as JSON). However, there are some functions, such as addNotification
, that require additional parameters (in this case message
). To create a new notifications, one would use the following request: