/login

Parametry

username

string

Uživatelské jméno

password

string

Heslo

Návratová struktura

Success

boolean

Úspěch akce. true v případě úspěšného ověření, false v případě chyby.

Error

string

V případě neúspěchu obsahuje chybovou zprávu s popisem chyby.

ErrorCode

int

Chybový kód.

Session

string

V případě úspěchu obsahuje 32 znaků dlouhý identifikátor session, který aplikace musí uchovat a používat v dalším volání funkcí. Platnost identifikátoru je 1 hodina od posledního volání API.

Popis

Slouží k autentizaci uživatele. Předané parametry identifikují uživatele a v případě úspěšného ověření je zpět vrácen identifikátor session, který je možné použít k dalšímu volání API.

/login-info

Parametry

Funkce nepřijímá žádné specifické parametry kromě autentizačních.

Návratová struktura

Success

string

Úspěch akce. true v případě že je uživatel přihlášen, false pokud přihlášen není.

Error

string

V případě neúspěchu obsahuje chybovou zprávu s popisem chyby (důvodem, proč uživatel není přihlášen).

ErrorCode

int

Chybový kód.

User

struct

Informace o přihlášeném uživateli.

name

string

Uživatelské jméno

/register

Parametry

username

string

Uživatelské jméno. Smí obsahovat jakékoliv znaky a musí být v systému unikátní.

password

string

Heslo. Heslo je posíláno jako čistý text a musí být nejméně 6 znaků dlouhé.

email

string

Email

Návratová struktura

Success

bool

Úspěch akce. true v případě úspěšné registrace, false v případě chyby.

Error

string

Chybová zpráva v případě, že došlo k chybě ve zpracování registrace.

ErrorCode

int

Chybový kód.

User

struct

Informace o zaregistrovaném uživateli.

name

string

Uživatelské jméno

Popis

Tato funkce nevyžaduje autentizaci.

Slouží k registraci nového uživatelského účtu. Funkčnost je ekvivalentní registraci na webu, včetně požadavků na vstupní parametry. Všechny tři parametry (uživatelské jméno, heslo a email) jsou povinné.

/users/statbar/<username>

Parametry

username

string

Parametr se předává přímo jako součást volání funkce. Obsahuje jméno uživatele, jehož statistiky chceme získat.

Návratová struktura

Success

boolean

Úspěch akce.

User

string

Uživatelské jméno, jehož statistiky jsou vráceny. Odpovídá parametru username.

UniqueCWGCount

int

Počet unikátních CWG, která má uživatel ve své sbírce.

Popis

Tato funkce nevyžaduje autentizaci.

Funkce vrací počet unikátních CWG, které jsou ve sbírce. Tento údaj může být použit k zobrazování například ve statistikách nebo na ikonkách.

/collection/export

Parametry

format

enum

Formát exportu kolekce. O konkrétních formátech více v kapitole Datové formáty
Přípustné hodnoty:

• fullxml - Kompletní XML
• json - JSON

since

datetime

null

Volitelný parametr. Pokud je specifikován, zahrne do exportu pouze změny od specifikovaného data.

from

int

0

Pouze pro JSON export. Stránkování - počet záznamů, které mají být přeskočeny. Export je řazen podle data poslední aktualizace záznamu.

count

int

100

Pouze pro JSON export. Stránkování - kolik záznamů se má maximálně exportovat. Hodnota může být v rozmezí (1-1000). Export je řazen podle data poslední aktualizace záznamu.

Návratová hodnota

Funkce vrací soubor s exporem kolekce ve formátu závislém na specifikovaném parametru.

Popis

Funkce slouží pro export informací o katalogizovaných CWG pro přihlášeného uživatele.

/collection/collect

Parametry

cwgno

string

Katalogové číslo CWG, které má být zařazeno do kolekce.

name

string

Název CWG v případě, že se jedná o nekatalogizované CWG.

version

int

Verze CWG v případě, že se jedná o nekatalogizované CWG.

date

date

aktuální datum

Volitelný parametr. Datum zařazení do kolekce.

year

int

aktuální rok

Volitelný parametr. Rok výroby CWG.

pieces

int

?

Volitelný parametr. Počet zařazených kusů.

comment

string

""

Volitelný parametr. Poznámka týkající se katalogizovaného kusu CWG.

update

boolean

true

V případě, že je CWG již v kolekci s uvedeným datem, má dojít k aktualizaci nebo nahrazení záznamu? true pro aktualizaci (doplnění dalšího kusu), false pro nahrazení.

Návratová struktura

Success

boolean

Úspěch akce. true CWG bylo úspěšně zařazeno do kolekce.

Error

string

V případě neúspěchu obsahuje chybovou zprávu.

ErrorCode

int

Chybový kód.

Popis

