URLParameters » Historie » Verze 2

Verze 1 (Jakub Jirůtka, 2011-06-25 23:25) → Verze 2/8 (Jakub Jirůtka, 2011-06-26 12:24)

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]]. elementů.

*Vstup:* [[XPartial]] XPartial výraz

*Působnost:* Atom Feed, Atom Entry

h2. lang

*Popis:* Jazyk obsahu, přepíše hodnotu zadanou HTTP(Hypertext Transfer Protocol) HTTP hlavičkou Accept-Language.

_Accept-Language_.

*Vstup:* cs|en

*Působnost:* všude

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. 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

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]])? zadaném?

*Vstup:* true|false

*Působnost:* Atom Feed, Atom Entry

h2. orderBy

*Popis:* Název atributu, podle kterého se mají záznamy seřadit. Atributy jsou elementy uvnitř <atom:content>. _&lt;atom:content&gt;_.

*Vstup:* validní název atributu

*Působnost:* Atom Feed

h2. query

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

*Vstup:* [[RSQL]] RSQL výraz

*Působnost:* Atom Feed

h2. startIndex

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

*Vstup:* 0 1 - 2147483647

*Působnost:* Atom Feed