5.14.1 api dir template

Funkce /api/dir/template umožňuje vyhledávat šablonu záznamu v adresáři.

Skupiny služeb a privilegií

Služba je System.
Privilegia jsou Systém – řízení.

Metody

GET
POST

Požadavek

Tabulka 1. Parametry požadavku

Název klíče	Povinný	Očekávané hodnoty	Výchozí hodnota	Popis
není	-	-	-	-

Příklad požadavku

https://192.168.1.1/api/dir/template

Odpověď

Odpověď je ve formátu application/json. Objekt result obsahuje klíče series a users.

Více informací o použití klíče series najdete v kapitole api/dir/query.

Klíč users obsahuje pole s jedním objektem (šablona záznamu), který obsahuje všechny dostupné klíče záznamu v adresáři včetně výchozích hodnot pro dané zařízení.

Tip

Více o struktuře JSON odpovědi se dozvíte z příkladu na konci této kapitoly.

Note

Dostupnost klíčů závisí na modelu, typu a hardwarové konfiguraci zařízení (např. klíč photo je dostupný pouze u zařízení, která jsou vybavena displejem a ukládají obrázky do adresáře).

Tabulka 2. Klíče odpovědi JSON v poli users

Klíč	Typické vrácené hodnoty	Popis
uuid	Prázdný	Unikátní uživatelský identifikátor. Když je pomocí funkce api/dir/create vytvořen nový záznam v adresáři, je jeho uuid buď ve formě parametru požadavku, nebo je automaticky generován zařízením. Formát uuid je "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", kde X může být jakákoli hexadecimální číslice. Všechny nuly jsou rezervovány pro prázdný uuid.
deleted	`false`	Indikuje, jestli byl záznam v adresáři vymazán, nebo ne. Vymazané záznamy zůstávají v adresáři, dokud není dosažen maximální počet záznamů. Uložené vymazané záznamy si ponechávají uuid jen z důvodů ukládání do logů. Jsou dvě platné hodnoty: `false`, `true`.
owner	Prázdný	Informace o tom, zda je záznam v adresáři vzdáleně spravován aplikací 2N® My2N nebo 2N® Access Commander nebo jiným systémem pro vzdálenou správu. Tato hodnota je určena pro interní potřeby 2N® TELEKOMUNIKACE a.s., případně pro vymazání skupiny uživatelů (viz api/dir/delete).
name	Prázdný	Název záznamu v adresáři (název uživatele nebo zařízení). Očekává se řetězec o maximální délce 63 znaků. Název může zůstat nevyplněn (v takovém případě je záznam v logu, e-mailu apod. identifikován pomocí uuid).
photo	Prázdný	Obrázek záznamu v adresáři (např. fotografie uživatele nebo logo společnosti). Ukládá se jako jpeg soubor šifrovaný pomocí base64 s touto syntaxí: PŘÍKLAD: data:image/jpeg;base64,IMAGE_DATA_IN_BASE64
email	Prázdný	E-mailová adresa záznamu v adresáři. Očekávaný formát je namestructure@domainhierarchy.top. Je možno zadat i více adres a oddělit je čárkou (uložit je jako řetězec).
treepath	/	Definice pozic záznamu v adresáři na displeji. Výchozí pozice je kořenová složka. Tuto pozici zajistíte pouhým stiskem jednoho lomítka. PŘÍKLAD: / ukázka záznamu v kořenové složce Záznam je možno umístit na několik pozic a ty oddělit středníkem (;). **PŘÍKLAD: /Folder1/;/Folder2/ ukazuje záznam ve složce Folder1 i Folder2 Záznamu může být přidělena volací skupina, která slouží i jako náhradní název v určité pozici na displeji, když se vynechá lomítko na konci definice pozice. PŘÍKLAD: /Folder1/Calling Group ukazuje záznam ve složce Folder1 pod názvem "Calling Group" Záznamu je v každé pozici možno individuálně přiřadit prioritu (prioritní záznam se pak zobrazuje nad ostatními záznamy) přidáním :1 na konec definice pozice. PŘÍKLAD: /Folder1/:1;Folder2/Calling Group:1 ukazuje prioritní záznam ve Folder1 pod jeho názvem a prioritní záznam ve Folder2 pod názvem "Calling Group" Jedné volací skupině je možno přiřadit více záznamů (výběr této volací skupiny na displeji vede ke skupinovému volání na všechny záznamy ve volací skupině). PŘÍKLAD*: Entry1:* */Calling Group* Entry2: */Calling Group* ukazuje oba záznamy v kořenové složce na jednom řádku s názvem "Calling Group" (při výběru tohoto řádku se volá na oba záznamy)
virtNumber	Prázdný	Virtuální číslo záznamu v adresáři. Virtuální čísla se dají vytáčet na numerické klávesnici (pokud je k dispozici). Maximální délka je 7 znaků. První a poslední znak se dá vybrat z rozmezí A až Z nebo 0 až 9. Zbylé znaky mohou být mezi 0 a 9.
deputy	Prázdný	Uuid zástupného záznamu, který je volán, když původně volaný uživatel není k dispozici nebo neodpovídá. Jestliže zástupce nemá nastaven zástupný uuid, zůstane klíč prázdný.
buttons	Prázdný	Tlačítka přiřazená tomuto záznamu v adresáři. Pole celých čísel (přiřazovaných podle pozice tlačítka počínaje 1) oddělených čárkami.
callPos	Pole	Informace o volání pro záznam v adresáři. Zadává se jako pole až tří objektů, tj. tří sad informací o volání. Každý z těchto tří objektů může obsahovat následující klíče: peer - telefonní číslo záznamu v adresáři profiles - časové profily, pokud je toto telefonní číslo platné (číslo se nevytočí, když je neplatné) P=X,..,Y kde X,..,Y představují pole předdefinovaných časových profilů oddělených čárkou od 0 (časový profil 1) do 19 (časový profil 20) **PŘÍKLAD: P=1,3,5 znamená, že předdefinované profily 2, 4 a 6 definují dobu platnosti telefonního čísla D=A,..,B@H:MM-H:MM kde A,..,B představují pole dnů v týdnu oddělených čárkou (0 až 6 pro neděle až sobota, 7 je svátek), H znamená denní hodinu (od 0 do 23), MM znamená minuty (od 00 do 59) - dvě hodnoty definující interval. Jednotlivé definice se dají kombinovat a oddělovat středníkem. PŘÍKLAD: D=7@0:15-13:15;D=5,7@13:15-15:15;D=7@15:15-23:30 znamená, že telefonní číslo je platné ve svátek od 0:15 do 13:15, v pátek a ve svátek od 13:15 to 15:15 a ve svátek od 15:15 do 23:30. PŘÍKLAD: D=5,7** znamená, že telefonní číslo je platné v pátek a ve svátek celý den. grouped - definuje, zda se číslo vytočí ve skupinovém volání spolu s předchozím číslem (třetí číslo se vytočí se zástupcem). Může nabývat hodnot `true` nebo `false`. ipEye - definuje IP adresu počítače, na němž běží aplikace 2N® IP Eye (pro příjem videa, jestliže telefon nemá displej).
access	JSON objekt	Informace o kontrole přístupu pro záznam v adresáři. Obsahuje tyto klíče: validFrom - definice začátku doby platnosti pověření záznamu v adresáři. Zadává se ve formátu Unix Time. Je-li pole prázdné, začíná doba platnosti na začátku časového období (tj. 00:00:00 UTC 1.1. 1970). validTo - definice konce doby platnosti pověření záznamu v adresáři. Zadává se ve formátu Unix Time. Je-li pole prázdné, končí doba platnosti na konci časového období (tj. 03:14:07 UTC 19.1. 2038). accessPoints - obsahuje pole přístupových bodů (dva přístupové body, vstup a výstup). Každá položka pole je reprezentována JSON objektem s těmito klíči: enabled - definuje, zda je obecně možné tento přístupový bod použít (tj. zda je možné se na tomto konkrétním přístupovém bodu autentizovat). Jsou dvě platné hodnoty: `true`, `false`. profiles - definuje, zda je aktuálně možné tento přístupový bod použít (tj. zda je možné se v tuto chvíli na tomto přístupovém bodě autentizovat). Syntax definice profilu je stejná jako u callPos. pairingExpired - určuje, zda párování záznamu v adresáři pomocí Bluetooth vypršelo, nebo ne. Jsou dvě platné hodnoty: `true`, `false`. virtCard - definuje virtuální kartu záznamu v adresáři, která je přenášena na rozhraní Wiegand a do dalších systémů třetích stan, pokud je autentizace záznamu v adresáři úspěšná. Očekává se 6 až 32 hexadecimálních znaků. card - definuje až dvě karty záznamu v adresáři, které se používají pro autentizaci. Čísla karet jsou zapsána jako pole řetězců. Očekává se 6 až 32 hexadecimálních znaků. mobkey - definuje ID Bluetoothové autentizace záznamu v adresáři. Očekává se 32 hexadecimálních znaků. fpt - šablony otisků prstů záznamu v adresáři. Očekává se zašifrovaný otisk prstu (pro více informací kontaktujte Technickou podporu). pin - definuje PIN záznamu v adresáři. Očekává se 2 až 15 číslic. apbException - definuje, zda má záznam v adresáři výjimku ze systému anti-passback (např. pokud ji má, mohou se jeho pověření použít vícenásobně pro vstup bez výstupu). Jsou dvě platné hodnoty: `true`, `false`. code - definuje až tři samostatné kódy spínačů. Ty jsou zapsány v poli řetězců (2 až 15 číslic). První pozice v poli definuje kód prvního spínače. Při vložení prázdného řetězce dojde k přeskočení kódu pro daný spínač. liftFloors - definuje konfiguraci přístupných pater výtahu po autentizaci. Očekává se následující formát: F=P,..,R@PROFILE1_DEFINITION\|F=X,..,Z@PROFILE2_DEFINITION kde P,..,R a X,..,Z jsou pole podlaží oddělených čárkou (0 až 63). io_1_1 se zadává jako 0, io_1_5 jako 4, io_2_2 jako 9 a tak dále. Pole pater aktivních v určitých profilech se oddělují \|. Dají se použít předem definované profily nebo ad hoc definice nového profilu (viz definice syntaxe v callPos/profily). Definici profilu lze vynechat, když není použit žádný profil. **PŘÍKLAD: F=2,4 definuje patra bez časového profilu (uživateli jsou vždy přístupná). PŘÍKLAD: F=5@P=0,7 definuje, že šesté patro (F=5) je přístupné v pondělí a ve svátek celý den. PŘÍKLAD: F=0@P=7,13\|F=0@D=5@9:15-11:45;D=4@11:45-13:30** definuje, že první patro (F=0) je přístupné podle předdefinovaných profilů 8 a 14 (P=7,13) a podle časového profilu definovaného v řetězci definice. licensePlates - definuje sadu registračních značek přiřazených uživateli (pro otevření dveří na základě rozpoznání registrační značky). Jednotlivé registrační značky se oddělují čárkou. Bílé znaky se ignorují. Maximální povolený počet znaků je 255 (včetně bílých znaků). Maximální počet registračních značek v poli je 20 a každá registrační značka může mít maximálně 10 znaků jiných než bílých.
timestamp	0	Časová značka změn provedených v adresáři. Časové značky se v adresáři generují automaticky ve vzestupném pořadí. Více informací o použití časových značek najdete v kapitole api/dir/query.

