[ { "type": "post", "url": "/alarm", "title": "create an alarm", "name": "createAlarm", "group": "Alarm", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

Name of the alarm.

" }, { "group": "Parameter", "type": "datetime", "optional": false, "field": "datetime", "description": "

Datetime of the alarm when the alarm is at a specific date

" }, { "group": "Parameter", "type": "time", "optional": false, "field": "time", "description": "

Time of the alarm when it's a reccurring alarm

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "dayofweek", "description": "

The day the alarm should ring (reccurring alarm)

" }, { "group": "Parameter", "type": "boolean", "optional": false, "field": "active", "description": "

If the alarm is active or not

" } ] } }, "version": "0.0.0", "filename": "api/controllers/AlarmController.js", "groupTitle": "Alarm", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the alarm.

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "datetime", "description": "

Datetime of the alarm when the alarm is at a specific date

" }, { "group": "Success 200", "type": "time", "optional": false, "field": "time", "description": "

Time of the alarm when it's a reccurring alarm

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "dayofweek", "description": "

The day the alarm should ring (reccurring alarm)

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "active", "description": "

If the alarm is active or not

" } ] } } }, { "type": "delete", "url": "/alarm/:id", "title": "delete an alarm", "name": "deleteAlarm", "group": "Alarm", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "success", "description": "" } ] } }, "version": "0.0.0", "filename": "api/controllers/AlarmController.js", "groupTitle": "Alarm" }, { "type": "get", "url": "/alarm", "title": "get all alarms", "name": "getAlarm", "group": "Alarm", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/AlarmController.js", "groupTitle": "Alarm", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the alarm.

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "datetime", "description": "

Datetime of the alarm when the alarm is at a specific date

" }, { "group": "Success 200", "type": "time", "optional": false, "field": "time", "description": "

Time of the alarm when it's a reccurring alarm

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "dayofweek", "description": "

The day the alarm should ring (reccurring alarm)

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "active", "description": "

If the alarm is active or not

" } ] } } }, { "type": "post", "url": "/area", "title": "create an area", "name": "createArea", "group": "Area", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/AreaController.js", "groupTitle": "Area", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

Name of the area.

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "radius", "description": "

The radius of the area in meters

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the area.

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "radius", "description": "

The radius of the area in meters

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

The owner of the area

" } ] } } }, { "type": "delete", "url": "/area/:id", "title": "delete an area", "name": "deleteArea", "group": "Area", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/AreaController.js", "groupTitle": "Area" }, { "type": "get", "url": "/area", "title": "get all areas", "name": "getArea", "group": "Area", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/AreaController.js", "groupTitle": "Area", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the area.

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "radius", "description": "

The radius of the area in meters

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

The owner of the area

" } ] } } }, { "type": "patch", "url": "/area/:id", "title": "update an area", "name": "updateArea", "group": "Area", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/AreaController.js", "groupTitle": "Area", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

Name of the area.

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "radius", "description": "

The radius of the area in meters

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the area.

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "radius", "description": "

The radius of the area in meters

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

The owner of the area

" } ] } } }, { "type": "get", "url": "/brain/classify", "title": "send a question to gladys", "name": "classify", "group": "Brain", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "q", "description": "

the message for Gladys

" } ] } }, "version": "0.0.0", "filename": "api/controllers/BrainController.js", "groupTitle": "Brain" }, { "type": "post", "url": "/brain/trainnew", "title": "re-train the sentence model", "name": "train", "group": "Brain", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/BrainController.js", "groupTitle": "Brain" }, { "type": "post", "url": "/devicestate", "title": "create a deviceState", "name": "createDeviceState", "group": "DeviceState", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceStateController.js", "groupTitle": "DeviceState", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "value", "description": "

The value of the state

" }, { "group": "Success 200", "type": "datetime", "optional": true, "field": "datetime", "description": "

When the state occurred

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "devicetype", "description": "

The deviceType ID

" } ] } } }, { "type": "get", "url": "/devicestate/create", "title": "create a deviceState (GET)", "name": "createDeviceStateGet", "group": "DeviceState", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceStateController.js", "groupTitle": "DeviceState", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "value", "description": "

The value of the state

" }, { "group": "Success 200", "type": "datetime", "optional": true, "field": "datetime", "description": "

When the state occurred

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "devicetype", "description": "

The deviceType ID

" } ] } } }, { "type": "get", "url": "/devicestate", "title": "get all deviceStates", "name": "getDeviceState", "group": "DeviceState", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": false, "field": "take", "description": "

the number of deviceState to return

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "skip", "description": "

the number of deviceState to skip

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceStateController.js", "groupTitle": "DeviceState", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "value", "description": "

The value of the state

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "datetime", "description": "

When the state occurred

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "devicetype", "description": "

The deviceType

" } ] } } }, { "type": "post", "url": "/devicetype", "title": "create a deviceType", "name": "createDeviceType", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": true, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Parameter", "type": "boolean", "optional": true, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Parameter", "type": "boolean", "optional": true, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } } }, { "type": "delete", "url": "/devicetype/:id", "title": "delete deviceType", "name": "deleteDeviceType", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType" }, { "type": "post", "url": "/devicetype/:id/exec", "title": "change a deviceType state", "name": "execDeviceType", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "float", "optional": true, "field": "value", "description": "

New value to apply to the deviceType

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "value", "description": "

The value of the state

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "datetime", "description": "

When the state occurred

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "devicetype", "description": "

The deviceType

" } ] } } }, { "type": "get", "url": "/device/:id/devicetype", "title": "get by device", "name": "getByDevice", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceController.js", "groupTitle": "DeviceType", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } } }, { "type": "get", "url": "/devicetype", "title": "get all deviceType", "name": "getDeviceType", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": false, "field": "take", "description": "

the number of deviceType to return

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "skip", "description": "

the number of deviceType to skip

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } } }, { "type": "get", "url": "/devicetype/:id", "title": "get by id", "name": "getDeviceTypeById", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "lastValue", "description": "

The last value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "lastValueId", "description": "

The ID of the last deviceState of this deviceType

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "lastChanged", "description": "

The last time this deviceType changed his value

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType" }, { "type": "get", "url": "/devicetype/room", "title": "get by room", "name": "getDeviceTypeByRoom", "group": "DeviceType", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "float", "optional": false, "field": "lastValue", "description": "

The last value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "lastValueId", "description": "

The ID of the last deviceState of this deviceType

" }, { "group": "Success 200", "type": "datetime", "optional": false, "field": "lastChanged", "description": "

The last time this deviceType changed his value

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the deviceType.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "type", "description": "

The type of the deviceType (binary, temperature, color ...)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify this deviceType

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "tag", "description": "

The name of the deviceType for text/voice recognition

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "sensor", "description": "

If the deviceType is a sensor or not

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "unit", "description": "

The unit of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "min", "description": "

The min value of the deviceType

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "max", "description": "

The max value of the deviceType

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "display", "description": "

If the deviceType should be displayed in the view

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "device", "description": "

The ID of the device of this deviceType

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceTypeController.js", "groupTitle": "DeviceType" }, { "type": "post", "url": "/device", "title": "create a device", "name": "createDevice", "group": "Device", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceController.js", "groupTitle": "Device", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

Name of the device.

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "protocol", "description": "

The protocol the device is using (zwave, wifi)

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "service", "description": "

The service handling the device (a module name)

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "identifier", "description": "

An unique identifier to identify the device

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

The room where the device is

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the device.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "protocol", "description": "

The protocol the device is using (zwave, wifi)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "service", "description": "

The service handling the device (a module name)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify the device

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

The room where the device is

" } ] } } }, { "type": "delete", "url": "/device/:id", "title": "delete a device", "name": "deleteDevice", "group": "Device", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceController.js", "groupTitle": "Device" }, { "type": "get", "url": "/device", "title": "get all devices", "name": "getDevice", "group": "Device", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": false, "field": "take", "description": "

the number of device to return

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "skip", "description": "

the number of device to skip

" } ] } }, "version": "0.0.0", "filename": "api/controllers/DeviceController.js", "groupTitle": "Device", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the device.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "protocol", "description": "

The protocol the device is using (zwave, wifi)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "service", "description": "

The service handling the device (a module name)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify the device

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

The room where the device is

" } ] } } }, { "type": "patch", "url": "/device/:id", "title": "update a device", "name": "updateDevice", "group": "Device", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/DeviceController.js", "groupTitle": "Device", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

Name of the device.

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "protocol", "description": "

The protocol the device is using (zwave, wifi)

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "service", "description": "

The service handling the device (a module name)

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "identifier", "description": "

An unique identifier to identify the device

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

The room where the device is

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Name of the device.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "protocol", "description": "

The protocol the device is using (zwave, wifi)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "service", "description": "

The service handling the device (a module name)

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "identifier", "description": "

An unique identifier to identify the device

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

The room where the device is

" } ] } } }, { "type": "post", "url": "/event", "title": "create event", "name": "CreateEvent", "group": "Event", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/EventController.js", "groupTitle": "Event", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

Event code you want to create

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "user", "description": "

id of the user concerned by the event (only for user-related event)

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "house", "description": "

id of the house where the events take place

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

id of the room where the events take place

" }, { "group": "Parameter", "type": "Datetime", "optional": true, "field": "datetime", "description": "

If you want to specify a specific datetime when the event took place

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

Event id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

User id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

Room id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "eventtype", "description": "

Event Type id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Event code

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Event name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Event description

" } ] } } }, { "type": "get", "url": "/event/create", "title": "create event (GET)", "name": "CreateEventGet", "group": "Event", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/EventController.js", "groupTitle": "Event", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

Event code you want to create

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "user", "description": "

id of the user concerned by the event (only for user-related event)

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "house", "description": "

id of the house where the events take place

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

id of the room where the events take place

" }, { "group": "Parameter", "type": "Datetime", "optional": true, "field": "datetime", "description": "

If you want to specify a specific datetime when the event took place

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

Event id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

User id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

Room id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "eventtype", "description": "

Event Type id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Event code

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Event name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Event description

" } ] } } }, { "type": "get", "url": "/event", "title": "get all events", "name": "GetEvents", "group": "Event", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "take", "description": "

Number of events to return

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "skip", "description": "

Where to start (for pagination)

" } ] } }, "version": "0.0.0", "filename": "api/controllers/EventController.js", "groupTitle": "Event", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

Event id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

User id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

Room id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "eventtype", "description": "

Event Type id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Event code

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Event name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Event description

" } ] } } }, { "type": "get", "url": "/house", "title": "get all houses", "name": "GetHouses", "group": "House", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/HouseController.js", "groupTitle": "House", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "uuid", "optional": false, "field": "uuid", "description": "

House unique id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The name of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address", "description": "

The address of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "city", "description": "

The city

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "postcode", "description": "

Postcode

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "country", "description": "

Country

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude of the house

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude of the house

" } ] } } }, { "type": "patch", "url": "/house/:id", "title": "create a house", "name": "createHouse", "group": "House", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/HouseController.js", "groupTitle": "House", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "uuid", "optional": false, "field": "uuid", "description": "

House unique id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

The name of the house

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "

The address of the house

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "city", "description": "

The city

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "postcode", "description": "

Postcode

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "country", "description": "

Country

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude of the house

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude of the house

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "uuid", "optional": false, "field": "uuid", "description": "

House unique id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The name of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address", "description": "

The address of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "city", "description": "

The city

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "postcode", "description": "

Postcode

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "country", "description": "

Country

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude of the house

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude of the house

" } ] } } }, { "type": "post", "url": "/house", "title": "create a house", "name": "createHouse", "group": "House", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/HouseController.js", "groupTitle": "House", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "uuid", "optional": false, "field": "uuid", "description": "

House unique id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

The name of the house

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "

The address of the house

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "city", "description": "

The city

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "postcode", "description": "

Postcode

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "country", "description": "

Country

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude of the house

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude of the house

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "uuid", "optional": false, "field": "uuid", "description": "

House unique id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The name of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address", "description": "

The address of the house

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "city", "description": "

The city

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "postcode", "description": "

Postcode

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "country", "description": "

Country

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude of the house

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude of the house

" } ] } } }, { "type": "delete", "url": "/house/:id", "title": "delete a house", "name": "deleteHouse", "group": "House", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/HouseController.js", "groupTitle": "House" }, { "type": "get", "url": "/house/:id/user", "title": "get all user in a house", "name": "getUserHouse", "group": "House", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/HouseController.js", "groupTitle": "House", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "post", "url": "/location", "title": "create location", "name": "createLocation", "group": "Location", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/LocationController.js", "groupTitle": "Location", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "datetime", "optional": true, "field": "datetime", "description": "

Datetime of the location

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Parameter", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Parameter", "type": "float", "optional": true, "field": "altitude", "description": "

Altitude

" }, { "group": "Parameter", "type": "float", "optional": true, "field": "accuracy", "description": "

Accuracy in meters

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "datetime", "optional": false, "field": "datetime", "description": "

Datetime of the location

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "latitude", "description": "

Latitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "longitude", "description": "

Longitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "altitude", "description": "

Altitude

" }, { "group": "Success 200", "type": "float", "optional": false, "field": "accuracy", "description": "

Accuracy in meters

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "user", "description": "

User ID

" } ] } } }, { "type": "get", "url": "/message/user/:id", "title": "Get messages", "name": "GetMessages", "group": "Message", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": false, "field": "take", "description": "

Number of elements to return

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "skip", "description": "

Number of elements to skip

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MessageController.js", "groupTitle": "Message", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

primary key

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "text", "description": "

Message content

" }, { "group": "Success 200", "type": "Datetime", "optional": false, "field": "datetime", "description": "

Datetime of the message

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "sender", "description": "

Message sender id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "receiver", "description": "

Message receiver id

" }, { "group": "Success 200", "type": "uuid", "optional": false, "field": "conversation", "description": "

Conversation unique ID (identify uniquely a discussion)

" } ] } } }, { "type": "post", "url": "/message", "title": "Send message", "name": "SendMessage", "group": "Message", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MessageController.js", "groupTitle": "Message", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "text", "description": "

Message content

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "receiver", "description": "

The person you are sending the message too. Put null to contact Gladys.

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

primary key

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "text", "description": "

Message content

" }, { "group": "Success 200", "type": "Datetime", "optional": false, "field": "datetime", "description": "

Datetime of the message

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "sender", "description": "

Message sender id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "receiver", "description": "

Message receiver id

" }, { "group": "Success 200", "type": "uuid", "optional": false, "field": "conversation", "description": "

Conversation unique ID (identify uniquely a discussion)

" } ] } } }, { "type": "post", "url": "/house/:id/mode", "title": "change mode", "name": "changeMode", "group": "Mode", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "mode", "description": "

Mode code

" } ] } }, "version": "0.0.0", "filename": "api/controllers/ModeController.js", "groupTitle": "Mode", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Integer", "optional": false, "field": "id", "description": "

Event id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "user", "description": "

User id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "room", "description": "

Room id

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "eventtype", "description": "

Event Type id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Event code

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

Event name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Event description

" } ] } } }, { "type": "post", "url": "/mode", "title": "create mode", "name": "createMode", "group": "Mode", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/ModeController.js", "groupTitle": "Mode", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

Unique code of the Mode

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

name

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "description", "description": "

Description

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Unique code of the Mode

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Description

" } ] } } }, { "type": "delete", "url": "/mode/:id", "title": "delete mode", "name": "deleteMode", "group": "Mode", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/ModeController.js", "groupTitle": "Mode" }, { "type": "get", "url": "/mode", "title": "get all modes", "name": "getModes", "group": "Mode", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/ModeController.js", "groupTitle": "Mode", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "code", "description": "

Unique code of the Mode

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

name

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "description", "description": "

Description

" } ] } } }, { "type": "post", "url": "/music/flushqueue", "title": "Flush Queue", "name": "MusicFlushQueue", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/currenttrack", "title": "Get Current Track", "name": "MusicGetCurrentTrack", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "title", "description": "

Title of the current track

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "artist", "description": "

Artist of the current track

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/queue", "title": "Get Queue", "name": "MusicGetCurrentTrack", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "title", "description": "

Title of the current track

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "artist", "description": "

Artist of the current track

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/muted", "title": "Get Muted", "name": "MusicGetMuted", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "muted", "description": "

Returns true if the music is muted

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/playing", "title": "Get Playing", "name": "MusicGetPlaying", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "playing", "description": "

Returns true if the music is playing

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/playlist", "title": "Get Playlists", "name": "MusicGetPlaylist", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "title", "description": "

Title of the playlist

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "get", "url": "/music/volume", "title": "Get Volume", "name": "MusicGetVolume", "group": "Music", "permission": [ { "name": "authenticated" } ], "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "integer", "optional": false, "field": "volume", "description": "

Volume of the music

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/next", "title": "Next", "name": "MusicNext", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/playplaylist", "title": "Play playlist", "name": "MusicNext", "group": "Music", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "identifier", "description": "

Identifier of the playlist

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/pause", "title": "Pause", "name": "MusicPause", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/play", "title": "Play", "name": "MusicPlay", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/previous", "title": "Previous", "name": "MusicPrevious", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/queue", "title": "Queue", "name": "MusicQueue", "group": "Music", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "uri", "description": "

Unique uri identifying the music to play

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/muted", "title": "Set muted", "name": "MusicSetMuted", "group": "Music", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "boolean", "optional": false, "field": "muted", "description": "

true if sound is muted

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/volum", "title": "Set Volume", "name": "MusicSetVolume", "group": "Music", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "integer", "optional": false, "field": "volume", "description": "

Volume level

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/music/stop", "title": "Stop", "name": "MusicStop", "group": "Music", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/MusicController.js", "groupTitle": "Music", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Integer", "optional": true, "field": "devicetype", "description": "

DeviceType ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "room", "description": "

Room ID

" } ] } }, "description": "

You can put the devicetype attribute OR the room attribute to determine in which room you want to control the music/which precise deviceType is playing.

" }, { "type": "post", "url": "/room", "title": "create room", "name": "createRoom", "group": "Room", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/RoomController.js", "groupTitle": "Room", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

The Name of the room

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "house", "description": "

House ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "permission", "description": "

Permission

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The Name of the room

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House ID

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "permission", "description": "

Permission

" } ] } } }, { "type": "delete", "url": "/room/:id", "title": "delete room", "name": "deleteRoom", "group": "Room", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/RoomController.js", "groupTitle": "Room" }, { "type": "get", "url": "/room", "title": "get rooms", "name": "getRooms", "group": "Room", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "integer", "optional": false, "field": "take", "description": "

number of rooms to return

" }, { "group": "Parameter", "type": "integer", "optional": false, "field": "skip", "description": "

number of rooms to skip

" } ] } }, "version": "0.0.0", "filename": "api/controllers/RoomController.js", "groupTitle": "Room", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The Name of the room

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House ID

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "permission", "description": "

Permission

" } ] } } }, { "type": "patch", "url": "/room/:id", "title": "update room", "name": "updateRoom", "group": "Room", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/RoomController.js", "groupTitle": "Room", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

The Name of the room

" }, { "group": "Parameter", "type": "Integer", "optional": false, "field": "house", "description": "

House ID

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "permission", "description": "

Permission

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "name", "description": "

The Name of the room

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "house", "description": "

House ID

" }, { "group": "Success 200", "type": "Integer", "optional": false, "field": "permission", "description": "

Permission

" } ] } } }, { "type": "post", "url": "/script/:id/exec", "title": "Execute a script", "name": "execScript", "group": "Script", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/ScriptController.js", "groupTitle": "Script" }, { "type": "post", "url": "/user/user", "title": "Login", "name": "LoginUser", "group": "User", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "password", "description": "

Password

" } ] } }, "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "get", "url": "/user/whoami", "title": "WhoAmI", "name": "WhoAmIUser", "group": "User", "permission": [ { "name": "authenticated" } ], "description": "

Return currently connected user

", "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "post", "url": "/user", "title": "create a user", "name": "createUser", "group": "User", "permission": [ { "name": "authenticated" }, { "name": "admin" } ], "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "password", "description": "

A Password

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "delete", "url": "/user/:id", "title": "delete a user", "name": "deleteUser", "group": "User", "permission": [ { "name": "authenticated" }, { "name": "admin" } ], "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "get", "url": "/user", "title": "get all users", "name": "getUsers", "group": "User", "permission": [ { "name": "authenticated" }, { "name": "admin" } ], "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "patch", "url": "/user/:id", "title": "update a user", "name": "updateUser", "group": "User", "permission": [ { "name": "authenticated" } ], "version": "0.0.0", "filename": "api/controllers/UserController.js", "groupTitle": "User", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "firstname", "description": "

Firstname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "lastname", "description": "

Lastname

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "email", "description": "

Email

" }, { "group": "Success 200", "type": "date", "optional": false, "field": "birthdate", "description": "

Birthdate

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "gender", "description": "

gender

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "language", "description": "

language of the user

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "password", "description": "

A Password

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "assistantName", "description": "

The name of your assistant for you

" }, { "group": "Success 200", "type": "integer", "optional": false, "field": "preparationTimeAfterWakeUp", "description": "

Time to prepare after wake up

" }, { "group": "Success 200", "type": "String", "allowedValues": [ "admin", "habitant", "guest" ], "optional": false, "field": "role", "description": "

The role of the user in the system

" } ] } } }, { "type": "get", "url": "/weather", "title": "get weather", "name": "GetWeather", "group": "Weather", "permission": [ { "name": "authenticated" } ], "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Float", "optional": false, "field": "latitude", "description": "

The latitude where you want the weather

" }, { "group": "Parameter", "type": "Float", "optional": false, "field": "longitude", "description": "

The longitude where you want the weather

" }, { "group": "Parameter", "type": "Integer", "optional": true, "field": "offset", "description": "

(in hour) If you want to get the weather in the future

" } ] } }, "version": "0.0.0", "filename": "api/controllers/WeatherController.js", "groupTitle": "Weather", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Float", "optional": false, "field": "temperature", "description": "

temperature

" }, { "group": "Success 200", "type": "Float", "optional": false, "field": "humidity", "description": "

humidity

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "weather", "description": "

The code of the weather (rain, cloud)

" }, { "group": "Success 200", "type": "Float", "optional": false, "field": "pressure", "description": "

pressure

" } ] } } } ]