Slouží k zařazení nového kusu CWG do kolekce. K identifikaci CWG slouží jeho katalogové číslo, případně pokud CWG není zařazeno v oficiálním katalogu, slouží k identifikaci název a verze CWG. Pokud se jedná o katalogizované CWG, nemusí být parametry name a version přítomny, stejně tak pokud se jedná o nekatalogizované CWG, nemusí být přítomen parametr cwgno.

Parametry date, pieces, comment jsou volitelné a slouží k doplění podrobnějších informací ke katalogizovanému kusu CWG. Pro jednoduché zařazení do kolekce (ekvivalentní kliknutí na zelenou fajvku v katalogu) stačí pouze zavolat tuto funkci s identifikací CWG.

Pro vyřazení CWG z kolekce uveďte parametr pieces = 0, update = false.

/collection/import

Parametry

overwrite

boolean

false

Uvádí, jestli má dojít k přepisu údajů v kolekci, nebo k jejich aktualizaci. false = aktualizovat, true = přepsat

fileformat

enum

Formát importovaného souboru. O formátech více v kapitole Datové formáty.
Přípustné hodnoty:

• fullxml - Kompletní XML

Návratová struktura

Success

bool

Úspěch akce.

Error

string

V případě neúspěchu obsahuje popis chyby.

ErrorCode

int

Chybový kód.

ImportedStatus

struct

Informace o výsledcích importu

added

int

Počet nově zařazených CWG.

updated

int

Počet aktualizovaných CWG.

errors

array[struct]

Pole obsahující údaje o chybách při importu.

cwg_no

string

Katalogové číslo CWG, pokud je uvedeno

name

name

Název CWG, pokud je uveden.

version

version

Verze CWG, pokud je uvedena.

error

string

Popis chyby.

Popis

Import kolekce. Standardní chování pouze doplní informace o nově zařazených CWG, pokud v importovaném souboru pro některý ze záznamů neexistuje informace, nedojde k jeho smazání.

Při hodnotě parametru overwrite = true dojde ke kompletnímu přepisu kolekce, tj. CWG která nejsou v importovaném souboru uvedena, budou vymazána z uživatelovy kolekce.

Uživatel by měl VŽDY být varován nebo dostat na výběr v případě použití parametru overwrite = true.

/cwg/info

Parametry

cwgno

string

Katalogové číslo CWG, které má být zařazeno do kolekce.

name

string

Název CWG v případě, že se jedná o nekatalogizované CWG.

version

int

Verze CWG v případě, že se jedná o nekatalogizované CWG.

id

int

ID CWG v případě, že nelze jednoznačně CWG dohledat pomocí katalogového čísla nebo názvu + verze.

Návratová struktura

Success

bool

Úspěch akce

Error

string

V případě neúspěchu obsahuje chybovou zprávu.

ErrorCode

int

Chybový kód.

CWG

struct

Informace o CWG.

id

int

Unikátní identifikační číslo CWG.

cwgno

string

Katalogové číslo CWG.

name

string

Název CWG

version

int

Verze CWG

tags

struct

Seznam tagů, do kterých CWG patří.

name

string

Název tagu

category

struct

Kategorie, do které patří tag.

name

string

Název kategorie

id

string

Identifikátor kategorie

comment

string

Poznámka uvedená v katalogu

image

string

Adresa obrázku CWG.

profile

string

Adresa profilu na gc.com.

since

date

Datum zařazení do katalogu.

collection

array[struct]

Seznam uživatelů mající toto CWG ve své kolekci.

name

string

Uživatelské jméno

profile

string

Adresa veřejného profilu uživatele

pieces

int

Počet kusů, které má uživatel ve sbírce

appropox

bool

Pokud je hodnota true, není počet kusů přesný - uživatel má u některého z CWG uveden pouze příznak že ho má v kolekci, avšak bez specifikování počtu kusů.

offers

array[struct]

Seznam uživatelů nabízejících toto CWG.

name

string

Uživatelské jméno

profile

string

Adresa veřejnéno profilu uživatele.

pieces

int

Počet kusů, které uživatel nabízí.

comment

string

Počet kusů, které uživatel nabízí.

wants

array[struct]

Seznam uživatelů, kteří toto CWG shánějí.

name

string

Uživatelské jméno

profile

string

Adresa veřejného profilu uživatele.

notwant

array[struct]

Seznam uživatelů, kteří toto CWG nechtějí.

name

string

Uživatelské jméno

profile

string

Adresa veřejného profilu uživatele.

Popis

Informace o jednom CWG. Specifikovat CWG je možno jeho katalogovým číslem nebo kombinací název + verze pro nekatalogizovaná CWG.

Obsahuje informace dostupné ve stejné podobě jako jsou obsaženy v katalogu na webu + informace o tom, kteří uživatelé CWG nabízejí, shání, nechtějí a mají v kolekci.

