Stručná dokumentace

Komunikace probíhá prostřednictvím protokolu HTTP. Vstupní bod pro komunikaci je http://www.rajce.idnes.cz/liveAPI/index.php. Požadavky se posílají metodou POST v položce jménem "data".

Příklad vrácené chyby:

    <?xml version="1.0" encoding="utf-8"?>
    <response>
        <result>Chybný přihlašovací token.</result>
        <errorCode>4</errorCode>
    </response>
			

  1. Přihlášení
  2. Získání seznamu alb
  3. Získání seznamu fotek a videí alba
  4. Vytvoření nového alba
  5. Otevře album pro přidávání fotek
  6. Přidání fotky do alba
  7. Uzavření alba
  8. Získání URL alba pro jeho zobrazení po dokončení uploadu
  9. Získá adresu pro vytvoření účtu
  10. Získá adresu pro obnovu hesla při jeho zapomenutí
  11. Dotaz na aktualizaci programu při spuštění programu
  12. Získání obecné URL k nějakému účelu
  13. Smazání alba
  14. Započatí nahrávání videa
  15. Nahrávání několika bloků videa
  16. Dokončení nahrávání videa
  17. Vyhledávání uživatelů
  18. Vyhledávání alb
  19. Získání seznamu oblíbených uživatelů
  20. Získání seznamu oblíbených alb
  21. Získání informací o uživateli
  22. Získání seznamu nej fotek
  23. Přidání uživatele do seznamu oblíbených
  24. Odebrání uživatele ze seznamu oblíbených
  25. Přidání alba do seznamu oblíbených alb
  26. Odebrání alba ze seznamu oblíbených
  27. Získání seznamu kategorií
  28. Získání seznamu nej alb v kategorii
  29. Smazání fotky

Přihlášení

Přihlášení k rajčeti. Za základě přihlášení dostanete sessionToken, který dále používáte pro komunikaci s rajčetem. Většina ostatní API funkcí též vrací sessionToken, který nahrazuje ten původní. Princip podobný cookies.

Požadavek

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>login</command>
<parameters>
<clientID>...</clientID> <!-- přidělený unikátní identifikátor programu -->
<currentVersion>1.2.3.4</currentVersion> <!-- číslo aktuální verze klienta (major, minor, revision, build) -->
<lang>12345</lang> <!-- volitelně může obsahovat seznam jazyků pro komunikaci - stejně jako Accept-Language v HTTP -->
<login>neco@neco.cz</login> <!-- e-mail -->
<password>123fb5b114fe979a4a4dbe7e8165a174</password> <!-- md5(hesla v cp1250) -->
</parameters>
</request>
  • clientIDpřidělený unikátní identifikátor programu
  • currentVersiončíslo aktuální verze klienta (major, minor, revision, build)
  • langvolitelně může obsahovat seznam jazyků pro komunikaci - stejně jako Accept-Language v HTTP
  • logine-mail
  • passwordmd5(hesla v cp1250)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<maxWidth>1400</maxWidth> <!-- max. šířka uploadované fotky v px -->
<maxHeight>1400</maxHeight> <!-- max. výška uploadované fotky v px -->
<quality>80</quality> <!-- stupeň jpeg komprese (100 = max. kvalita) -->
<nick>mujnick</nick> <!-- přezdívka uživatele -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • maxWidthmax. šířka uploadované fotky v px
  • maxHeightmax. výška uploadované fotky v px
  • qualitystupeň jpeg komprese (100 = max. kvalita)
  • nickpřezdívka uživatele

Získání seznamu alb

Požadavek

Vylistuje seznam svých alb.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getAlbumList</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<skip>0</skip> <!-- přeskočit určitý počet alb (volitelně) -->
<limit>20</limit> <!-- max. počet vrácených alb (volitelně) -->
<columns> <!-- seznam volitelných sloupců, které chceme vrátit -->
<column>viewCount</column> <!-- počet zobrazení stránky alba -->
<column>isFavourite</column> <!-- info, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu -->
<column>descriptionHtml</column> <!-- popis alba ve zjednodušené HTML podobě -->
<column>coverPhotoID</column> <!-- ID fotky tvořící obálku alba -->
<column>videoCount</column> <!-- počet videí v albu -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • skippřeskočit určitý počet alb (volitelně)
  • limitmax. počet vrácených alb (volitelně)
  • columnsseznam volitelných sloupců, které chceme vrátit
  • Sloupec viewCountpočet zobrazení stránky alba
  • Sloupec isFavouriteinfo, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu
  • Sloupec descriptionHtmlpopis alba ve zjednodušené HTML podobě
  • Sloupec coverPhotoIDID fotky tvořící obálku alba
  • Sloupec videoCountpočet videí v albu

Požadavek

Vylistuje seznam alb jiného uživatele – pouze viditelná alba (a veřejné údaje).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getAlbumList</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<userID>15635</userID> <!-- ID uživatele -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • userIDID uživatele

Požadavek

Zjistí základní informace o jednom albu - pouze viditelná alba (a veřejné údaje), pokud není uveden token majitele alba.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getAlbumList</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<albumID>12351351</albumID> <!-- ID alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • albumIDID alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>103</totalCount> <!-- celkový počet alb odpovídající dotazu (bez ohledu na skip a limit) -->
<albums> <!-- seznam alb -->
<album id="123"> <!-- reprezentuje jedno album -->
<albumName>Zvířata</albumName> <!-- jméno alba -->
<description></description> <!-- popis alba (může obsahovat BB tagy) -->
<descriptionHtml></descriptionHtml> <!-- popis alba ve zjednodušené HTML podobě -->
<url>http://qwerty.rajce.idnes.cz/Zvirata/</url> <!-- url alba -->
<thumbUrl>http://img5.rajce.idnes.cz/d0507/1/1886/1886565_ed7bd4066c53d5b5c7c96891407e6a44/thumb/Green_Sea_Turtle.jpg</thumbUrl> <!-- náhled v malé kvalitě, rozlišení není zaručeno -->
<thumbUrlBest>http://www.rajce.idnes.cz/f121586306/200px</thumbUrlBest> <!-- náhled ve velké kvalitě, rozlišení není zaručeno -->
<createDate>2012-01-11 18:34:23</createDate> <!-- datum vytvoření alba -->
<updateDate>2012-01-11 18:34:24</updateDate> <!-- datum poslední úpravy alba -->
<hidden>0</hidden> <!-- info, zda je album skryté (0/1) -->
<secure>0</secure> <!-- info, zda je album chráněné heslem (0/1) -->
<photoCount>26</photoCount> <!-- počet fotek (včetně videí) v albu -->
<videoCount>3</videoCount> <!-- počet videí v albu -->
<startDateInterval>2012-01-11 14:50:05</startDateInterval> <!-- počáteční datum, ze kterého pocházejí fotky -->
<endDateInterval>2012-01-11 16:03:14</endDateInterval> <!-- konečné datum, ze kterého pocházejí fotky -->
<isFavourite>1</isFavourite> <!-- info, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu -->
<coverPhotoID>123456789</coverPhotoID> <!-- ID fotky tvořící obálku alba -->
</album>
<album id="..."> <!-- -->
<...>...</...> <!-- -->
</album>
</albums>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet alb odpovídající dotazu (bez ohledu na skip a limit)
  • albumsseznam alb
  • albumreprezentuje jedno album
  • albumNamejméno alba
  • descriptionpopis alba (může obsahovat BB tagy)
  • descriptionHtmlpopis alba ve zjednodušené HTML podobě
  • urlurl alba
  • thumbUrlnáhled v malé kvalitě, rozlišení není zaručeno
  • thumbUrlBestnáhled ve velké kvalitě, rozlišení není zaručeno
  • createDatedatum vytvoření alba
  • updateDatedatum poslední úpravy alba
  • hiddeninfo, zda je album skryté (0/1)
  • secureinfo, zda je album chráněné heslem (0/1)
  • photoCountpočet fotek (včetně videí) v albu
  • videoCountpočet videí v albu
  • startDateIntervalpočáteční datum, ze kterého pocházejí fotky
  • endDateIntervalkonečné datum, ze kterého pocházejí fotky
  • isFavouriteinfo, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu
  • coverPhotoIDID fotky tvořící obálku alba

