Uživatelské role, tak jak jsou definována v rozhraní aplikace jsou přístupná i v REST API.

Upozornění: Ve verzi 2026.1.0 je dostupné pouze čtení, nikoliv import. Import bude povolen v některé z následujících verzí.

Způsob volání

Lze využít HTTP metodu: GET, PUT, POST

V REST API lze využít endpoint /c/{firma}/role, přes který lze exportovat, měnit, importovat a vytvářet role ve firmě.

GET http://demo.flexibee.eu/c/demo/role.xml

Jsou podporovány výstupní formáty: JSON, XML nebo CSV.

Popis evidencí

Definice evidence role
Definice evidence přístupové právo

Dostupné operace

Export

GET /c/{firma}/role Vrátí všechny role ve firmě.
GET /c/{firma}/role/{ID} Vrátí konkrétní roli se všemi přístupovými právy.

Je možné využít obvyklé filtrování a úrovní detailu v API.

Import

PUT a POST /c/{firma}/role
- Pokud dotaz obsahuje <id>{ID}</id>, tak se aktualizuje role odpovídající zadanému ID.
- Pokud dotaz neobsahuje <id>{ID}</id>, tak se založí nová role.
PUT a POST /c/{firma}/role/{ID} Aktualizuje se role odpovídající zadanému ID.

Povinné parametry importu

vytvoření nové role je potřeba mít vyplněné vlastnosti:
kod - požadovaný Kód/Zkratka.
nazev - požadovaný Název
otecRole - ID nebo kód výchozí role
- Při vytváření nové role se použijí přístupová práva z výchozí role, pokud nebyla definována v requestu
- <otecRole>code:ADMIN</otecRole>

Uživatelské role (<standard>false</standard>) jsou vytvořené uživatelem a musí vycházet z jiné role (vlastnost otecRole).

Standardní role (<standard>true</standard>) jsou vytvořené aplikací a jsou neměnné.

POZOR! U přístupových práv standardních rolí je ID ve formátu uuid:{kód role}-{klíč práva}

V případě importu je možné využít obvyklé identifikátory vč. externích.

Ukázka volání

1. Čtení všech dostupných rolí

GET

https://demo.flexibee.eu/c/demo/role.xml?limit=0&detail=full

Výstup:

