5.4.2 api switch status

Funkce api/switch/status vrací aktuální stavy spínačů.

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).

Tabulka 1. Parametry požadavku

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čů.
holdTimeout	No		–	Definuje zbývající čas přidržení spínače. Parametr se v odpovědi nezobrazuje, pokud není nastaven časový limit nebo je spínač přidržen bez časového limitu.

Příklad požadavku

URL: https://192.168.1.1/api/switch/status?switch=1

Odpověď

Ú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).

Tabulka 2. Klíče JSON odpovědi switches

Klíč	Typické vrácené hodnoty	Popis
switch	celé číslo (obvykle 1 až 4)	Definuje, ke kterému spínači se stav vztahuje.
active	`true` nebo `false`	Definuje aktuální stav spínače (`true` – spínač je sepnutý, `false` – spínač je vypnutý).
locked	`true` nebo `false`	Definuje, zda je spínač uzamčený, nebo ne (`true` – spínač je uzamčený ve vypnutém stavu a nedá se ovládat, `false` – spínač je odemčený a dá se normálně ovládat). Uzamčení má přednost před přidržením spínače – tj. když je spínač současně uzamčený a přidržený, je vypnutý a nedá se ovládat.
held	`true` nebo `false`	Definuje, zda je spínač přidržený, nebo ne (`true` – spínač je přidržen v sepnutém stavu a nedá se ovládat, `false` – spínač je uvolněn a dá se normálně ovládat). Uzamčení má přednost před přidržením spínače – tj. když je spínač současně uzamčený a přidržený, je vypnutý a nedá se ovládat.

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.