Získání seznamu fotek a videí alba

Požadavek

Pomocí columns lze zvolit požadované "sloupce" (údaje) a zmenšit tak množství přenášených dat. ThumbUrl obsahuje url předgenerovaného náhledu (nejrychlejší přístup i při velkém množství requestů - např. stažení náhledů všech fotek alba). ThumbUrlBest obsahuje url většího náhledu, který je cachovaný, ale jinak generovaný na přání. UrlBase pak obsahuje začátek url, pomocí které si můžeme nechat obrázek vygenerovat na přání - tedy zvolit rozměr a míru jpeg komprese. Stačí na konec doplnit tyto údaje, např.:

http://www.rajce.idnes.cz/f202525196-7a2782d3/ ... s výchozím nastavení (doporučeno)

http://www.rajce.idnes.cz/f202525196-7a2782d3/500px ... fotka vepsaná do čtverce 500 x 500 px

http://www.rajce.idnes.cz/f202525196-7a2782d3/500px/q50 ... fotka vepsaná do čtverce 500 x 500 px s jpeg kvalitou 50%

Generování na přání používat jen v případě nutnosti (např. mobilní zařízení).

V případě cizího alba funguje pouze pro veřejná alba.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getPhotoList</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumID>18757343</albumID> <!-- ID alba -->
<skip>0</skip> <!-- přeskočit určitý počet fotek (volitelně) -->
<limit>20</limit> <!-- max. počet vrácených fotek (volitelně) -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>date</column> <!-- datum vzniku fotky (nebo jeho odhad) -->
<column>name</column> <!-- název fotky -->
<column>description</column> <!-- popis fotky -->
<column>url</column> <!-- url stránky fotky -->
<column>imageUrl</column> <!-- url fotky v plné kvalitě (rozlišení není zaručeno) -->
<column>thumbUrl</column> <!-- url náhledu v menší kvalitě (rozlišení není zaručeno) -->
<column>thumbUrlBest</column> <!-- url náhledu ve větší kvalitě (rozlišení není zaručeno) -->
<column>urlBase</column> <!-- základní část pro vytvoření adresy volitelné kvality náhledu -->
<column>videoUrl</column> <!-- url videa -->
<column>fileFullName</column> <!-- Úplný název souboru v počítači uživatele včetně cesty dle konvencí dané platformy (není vždy k dispozici) -->
<column>rotate</column> <!-- Rotace oproti originální fotce (0 = 0°, 1 = 90° doprava , 2 = 180°, 3 = 90° doleva) -->
<column>fileSizeOriginal</column> <!-- Velikost originálu fotky (není vždy k dispozici) -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumIDID alba
  • skippřeskočit určitý počet fotek (volitelně)
  • limitmax. počet vrácených fotek (volitelně)
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec datedatum vzniku fotky (nebo jeho odhad)
  • Sloupec namenázev fotky
  • Sloupec descriptionpopis fotky
  • Sloupec urlurl stránky fotky
  • Sloupec imageUrlurl fotky v plné kvalitě (rozlišení není zaručeno)
  • Sloupec thumbUrlurl náhledu v menší kvalitě (rozlišení není zaručeno)
  • Sloupec thumbUrlBesturl náhledu ve větší kvalitě (rozlišení není zaručeno)
  • Sloupec urlBasezákladní část pro vytvoření adresy volitelné kvality náhledu
  • Sloupec videoUrlurl videa
  • Sloupec fileFullNameÚplný název souboru v počítači uživatele včetně cesty dle konvencí dané platformy (není vždy k dispozici)
  • Sloupec rotateRotace oproti originální fotce (0 = 0°, 1 = 90° doprava , 2 = 180°, 3 = 90° doleva)
  • Sloupec fileSizeOriginalVelikost originálu fotky (není vždy k dispozici)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<totalCount>207</totalCount> <!-- celkový počet fotek v albu (bez ohledu na skip a limit) -->
<photos> <!-- seznam fotek -->
<photo id="202416158"> <!-- reprezentuje jednu fotku nebo video -->
<date>2010-01-07 00:00:00</date> <!-- datum vzniku fotky YYYY-MM-DD HH:mm:ss (nebo jeho odhad) - není vždy známo -->
<name>nazev</name> <!-- název fotky -->
<description>popis</description> <!-- popis fotky -->
<url>http://nekdo.rajce.idnes.cz/album/#4051679.jpg</url> <!-- url stránky fotky -->
<imageUrl>http://img5.rajce.idnes.cz/d0508/2/2870/2870783_bacc4ed7b04d6b2c95b187dc39a3c30a/images/4051679.jpg</imageUrl> <!-- url náhledu v menší kvalitě (rozlišení není zaručeno) -->
<thumbUrl>http://img5.rajce.idnes.cz/d0508/2/2870/2870783_bacc4ed7b04d6b2c95b187dc39a3c30a/thumb/4051679.jpg</thumbUrl> <!-- url náhledu v menší kvalitě (rozlišení není zaručeno) -->
<thumbUrlBest>http://www.rajce.idnes.cz/f202416158-7a5782d3/200px</thumbUrlBest> <!-- url náhledu ve větší kvalitě (rozlišení není zaručeno) -->
<urlBase>http://www.rajce.idnes.cz/f202416158-7a5782d3/</urlBase> <!-- základní část pro vytvoření adresy volitelné kvality náhledu -->
<type>photo</type> <!-- informace o tom, zda se jedná o fotku nebo video (hodnoty photo nebo video) -->
<videoUrl>http://img99.rajce.idnes.cz/d0508/2/2870/2870783_bacc4ed7b04d6b2c95b187dc39a3c30a/video/4051679</videoUrl> <!-- soubor videa (element chybí, pokud se nejedná o video) -->
<fileFullName>fileSizeOriginal</fileFullName> <!-- Úplný název souboru v počítači uživatele včetně cesty dle konvencí dané platformy (není vždy k dispozici) -->
<rotate>0</rotate> <!-- Rotace oproti originální fotce (0 = 0°, 1 = 90° doprava , 2 = 180°, 3 = 90° doleva) -->
<fileSizeOriginal>videoUrl</fileSizeOriginal> <!-- Velikost originálu fotky (není vždy k dispozici) -->
</photo>
<photo id="..."> <!-- -->
<...>...</...> <!-- -->
</photo>
</photos>
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání
  • totalCountcelkový počet fotek v albu (bez ohledu na skip a limit)
  • photosseznam fotek
  • photoreprezentuje jednu fotku nebo video
  • datedatum vzniku fotky YYYY-MM-DD HH:mm:ss (nebo jeho odhad) - není vždy známo
  • namenázev fotky
  • descriptionpopis fotky
  • urlurl stránky fotky
  • imageUrlurl náhledu v menší kvalitě (rozlišení není zaručeno)
  • thumbUrlurl náhledu v menší kvalitě (rozlišení není zaručeno)
  • thumbUrlBesturl náhledu ve větší kvalitě (rozlišení není zaručeno)
  • urlBasezákladní část pro vytvoření adresy volitelné kvality náhledu
  • typeinformace o tom, zda se jedná o fotku nebo video (hodnoty photo nebo video)
  • videoUrlsoubor videa (element chybí, pokud se nejedná o video)
  • fileFullNameÚplný název souboru v počítači uživatele včetně cesty dle konvencí dané platformy (není vždy k dispozici)
  • rotateRotace oproti originální fotce (0 = 0°, 1 = 90° doprava , 2 = 180°, 3 = 90° doleva)
  • fileSizeOriginalVelikost originálu fotky (není vždy k dispozici)

Vytvoření nového alba

Požadavek

