5.17.3 api accesspoint grantaccess

Funkce api/accesspoint/grantaccess slouží k povolení vzdáleného přístupu příslušnému uživateli (konkrétního zaměstnance/uživatele nebo uživatele zahrnutého do obecné skupiny, např. návštěvník). Povolení vzdáleného přístupu lze udělit také pod přihlášeným účtem, kdy je ze záznamu zřejmé, který uživatel přístup umožnil.

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 parametru

Povinný

Očekávané hodnoty

Výchozí hodnota

Popis

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

user

Ano

uuid

Identifikace uživatele, jehož jménem má být otevřeno (a jehož přístupová nastavení mají být vzata v potaz).


Odpověď

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

Tabulka 2. Klíče odpovědi JSON

Klíč

Typické vrácené hodnoty

Popis

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

reason

invalidAp, invalidCredential, accessBlocked

Klíč se zobrazuje v případě odpovědi accessGranted:false. V případě úspěšného přístupu není tento klíč zobrazen.


Příklad odpovědi

{
  "success" : true,
  "result" : {
    "accessGranted" : false,
    "reason" : "invalidAp"
  }
}

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 nebyl v té době povolen.