Příklad odpovědi

{
    "success": true,
    "result": {
        "series": "5247939846841727056",
        "users": [
            {
                "uuid": "",
                "deleted": false,
                "owner": "",
                "name": "",
                "photo": "",
                "email": "",
                "treepath": "\/",
                "virtNumber": "",
                "deputy": "",
                "buttons": "",
                "callPos": [
                    {
                        "peer": "",
                        "profiles": "",
                        "grouped": false,
                        "ipEye": ""
                    },
                    {
                        "peer": "",
                        "profiles": "",
                        "grouped": false,
                        "ipEye": ""
                    },
                    {
                        "peer": "",
                        "profiles": "",
                        "grouped": false,
                        "ipEye": ""
                    }
                ],
                "access": {
                    "validFrom": "0",
                    "validTo": "0",
                    "accessPoints": [
                        {
                            "enabled": true,
                            "profiles": ""
                        },
                        {
                            "enabled": true,
                            "profiles": ""
                        }
                    ],
                    "pairingExpired": false,
                    "virtCard": "",
                    "card": [
                        "",
                        ""
                    ],
                    "mobkey": "",
                    "fpt": "",
                    "pin": "",
                    "apbException": false,
                    "code": [
                        "",
                        "",
                        "",
                        ""
                    ],
                    "licensePlates": "",
                    "liftFloors": ""
                },
                "timestamp": 0
            }
        ]
    }
}