Vytvoří nové prázdné album.
<?xml version="1.0" encoding="utf-8"?>
<request>
<command>createAlbum</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumName>Nové album 2</albumName> <!-- název alba -->
<albumDescription></albumDescription> <!-- popis alba -->
<albumVisible>1</albumVisible> <!-- viditelnost alba (0=skryté, 1=viditelné) -->
<secure>1</secure> <!-- heslem chráněné album (0=nechráné, 1=chráněné) (volitelně, implicitně 0) -->
<secureName>Franta</secureName> <!-- Jméno ochrany alba v plaintextu (pouze v případě secure=1) -->
<securePass>rohlík</securePass> <!-- Heslo ochrany alba v plaintextu (pouze v případě secure=1) -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumNamenázev alba
  • albumDescriptionpopis alba
  • albumVisibleviditelnost alba (0=skryté, 1=viditelné)
  • secureheslem chráněné album (0=nechráné, 1=chráněné) (volitelně, implicitně 0)
  • secureNameJméno ochrany alba v plaintextu (pouze v případě secure=1)
  • securePassHeslo ochrany alba v plaintextu (pouze v případě secure=1)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<albumToken>2974516&83297ad608</albumToken> <!-- token pro editaci alba -->
<albumID>2974516</albumID> <!-- ID alba -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • albumTokentoken pro editaci alba
  • albumIDID alba

Otevře album pro přidávání fotek

Požadavek

Nástěnku lze otevřít zadáním albumID = 0.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>openAlbum</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumID>2871724</albumID> <!-- ID alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumIDID alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<albumToken>2974516&83297ad608</albumToken> <!-- token pro editaci alba -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • albumTokentoken pro editaci alba

Přidání fotky do alba

Požadavek

MIME Multipart. Další informace o fotce - konzultujte.

Content-Disposition: form-data; name="thumb"; filename="cokoli"

Content-Type: image/jpeg

Náhled 100x100 px

Content-Disposition: form-data; name="photo"; filename="cokoli"

Content-Type: image/jpeg

Zmenšená fotka

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>addPhoto</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<width>1024</width> <!-- šířka uploadované fotky v px -->
<height>768</height> <!-- výška uploadované fotky v px -->
<albumToken>2871724&225c528f52</albumToken> <!-- token pro editaci alba, který lze získat vytvořením nebo otevřením alba -->
<photoName>Karlův most</photoName> <!-- název fotky (max 255 znaků) -->
<fullFileName>C:\Users\Public\Pictures\Sample Pictures\Desert Landscape.jpg</fullFileName> <!-- Úplné jméno souboru na počítači uživatele (s cestou) v konvenci dle příslušné platformy (volitelně) -->
<description>Karlův most je nejstarší most v Praze.</description> <!-- popis fotky, TODO doplnit formát a max. délku (volitelně). -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • widthšířka uploadované fotky v px
  • heightvýška uploadované fotky v px
  • albumTokentoken pro editaci alba, který lze získat vytvořením nebo otevřením alba
  • photoNamenázev fotky (max 255 znaků)
  • fullFileNameÚplné jméno souboru na počítači uživatele (s cestou) v konvenci dle příslušné platformy (volitelně)
  • descriptionpopis fotky, TODO doplnit formát a max. délku (volitelně).

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem

Uzavření alba

Požadavek

Po dokončení přidávání fotek do alba.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>closeAlbum</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumToken>2871724&225c528f52</albumToken> <!-- token pro editaci alba, který lze získat vytvořením nebo otevřením alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumTokentoken pro editaci alba, který lze získat vytvořením nebo otevřením alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem

Získání URL alba pro jeho zobrazení po dokončení uploadu

Požadavek

Po dokončení přidávání fotek.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getAlbumUrl</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumToken>2871724&225c528f52</albumToken> <!-- token pro editaci alba, který lze získat vytvořením nebo otevřením alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumTokentoken pro editaci alba, který lze získat vytvořením nebo otevřením alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<url>http://www.rajce.idnes.cz/?mod=Login&act=LoginByTicket&ticket=1b343a5453c132ab14a5e13f21&oldURL=http%3A%2F%2Fabc.rajce.idnes.cz%2FNove_album%2F</url> <!-- url stránky alba, která mimo jiné zajistí přihlášení uživatele -->
<shareUrl>http://abc.rajce.idnes.cz/Nove_album/</shareUrl> <!-- url stránky alba vhodná pro sdílení -->
<albumName>Nove_album</albumName> <!-- název alba -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • urlurl stránky alba, která mimo jiné zajistí přihlášení uživatele
  • shareUrlurl stránky alba vhodná pro sdílení
  • albumNamenázev alba

Získá adresu pro vytvoření účtu

Požadavek

Získá adresu stránky, kde lze vytvořit nový účet.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getRegisterUrl</command>
<parameters>
</parameters>
</request>

    Odpověď

    <?xml version="1.0" encoding="utf-8"?>
    <response>
    <url>http://www.rajce.idnes.cz/ucet/</url> <!-- url stránky, kde lze vytvořit nový účet -->
    </response>
    • urlurl stránky, kde lze vytvořit nový účet

Získá adresu pro obnovu hesla při jeho zapomenutí

Požadavek

Získá url stránky, kde si lze nechat obnovit zapomenuté heslo.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getRecoverPasswordUrl</command>
<parameters>
</parameters>
</request>

    Odpověď

    <?xml version="1.0" encoding="utf-8"?>
    <response>
    <url>http://www.rajce.idnes.cz/heslo/</url> <!-- url stránky, kde si lze nechat obnovit zapomenuté heslo -->
    </response>
    • urlurl stránky, kde si lze nechat obnovit zapomenuté heslo

Dotaz na aktualizaci programu při spuštění programu

Požadavek

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getUpdateInfo</command>
<parameters>
<clientID>...</clientID> <!-- přidělený unikátní identifikátor programu -->
<currentVersion>12345</currentVersion> <!-- číslo aktualní verze -->
<lang></lang> <!-- volitelně může obsahovat seznam jazyků pro komunikaci - stejně jako Accept-Language v HTTP (zatím se ignoruje) -->
</parameters>
</request>
  • clientIDpřidělený unikátní identifikátor programu
  • currentVersiončíslo aktualní verze
  • langvolitelně může obsahovat seznam jazyků pro komunikaci - stejně jako Accept-Language v HTTP (zatím se ignoruje)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<latestVersion></latestVersion> <!-- číslo nejnovější verze programu -->
<canUpdate></canUpdate> <!-- lze aktualizovat program? (0/1) -->
<needUpdate></needUpdate> <!-- je nutné aktualizovat program (bez aktualizace program nelze použít - třeba kvůli objevené zavážné chybě)? (0/1) -->
<message></message> <!-- volitelné upozornění - program zobrazí informační hlášku např. o plánované odstávce serverů -->
<exit>0</exit> <!-- po zobrazení hlášky bude program ukončen, pokud exit=1 ... např. probíhá odstávka a nelze na server nahrávat fotky -->
<updateInfo> <!-- informace o aktualizaci -->
<description></description> <!-- textový popis, který obsahuje změny či nějaké vysvětlení, proč je dobře/nutné program aktualizovat -->
<url></url> <!-- url, kde lze stáhnout novou verzi -->
</updateInfo>
</response>
  • latestVersiončíslo nejnovější verze programu
  • canUpdatelze aktualizovat program? (0/1)
  • needUpdateje nutné aktualizovat program (bez aktualizace program nelze použít - třeba kvůli objevené zavážné chybě)? (0/1)
  • messagevolitelné upozornění - program zobrazí informační hlášku např. o plánované odstávce serverů
  • exitpo zobrazení hlášky bude program ukončen, pokud exit=1 ... např. probíhá odstávka a nelze na server nahrávat fotky
  • updateInfoinformace o aktualizaci
  • descriptiontextový popis, který obsahuje změny či nějaké vysvětlení, proč je dobře/nutné program aktualizovat
  • urlurl, kde lze stáhnout novou verzi

Získání obecné URL k nějakému účelu

Požadavek

Parametr "target" může nabývat hodnot:

- user-profile (uživatelský profil - nastavení)

- email-notifications (e-mailové notifikace - nastavení)

- service-notifications (notifikace do různých služeb, např. Facebook - nastavení)

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getUrl</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<target>user-profile</target> <!-- požadovaný typ url (viz popis metody) -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • targetpožadovaný typ url (viz popis metody)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<url>http://www.rajce.idnes.cz/nastaveni</url> <!-- vrácená url -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • urlvrácená url

Smazání alba

Požadavek

