5.17.1 api accesspoint blocking ctrl

Funkce api/accesspoint/blocking/ctrl slouží ke kontrole blokování přístupu pro jednotlivé přístupové body.

Skupiny služeb a privilegií
  • Skupina služeb je Access Control API.

  • Skupina privilegií je Správa přístupu – řízení.


Metody
  • GET

  • POST


Požadavek

Požadavek obsahuje parametry ve formátu URL.


Tabulka 1. Parametry URL požadavku
Název parametruPovinnýOčekávané hodnotyVýchozí hodnotaPopis

id

Ano

Celé číslo (0, 1)

-

Určuje identifikátor přístupového bodu, který se má kontrolovat (0 pro Příchod a 1 pro Odchod).

action

Ano

Řetězec (on, off)

-

Určuje, zda má být blokování daného přístupového bodu zapnuto / vypnuto.


Příklad požadavku

URL: https://192.168.1.1/api/accesspoint/blocking/ctrl?id=0&action=on


Odpověď

Odpověď je ve formátu application/json.

Tabulka 2. Klíče odpovědi JSON

KlíčTypické vrácené hodnotyPopis

success

truefalse

Hodnota je true, když je požadavek úspěšně zpracován (tj. blokování přístupu je v požadovaném stavu bez ohledu na nastalou změnu).


Příklad odpovědi

{ "success": true }

Může dojít k různým chybám (např. chybějící povinný parametr). Chybový kód 18 (přístupový bod nepovolen) znamená, že požadavek nebyl zpracován, protože daný přístupový bod byl v té době nepovolen.