KOSapi

h1. Předměty

{{>toc}}

Rozlišují se dvě entity předmětu - předmět (course) a tzv. instance předmětu (coursin). První obsahuje všechny statické údaje předmětu jako je název, způsob zakončení, anotace, osnovy apod. Tyto údaje by měly být po dobu existence předmětu neměnné. Instance předmětu je pak konkrétní instance vypsaná v semestru (tzv. „semestropředmět“) a obsahuje proměnné údaje jako je kapacita, počet obsazených míst apod.

h2. GET /courses

Vrátí všechny předměty.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Course]]

* *Formáty:* [[atom]], [[xml]]

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]], [[URLParameters#startIndex|startIndex]], [[URLParameters#maxResults|maxResults]], [[URLParameters#orderBy|orderBy]], [[URLParameters#query|query]]

h2. GET /courses/{code}

Vrátí konkrétní předmět podle jeho kódu.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}

* *Typ zdroje:* Atom Entry

* *Typ obsahu:* [[Course]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/texts

Vrátí texty daného předmětu (anotace, osnovy apod.) 

Pozn.: _Získání těchto dat je databázově poměrně drahé, proto jsou odděleny do samostatného zdroje._

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/texts

* *Typ zdroje:* Atom Entry

* *Typ obsahu:* [[CourseTexts]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]]

h1. Instance předmětů

h2. GET /courses/{code}/instances

Vrátí všechny instance daného předmětu.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Coursin]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/instances/{semester}

Vrátí danou instanci předmětu podle jeho kódu a semestru.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/{semester}

* *Typ zdroje:* Atom Entry

* *Typ obsahu:* [[Coursin]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu, @{semester}@ kód semestru

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/instances/{semester}/examiners/

Vrátí zkoušející tohoto předmětu v daném semestru.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/{semester}/examiners/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Teacher]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu, @{semester}@ kód semestru

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/instances/{semester}/guarantors/

Vrátí garanty tohoto předmětu v daném semestru.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/{semester}/guarantors/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Teacher]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu, @{semester}@ kód semestru

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/instances/{semester}/instructors/

Vrátí cvičící tohoto předmětu v daném semestru.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/{semester}/instructors/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Teacher]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu, @{semester}@ kód semestru

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]

h2. GET /courses/{code}/instances/{semester}/lecturers/

Vrátí přednášející tohoto předmětu v daném semestru.

* *URI:* https://kosapi.fit.cvut.cz/api/3/courses/{code}/instances/{semester}/lecturers/

* *Typ zdroje:* Atom Feed

* *Typ obsahu:* [[Teacher]]

* *Formáty:* [[atom]], [[xml]]

* *Proměnné:* @{code}@ kód předmětu, @{semester}@ kód semestru

* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]