users | |
---|---|
Description | Uživatelé - Spojení mezi externím uživatelským jménem a identitami v IS/STAG. |
Type | REST |
Address | /ws/services/rest2/users |
Specifikace | |
Title | users |
activateStagUser | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Aktivuje nebo deaktivuje uživatelské konto. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/activateStagUser |
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 | |||
stagUserNameForUpdate | String | Uživatelské jméno, u kterého provést změnu. | ||
stavAktivace | String | Aktivovat (A) ci zneplatnit (N) dane uzivatelske konto? |
deleteStagUser | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/deleteStagUser |
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 | |||
stagUserNameForDelete | String |
getExternalLoginByOsobniCislo | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí externí login studenta podle jeho osobního čísla. Může vrátit prázdný řetězec - student nemusí mít externí login. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getExternalLoginByOsobniCislo |
Možné výstupní MIME typy | text/plain |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
osCislo | String |
getExternalLoginByUcitIdno | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí externí login učitele na základě STAGovského ID (ucitIdno). |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getExternalLoginByUcitIdno |
Možné výstupní MIME typy | text/plain |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
ucitIdno | Long | STAG ID učitele (ucitIdno). |
getFotoOsoby | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrati fotku osoby podle osobIdno. Funguje pouze na skolach, kde je fotka fyzicky ulozena v IS/STAG (tabulka OSOBY_FOTO). |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getFotoOsoby |
Možné výstupní MIME typy | */* |
Areas | root, downloads |
Authentication necessary | log in, authenticate with user role |
Permitted roles |
PR
(Vice-Rector)
AD (Administrator) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
stagUser | String | |||
osobIdno | Long |
getKalendarOsoby | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí rozvrh osoby na podle jejího externího loginu (pripadne podle jejiho linku vygenerovaneho v portalu), ve formátu iCAL (např. po GoogleCalendar). Pokud má osoba více identit (student i učitel, více os. čísel..), vrací všechny identity dohromady. Pro studenta vrací rozvrh jeho předmětů plus termíny zkoušek, na kterých je/byl přihlášen, pro vyučujícího rozvrh jím vyučovaných předmětů a termínů jím zkoušených zkoušek |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getKalendarOsoby |
Možné výstupní MIME typy | text/calendar |
Areas | root, downloads |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
login | String | Externí login uživatele nebo speciální link uživatele vygenerovaný v portálu (přístup přes orion login bude brzy omezen) | ||
rokOd | Long | |||
rokDo | Long | |||
semestr | String | Semestr. Není-li uveden, berou se oba semestry | ||
lang | String |
getOsoba | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrati osobu z tabulky OSOBY zadanou PRAVE jednim ze svych identifikatoru (osobIdno, osCislo, rodCislo). |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getOsoba |
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 |
PR
(Vice-Rector)
AD (Administrator) SP (Spec. officer) SR (Study Office Secretary) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
stagUser | String | |||
osobIdno | Long | |||
osCislo | String | |||
rodCislo | String |
getOsobniCislaByExternalLogin | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí seznam osobních čísel studenta dle jeho zadaného externího loginu. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getOsobniCislaByExternalLogin |
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 | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
login | String | Externí login studenta | ||
pouzeStudujici | Boolean | Je-li true (defaultne), vraci pouze aktualne studujici nebo prerusena studia. Je-li false, vraci vsechny |
getStagUserForStagLogin | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí informaci o roli uživatele dle jeho zadaného IS/STAG loginu. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getStagUserForStagLogin |
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 | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
login | String | IS/STAG login uživatele |
getStagUserListForExternalLogin | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí seznam IS/STAG rolí uživatele dle jeho zadaného externího loginu. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getStagUserListForExternalLogin |
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 | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
externalLogin | String | Externí login uživatele |
getStagUserListForExternalLoginV2 | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí seznam IS/STAG rolí uživatele dle jeho zadaného externího loginu. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getStagUserListForExternalLoginV2 |
Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
externalLogin | String | Externí login uživatele |
getStagUsersRoles | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrací seznam uživatelů a jejich rolí v IS/STAG dle zadané fakulty, katedry a dalších parametrů. Uživatelé s rolí fakulta mohou vidět jen svoji fakultu, uživatelé s rolí katedra jen svoji katedru. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getStagUsersRoles |
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 |
PR
(Vice-Rector)
AD (Administrator) KA (Department) FA (Faculty Secretary) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
stagUser | String | |||
fakulta | String | |||
katedra | String | |||
idRole | String |
getUcitIdnoByExternalLogin | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí STAGovské ID učitele (ucitIdno) na základě externího uživatelského jména učitele. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/getUcitIdnoByExternalLogin |
Možné výstupní MIME typy | text/plain |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
externalLogin | String | Externí login učitele. |
insertOsoba | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vlozi do systemu novou osobu. Vraci zpet informace o teto osobe plus vyplnene osobidno (ktere databaze generuje sama). Neni-li zadano rodne cislo, vygeneruje se pseudorodny kod podle data narozeni a pohlavi. |
HTTP metoda | POST |
Adresa | /ws/services/rest2/users/insertOsoba |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | log in, authenticate with user role |
Permitted roles |
PR
(Vice-Rector)
AD (Administrator) SP (Spec. officer) SR (Study Office Secretary) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
stagUser | String | |||
osoba | WSOsobaBean |
insertStagUser | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
HTTP metoda | POST |
Adresa | /ws/services/rest2/users/insertStagUser |
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 | |||
stagUserForInsert | WSStagUserForEdit |
kalendar | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Vrátí rozvrh osoby na podle jejího externího loginu (pripadne podle jejiho linku vygenerovaneho v portalu), ve formátu iCAL (např. po GoogleCalendar). Pokud má osoba více identit (student i učitel, více os. čísel..), vrací všechny identity dohromady. Pro studenta vrací rozvrh jeho předmětů plus termíny zkoušek, na kterých je/byl přihlášen, pro vyučujícího rozvrh jím vyučovaných předmětů a termínů jím zkoušených zkoušek |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/kalendar/{link} |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
arg0 | String | Speciální link uživatele vygenerovaný v portálu |
kalendar2 | |
---|---|
Garance | Negarantováno! Pozor, tato služa je sice na IS/STAG API přítomna, ale její přesná specifikace a funkčnost není jakkoliv garantována a její použití je zcela na riziko klienta. Služba se může kdykoliv bez varování změnit či zmizet. |
HTTP metoda | GET |
Adresa | /ws/services/rest2/users/kalendar/{link}/{anything} |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
arg0 | String | Speciální link uživatele vygenerovaný v portálu | ||
arg1 | String |
kalendarHead | |
---|---|
Garance | Negarantováno! Pozor, tato služa je sice na IS/STAG API přítomna, ale její přesná specifikace a funkčnost není jakkoliv garantována a její použití je zcela na riziko klienta. Služba se může kdykoliv bez varování změnit či zmizet. |
HTTP metoda | HEAD |
Adresa | /ws/services/rest2/users/kalendar/{link} |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
arg0 | String | Speciální link uživatele vygenerovaný v portálu |
kalendarHead2 | |
---|---|
Garance | Negarantováno! Pozor, tato služa je sice na IS/STAG API přítomna, ale její přesná specifikace a funkčnost není jakkoliv garantována a její použití je zcela na riziko klienta. Služba se může kdykoliv bez varování změnit či zmizet. |
HTTP metoda | HEAD |
Adresa | /ws/services/rest2/users/kalendar/{link}/{anything} |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | probably without the need to log in (however, based on the configuration of a specific IS/STAG installation, the service may require a login or a specific user role) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
arg0 | String | Speciální link uživatele vygenerovaný v portálu | ||
arg1 | String |
updateOsoba | |
---|---|
Garance | Garantováno minimálně do 5.12.2024 |
Comment | Upravi zaznam v tabulce OSOBY. Upravuje pouze ty polozky, jejichz hodnota byla predana (tj. neni prazdna nebo null). |
HTTP metoda | POST |
Adresa | /ws/services/rest2/users/updateOsoba |
Možné výstupní MIME typy | */* |
Areas | root |
Authentication necessary | log in, authenticate with user role |
Permitted roles |
PR
(Vice-Rector)
AD (Administrator) SP (Spec. officer) SR (Study Office Secretary) |
Arguments | ||||
---|---|---|---|---|
Title | Type (Java) | Comment | ||
stagUser | String | |||
osoba | WSOsobaBean |