URLParameters » History » Version 3

« Previous - Version 3/8 (diff) - Next » - Current version
Jakub Jirůtka, 08/15/2011 04:46 PM
opraven odkaz na RSQL


URL parametry

Seznam všech obecných URL parametrů používaných v KOSapi. Tyto parametry se zapisují do URL jako query string.

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

locEnums

Popis: Mají se lokalizovat výčtové typy, nebo použít výčtový název?

Vstup: true|false

Působnost: Atom Feed, Atom Entry

maxResults

Popis: Maximální počet požadovaných záznamů, neboli po kolika záznamech se má stránkovat.

Vstup: 1 - 2147483647

Působnost: Atom Feed

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

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

query

Popis: Vyhledá záznamy odpovídající zadanému RSQL výrazu.

Vstup: RSQL výraz

Působnost: Atom Feed

startIndex

Popis: Index prvního požadovaného záznamu (číslované od nuly) pro stránkování.

Vstup: 0 - 2147483647

Působnost: Atom Feed

Also available in: PDF HTML TXT