ciselniky
Description Číselníky STAGu
Type REST
Address /ws/services/rest2/ciselniky
Specifikace REST WADL  Open API  Open API (YAML) 
Title ciselniky

Operation

deletePracoviste
Comment Smaže existující pracoviště z číselníku.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/deletePracoviste
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
Arguments
Title Type (Java) Comment
stagUser String
pracovisteForDelete String Zkratka pracoviště, které smazat.

getCasovaRada
Comment Vrátí časovou řadu podle jejího kódu - tj. seznam položek časové řady.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getCasovaRada
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
kod String Kód (=název) časové řady. Seznam časových řad školy lze najít dotazem na číselník s názvem 'CASOVA_RADA' (služba 'getCiselnik').

getCiselnik
Comment Vrátí obsah číselníku zadaného doménou.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getCiselnik
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
domena String Název domény číselníku. Seznam domén lze zjistit službou 'getSeznamDomen'.
lang String

getCiselnikNewDomains
Comment Vrátí seznam nazvu domen ciselniku
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getCiselnikNewDomains
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in

getCiselnikNewItems
Comment Vrátí položky číselníku dle zadaného dotazu
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getCiselnikNewItems
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
domena String Doména. Seznam domen lze zjistit metodou 'getCiselnikNewDomains'
key String Klíč - tj. interní reprezentace hodnoty tohoto číselníku. Vyplňte v případě, že chcete vrátit pouze položku s tímto jedním konkrétním klíčem.
resultsStartAt Integer Je-li vyplněno, udává, od jaké pozice v seznamu vracet výsledky, určeno např. pro stránkování. První pozice má index 0.
resultsEndAt Integer Je-li vyplněno, udává, do jaké pozice v seznamu vracet výsledky, určeno např. pro stránkování. První pozice má index 0.
onlyValidItems Boolean Určuje, zda vracet pouze platné položky. Není-li vyplněno, vrací se pouze platné položky.
sortItems Boolean Určuje, zda budou výsledné položky seřazené. Není-li vyplněno, položky nebudou seřazené (resp. není garantováno jejich pořadí).
lang String Jazyk. Využívá se pokud je požadavek na seřazení položek. Výchozí hodnota je 'cs'

getHierarchiePracovist
Comment Vrátí seznam všech pracovišť, hierarchicky uspořádaný.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getHierarchiePracovist
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in

getSeznamDomen
Comment Vrátí seznam nazvu vsech domen, ktere jsou v ciselniku.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getSeznamDomen
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in

getSeznamPracovist
Comment Vrátí seznam pracovišť. Nejsou-li uvedený žádné parametry, vrací všechna pracoviště. Jinak se filtruje podle parametrů.
HTTP metoda GET
Adresa /ws/services/rest2/ciselniky/getSeznamPracovist
Možné výstupní MIME typy application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
zkratka String Zkratka pracoviště, není-li uvedeno, nezáleží na tomto parametru.
nadrazenePracoviste String Zkratka nadřazeného pracoviště, není-li uvedeno, nezáleží na tomto parametru.
typPracoviste String Typ pracoviště, není-li uvedeno, nezáleží na tomto parametru.

insertPracoviste
Comment Vloží do číselniku nové pracovište. Vrací zpět informace o tomto záznamu.
HTTP metoda POST
Adresa /ws/services/rest2/ciselniky/insertPracoviste
Možné výstupní MIME typy */*
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
Arguments
Title Type (Java) Comment
stagUser String
pracoviste WSPracovisteForEdit Pracoviště, které vložit do systému. Povinné položky jsou: zkratka, cisloPracoviste, nadrazenePracoviste (zkratka nadřazeného pracoviště. Nejvyšší pracoviště je vždy REK), nazev, typPracoviste (klíč položky z číselníku TYP_PRACOVISTE)

insertTitul
Comment Vlozi do ciselniku novy titul pred nebo titul za (jako domena musi byt uvedeno 'TITUL_PRED' nebo 'TITUL_ZA', nic jineho neni podporovano). Automaticky vygeneruje klic noveho zaznamu. Vraci zpet informace o tomto zaznamu.
HTTP metoda POST
Adresa /ws/services/rest2/ciselniky/insertTitul
Možné výstupní MIME typy */*
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
Arguments
Title Type (Java) Comment
stagUser String
ciselnikItem WSCiselnikItemForEdit Položka k vložení. Povinné údaje jsou: domena, valueCs. Další nepovinné jsou: zkratka, valueEn.

updatePracoviste
Comment Upraví existující pracoviště v číselníku. Upraví pouze ty položky, které byly předány.
HTTP metoda POST
Adresa /ws/services/rest2/ciselniky/updatePracoviste
Možné výstupní MIME typy */*
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
Arguments
Title Type (Java) Comment
stagUser String
pracoviste WSPracovisteForEdit Pracoviště, které upravit. Povinná položka je pouze 'zkratka', ostatní položky jsou upraveny, jsou-li vyplněny.

updateTitul
Comment Upraví existující titul v číselníku.
HTTP metoda POST
Adresa /ws/services/rest2/ciselniky/updateTitul
Možné výstupní MIME typy */*
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
Arguments
Title Type (Java) Comment
stagUser String
ciselnikItem WSCiselnikItemForEdit Titul k úpravě. Povinná položka je 'key' (klíč položky), upraveny pak mohou být položky: valueCs, valueEn, zkratka