KOSapi

h1. Studenti / studia

{{>toc}}

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.

*Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*

h2. GET /students

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.

* *URI:* {{base_url}}/api/3/students/
* *Typ zdroje:* Atom Feed
* *Typ obsahu:* [[Student]]
* *Formáty:* [[atom]], [[xml]]
* *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]]

h2. GET /students/{studyCodeOrId}

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.

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_.

* *URI:* {{base_url}}/api/3/students/{username}(-{order}/ | {{base_url}}/api/3/students/{id: [0-9]+}/
* *Typ zdroje:* Atom Entry
* *Typ obsahu:* [[Student]]
* *Formáty:* [[atom]], [[xml]]
* *Proměnné:* @{username}@ uživatelské jméno, @{order}@ pořadové číslo aktivního studia
* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]]

h2. GET /students/{studyCodeOrId}/enrolledCourses

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_).

* *URI:* {{base_url}}/api/3/students/{username}(-{order}/enrolledCourses/ | {{base_url}}/api/3/students/{id: [0-9]+}/enrolledCourses/
* *Typ zdroje:* Atom Feed
* *Typ obsahu:* [[CourseEnrollment]]
* *Formáty:* [[atom]], [[xml]], [[text]]
* *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]]

h2. GET /students/{studyCodeOrId}/parallels

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_).

* *URI:* {{base_url}}/api/3/students/{username}(-{order}/parallels/ | {{base_url}}/api/3/students/{id: [0-9]+}/parallels/
* *Typ zdroje:* Atom Feed
* *Typ obsahu:* [[Parallel]]
* *Formáty:* [[atom]], [[xml]]
* *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]]

h2. GET /students/{studyCodeOrId}/registeredExams

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_).

* *URI:* {{base_url}}/api/3/students/{username}(-{order}/registeredExams/ | {{base_url}}/api/3/students/{id: [0-9]+}/registeredExams/
* *Typ zdroje:* Atom Feed
* *Typ obsahu:*
* *Formáty:* [[atom]], [[xml]]
* *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]]

h2. GET /students/{studyCodeOrId}/exams

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ů).

* *URI:* {{base_url}}/api/3/students/{username}(-{order}/exams/ | {{base_url}}/api/3/students/{id: [0-9]+}/exams/
* *Typ zdroje:* Atom Feed
* *Typ obsahu:* [[Exam]]
* *Formáty:* [[atom]], [[xml]]
* *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]]