Maže album přihlášeného uživatele.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>deleteAlbum</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumID>4655343</albumID> <!-- ID alba, které chceme smazat -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumIDID alba, které chceme smazat

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem

Započatí nahrávání videa

Požadavek

Započne nové nahrávání videa nebo naváže na předchozí nedokončený upload (v takovém případě je třeba uvést stejné clientVideoID).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>beginVideoUpload</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<albumToken>2871724&225c528f52</albumToken> <!-- token pro editaci alba, který lze získat vytvořením nebo otevřením alba -->
<clientVideoID>da261d5386</clientVideoID> <!-- vlastní identifikátor uplodovaného videa unikátní v rámci alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • albumTokentoken pro editaci alba, který lze získat vytvořením nebo otevřením alba
  • clientVideoIDvlastní identifikátor uplodovaného videa unikátní v rámci alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<uploadID>15135</uploadID> <!-- přidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa -->
<blocks> <!-- seznam bloků videa, která již na serveru existují v případě, že máme s daným clientVideoID rozpracovaný nějaký upload videa (tedy nejedná se o počátek uploadu, ale navázání po přerušení) -->585&241bbb3543
<block index="0"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>562f5fe60f45ca8adc28f837053dae42</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
<block index="1"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>14c3e75aa5fe4aa40607847dba87ddb5</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
</blocks>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • uploadIDpřidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa
  • blocksseznam bloků videa, která již na serveru existují v případě, že máme s daným clientVideoID rozpracovaný nějaký upload videa (tedy nejedná se o počátek uploadu, ale navázání po přerušení)
  • blockblock videa
  • sizeskutečná velikost bloku videa (poslední blok bývá menší)
  • md5kontrolní hash bloku (md5 vlastních dat bloku)

Nahrávání několika bloků videa

Požadavek

Nahraje několik bloků videa - tedy při uploadu videa se tato metoda volá opakovaně tak, aby jeden požadavek na server trval rozumnou dobu.

Vlastní data bloků musí být v POST položkách data[blockIndex], tedy např. data2, data3 s context-typem application/octet-stream (položky také musí obsahoval libovolný filename, viz příklad u příkazu addPhoto), přičemž celý požadavek bude MIME Multipart.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>blocksVideoUpload</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<uploadID>15135</uploadID> <!-- přidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa -->
<blocks> <!-- seznam nahrávaných bloků videa -->
<block index="2"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>562f5fe60f45ca8adc28f837053dae42</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
<block index="3"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>14c3e75aa5fe4aa40607847dba87ddb5</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
</blocks>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • uploadIDpřidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa
  • blocksseznam nahrávaných bloků videa
  • blockblock videa
  • sizeskutečná velikost bloku videa (poslední blok bývá menší)
  • md5kontrolní hash bloku (md5 vlastních dat bloku)
  • blockblock videa
  • sizeskutečná velikost bloku videa (poslední blok bývá menší)
  • md5kontrolní hash bloku (md5 vlastních dat bloku)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<blocks> <!-- seznam úspěšně nahraných bloků videa při tom požadavku -->
<block index="2"></block> <!-- block videa -->
<block index="3"></block> <!-- block videa -->
</blocks>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • blocksseznam úspěšně nahraných bloků videa při tom požadavku
  • blockblock videa

Dokončení nahrávání videa

Požadavek

Pokusí se dokončit upload videa.

Náhled videa v rozlišení výsledného videa v POST položce "image", náhled vepsaný do čtverce 100x100px v položce "thumb" s context-typem image/jpeg, přičemž celý požadavek bude MIME Multipart. Náhledy jsou ve formátu JPEG.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>endVideoUpload</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<uploadID>15135</uploadID> <!-- přidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa -->
<blocks> <!-- seznam všech bloků videa pro ověření, zda jsou všechny nahrané na serveru -->
<block index="0"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>562f5fe60f45ca8adc28f837053dae42</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
<block index="1"> <!-- block videa -->
<size>65536</size> <!-- skutečná velikost bloku videa (poslední blok bývá menší) -->
<md5>14c3e75aa5fe4aa40607847dba87ddb5</md5> <!-- kontrolní hash bloku (md5 vlastních dat bloku) -->
</block>
</blocks>
<videoInfo> <!-- informace o videu -->
<name>Video z dovolené</name> <!-- název videa (max 250 znaků) -->
<description>Hotel na krásné slunné pláži uprostřed rybníka na jižním pólu</description> <!-- popis videa -->
<fileSizeOriginal>13213513</fileSizeOriginal> <!-- velikost originálu video souboru (před rekódováním) -->
<width>320</width> <!-- šířka rekódovaného videa v px -->
<height>240</height> <!-- výška rekódovaného videa v px -->
<sourceWidth>640</sourceWidth> <!-- šířka originálního videa před rekódováním v px -->
<sourceHeight>480</sourceHeight> <!-- výška originálního videa před rekódováním v px -->
<cameraMake>Casio</cameraMake> <!-- název výrobce zařízení, které pořídilo nahrávku -->
<cameraModel>Exilim 123</cameraModel> <!-- model zařízení, které pořídilo nahrávku -->
<gps></gps> <!-- geografické souřadnice videonahrávky (při pohybu nějaký reprezentativní bod) -->
<rotate>0</rotate> <!-- rotace originálního videa (TODO - doplnit číselník) -->
<fullFileName>c:\videa\dovolena.avi</fullFileName> <!-- plné jméno (s cestou) k originální nahrávce -->
<dateTime>2008-02-25 14:42:46</dateTime> <!-- datum a čas vzniku originální nahrávky (resp. jejího začátku) ve formatu YYYY-MM-DD hh:mm:ss -->
<vcodec>mjpeg</vcodec> <!-- video kodek (max 8 znaků) -->
<vcodecSrc>mjpeg</vcodecSrc> <!-- video kodek originálního videa (max 8 znaků) -->
<colorSpace>yuvj420p</colorSpace> <!-- barevný prostor videa (max 8 znaků) -->
<duration>30.000</duration> <!-- celkový čas nahrávky po encodování (v sekundách, 3 desetinná místa, oddělovač tečka) -->
<durationSrc>127.002</durationSrc> <!-- celkový čas originální nahrávky (v sekundách, 3 desetinná místa, oddělovač tečka) -->
<begin>10.000</begin> <!-- pozice začátku výřezu nahravaného videa v originální nahrávce (v sekundách, 3 desetinná místa, oddělovač tečka) -->
<end>40.000</end> <!-- pozice konce výřezu nahravaného videa v originální nahrávce (v sekundách, 3 desetinná místa, oddělovač tečka) -->
<thumbpos>15.723</thumbpos> <!-- pozice reprezentativního snímku vzhledem k počátku nahrávaného výřezu (v sekundách, 3 desetinná místa, oddělovač tečka) -->
<framerate>30.000</framerate> <!-- snímková frekvence (v Hz, 3 desetinná místa, oddělovač tečka) -->
<framerateSrc>15</framerateSrc> <!-- snímková frekvence originálního videa (v Hz, 3 desetinná místa, oddělovač tečka) -->
<vbitrate>524288</vbitrate> <!-- průměrná bitová rychlost videa (bez audia, v kbps) -->
<vbitrateSrc>1980416</vbitrateSrc> <!-- průměrná bitová rychlost originálního videa (bez audia, v kbps) -->
<acodec>mjpeg</acodec> <!-- audio kodek (max 8 znaků) -->
<acodecSrc>mjpeg</acodecSrc> <!-- audio kodek originálního videa (max 8 znaků) -->
<asamplingRate>16000</asamplingRate> <!-- vzorkovací frekvence audia (v Hz) -->
<asamplingRateSrc>8000</asamplingRateSrc> <!-- vzorkovací frekvence audia originálního videa (v Hz) -->
<achannelCount>2</achannelCount> <!-- počet kanálů audia -->
<abitrate>32768</abitrate> <!-- průměrná bitová rychlost audia (v kbps) -->
<abitrateSrc>65536</abitrateSrc> <!-- průměrná bitová rychlost audia originálního videa (v kbps) -->
</videoInfo>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • uploadIDpřidělené unikátní ID uploadu videa, který dále používáme při nahrávání bloků a dokončení uploadu videa
  • blocksseznam všech bloků videa pro ověření, zda jsou všechny nahrané na serveru
  • blockblock videa
  • sizeskutečná velikost bloku videa (poslední blok bývá menší)
  • md5kontrolní hash bloku (md5 vlastních dat bloku)
  • blockblock videa
  • sizeskutečná velikost bloku videa (poslední blok bývá menší)
  • md5kontrolní hash bloku (md5 vlastních dat bloku)
  • videoInfoinformace o videu
  • namenázev videa (max 250 znaků)
  • descriptionpopis videa
  • fileSizeOriginalvelikost originálu video souboru (před rekódováním)
  • widthšířka rekódovaného videa v px
  • heightvýška rekódovaného videa v px
  • sourceWidthšířka originálního videa před rekódováním v px
  • sourceHeightvýška originálního videa před rekódováním v px
  • cameraMakenázev výrobce zařízení, které pořídilo nahrávku
  • cameraModelmodel zařízení, které pořídilo nahrávku
  • gpsgeografické souřadnice videonahrávky (při pohybu nějaký reprezentativní bod)
  • rotaterotace originálního videa (TODO - doplnit číselník)
  • fullFileNameplné jméno (s cestou) k originální nahrávce
  • dateTimedatum a čas vzniku originální nahrávky (resp. jejího začátku) ve formatu YYYY-MM-DD hh:mm:ss
  • vcodecvideo kodek (max 8 znaků)
  • vcodecSrcvideo kodek originálního videa (max 8 znaků)
  • colorSpacebarevný prostor videa (max 8 znaků)
  • durationcelkový čas nahrávky po encodování (v sekundách, 3 desetinná místa, oddělovač tečka)
  • durationSrccelkový čas originální nahrávky (v sekundách, 3 desetinná místa, oddělovač tečka)
  • beginpozice začátku výřezu nahravaného videa v originální nahrávce (v sekundách, 3 desetinná místa, oddělovač tečka)
  • endpozice konce výřezu nahravaného videa v originální nahrávce (v sekundách, 3 desetinná místa, oddělovač tečka)
  • thumbpospozice reprezentativního snímku vzhledem k počátku nahrávaného výřezu (v sekundách, 3 desetinná místa, oddělovač tečka)
  • frameratesnímková frekvence (v Hz, 3 desetinná místa, oddělovač tečka)
  • framerateSrcsnímková frekvence originálního videa (v Hz, 3 desetinná místa, oddělovač tečka)
  • vbitrateprůměrná bitová rychlost videa (bez audia, v kbps)
  • vbitrateSrcprůměrná bitová rychlost originálního videa (bez audia, v kbps)
  • acodecaudio kodek (max 8 znaků)
  • acodecSrcaudio kodek originálního videa (max 8 znaků)
  • asamplingRatevzorkovací frekvence audia (v Hz)
  • asamplingRateSrcvzorkovací frekvence audia originálního videa (v Hz)
  • achannelCountpočet kanálů audia
  • abitrateprůměrná bitová rychlost audia (v kbps)
  • abitrateSrcprůměrná bitová rychlost audia originálního videa (v kbps)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<photoID>446904123</photoID> <!-- ID videa, které bylo videu přiděleno -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • photoIDID videa, které bylo videu přiděleno

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<result>Některé bloky videa chybí.</result> <!-- text chyby -->
<errorCode>23</errorCode> <!-- Kód chyby -->
<blocks> <!-- seznam bloků videa, které na serveru chybí nebo mají jiný obsah -->585&241bbb3543
<block index="0"></block> <!-- chybějící block videa -->
<block index="1"></block> <!-- chybějící block videa -->
</blocks>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • resulttext chyby
  • errorCodeKód chyby
  • blocksseznam bloků videa, které na serveru chybí nebo mají jiný obsah
  • blockchybějící block videa

