{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/presence/state","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"presence\": true\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"mode\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}","name":"Invalid Mode"},{"status":400,"name":"Invalid Zone","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":404,"name":"Zone Not Found","language":"text","code":"Zone with id Z5b9241a6ecf941b0662918ba does not exist."}]},"settings":"59a85c5502c545000f08a7a5","params":[{"name":"id","type":"string","default":"","desc":"The ID of the zone.","required":true,"in":"path","ref":"","_id":"5b427a127a40bd000367c88b"},{"name":"mode","type":"string","default":"","desc":"Optionally override the current mode setting of the zone.","required":false,"in":"query","ref":"","_id":"5b427a127a40bd000367c88a"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b427a127a40bd000367c889"}],"examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/zones/Z5b924aa62cf841b0612958ba/presence/state?mode=combined HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get presence.","type":"endpoint","slug":"get-presence","excerpt":"View whether or not the zone detects presence.","body":"The presence detection **mode** of a zone may be one of the following:\n\n* `local`: only the direct factors of the zone are considered\n* `descendants`: only the factors of the child zones are considered\n* `combined`: both the zone's own factors and the factors of its children are considered","updates":[],"order":20,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b42785927e27d0003a62232","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Zones API","slug":"zones-api","order":28,"from_sync":false,"reference":false,"_id":"59c7e975c50cf30010d712a0","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-24T17:20:53.835Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-07-08T20:47:21.388Z","githubsync":"","__v":3,"parentDoc":null}

getGet presence.

View whether or not the zone detects presence.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the zone.

Query Params

mode:
string
Optionally override the current mode setting of the zone.

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

The presence detection **mode** of a zone may be one of the following: * `local`: only the direct factors of the zone are considered * `descendants`: only the factors of the child zones are considered * `combined`: both the zone's own factors and the factors of its children are considered

User Information

Try It Out

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