Courses » Historie » Verze 11

Jakub Jirůtka, 2012-08-31 22:12
přidána informace o rozsahu dat

1 1 Jakub Jirůtka
h1. Předměty
2 1 Jakub Jirůtka
3 2 Jakub Jirůtka
{{>toc}}
4 2 Jakub Jirůtka
5 1 Jakub Jirůtka
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.
6 1 Jakub Jirůtka
7 10 Jakub Jirůtka
8 1 Jakub Jirůtka
h2. GET /courses
9 1 Jakub Jirůtka
10 6 Jakub Jirůtka
Vrátí všechny předměty vyučované na ČVUT. Výchozí hodnota parametru [[URLParameters#sem|sem]] je _none_, což zde znamená, že se vypíší pouze obecné atributy platné pro předmět samotný, nikoli jeho instanci v semestru.
11 1 Jakub Jirůtka
12 6 Jakub Jirůtka
Pomocí parametru [[URLParameters#sem|sem]] lze vyfiltrovat pouze ty předměty, které jsou/byly vypsané (tzn. existuje jejich instance) v alespoň jednom z daných semestrů (např. _sem=current_ pro aktuální semestr). Zároveň se vypíší i atributy instance předmětu pro dané semestry.
13 6 Jakub Jirůtka
14 6 Jakub Jirůtka
Vysvětlení k parametru _detail_ viz dále.
15 6 Jakub Jirůtka
16 1 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/
17 1 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
18 1 Jakub Jirůtka
* *Typ obsahu:* [[Course]]
19 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
20 1 Jakub Jirůtka
* *Parametry:* [[URLParameters#detail|detail]], [[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]]
21 11 Jakub Jirůtka
* *Rozsah dat:* úplný / záznamy pro celé ČVUT *[[data_restrictions|/?/]]*
22 1 Jakub Jirůtka
23 1 Jakub Jirůtka
24 1 Jakub Jirůtka
h2. GET /courses/{code}
25 1 Jakub Jirůtka
26 6 Jakub Jirůtka
Vrátí konkrétní předmět podle jeho kódu. Výchozí hodnota parametru [[URLParameters#sem|sem]] je _none_, což zde znamená, že se vypíší pouze obecné atributy platné pro předmět samotný, nikoli jeho instanci v semestru.
27 1 Jakub Jirůtka
28 6 Jakub Jirůtka
Pomocí parametru [[URLParameters#sem|sem]] lze zároveň zobrazit i atributy instance předmětu ve vybraném semestru (např. _sem=current_ pro aktuální semestr). Pakliže předmět není/nebyl vypsaný v žádném z daných semestrů (tzn. neexistuje jeho instance pro tyto semestry), tak vrátí kód 404 (Not Found).
29 6 Jakub Jirůtka
30 6 Jakub Jirůtka
Ve výchozím nastavení se nevypisují popisné texty předmětu (např. osnova přednášek, požadavky, …), jelikož jejich načítání je pomalé a hodně navyšují velikost vráceného XML. Pro vypsání i popisných textů lze použít parametr _[[URLParameters#detail|detail]]=1_.
31 6 Jakub Jirůtka
32 1 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/
33 1 Jakub Jirůtka
* *Typ zdroje:* Atom Entry
34 3 Jakub Jirůtka
* *Typ obsahu:* [[Course]]
35 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
36 1 Jakub Jirůtka
* *Proměnné:* @{code}@ kód předmětu
37 1 Jakub Jirůtka
* *Parametry:* [[URLParameters#detail|detail]], [[URLParameters#sem|sem]], [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#locEnums|locEnums]], [[URLParameters#multilang|multilang]]
38 11 Jakub Jirůtka
* *Rozsah dat:* úplný / záznamy pro celé ČVUT *[[data_restrictions|/?/]]*
39 5 Jakub Jirůtka
40 1 Jakub Jirůtka
41 9 Jakub Jirůtka
h2. GET /courses/{code}/events
42 9 Jakub Jirůtka
43 9 Jakub Jirůtka
Vrátí jednorázové akce (instance) předmětu a) v aktuálním semestru, b) ve zvolených semestrech parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
44 9 Jakub Jirůtka
45 9 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/events/
46 9 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
47 9 Jakub Jirůtka
* *Typ obsahu:* [[CourseEvent]]
48 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
49 9 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]]
50 11 Jakub Jirůtka
* *Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*
51 9 Jakub Jirůtka
52 9 Jakub Jirůtka
53 8 Jakub Jirůtka
h2. GET /courses/{code}/exams
54 1 Jakub Jirůtka
55 6 Jakub Jirůtka
Vrátí zkouškové termíny (instance) předmětu a) v aktuálním semestru, b) ve zvolených semestrech parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
56 1 Jakub Jirůtka
57 8 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/exams/
58 1 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
59 8 Jakub Jirůtka
* *Typ obsahu:* [[Exam]]
60 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
61 1 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]]
62 11 Jakub Jirůtka
* *Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*
63 1 Jakub Jirůtka
64 1 Jakub Jirůtka
65 6 Jakub Jirůtka
h2. GET /courses/{code}/parallels
66 1 Jakub Jirůtka
67 6 Jakub Jirůtka
Vrátí paralelky (instance) předmětu a) v aktuálním semestru, b) ve zvolených semestrech parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
68 1 Jakub Jirůtka
69 6 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/parallels/
70 1 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
71 6 Jakub Jirůtka
* *Typ obsahu:* [[Parallel]]
72 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
73 1 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]]
74 11 Jakub Jirůtka
* *Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*
75 1 Jakub Jirůtka
76 1 Jakub Jirůtka
77 6 Jakub Jirůtka
h2. GET /courses/{code}/students
78 5 Jakub Jirůtka
79 6 Jakub Jirůtka
Vrátí studenty zapsané na (instanci) předmětu a) v aktuálním semestru, b) ve zvolených semestrech parametrem [[URLParameters#sem|sem]], c) nebo pro všechny semestry (parametr _sem=none_).
80 1 Jakub Jirůtka
81 6 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/students/
82 4 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
83 6 Jakub Jirůtka
* *Typ obsahu:* [[Student]]
84 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
85 1 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]]
86 11 Jakub Jirůtka
* *Rozsah dat:* omezený / záznamy pro danou fakultu *[[data_restrictions|/?/]]*
87 1 Jakub Jirůtka
88 1 Jakub Jirůtka
89 6 Jakub Jirůtka
h2. GET /courses/{code}/instances
90 1 Jakub Jirůtka
91 7 Jakub Jirůtka
Vrátí všechny instance daného předmětu – pouze atributy instance, nikoli obecné předmětu. Ve většině případech budete chtít použít spíše zdroj [[Courses#GET-coursescode|/courses/{code}]] s parametrem [[URLParameters#sem|sem]].
92 1 Jakub Jirůtka
93 6 Jakub Jirůtka
* *URI:* {{base_url}}/api/3/courses/{code}/instances/
94 1 Jakub Jirůtka
* *Typ zdroje:* Atom Feed
95 6 Jakub Jirůtka
* *Typ obsahu:* [[Coursin]]
96 1 Jakub Jirůtka
* *Formáty:* [[atom]], [[xml]]
97 1 Jakub Jirůtka
* *Proměnné:* @{code}@ kód předmětu
98 6 Jakub Jirůtka
* *Parametry:* [[URLParameters#fields|fields]], [[URLParameters#lang|lang]], [[URLParameters#multilang|multilang]], [[URLParameters#locEnums|locEnums]]
99 11 Jakub Jirůtka
* *Rozsah dat:* úplný / záznamy pro celé ČVUT *[[data_restrictions|/?/]]*