<winstrom version="1.0">
<!--  Role uživatele  -->
<role>
<!--  ID (celé číslo) -  -->
<id>1</id>
<!--  Poslední změna (datum a čas) -  -->
<lastUpdate>2020-02-12T15:10:00.172+01:00</lastUpdate>
<!--  Zkratka (řetězec) - max. délka: 20  -->
<kod>ADMIN</kod>
<!--  Název (řetězec) - max. délka: 255  -->
<nazev>Administrátor</nazev>
<!--  Název EN (řetězec) - max. délka: 255  -->
<nazevA>Administrator</nazevA>
<!--  Název IT (řetězec) - max. délka: 255  -->
<nazevB>Verwalter</nazevB>
<!--  Název FR (řetězec) - max. délka: 255  -->
<nazevC/>
<!--  Poznámka (řetězec) -  -->
<poznam/>
<!--  Popis (řetězec) -  -->
<popis/>
<!--  Zobrazovat (logická hodnota) -  -->
<visible>true</visible>
<!--  Standardní role (logická hodnota) -  -->
<standard>true</standard>
<!--  Přístup        Administrátor - typPrav.admin       Super uživatel - typPrav.superUzivatel       Standardní uživatel - typPrav.uzivatel       Obchodník - typPrav.obchodnik       Účetní - typPrav.ucetni       Mzdový účetní - typPrav.mzdovyUcetni       Skladník - typPrav.skladnik       Skladník s pokladnou - typPrav.skladnikSPokladnou       Jen číst - typPrav.jenCist       Neaktivní účet - typPrav.zablokovan  -->
<pristupK showAs="Administrátor">typPrav.admin</pristupK>
<!--  Odvozeno z role (objekt) - max. délka: 20  -->
<otecRole/>
<pristupova-prava>
<!--  Přístupová práva  -->
<pristupove-pravo>
<!--  ID (celé číslo) -  -->
<id>uuid:ADMIN-cTypZbozi</id>
<!--  Poslední změna (datum a čas) -  -->
<lastUpdate/>
<!--  Typ přístupu        Plný přístup - typPristPrav.plny       Nepřístupné - typPristPrav.nepripustne       Pouze číst - typPristPrav.pouzeCist       Upřesnění přístupu - typPristPrav.upresneni  -->
<typeK showAs="Plný přístup">typPristPrav.plny</typeK>
<!--  Klíč přístupového práva (řetězec) -  -->
<groupKey>cTypZbozi</groupKey>
<!--  Role uživatele (objekt) - max. délka: 20  -->
<role ref="/c/demo141020_v26/role/1.xml" showAs="ADMIN: Administrátor">code:ADMIN</role>
<!--  Upřesňující přístupová práva        Přidávat nové - Pridavat       Měnit existující - Menit       Mazat - Mazat       Export - Export       Import - Import       Otevírat detail - OteviratDetail       Měnit sloupce - Sloupce       Kusovník - Kusovnik       Stornovat - Storno       Povolit slevu a změnu ceny - SlevaZmenaCeny       Sumace - Sumace       Služby - Sluzby       Vazby - Vazby       Hromadné změny - HromZmeny       Vidět nákupní cenu - NakupCena       Měnit zaúčtování - MenitZauctovani       Měnit předpis zaúčtování - MenitTuo       Generovat faktury ze smluv - GenerovatZeSmluv       Podepisovat faktury - PodepsatFaktury       Prodávat pod minimální marží - ProdejPodMinMarzi  -->
<featureK>
<feature>Pridavat</feature>
<feature>Menit</feature>
<feature>Mazat</feature>
<feature>Export</feature>
<feature>Import</feature>
<feature>OteviratDetail</feature>
<feature>Sloupce</feature>
</featureK>
</pristupove-pravo>
....
....
</role>

2. Kopie role ADMIN se stejnými právy

POST

https://demo.flexibee.eu/c/demo/role.xml

Vstup:

<winstrom version="1.0">     
 <role>         
  <kod>ADMIN_COPY</kod>         
  <nazev>Kopie role ADMIN.</nazev>         
  <otecRole>code:ADMIN</otecRole>     
 </role> 
</winstrom>

3. Zjištění klíčů pro měněná práva

GET

https://demo.flexibee.eu/c/demo/role.xml

Výstup:

...
 <pristupove-pravo>
  <id>uuid:ADMIN-dDoklFak$$FAP</id>
  <groupKey evidencePath="faktura-prijata">dDoklFak$$FAP</groupKey>
</pristupove-pravo>
...
 <pristupove-pravo>
  <id>uuid:ADMIN-dDoklFak$$FAV</id>
  <groupKey evidencePath="faktura-vydana">dDoklFak$$FAV</groupKey>
</pristupove-pravo>
...

Je potřeba nalézt odpovídající klíče práv pro krok 4. Zajímají nás klíče dDoklFak$$FAV a dDoklFak$$FAP.

4. Přístup k fakturám vydaným pouze pro čtení a vypnutí zcela přístup k fakturám přijatým.

POST

https://demo.flexibee.eu/c/demo/role.xml

Vstup

<winstrom version="1.0">     
 <role>
<!-- identifikace měněné role -->         
  <id>code:ADMIN_COPY</id>  
<!-- definice nastavovaných přístupových práv -->       
  <pristPrava>        
<!-- klíč pro FAV a nastavení práva pro čtení -->      
   <pristupove-pravo>                 
    <groupKey>dDoklFak$$FAV</groupKey>                   
    <typeK>typPristPrav.pouzeCist</typeK>             
   </pristupove-pravo>  
<!-- klíč pro FAP a nastavení bez přístupu -->             
   <pristupove-pravo>                 
    <groupKey>dDoklFak$$FAP</groupKey>                 
    <typeK>typPristPrav.nepripustne</typeK>             
   </pristupove-pravo>         
  </pristPrava>     
 </role> 
</winstrom>