URLParameters » Historie » Verze 4
Verze 3 (Jakub Jirůtka, 2011-08-15 16:46) → Verze 4/8 (Jakub Jirůtka, 2012-07-10 15:46)
h1. URL parametry
Seznam všech obecných URL parametrů používaných v KOSapi. Tyto parametry se zapisují do URL jako "query string":http://en.wikipedia.org/wiki/Query_string.
h2. fields
*Popis:* Filtrace vypisovaných elementů pomocí [[XPartial]].
*Vstup:* [[XPartial]] výraz
*Působnost:* Atom Feed, Atom Entry
h2. lang
*Popis:* Jazyk obsahu, přepíše hodnotu zadanou HTTP(Hypertext Transfer Protocol) hlavičkou Accept-Language.
*Vstup:* cs|en
*Působnost:* všude
h2. limit locEnums
*Popis:* Mají se lokalizovat výčtové typy, nebo použít výčtový název?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. maxResults
*Popis:* Maximální počet požadovaných záznamů, neboli po kolika záznamech se má stránkovat (v předchozí verzi _maxResults_). stránkovat.
*Vstup:* 1 - 2147483647
*Působnost:* Atom Feed
h2. locEnums
*Popis:* Mají se lokalizovat výčtové typy, nebo použít výčtový název?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. multilang
*Popis:* Mají se vypsat multijazyčné názvy ve všech jazycích, nebo jen v zadaném (pomocí HTTP(Hypertext Transfer Protocol) hlavičky Accept-Language nebo parametru [[URLParameters#lang|lang]])?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. offset
*Popis:* Index prvního požadovaného záznamu (číslované od nuly) pro stránkování (v předchozí verzi _startIndex_).
*Vstup:* 0 - 2147483647
*Působnost:* Atom Feed
h2. orderBy
*Popis:* Název atributu, podle kterého se mají záznamy seřadit. Atributy jsou elementy uvnitř <atom:content>.
*Vstup:* validní název atributu
*Působnost:* Atom Feed
h2. query
*Popis:* Vyhledá záznamy odpovídající zadanému [[Query#RSQL|RSQL]] výrazu.
*Vstup:* RSQL(RESTful Resource Query Language) výraz
*Působnost:* Atom Feed
h2. sem startIndex
*Popis:* Vyhledá záznamy platné Index prvního požadovaného záznamu (číslované od nuly) 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. stránkování.
*Vstup:* [[SemesterFilter]] 0 - 2147483647
*Působnost:* _není globálním parametrem_ Atom Feed
Seznam všech obecných URL parametrů používaných v KOSapi. Tyto parametry se zapisují do URL jako "query string":http://en.wikipedia.org/wiki/Query_string.
h2. fields
*Popis:* Filtrace vypisovaných elementů pomocí [[XPartial]].
*Vstup:* [[XPartial]] výraz
*Působnost:* Atom Feed, Atom Entry
h2. lang
*Popis:* Jazyk obsahu, přepíše hodnotu zadanou HTTP(Hypertext Transfer Protocol) hlavičkou Accept-Language.
*Vstup:* cs|en
*Působnost:* všude
h2. limit locEnums
*Popis:* Mají se lokalizovat výčtové typy, nebo použít výčtový název?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. maxResults
*Popis:* Maximální počet požadovaných záznamů, neboli po kolika záznamech se má stránkovat (v předchozí verzi _maxResults_). stránkovat.
*Vstup:* 1 - 2147483647
*Působnost:* Atom Feed
h2. locEnums
*Popis:* Mají se lokalizovat výčtové typy, nebo použít výčtový název?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. multilang
*Popis:* Mají se vypsat multijazyčné názvy ve všech jazycích, nebo jen v zadaném (pomocí HTTP(Hypertext Transfer Protocol) hlavičky Accept-Language nebo parametru [[URLParameters#lang|lang]])?
*Vstup:* true|false
*Působnost:* Atom Feed, Atom Entry
h2. offset
*Popis:* Index prvního požadovaného záznamu (číslované od nuly) pro stránkování (v předchozí verzi _startIndex_).
*Vstup:* 0 - 2147483647
*Působnost:* Atom Feed
h2. orderBy
*Popis:* Název atributu, podle kterého se mají záznamy seřadit. Atributy jsou elementy uvnitř <atom:content>.
*Vstup:* validní název atributu
*Působnost:* Atom Feed
h2. query
*Popis:* Vyhledá záznamy odpovídající zadanému [[Query#RSQL|RSQL]] výrazu.
*Vstup:* RSQL(RESTful Resource Query Language) výraz
*Působnost:* Atom Feed
h2. sem startIndex
*Popis:* Vyhledá záznamy platné Index prvního požadovaného záznamu (číslované od nuly) 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. stránkování.
*Vstup:* [[SemesterFilter]] 0 - 2147483647
*Působnost:* _není globálním parametrem_ Atom Feed