Actuator OFF

Owned by Pieter Werbrouck
Last updated: Nov 26, 2021
1 min read

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

{"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:

  • 300

  • 900

  • 1800

  • 3600

Putting 0 will result in a infinite duration.

Example

https://app1pub.smappee.net/dev/v3/servicelocation/123/actuator/2/off

HTTP body:

{"duration": 900}

Result

Empty body





Content