Vyhledávání uživatelů

Požadavek

Vyhledá uživatele (fulltext).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>searchUsers</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<query>Lojza</query> <!-- text dotazu -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>fullName</column> <!-- plné jméno uživatele -->
<column>albumCount</column> <!-- počet alb uživatele -->
<column>viewCount</column> <!-- počet zobrazení stránky uživatele -->
<column>isMyFavourite</column> <!-- je to můj oblíbený uživatel? Lze použít pouze v případě uvedeného tokenu -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • querytext dotazu
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec fullNameplné jméno uživatele
  • Sloupec albumCountpočet alb uživatele
  • Sloupec viewCountpočet zobrazení stránky uživatele
  • Sloupec isMyFavouriteje to můj oblíbený uživatel? Lze použít pouze v případě uvedeného tokenu

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>207</totalCount> <!-- celkový počet nalezených uživatelů (bez ohledu na skip a limit) -->
<users> <!-- seznam nalezených uživatelů -->585&241bbb3543
<user id="1561"> <!-- nalezený uživatel -->
<name>lojzik</name> <!-- přezdívka uživatele -->
<fullName>Lojza Novak</fullName> <!-- plné jméno uživatele (nemusí být známé) -->
<albumCount>123</albumCount> <!-- počet alb uživatele -->
<viewCount>4567</viewCount> <!-- počet zobrazení stránky uživatele -->
<isMyFavourite>1</isMyFavourite> <!-- je to můj oblíbený uživatel? (0 = ne, 1 = ano) -->
</user>
<user id="1561"> <!-- nalezený uživatel -->
<name>nekdo</name> <!-- přezdívka uživatele -->
<fullName></fullName> <!-- plné jméno uživatele (nemusí být známé) -->
<albumCount>456</albumCount> <!-- počet alb uživatele -->
<viewCount>1561</viewCount> <!-- počet zobrazení stránky uživatele -->
<isMyFavourite>0</isMyFavourite> <!-- je to můj oblíbený uživatel? (0 = ne, 1 = ano) -->
</user>
</users>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet nalezených uživatelů (bez ohledu na skip a limit)
  • usersseznam nalezených uživatelů
  • usernalezený uživatel
  • namepřezdívka uživatele
  • fullNameplné jméno uživatele (nemusí být známé)
  • albumCountpočet alb uživatele
  • viewCountpočet zobrazení stránky uživatele
  • isMyFavouriteje to můj oblíbený uživatel? (0 = ne, 1 = ano)

Vyhledávání alb

Požadavek