/cwg/export

Parametry

since

datetime

null

Volitelný parametr. Pokud je specifikován, budou exportovány pouze změněné záznamy od specifikovaného data. Změna může být jak ze strany katalogu (aktualizace údajů o CWG), tak ze strany uživatele (změna některého ze stavů, které jsou v tomto exportu obsaženy).

Návratová hodnota

Funkce vrací soubor s exporem kolekce ve formátu CSV. CSV obsahuje následující sloupečky:

1. Katalogové číslo
2. Název
3. Verze
4. Komentář
5. Adresa obrázku
6. Adresa profilu
7. Datum zařazení do katalogu (ISO 8601)
8. Má v kolekci? (true/false)
9. Nabízí? (true/false)
10. Shání? (true/false)
11. Nechce? (true/false)
12. Datum poslední aktualizace stavu CWG ze strany uživatele (nebo null pokud uživatel u CWG nic nemá)
13. Unikátní ID CWG
14. Seznam tagů přiřazených CWG

Jako oddělovač je použita čárka a pokud některý ze sloupečků obsahuje tento znak, je celá hodnota sloupečku uvedena v uvozovkách (").

Seznam tagů je ve formátu id-kategorie:název tagu a seznam je oddělený čárkami.

V HTTP hlavičce Item-Count je zároveň odeslán celkový počet položek v exportním souboru.

Popis

Export celého CWG katalogu včetně základních informací o uživatelově sbírce.

/cwg/search

Parametry

name

string

Název CWG, který se má vyhledat.

Návratová hodnota

Funkce vrací soubor s výsledky vyhledávání kolekce ve formátu CSV. CSV obsahuje následující sloupečky:

1. Katalogové číslo
2. Název
3. Verze
4. ID Kategorie (viz číselník kategorií)
5. Komentář
6. Adresa obrázku
7. Adresa profilu
8. Datum zařazení do katalogu (ISO 8601)
9. Má v kolekci? (true/false)
10. Nabízí? (true/false)
11. Shání? (true/false)
12. Nechce? (true/false)
13. Datum poslední aktualizace stavu CWG ze strany uživatele (nebo null pokud uživatel u CWG nic nemá)
14. Unikátní ID CWG

Jako oddělovač je použita čárka a pokud některý ze sloupečků obsahuje tento znak, je celá hodnota sloupečku uvedena v uvozovkách (").

Popis

Export celého CWG katalogu včetně základních informací o uživatelově sbírce.

/cwg/categoryList

Parametry

Funkce nepřijímá žádné specifické parametry kromě autentizačních.

Návratová struktura

Success

bool

Úspěch akce

Error

string

V případě neúspěchu obsahuje chybovou zprávu.

ErrorCode

int

Chybový kód.

Categories

array

Seznam existujících kategorií

id

int

Kód kategorie

name

string

Název kategorie

freeAdd

bool

Pokud je true, do této kategorie je možné vkládat nová CWG.

parentId

int

ID nadřazené kategorie nebo null, pokud se jedná o kategorii na nejvyšší úrovni.

Popis

Funkce vrací seznam existujících a platných kategorií v systému.

/cwg/joinedList

Parametry

since

datetime

null

Volitelný parametr - čas poslední aktualizace. Ve výsledku budou zahrnuty jen sloučené CWG, které byly sloučeny později než je hodnota parametru.

Návratová hodnota

Success

bool

Úspěch akce

Error

string

V případě neúspěchu obsahuje chybovou zprávu.

ErrorCode

int

Chybový kód.

Joined

array

Seznam sloučených CWG

from_cwg

int

ID CWG, které bylo zrušeno sloučením.

to_cwg

int

ID cílového CWG, které zůstalo v katalogu po sloučení.

/cwg/images

Parametry

since

datetime

null

Volitelný parametr. Pokud je specifikován, pošle pouze obrázky, které jsou nové nebo aktualizované od zadaného data. Slouží k inkrementální aktualizaci lokálního úložiště obrázků CWG. Bez tohoto parametru je vždy staženo všechno, což je časově i datově náročná operace, takže doporučuji používat inkrementální režim.

Návratová hodnota

Funkce vrací soubor ve formátu ZIP s požadovanými obrázky.

Popis

Funkce sloužící ke stažení obrázků (náhledů) CWG. Umí pracovat ve dvou módech - plný a inkrementální. V případě, že není předán parametr since, jedná se o plný mód. Pokud parametr předán je, jedná se o inkrementální.

Při plném módu jsou vždy odeslány všechny obrázky, které existují.

Při inkrementálním módu jsou odeslány pouze obrázky, které byly aktualizovány nebo přidány od specifikovaného data.

Z důvodu velké datové náročnosti doporučuji vždy, pokud je to možné, využívat inkrementální mód, který zbytečně nestahuje již stažená data.