| oznameni | |
|---|---|
| Description | Oznámení systému. |
| Type | REST |
| Address | /ws/services/rest2/oznameni |
| Specifikace | |
| Title | oznameni |
Operation
| getAllNotifikaceTypSettings | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Vrátí stav nastavení doručení všech typů notifikací pro daného uživatele. Pokud nějaký typ notifikace v seznamu není, znamená to, že uživatelem není specificky nastaven žádný typ doručení a notifikace je zasílána výchozím způsobem. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/oznameni/settings |
| Možné vstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| list | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Vrátí seznam oznámení dle zadaných kritérií pro aktuálně přihlášeného uživatele. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/oznameni/list |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| notiIdno | Long | ID oznameni, pokud chcete pouze jedno konkretni oznameni | ||
| jenNeprectene | Boolean | Pouze neprectena oznameni? | ||
| fromTimestamp | Long | Nepovinny timestamp (tj. pocet milisekund od zacatku linux time) - sluzba pak vraci pouze oznameni novejsi nez tento timestamp. | ||
| lang | String | |||
| neprecteno | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Zrusi informaci o tom, ze oznameni bylo precteno. Muze byt predano jedno ci vice parametru notiIdno. Metoda vraci pouze text, bud vrati HTTP kod 200 a konstantu 'OK' a nebo vrati jiny HTTP kod a retezec s vypisem chyb, ktere nastaly |
| HTTP metoda | PUT |
| Adresa | /ws/services/rest2/oznameni/neprecteno |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| notiIdno | List | Jedno ci vice ID oznameni. Predavejte ve forme vicekrat uvedeneho parametru notiIdno=XX | ||
| oznameniStudentum | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Založí nové oznámení směřovaná studentovi/studentům. Využívá-li rozhraní vyučující, může posílat zprávy pouze studentům, s nimiž má nějaký vztah (předmět / termín / ...) |
| HTTP metoda | PUT |
| Adresa | /ws/services/rest2/oznameni/oznameniStudentum |
| Možné vstupní MIME typy | application/json |
| Možné výstupní MIME typy | application/json |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
PR
(Vice-Rector)
VY (Lecturer) AD (Administrator) KA (Department) FA (Faculty Secretary) |
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| arg1 | OznameniStudentum | |||
| precteno | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Nastavi informaci o tom, ze oznameni bylo precteno. Muze byt predano jedno ci vice parametru notiIdno. Metoda vraci pouze text, bud vrati HTTP kod 200 a konstantu 'OK' a nebo vrati jiny HTTP kod a retezec s vypisem chyb, ktere nastaly |
| HTTP metoda | PUT |
| Adresa | /ws/services/rest2/oznameni/precteno |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| notiIdno | List | Jedno ci vice ID oznameni. Predavejte ve forme vicekrat uvedeneho parametru notiIdno=XX | ||
| registerDeviceToken | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Zaregistruje uživateli Firebase device token, který umožňuje zasílání push notifikací na jeho mobilní zařízení. |
| HTTP metoda | POST |
| Adresa | /ws/services/rest2/oznameni/push/devices/register |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| deviceTokenRequest | WsDeviceTokenRequest | |||
| setNotifikaceTypSettings | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Nastaví uživateli stav doručení pro daný typ notifikace. |
| HTTP metoda | POST |
| Adresa | /ws/services/rest2/oznameni/settings/{notifikaceTyp} |
| Možné vstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Možné výstupní MIME typy | */* |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| notifikaceTyp | String | |||
| notifikaceTypSettingsRequest | NotifikaceNastaveniDoruceni | |||
| unregisterDeviceToken | |
|---|---|
| Garance | Garantováno minimálně do 11.7.2027 |
| Comment | Odregistuje uživatelův Firebase device token. |
| HTTP metoda | DELETE |
| Adresa | /ws/services/rest2/oznameni/push/devices/unregister |
| Možné vstupní MIME typy | application/xml, text/xml, application/json, text/yaml |
| Možné výstupní MIME typy | */* |
| Areas | root |
| Authentication necessary | log in, authenticate with user role |
| Permitted roles |
ALL
|
| Arguments | ||||
|---|---|---|---|---|
| Title | Type (Java) | Comment | ||
| stagUser | String | |||
| deviceTokenRequest | WsDeviceTokenRequest | |||