Vyhledá uživatele (fulltext).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>searchAlbums</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<query>Dovolená</query> <!-- text dotazu -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>description</column> <!-- popis alba -->
<column>shortenedDescription</column> <!-- zkrácený popis alba -->
<column>viewCount</column> <!-- počet zobrazení alba -->
<column>mediaCount</column> <!-- počet fotek a videí -->
<column>createDate</column> <!-- datum vytvoření alba -->
<column>thumbUrl</column> <!-- URL náhledu -->
<column>thumbUrlBest</column> <!-- URL náhledu ve větším rozlišení -->
<column>isMyFavourite</column> <!-- je to moje oblíbenené album? Lze použít pouze v případě uvedeného tokenu -->
<column>descriptionHtml</column> <!-- popis alba ve zjednodušené HTML podobě -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • querytext dotazu
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec descriptionpopis alba
  • Sloupec shortenedDescriptionzkrácený popis alba
  • Sloupec viewCountpočet zobrazení alba
  • Sloupec mediaCountpočet fotek a videí
  • Sloupec createDatedatum vytvoření alba
  • Sloupec thumbUrlURL náhledu
  • Sloupec thumbUrlBestURL náhledu ve větším rozlišení
  • Sloupec isMyFavouriteje to moje oblíbenené album? Lze použít pouze v případě uvedeného tokenu
  • Sloupec descriptionHtmlpopis alba ve zjednodušené HTML podobě

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>8845</totalCount> <!-- celkový počet nalezených alb (bez ohledu na skip a limit) -->
<albums> <!-- seznam nalezených alb -->585&241bbb3543
<album id="447070"> <!-- nalezené album -->
<name>Dovolená</name> <!-- název alba -->
<userID>Lojza Novak</userID> <!-- ID uživatele - vlastníka alba -->
<userName>123</userName> <!-- přezdívka uživatele -->
<description>4567</description> <!-- popis alba -->
<descriptionHtml></descriptionHtml> <!-- popis alba ve zjednodušené HTML podobě -->
<viewCount>4567</viewCount> <!-- počet zobrazení alba -->
<mediaCount>4567</mediaCount> <!-- počet fotek a videí -->
<createDate>4567</createDate> <!-- datum vytvoření alba -->
<thumbUrl>4567</thumbUrl> <!-- URL náhledu -->
<thumbUrlBest>4567</thumbUrlBest> <!-- URL náhledu ve větším rozlišení -->
<isMyFavourite>1</isMyFavourite> <!-- je to moje oblíbenené album? (0 = ne, 1 = ano) -->
</album>
<album id="447070"> <!-- nalezené album -->
<name>Dovolená</name> <!-- název alba -->
<userID>Lojza Novak</userID> <!-- ID uživatele - vlastníka alba -->
<userName>123</userName> <!-- přezdívka uživatele -->
<description>4567</description> <!-- popis alba -->
<descriptionHtml></descriptionHtml> <!-- popis alba ve zjednodušené HTML podobě -->
<viewCount>4567</viewCount> <!-- počet zobrazení alba -->
<mediaCount>4567</mediaCount> <!-- počet fotek a videí -->
<createDate>4567</createDate> <!-- datum vytvoření alba -->
<thumbUrl>4567</thumbUrl> <!-- URL náhledu -->
<thumbUrlBest>4567</thumbUrlBest> <!-- URL náhledu ve větším rozlišení -->
<isMyFavourite>1</isMyFavourite> <!-- je to moje oblíbenené album? (0 = ne, 1 = ano) -->
</album>
</albums>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet nalezených alb (bez ohledu na skip a limit)
  • albumsseznam nalezených alb
  • albumnalezené album
  • namenázev alba
  • userIDID uživatele - vlastníka alba
  • userNamepřezdívka uživatele
  • descriptionpopis alba
  • descriptionHtmlpopis alba ve zjednodušené HTML podobě
  • viewCountpočet zobrazení alba
  • mediaCountpočet fotek a videí
  • createDatedatum vytvoření alba
  • thumbUrlURL náhledu
  • thumbUrlBestURL náhledu ve větším rozlišení
  • isMyFavouriteje to moje oblíbenené album? (0 = ne, 1 = ano)
  • descriptionHtmlpopis alba ve zjednodušené HTML podobě

Získání seznamu oblíbených uživatelů

Požadavek

Získá seznam oblíbených uživatelů přihlášeného nebo jiného uživatele.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getFavouriteUsers</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<userID>585</userID> <!-- ID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně) -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>favVisibility</column> <!-- viditelnost oblíbenosti pro ostatní (public|private) -->
<column>favDesc</column> <!-- popis (poznámka toho, kdo si přidal uživatele na svůj seznam oblíbených) -->
<column>fullName</column> <!-- plné jméno uživatele -->
<column>albumCount</column> <!-- počet alb uživatele -->
<column>viewCount</column> <!-- počet zobrazení stránky uživatele -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • userIDID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně)
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec favVisibilityviditelnost oblíbenosti pro ostatní (public|private)
  • Sloupec favDescpopis (poznámka toho, kdo si přidal uživatele na svůj seznam oblíbených)
  • Sloupec fullNameplné jméno uživatele
  • Sloupec albumCountpočet alb uživatele
  • Sloupec viewCountpočet zobrazení stránky uživatele

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>45</totalCount> <!-- celkový počet oblíbených uživatelů (bez ohledu na skip a limit) -->
<users> <!-- seznam oblíbených uživatelů -->585&241bbb3543
<user id="1561"> <!-- oblíbený uživatel -->
<favDesc>lojzik</favDesc> <!-- popis (poznámka toho, kdo si přidal uživatele na svůj seznam oblíbených) -->
<favVisibility>public</favVisibility> <!-- viditelnost oblíbenosti pro ostatní (public|private) -->
<name>lojzik</name> <!-- přezdívka uživatele -->
<fullName>Lojza Novak</fullName> <!-- plné jméno uživatele (nemusí být známé) -->
<albumCount>123</albumCount> <!-- počet alb uživatele -->
<viewCount>4567</viewCount> <!-- počet zobrazení stránky uživatele -->
</user>
<user id="1561"> <!-- oblíbený uživatel -->
<favDesc>lojzik</favDesc> <!-- popis (poznámka toho, kdo si přidal uživatele na svůj seznam oblíbených) -->
<favVisibility>public</favVisibility> <!-- viditelnost oblíbenosti pro ostatní (public|private) -->
<name>lojzik</name> <!-- přezdívka uživatele -->
<fullName>Lojza Novak</fullName> <!-- plné jméno uživatele (nemusí být známé) -->
<albumCount>123</albumCount> <!-- počet alb uživatele -->
<viewCount>4567</viewCount> <!-- počet zobrazení stránky uživatele -->
</user>
</users>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet oblíbených uživatelů (bez ohledu na skip a limit)
  • usersseznam oblíbených uživatelů
  • useroblíbený uživatel
  • favDescpopis (poznámka toho, kdo si přidal uživatele na svůj seznam oblíbených)
  • favVisibilityviditelnost oblíbenosti pro ostatní (public|private)
  • namepřezdívka uživatele
  • fullNameplné jméno uživatele (nemusí být známé)
  • albumCountpočet alb uživatele
  • viewCountpočet zobrazení stránky uživatele

Získání seznamu oblíbených alb

Požadavek

Získá seznam oblíbených alb přihlášeného nebo jiného uživatele.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getFavouriteAlbums</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<userID>585</userID> <!-- ID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně) -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>userName</column> <!-- přezdívka uživatele - vlastníka alba -->
<column>userID</column> <!-- ID vlastníka alba -->
<column>description</column> <!-- popis alba -->
<column>shortenedDescription</column> <!-- zkrácený popis alba -->
<column>descriptionHtml</column> <!-- popis alba ve zjednodušené HTML podobě -->
<column>createDate</column> <!-- datum vytvoření alb -->
<column>mediaCount</column> <!-- počet fotek a videí v albu -->
<column>viewCount</column> <!-- počet zobrazení stránky alba -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • userIDID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně)
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec userNamepřezdívka uživatele - vlastníka alba
  • Sloupec userIDID vlastníka alba
  • Sloupec descriptionpopis alba
  • Sloupec shortenedDescriptionzkrácený popis alba
  • Sloupec descriptionHtmlpopis alba ve zjednodušené HTML podobě
  • Sloupec createDatedatum vytvoření alb
  • Sloupec mediaCountpočet fotek a videí v albu
  • Sloupec viewCountpočet zobrazení stránky alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>45</totalCount> <!-- celkový počet oblíbených alb (bez ohledu na skip a limit) -->
<albums> <!-- seznam oblíbených alb -->585&241bbb3543
<album id="1561"> <!-- oblíbené album -->
<name>Asdajdhajkd</name> <!-- název alba -->
<userName>dfasfasf</userName> <!-- přezdívka uživatele - vlastníka alba -->
<userID>2131351</userID> <!-- ID vlastníka alba -->
<description>Tesdfetfwev werf w .</description> <!-- popis alba -->
<shortenedDescription>Tesdfetfwev werf w .</shortenedDescription> <!-- zkrácený popis alba -->
<descriptionHtml></descriptionHtml> <!-- popis alba ve zjednodušené HTML podobě -->
<createDate>2010-11-12 02:36:55</createDate> <!-- datum vytvoření alba (YYYY-MM-DD hh:mm:ss) -->
<mediaCount>319</mediaCount> <!-- počet fotek a videí v albu -->
<viewCount>129</viewCount> <!-- počet zobrazení stránky alba -->
</album>
<album id="1561"> <!-- oblíbené album -->
<name>Asdajdhajkd</name> <!-- název alba -->
<userName>dfasfasf</userName> <!-- přezdívka uživatele - vlastníka alba -->
<userID>2131351</userID> <!-- ID vlastníka alba -->
<description>Tesdfetfwev werf w .</description> <!-- popis alba -->
<shortenedDescription>Tesdfetfwev werf w .</shortenedDescription> <!-- zkrácený popis alba -->
<descriptionHtml></descriptionHtml> <!-- popis alba ve zjednodušené HTML podobě -->
<createDate>2010-11-12 02:36:55</createDate> <!-- datum vytvoření alba (YYYY-MM-DD hh:mm:ss) -->
<mediaCount>319</mediaCount> <!-- počet fotek a videí v albu -->
<viewCount>129</viewCount> <!-- počet zobrazení stránky alba -->
</album>
</albums>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet oblíbených alb (bez ohledu na skip a limit)
  • albumsseznam oblíbených alb
  • albumoblíbené album
  • namenázev alba
  • userNamepřezdívka uživatele - vlastníka alba
  • userIDID vlastníka alba
  • descriptionpopis alba
  • shortenedDescriptionzkrácený popis alba
  • descriptionHtmlpopis alba ve zjednodušené HTML podobě
  • createDatedatum vytvoření alba (YYYY-MM-DD hh:mm:ss)
  • mediaCountpočet fotek a videí v albu
  • viewCountpočet zobrazení stránky alba
  • descriptionHtmlpopis alba ve zjednodušené HTML podobě

