Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Description
Turn a specified Smappee Switch or Comfort plug OFF. This can be done for a specific period or infinite.
Resource URL
https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/actuator/[ACTUATORID]/off
HTTP method
POST
HTTP header
Authorization: Bearer [ACCESS_TOKEN]
[ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.
HTTP body
Code Block | ||
---|---|---|
| ||
{"duration": [DURATION]} |
Parameters
Parameter | Type | Description |
---|---|---|
SERVICELOCATIONID | Path Parameter | The actual id of an accessible service location (see Get Servicelocations) |
ACTUATORID | Path Parameter | The id of the actuator object that will be turned off (see Get Servicelocation Info) |
duration | JSON attribute | The duration in seconds the actuator should be turned off. Possible values are:
Putting 0 will result in a infinite duration. |
Example
https://app1pub.smappee.net/dev/v3/servicelocation/123/actuator/2/off
HTTP body:
Code Block | ||
---|---|---|
| ||
{"duration": 900} |
Result
Code Block | ||
---|---|---|
| ||
Empty body |
Page Properties | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Panel | ||
---|---|---|
| ||
|