Students » Historie » Verze 11

Jakub Jirůtka, 2016-08-08 14:52
Přidáno upozornění ke kódu studia

1 1 Jakub Jirůtka
h1. Studenti / studia
2 1 Jakub Jirůtka
3 1 Jakub Jirůtka
{{>toc}}
4 1 Jakub Jirůtka
5 1 Jakub Jirůtka
Jedna osoba může mít na ČVUT více souběžných studií, dokonce i v rámci jediné fakulty. Takoví studenti existují a ačkoli jde o minoritní případy, je nutné s nimi počítat.
6 1 Jakub Jirůtka
7 7 Jakub Jirůtka
*Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*
8 7 Jakub Jirůtka
9 1 Jakub Jirůtka
10 1 Jakub Jirůtka
h2. GET /students
11 1 Jakub Jirůtka
12 1 Jakub Jirůtka
Vrátí všechny studenty, které má fakulta právo vidět. To znamená všechny její studenty a studenty „cizích“ fakult, kteří mají zapsaný nějaký předmět z dané fakulty.
13 1 Jakub Jirůtka
14 1 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/
15 1 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
16 1 Jakub Jirůtka
* *Typ obsahu:* [[Student]]
17 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
18 1 Jakub Jirůtka
* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#limit|limit]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]], [[URLParameters#offset|offset]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]
19 1 Jakub Jirůtka
20 1 Jakub Jirůtka
21 9 Jakub Jirůtka
h2. GET /students/{studyCodeOrId}
22 1 Jakub Jirůtka
23 9 Jakub Jirůtka
Vrátí _studium_ studenta podle jeho uživatelského jména a příp. pořadového čísla studia (řazeno od nejnovějšího), má-li více souběžných studií, nebo podle jeho databázového ID.
24 1 Jakub Jirůtka
25 1 Jakub Jirůtka
Příklad: Student s uživatelským jménem _flynnkev_ má tři aktivní souběžná studia. Potom jeho nejnovější studium (podle data vytvoření záznamu v KOS) bude mít identifikátor _flynnkev_, další _flynnkev-1_ a nejstarší studium _flynnkev-2_.
26 1 Jakub Jirůtka
27 11 Jakub Jirůtka
*Kód studia není stabilní, v čase se mění* (když student ukončí některé studium nebo započne nové)! Doporučuji namísto toho používat databázové ID, všude kde je to možné.
28 11 Jakub Jirůtka
29 9 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/{username}(-{order}/ | {{base_url}}/api/3/students/{id: [0-9]+}/
30 1 Jakub Jirůtka
* *Typ zdroje:* Atom Entry
31 1 Jakub Jirůtka
* *Typ obsahu:* [[Student]]
32 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
33 1 Jakub Jirůtka
* *Proměnné:* @{username}@ uživatelské jméno, @{order}@ pořadové číslo aktivního studia
34 1 Jakub Jirůtka
* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]]
35 3 Jakub Jirůtka
36 3 Jakub Jirůtka
37 9 Jakub Jirůtka
h2. GET /students/{studyCodeOrId}/enrolledCourses
38 3 Jakub Jirůtka
39 3 Jakub Jirůtka
Vrátí zápisy předmětů daného studenta pro a) aktuální semestr, b) zvolené semestry parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
40 3 Jakub Jirůtka
41 9 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/{username}(-{order}/enrolledCourses/ | {{base_url}}/api/3/students/{id: [0-9]+}/enrolledCourses/
42 3 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
43 5 Jakub Jirůtka
* *Typ obsahu:* [[CourseEnrollment]]
44 3 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]], [[text]]
45 3 Jakub Jirůtka
* *Parametry:* [[URLParameters#sem|sem]], [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#limit|limit]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]], [[URLParameters#offset|offset]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]
46 3 Jakub Jirůtka
47 3 Jakub Jirůtka
48 9 Jakub Jirůtka
h2. GET /students/{studyCodeOrId}/parallels
49 3 Jakub Jirůtka
50 3 Jakub Jirůtka
Vrátí paralelky, na kterých je student zapsaný, pro a) aktuální semestr, b) zvolené semestry parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
51 3 Jakub Jirůtka
52 9 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/{username}(-{order}/parallels/ | {{base_url}}/api/3/students/{id: [0-9]+}/parallels/
53 3 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
54 3 Jakub Jirůtka
* *Typ obsahu:* [[Parallel]]
55 3 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
56 3 Jakub Jirůtka
* *Parametry:* [[URLParameters#sem|sem]], [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#limit|limit]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]], [[URLParameters#offset|offset]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]
57 8 Jakub Jirůtka
58 8 Jakub Jirůtka
59 9 Jakub Jirůtka
h2. GET /students/{studyCodeOrId}/registeredExams
60 8 Jakub Jirůtka
61 8 Jakub Jirůtka
Vrátí zápisy zkoušek daného studenta pro a) aktuální semestr, b) zvolené semestry parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
62 8 Jakub Jirůtka
63 9 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/{username}(-{order}/registeredExams/ | {{base_url}}/api/3/students/{id: [0-9]+}/registeredExams/
64 8 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
65 8 Jakub Jirůtka
* *Typ obsahu:* 
66 8 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
67 8 Jakub Jirůtka
* *Parametry:* [[URLParameters#sem|sem]], [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#limit|limit]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]], [[URLParameters#offset|offset]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]
68 10 Jakub Jirůtka
69 10 Jakub Jirůtka
70 10 Jakub Jirůtka
h2. GET /students/{studyCodeOrId}/exams
71 10 Jakub Jirůtka
72 10 Jakub Jirůtka
Vrátí zkoušky, na které je student zapsaný v a) aktuálním semestru, b) ve zvolených semestrech parametrem [[URLParameters#sem|sem]], c) nebo ve všech semestrech (parametr _sem=none_). Oproti zdroji _registeredExams_ se liší v tom, že vrací přímo objekt zkoušky, kdežto _registeredExams_ vrací zápis na zkoušku (v budoucnu bude obsahovat více údajů).
73 10 Jakub Jirůtka
74 10 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/students/{username}(-{order}/exams/ | {{base_url}}/api/3/students/{id: [0-9]+}/exams/
75 10 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
76 10 Jakub Jirůtka
* *Typ obsahu:* [[Exam]]
77 10 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
78 10 Jakub Jirůtka
* *Parametry:* [[URLParameters#sem|sem]], [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#limit|limit]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]], [[URLParameters#offset|offset]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]