Získání informací o uživateli

Požadavek

Získání informací o jednom konkrétním uživateli.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getUserInfo</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<userID>585</userID> <!-- ID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně) -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>www</column> <!-- webová adresa uživatele (mimo rajče) -->
<column>hasAvatar</column> <!-- má avatar (0 = ne, 1 = ano)? -->
<column>description</column> <!-- popis uživatele -->
<column>descriptionHtml</column> <!-- popis uživatele ve zjednodušeném formátu HTML -->
<column>name</column> <!-- přezdívka uživatele -->
<column>fullName</column> <!-- plné jméno uživatele -->
<column>isMyFavourite</column> <!-- je to oblíbený uživatel přihlášeného uživatele (0 = ne, 1 = ano) -->
<column>albumCount</column> <!-- počet alb uživatele -->
<column>viewCount</column> <!-- počet zobrazení stránky uživatele -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • userIDID uživatele, od kterého chceme získat seznam oblíbených alb (volitelně)
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec wwwwebová adresa uživatele (mimo rajče)
  • Sloupec hasAvatarmá avatar (0 = ne, 1 = ano)?
  • Sloupec descriptionpopis uživatele
  • Sloupec descriptionHtmlpopis uživatele ve zjednodušeném formátu HTML
  • Sloupec namepřezdívka uživatele
  • Sloupec fullNameplné jméno uživatele
  • Sloupec isMyFavouriteje to oblíbený uživatel přihlášeného uživatele (0 = ne, 1 = ano)
  • Sloupec albumCountpočet alb uživatele
  • Sloupec viewCountpočet zobrazení stránky uživatele

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
<totalCount>45</totalCount> <!-- celkový počet oblíbených uživatelů (bez ohledu na skip a limit) -->
<user id="1561"> <!-- uživatel -->
<name>cubas</name> <!-- přezdívka uživatele -->
<fullName>Miroslav Buček</fullName> <!-- plné jméno uživatele (nemusí být známé) -->
<www>http://www.miroslavbucek.cz</www> <!-- webová adresa uživatele (mimo rajče) -->
<description>zakladatel služby rajce.net, moje nové fotky najdete pod přezdívkou [url=http://www.rajce.idnes.cz/u2834]http://odmirka.rajce.net[/url]</description> <!-- popis uživatele (BB code) -->
<descriptionHtml>zakladatel služby rajce.net, moje nové fotky najdete pod přezdívkou <a href="http://www.rajce.idnes.cz/u2834">http://odmirka.rajce.net</a></descriptionHtml> <!-- popis uživatele (HTML) -->
<hasAvatar>1</hasAvatar> <!-- má avatar (0 = ne, 1 = ano)? -->
<isMyFavourite>0</isMyFavourite> <!-- je to oblíbený uživatel přihlášeného uživatele (0 = ne, 1 = ano) -->
<viewCount>61337</viewCount> <!-- počet zobrazení stránky uživatele -->
<albumCount>28</albumCount> <!-- počet alb uživatele -->
</user>
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem
  • totalCountcelkový počet oblíbených uživatelů (bez ohledu na skip a limit)
  • useruživatel
  • namepřezdívka uživatele
  • fullNameplné jméno uživatele (nemusí být známé)
  • wwwwebová adresa uživatele (mimo rajče)
  • descriptionpopis uživatele (BB code)
  • descriptionHtmlpopis uživatele (HTML)
  • hasAvatarmá avatar (0 = ne, 1 = ano)?
  • isMyFavouriteje to oblíbený uživatel přihlášeného uživatele (0 = ne, 1 = ano)
  • viewCountpočet zobrazení stránky uživatele
  • albumCountpočet alb uživatele

Získání seznamu nej fotek

Požadavek

Získání seznamu nej(lepších?) fotek.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getBestPhotos</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<randomKey>15785</randomKey> <!-- náhodné číslo, které definuje pevné náhodné pořadí (umožní tedy stránkování) -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • randomKeynáhodné číslo, které definuje pevné náhodné pořadí (umožní tedy stránkování)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<totalCount>207</totalCount> <!-- celkový počet nej fotek (bez ohledu na skip a limit) -->
<photos> <!-- seznam fotek -->
<photo id="422410278"> <!-- reprezentuje jednu fotku -->
<albumID>5638684</albumID> <!-- ID alba -->
<albumName>Dolomity 2011</albumName> <!-- název alba -->
<dateFrom>2011-11-09 07:43:22</dateFrom> <!-- datum zařazení fotky mezi nej(lepší?) -->
<fullName>Jiřina</fullName> <!-- plné jméno uživatele (pokud jej uvedl) -->
<height>800</height> <!-- výška fotky (px) -->
<link>http://www.rajce.idnes.cz/f422410278</link> <!-- odkaz na stránku s fotkou -->
<imageUrl>http://img1.rajce.idnes.cz/d0103/6/6007/6007104_3704052eb4fa437f4a6250f41e2fe248/images/DA_6223Gm.jpg</imageUrl> <!-- url fotky v maximální kvalitě -->
<thumbUrl>http://www.rajce.idnes.cz/f422410278/res/800.jpg</thumbUrl> <!-- url náhledu v menší kvalitě (rozlišení není zaručeno) -->
<userID>176211</userID> <!-- ID uživatele - vlastníka fotky -->
<userLink>http://www.rajce.idnes.cz/u176211</userLink> <!-- odkaz na stránku uživatele - vlastníka fotky -->
<userName>jija21</userName> <!-- přezdívka uživatele - vlastníka fotky -->
<width>1200</width> <!-- šířka fotky (px) -->
</photo>
<photo> <!-- ... -->
<...>...</...> <!-- -->
</photo>
</photos>
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání
  • totalCountcelkový počet nej fotek (bez ohledu na skip a limit)
  • photosseznam fotek
  • photoreprezentuje jednu fotku
  • albumIDID alba
  • albumNamenázev alba
  • dateFromdatum zařazení fotky mezi nej(lepší?)
  • fullNameplné jméno uživatele (pokud jej uvedl)
  • heightvýška fotky (px)
  • linkodkaz na stránku s fotkou
  • imageUrlurl fotky v maximální kvalitě
  • thumbUrlurl náhledu v menší kvalitě (rozlišení není zaručeno)
  • userIDID uživatele - vlastníka fotky
  • userLinkodkaz na stránku uživatele - vlastníka fotky
  • userNamepřezdívka uživatele - vlastníka fotky
  • widthšířka fotky (px)

Přidání uživatele do seznamu oblíbených

Požadavek

Přidání uživatele do seznamu oblíbených.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>addFavUser</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<favUserID>123</favUserID> <!-- ID oblíbeného uživatele -->
<desc>popisek</desc> <!-- Popisek, který si k tomuto uživateli přidíáme -->
<private>1</private> <!-- Viditelnost oblínosti pro ostatní (0 = viditelný, 1 = neviditelný) -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • favUserIDID oblíbeného uživatele
  • descPopisek, který si k tomuto uživateli přidíáme
  • privateViditelnost oblínosti pro ostatní (0 = viditelný, 1 = neviditelný)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání

Odebrání uživatele ze seznamu oblíbených

Požadavek

Přidání uživatele do seznamu oblíbených.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>removeFavUser</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<favUserID>123</favUserID> <!-- ID oblíbeného uživatele -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • favUserIDID oblíbeného uživatele

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání

Přidání alba do seznamu oblíbených alb

Požadavek

Přidání aba do seznamu oblíbených alb.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>addFavAlbum</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<favAlbumID>123456</favAlbumID> <!-- ID oblíbeného alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • favAlbumIDID oblíbeného alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání

Odebrání alba ze seznamu oblíbených

Požadavek

Odebrání alba ze seznamu oblíbených.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>removeFavAlbum</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<favAlbumID>123456</favAlbumID> <!-- ID oblíbeného alba -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • favAlbumIDID oblíbeného alba

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání

Získání seznamu kategorií

Požadavek

Získá seznam kategorií alb (zatím jen těch základních - bez soutěží apod.).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getCategories</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání, pokud byl uvedený -->
<categories> <!-- seznam kategorií -->
<category id="1"> <!-- reprezentuje jednu kategorii -->
<index>0</index> <!-- relativní pořadí kategorií (více kategorií můžě mít shodný index) -->
<parentID></parentID> <!-- ID rodičovské kategorie (definuje stromovou strukturu kategorií), nevyplněné = kořenová kategorie (takových může být více) -->
<name>architektura</name> <!-- název kategorie -->
</category>
<category> <!-- ... -->
<...>...</...> <!-- -->
</category>
</categories>
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání, pokud byl uvedený
  • categoriesseznam kategorií
  • categoryreprezentuje jednu kategorii
  • indexrelativní pořadí kategorií (více kategorií můžě mít shodný index)
  • parentIDID rodičovské kategorie (definuje stromovou strukturu kategorií), nevyplněné = kořenová kategorie (takových může být více)
  • namenázev kategorie

Získání seznamu nej alb v kategorii

Požadavek

Získá seznam alb v dané kategorii (výchozí řazení - od nejnovějšího, jiné nyní není k dispozici). Nelze procházet všemi alby (počet je omezen např. na 1000).

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>getAlbumsFromCategory</command>
<parameters>
<token>585&241bbb3543</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání (volitelně) -->
<categoryID>3</categoryID> <!-- ID kategorie (0 = bez ohledu na kategorie) -->
<order>topNews</order> <!-- Řazení alb, možné hodnoty: createDate - od nejnovějšího, viewCount - od nejprohlíženějšího, topNews - nová navštěvovaná (volitelně - výchozí je createDate) -->
<skip>0</skip> <!-- přeskočit určitý počet výsledků -->
<limit>20</limit> <!-- max. počet vrácených výsledků -->
<columns> <!-- seznam sloupců, které chceme vrátit -->
<column>viewCount</column> <!-- počet zobrazení stránky alba -->
<column>isFavourite</column> <!-- info, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu -->
</columns>
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání (volitelně)
  • categoryIDID kategorie (0 = bez ohledu na kategorie)
  • orderŘazení alb, možné hodnoty: createDate - od nejnovějšího, viewCount - od nejprohlíženějšího, topNews - nová navštěvovaná (volitelně - výchozí je createDate)
  • skippřeskočit určitý počet výsledků
  • limitmax. počet vrácených výsledků
  • columnsseznam sloupců, které chceme vrátit
  • Sloupec viewCountpočet zobrazení stránky alba
  • Sloupec isFavouriteinfo, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- sessionToken získaný při přihlášení nebo z předchozího volání, pokud byl uvedený -->
<totalCount>8845</totalCount> <!-- celkový počet nalezených alb (bez ohledu na skip a limit) -->
<categories> <!-- seznam kategorií -->
<album id="1561"> <!-- reprezentuje jedno album -->
<albumName>Zvířata</albumName> <!-- jméno alba -->
<description></description> <!-- popis alba (může obsahovat BB tagy) -->
<url>http://qwerty.rajce.idnes.cz/Zvirata/</url> <!-- url alba -->
<createDate>2012-01-11 18:34:23</createDate> <!-- datum vytvoření alba -->
<updateDate>2012-01-11 18:34:24</updateDate> <!-- datum poslední úpravy alba -->
<photoCount>26</photoCount> <!-- počet fotek (a videí) -->
<startDateInterval>2012-01-11 14:50:05</startDateInterval> <!-- počáteční datum, ze kterého pocházejí fotky -->
<endDateInterval>2012-01-11 16:03:14</endDateInterval> <!-- konečné datum, ze kterého pocházejí fotky -->
<thumbUrlBest>http://www.rajce.idnes.cz/f121586306/200px</thumbUrlBest> <!-- náhled ve velké kvalitě, rozlišení není zaručeno -->
<viewCount>0</viewCount> <!-- počet zobrazení alba -->
<isFavourite>1</isFavourite> <!-- info, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu -->
</album>
<album> <!-- ... -->
<...>...</...> <!-- -->
</album>
</categories>
</response>
  • sessionTokensessionToken získaný při přihlášení nebo z předchozího volání, pokud byl uvedený
  • totalCountcelkový počet nalezených alb (bez ohledu na skip a limit)
  • categoriesseznam kategorií
  • albumreprezentuje jedno album
  • albumNamejméno alba
  • descriptionpopis alba (může obsahovat BB tagy)
  • urlurl alba
  • createDatedatum vytvoření alba
  • updateDatedatum poslední úpravy alba
  • photoCountpočet fotek (a videí)
  • startDateIntervalpočáteční datum, ze kterého pocházejí fotky
  • endDateIntervalkonečné datum, ze kterého pocházejí fotky
  • thumbUrlBestnáhled ve velké kvalitě, rozlišení není zaručeno
  • viewCountpočet zobrazení alba
  • isFavouriteinfo, zda je album oblíbené (0/1); lze použít pouze v případě uvedení tokenu

Smazání fotky

Požadavek

Maže fotku přihlášeného uživatele.

<?xml version="1.0" encoding="utf-8"?>
<request>
<command>deletePhoto</command>
<parameters>
<token>256&123bbbb456</token> <!-- sessionToken získaný při přihlášení nebo z předchozího volání -->
<photoID>4655343</photoID> <!-- ID fotky, kterou chceme smazat -->
</parameters>
</request>
  • tokensessionToken získaný při přihlášení nebo z předchozího volání
  • photoIDID fotky, kterou chceme smazat

Odpověď

<?xml version="1.0" encoding="utf-8"?>
<response>
<sessionToken>585&241bbb3543</sessionToken> <!-- něco jako cookies - třeba posílat s příštím dotazem -->
</response>
  • sessionTokenněco jako cookies - třeba posílat s příštím dotazem

Možné chyby

KódText chyby
1Neznámá chyba.
2Neplatný příkaz.
3Chybné přihlašovací údaje.
4Chybný přihlašovací token.
5Neznámý nebo opakující se sloupec {colName}.
6Není uvedeno správné albumID.
7Album neexistuje nebo není přihlášeného uživatele.
8Chybný token alba.
9Album nemůže mít prázdné jméno.
10Nepodařilo se vytvořit album. (těžko říct, proč ... asi chyba na straně serveru)
11Album neexistuje.
12Neexistující aplikace.
13Chybný klíč aplikace.
14Není přiložený soubor.
15Již existuje novější verze {version}.
16Chyba při ukládání souboru.
17Nepovolená přípona souboru {extension}.
18Chybné číslo verze klienta.
19Neexistující cíl (target).
20Chybí jméno k ochraně alba.
21Chybí heslo k ochraně alba.
22Chyba komunikace - dorazil prázdný soubor.
23Některé bloky videa chybí.
24Uživatel neexistuje.
25Není uvedeno správné userID ani albumID.
26Album neexistuje nebo není přihlášeného uživatele ani veřejné.
27Chybný clientVideoID.
28Upload s daným číslem neexistuje.
29Chybné favUserID.
30K albu nyní nelze z technických důvodů přistupovat pro zápis. Opakujte pokus později.
31Příliš mnoho neúspěšných pokusů o přihlášení - zkuste to za chvíli.
32Album neexistuje nebo není přihlášeného uživatele.