{"_id":"5ab164fd825cbc0077aba499","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c7e975c50cf30010d712a0","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-24T17:20:53.835Z","from_sync":false,"order":27,"slug":"zones-api","title":"Zones API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-20T19:46:05.097Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"59a85c5502c545000f08a7a5","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"transactionId\": \"5abb662e5471f3ea270cfbf1\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","name":"Zone Invalid"},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"contains fields that are not allowed: [ query ]\",\n            \"path\": \"additional parameters\"\n        }\n    ]\n}","language":"json","name":"No Query String Allowed","status":400},{"code":"Zone with id Z5aaac18b97590911c4d252c1 does not exist.","language":"text","name":"Zone Not Found","status":404}]},"examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/zones/Z55aa118b9f590c11c45252c1/services/BinarySwitch.flash HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"value\": \"3\"\n}","language":"http"},{"code":"droplit zone call Z55aa118b9f590c11c45252c1 BinarySwitch.switchOff","language":"text","name":"Droplit Console"},{"code":"droplit.zones.callServiceMethod(\"Z55aa118b9f590c11c45252c1\", \"BinarySwitch.flash\", { \"value\" : \"3\" });","language":"javascript","name":"Droplit SDK"}]},"method":"post","auth":"required","params":[{"_id":"59d8417e6adbaf00262ee854","ref":"","in":"path","required":true,"desc":"The ID of the zone","default":"","type":"string","name":"id"},{"_id":"59d8417e6adbaf00262ee853","ref":"","in":"path","required":true,"desc":"The full name of the service method of the format SERVICE_NAME.METHOD","default":"","type":"string","name":"selector"},{"_id":"59d8417e6adbaf00262ee852","ref":"","in":"body","required":true,"desc":"The parameters of the service method","default":"","type":"string","name":"value"},{"_id":"5ab166ad9975050079734328","ref":"","in":"header","required":true,"desc":"The user's authorization token","default":"","type":"string","name":"authorization"},{"_id":"5ab166ad9975050079734327","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object","default":"","type":"string","name":"content-type"}],"url":"/:id/services/:selector"},"isReference":false,"order":14,"body":"Call an action on devices in a zone.\n\nIf a device does not implement the given action, it will be skipped.\n\nAn account token, server token, or user token may be used to run this endpoint.","excerpt":"","slug":"zones-services-call-method","type":"endpoint","title":"Call Service Method"}

postCall Service Method


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the zone
selector:
required
string
The full name of the service method of the format SERVICE_NAME.METHOD

Body Params

value:
required
string
The parameters of the service method

Headers

authorization:
required
string
The user's authorization token
content-type:
required
string
Specify that the sent data will be a JSON object

Examples


Result Format


Documentation

Call an action on devices in a zone. If a device does not implement the given action, it will be skipped. An account token, server token, or user token may be used to run this endpoint.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}