URL parametry¶
Seznam všech obecných URL parametrů používaných v KOSapi. Tyto parametry se zapisují do URL jako query string.
detail¶
Popis: Úroveň detailu vypsání zdroje. Zatím se používá pouze v Course.
Vstup: 0–1
Působnost: Course
fields¶
Popis: Filtrace vypisovaných elementů pomocí XPartial.
Vstup: XPartial výraz
Působnost: Atom Feed, Atom Entry
lang¶
Popis: Jazyk obsahu, přepíše hodnotu zadanou HTTP hlavičkou Accept-Language.
Vstup: cs|en
Působnost: všude
limit¶
Popis: Maximální počet požadovaných záznamů, neboli po kolika záznamech se má stránkovat.
Vstup: 1 - 1 000
Působnost: Atom Feed
locEnums¶
Popis: Mají se lokalizovat výčtové typy, nebo použít výčtový název?
Vstup: true|false
Působnost: Atom Feed, Atom Entry
multilang¶
Popis: Mají se vypsat multijazyčné názvy ve všech jazycích, nebo jen v zadaném (pomocí HTTP hlavičky Accept-Language nebo parametru lang)?
Vstup: true|false
Působnost: Atom Feed, Atom Entry
offset¶
Popis: Index prvního požadovaného záznamu (číslované od nuly) pro stránkování. Pozor na to, že KOSapi při stránkování nevynucuje řazení a bez něj databáze vrací záznamy v nedefinovaném pořadí! U některých zdrojů to může mít za následek vrácení nekompletní množiny záznamů s duplicitami. V takovém případě použijte parametr orderBy a řaďte např. podle id
.
Vstup: 0 - 21 4748 3647
Působnost: Atom Feed
orderBy¶
Popis: Specifikuje řazení záznamů.
Vstup: Ordering
Působnost: Atom Feed
query¶
Popis: Vyhledá záznamy odpovídající zadanému RSQL výrazu.
Vstup: RSQL výraz
Působnost: Atom Feed
sem¶
Popis: Vyhledá záznamy platné pro dané semestry. V některých zdrojích má širší význam, který je poté explicitně uveden v dokumentaci příslušného zdroje.
Vstup: SemesterFilter
Působnost: není globálním parametrem