| vsp | |
|---|---|
| Popis | Služby poskytující data pro vizualizaci (studentova) studijního plánu. POZOR - jedná se o INTERNÍ služby, které lze využívat, ale s rizikem, že může kdykoliv dojít k jejich změně a to i bez předchozího ohlášení! |
| Typ | REST |
| Adresa | /ws/services/rest2/vsp |
| Specifikace | |
| Název | vsp |
Operace
| getStudent | |
|---|---|
| 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. |
| Komentář | Vrátí kompletní informace o studentovi a jeho rocích studia ("kompletní" znamená z hlediska použití v aplikaci pro vizualizaci plánu). |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/vsp/getStudent |
| 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 |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
ST
(Student)
PR (Prorektor) AD (Administrátor) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| osCislo | String | Osobní číslo studenta | ||
| getStudijniPlan | |
|---|---|
| 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. |
| Komentář | Vrátí kompletní informace o studijním plánu a celé jeho struktuře ("kompletní" znamená z hlediska použití v aplikaci pro vizualizaci plánu). |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/vsp/getStudijniPlan |
| 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 |
| Oblasti | root |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stplIdno | long | ID požadovaného studijního plánu | ||