5.4.2 api switch status
Skupiny služeb a privilegií
Skupina služeb je Switch.
Skupina privilegií je Spínače – řízení.
Metody
GET
POST
Požadavek
Požadavek obsahuje parametry ve formátu URL (nebo application/x-www-form-urlencoded při použití POST).
Název parametru | Povinný | Očekávané hodnoty | Výchozí hodnota | Popis |
---|---|---|---|---|
switch | No | celé číslo definující spínač (obvykle 1 až 4) | – | Definuje spínač, jehož stav má být vrácen. Funkce api/switch/caps může sloužit ke zjištění počtu spínačů určitého zařízení. Jestliže je tento parametr vynechán, vrátí se stav všech spínačů. |
Příklad požadavku
URL: https://192.168.1.1/api/switch/status?switch=1
Úspěšná odpověď je ve formátu application/json. Obsahuje dva JSON klíče success
a result
, který obsahuje klíč switches
(stavové informace jednotlivých spínačů jsou v poli s jedním až čtyřmi prvky).
Klíč | Typické vrácené hodnoty | Popis |
---|---|---|
switch | celé číslo (obvykle 1 až 4) | Definuje, ke kterému spínači se stav vztahuje. |
active |
| Definuje aktuální stav spínače ( |
locked |
| Definuje, zda je spínač uzamčený, nebo ne ( |
held |
| Definuje, zda je spínač přidržený, nebo ne ( |
Příklad odpovědi
GET /api/switch/status { "success" : true, "result" : { "switches" : [ { "switch" : 1, "active" : true "locked" : false "held" : true }, { "switch" : 2, "active" : false "locked" : false "held" : false }, { "switch" : 3, "active" : false "locked" : true "held" : false }, { "switch" : 4, "active" : false "locked" : true "held" : true } ] } }
Mohou se vyskytnout různé chyby (např. chybějící povinný parametr). Chyby se vracejí ve formátu .json s odpovědním kódem 200.