URLParameters » History » Version 5

Jakub Jirůtka, 07/12/2012 11:49 PM
přidán detail

1 1 Jakub Jirůtka
h1. URL parametry
2 1 Jakub Jirůtka
3 1 Jakub Jirůtka
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.
4 1 Jakub Jirůtka
5 1 Jakub Jirůtka
6 5 Jakub Jirůtka
h2. detail
7 5 Jakub Jirůtka
8 5 Jakub Jirůtka
*Popis:* Úroveň detailu vypsání zdroje. Zatím se používá pouze v [[Course]].
9 5 Jakub Jirůtka
10 5 Jakub Jirůtka
*Vstup:* 0–1
11 5 Jakub Jirůtka
12 5 Jakub Jirůtka
*Působnost:* [[Course]]
13 5 Jakub Jirůtka
14 5 Jakub Jirůtka
15 1 Jakub Jirůtka
h2. fields
16 1 Jakub Jirůtka
17 2 Jakub Jirůtka
*Popis:* Filtrace vypisovaných elementů pomocí [[XPartial]].
18 1 Jakub Jirůtka
19 2 Jakub Jirůtka
*Vstup:* [[XPartial]] výraz
20 1 Jakub Jirůtka
21 1 Jakub Jirůtka
*Působnost:* Atom Feed, Atom Entry
22 1 Jakub Jirůtka
23 1 Jakub Jirůtka
24 1 Jakub Jirůtka
h2. lang
25 1 Jakub Jirůtka
26 2 Jakub Jirůtka
*Popis:* Jazyk obsahu, přepíše hodnotu zadanou HTTP(Hypertext Transfer Protocol) hlavičkou Accept-Language.
27 1 Jakub Jirůtka
28 1 Jakub Jirůtka
*Vstup:* cs|en
29 1 Jakub Jirůtka
30 1 Jakub Jirůtka
*Působnost:* všude
31 1 Jakub Jirůtka
32 1 Jakub Jirůtka
33 4 Jakub Jirůtka
h2. limit
34 1 Jakub Jirůtka
35 4 Jakub Jirůtka
*Popis:* Maximální počet požadovaných záznamů, neboli po kolika záznamech se má stránkovat (v předchozí verzi _maxResults_).
36 1 Jakub Jirůtka
37 4 Jakub Jirůtka
*Vstup:* 1 - 2147483647
38 1 Jakub Jirůtka
39 4 Jakub Jirůtka
*Působnost:* Atom Feed
40 1 Jakub Jirůtka
41 1 Jakub Jirůtka
42 4 Jakub Jirůtka
h2. locEnums
43 1 Jakub Jirůtka
44 4 Jakub Jirůtka
*Popis:* Mají se lokalizovat výčtové typy, nebo použít výčtový název?
45 1 Jakub Jirůtka
46 4 Jakub Jirůtka
*Vstup:* true|false
47 1 Jakub Jirůtka
48 4 Jakub Jirůtka
*Působnost:* Atom Feed, Atom Entry
49 1 Jakub Jirůtka
50 1 Jakub Jirůtka
51 1 Jakub Jirůtka
h2. multilang
52 1 Jakub Jirůtka
53 1 Jakub Jirůtka
*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]])?
54 1 Jakub Jirůtka
55 1 Jakub Jirůtka
*Vstup:* true|false
56 1 Jakub Jirůtka
57 1 Jakub Jirůtka
*Působnost:* Atom Feed, Atom Entry
58 1 Jakub Jirůtka
59 1 Jakub Jirůtka
60 4 Jakub Jirůtka
h2. offset
61 4 Jakub Jirůtka
62 4 Jakub Jirůtka
*Popis:* Index prvního požadovaného záznamu (číslované od nuly) pro stránkování (v předchozí verzi _startIndex_).
63 4 Jakub Jirůtka
64 4 Jakub Jirůtka
*Vstup:* 0 - 2147483647
65 4 Jakub Jirůtka
66 4 Jakub Jirůtka
*Působnost:* Atom Feed
67 4 Jakub Jirůtka
68 4 Jakub Jirůtka
69 1 Jakub Jirůtka
h2. orderBy
70 2 Jakub Jirůtka
71 1 Jakub Jirůtka
*Popis:* Název atributu, podle kterého se mají záznamy seřadit. Atributy jsou elementy uvnitř <atom:content>.
72 1 Jakub Jirůtka
73 1 Jakub Jirůtka
*Vstup:* validní název atributu
74 1 Jakub Jirůtka
75 1 Jakub Jirůtka
*Působnost:* Atom Feed
76 3 Jakub Jirůtka
77 1 Jakub Jirůtka
78 1 Jakub Jirůtka
h2. query
79 1 Jakub Jirůtka
80 1 Jakub Jirůtka
*Popis:* Vyhledá záznamy odpovídající zadanému [[Query#RSQL|RSQL]] výrazu.
81 1 Jakub Jirůtka
82 3 Jakub Jirůtka
*Vstup:* RSQL(RESTful Resource Query Language) výraz
83 1 Jakub Jirůtka
84 1 Jakub Jirůtka
*Působnost:* Atom Feed
85 1 Jakub Jirůtka
86 1 Jakub Jirůtka
87 4 Jakub Jirůtka
h2. sem
88 1 Jakub Jirůtka
89 4 Jakub Jirůtka
*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.
90 1 Jakub Jirůtka
91 4 Jakub Jirůtka
*Vstup:* [[SemesterFilter]]
92 1 Jakub Jirůtka
93 4 Jakub Jirůtka
*Působnost:* _není globálním parametrem_