5.18.1 api lift grantaccess
Funkce api/lift/grantaccess slouží k aktivaci pater výtahu na základě autorizace v jiném zařízení.
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 (nebo ve formátu application/x-www-form-urlencoded při použití metody POST).
Tabulka 1. Klíče požadavku JSON
Název klíče | Povinný | Očekávané hodnoty | Výchozí hodnoty | Popis |
---|---|---|---|---|
uuid | Ano | uuid | - | Uuid uživatele, kterému má být udělen přístup do jeho pater (podle nastavení Přístupových práv). |
duration | NE | 1 .. 600 | doba trvání nastavená v cílovém zařízení | Definuje dobu aktivace pater. Je-li tento parametr vynechán, použije se výchozí hodnota uvedená v parametru Switch-On Duration. |
Příklad požadavku
URL: https://192.168.1.1/api/lift/grantaccess?user=09ebfd7d-24e4-4d58-ad02-804ad69938a6&duration=180
Odpověď
Odpověď je ve formátu application/json.
Tabulka 2. Klíče odpovědi JSON
Klíč | Typické vrácené hodnoty | Popis |
---|---|---|
success | true, false | Když je požadavek úspěšně zpracován, je hodnota |
Příklad odpovědi
{ "success": true }
Může dojít k různým chybám (např. chybějící povinný parametr). Vrátí-li se chybový kód 12, param: user (Uživatel nenalezen), požadavek nebyl zpracován, protože v adresáři cílového zařízení nebyl tento identifikátor uuid nalezen. Pokud zadaný uuid chybí nebo má nesprávný formát, zařízení odpoví chybovým kódem 11 (chybějící povinný parametr) nebo chybovým kódem 12 (neplatná hodnota parametru) v tomto pořadí.
Když dojde k aktivaci pater, která jsou již aktivní, bude použita delší doba trvání (zbývající čas versus nově požadovaná doba trvání).
Tento koncový bod API se dá použít k ovládání výtahových pater spolu se standardním řízením přístupu z jiného zařízení (např. posílat aktivační požadavek pro výtahová patra z interkomu na přístupovou jednotku, která je ve výtahu a komunikuje přímo s reléovými deskami).