5.17.2 api accesspoint blocking status

Funkce api/accesspoint/blocking/status vrací stav 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 – sledování.


Metody

  • GET

  • POST


Požadavek

Požadavek obsahuje parametry ve formátu URL.


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

id

Ne

Celé číslo (0, 1)

Všechny

Určuje, pro který přístupový bod se má vrátit stav blokování přístupu. Jestliže je tento parametr vynechán, stav blokování přístupu se vrátí pro všechny přístupové body.


Příklad požadavku

URL: https://192.168.1.1/api/accesspoint/blocking/status?id=0

Odpověď

Odpověď je ve formátu application/json. Hodnota klíče result obsahuje jeden klíč, accessPoints, který obsahuje pole s objektem pro každý přístupový bod (pole má délku 1, jestliže byl v požadavku přístupový bod specifikován). Objekty v poli obsahují následující klíče.

Tabulka 2. Klíče odpovědi JSON
KlíčTypické vrácené hodnotyPopis

id

Celé číslo (0, 1)

Identifikuje přístupový bod (0 pro příchod, 1 pro odchod).

blocked

Boolean (true, false)

Obsahuje aktuální stav blokování přístupového bodu (true, když je přístupový bod blokován, false, když není blokován).


Příklad odpovědi

{ "success": true, "result": { "accessPoints": [ { "id": 0, "blocked": true }, { "id": 1, "blocked": false } ] } }

Může dojít k různým chybám (např. nedostatečná privilegia).