Module Interaction

Within the context of a system, a number of actions are possible that interact with the modules it contains.

post
Start all modules

https://aca.example.com/api/control/systems/{id}/start
Starts all modules contained in the specified system.
Request
Response
Path Parameters
id
optional
string
ID of the system to start.
200: OK

post
Stop all modules

https://aca.example.com/api/control/systems/{id}/stop
Stops and deactivates all modules in the specified system.
Request
Response
Path Parameters
id
optional
string
ID of the system to stop.
200: OK

post
Execute a module method

https://aca.example.com/api/control/systems/{id}/exec
Run behaviour that has been exposed by a module. The associated method will be executed and the response returned. If this includes asynchonous or long running behaviour, the result will be awaiting up until a timeout value.
Request
Response
Path Parameters
id
optional
string
ID of the system to execute within.a
Body Parameters
module
required
string
Class name of the module. i.e. `Display`, `Bookings` etc
index
optional
integer
(default 1) Module index in the system.
method
required
string
The name of the method that should be executed.
args
optional
array
Argument to be sent to the method.
200: OK
All response values are wrapped in an array. This ensures that method which return primatives (strings, numbers, booleans or null) still provide a valid JSON response.
[]

get
Retrieve module state

https://aca.example.com/api/control/systems/{id}/state
Query the current state exposed by a module within the system.
Request
Response
Path Parameters
id
optional
string
ID of the system the module is in.
Query Parameters
module
required
string
Class name of the module.
index
optional
integer
(default 1) Module index within the system.
lookup
optional
string
A specified status key of interest. If specified this is the only value returned.
200: OK