• No results found

SerialTracker - API

N/A
N/A
Protected

Academic year: 2022

Share "SerialTracker - API"

Copied!
46
0
0

Loading.... (view fulltext now)

Full text

(1)

Account

Show/Hide List Operations Expand Operations Raw GET

/Api/Account/Info

Vrací informace o aktuálně přihlášeném uživateli

Model

Model Schema

SerialTracker - API

Pro přístup Vaší aplikace k API je nutné nás kontaktovat na api@serialtracker.cz

Názvy položek a struktura informací se může od modelu lišit na základě vybraného Content-Typu

Response Class

UserDto {

Id (integer): Id uživatele,

Nickname (string): Username/Nickname uživatele, Email (string): Email uživatele,

FirstName (string, optional): Křestní jméno uživatele, LastName (string, optional): Příjmení uživatele,

HideEpisodes (boolean): Informace o tom zda uživatel chce mít skryté zhlédnuté epizody, AvatarImageFilePath (string): Cesta k obrázku avatara,

Roles (array[string], optional): Role ve kterých je uživatel, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Messages

HTTP Status

Code Reason Response Model

(2)

Try it out!

POST

/Api/Account/Login

Přihlášení uživatele

Model

Model Schema

Model Model Schema

Try it out!

Discussion

Show/Hide List Operations Expand Operations Raw

GET

/Api/Discussion

Přípěvky v diskuzi

200 Info o přihlášeném uživateli 401 Uživatel není přihlášen

Response Class

UserTicketDto {

Ticket (string): Autentizační token, HeaderName (string): Jméno hlavičky }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type model (required)

Parameter content type:

application/json

body

LoginModel { UserName (string):

Uživatelské jméno, Password (string):

Heslo }

Response Messages

HTTP Status

Code Reason Response Model

400 Login model není validní 401 Přihlášení nebylo úspěšné

(3)

Model

Model Schema

Response Class

DiscussionPagedDto {

Messages (array[DiscussionMessageDto]): Zprávy diskuze, PageNumber (integer): Číslo stránky,

PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

DiscussionMessageDto { Id (integer): ID zprávy, Text (string): Text zprávy,

CreatedAt (string): Datum a čas vytvoření,

UserData (DiscussionMessageUserData): Autor zprávy,

Reply (boolean): Určuje zda se jedná o odpověď admina či jiné spolehlivé osoby, Links (array[Link], optional)

}

DiscussionMessageUserData {

Nickname (string): Přezdívka uživatele, AvatarFilePath (string): Cesta k avatarovi }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

(4)

Try it out!

POST

/Api/Discussion

Vytvoření nové zpávy v diskuzi

Model Model Schema

Try it out!

GET

/Api/Discussion/{id}

Vrací DTO zprávy

Model

Model Schema

Response Class

string

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

message (required)

Parameter content type:

application/json

body

MessageParameterModel {

Message (string): Text zprávy,

Reply (boolean):

Odpověď v diskuzi (poue pro povolené uživatele) }

Response Messages

HTTP Status

Code Reason Response Model

201 Zpráva byla vytvořena 400 Zpráva již existuje

401 Uživatel nemá oprávnění vytvořit zprávu

Response Class

DiscussionMessageDto { Id (integer): ID zprávy, Text (string): Text zprávy,

CreatedAt (string): Datum a čas vytvoření,

UserData (DiscussionMessageUserData): Autor zprávy,

Reply (boolean): Určuje zda se jedná o odpověď admina či jiné spolehlivé osoby, Links (array[Link], optional)

(5)

Try it out!

GET

/Api/Discussion/page-{page}

Přípěvky v diskuzi

Model

Model Schema }

DiscussionMessageUserData {

Nickname (string): Přezdívka uživatele, AvatarFilePath (string): Cesta k avatarovi }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) Id zprávy path integer

Response Messages

HTTP Status

Code Reason Response Model

404 Zpráva neexistuje

Response Class

DiscussionPagedDto {

Messages (array[DiscussionMessageDto]): Zprávy diskuze, PageNumber (integer): Číslo stránky,

PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

(6)

Try it out!

Episode

Show/Hide List Operations Expand Operations Raw GET

/Api/Episodes

Vrací vyšlé epizody (odpovídá úvodní stránce SerialTrackeru) Obsahuje uživatelsky zohledněná data pokud je uživatel přihlášen

DiscussionMessageDto { Id (integer): ID zprávy, Text (string): Text zprávy,

CreatedAt (string): Datum a čas vytvoření,

UserData (DiscussionMessageUserData): Autor zprávy,

Reply (boolean): Určuje zda se jedná o odpověď admina či jiné spolehlivé osoby, Links (array[Link], optional)

}

DiscussionMessageUserData {

Nickname (string): Přezdívka uživatele, AvatarFilePath (string): Cesta k avatarovi }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

(7)

Model

Model Schema

Response Class

EpisodesPagedDto {

Episodes (array[EpisodeDto]): Epizody, PageNumber (integer): Číslo stránky, PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional),

(8)

Try it out!

GET

/Api/Episodes/{id}

Informace o epizodě

Model

Model Schema Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu,

(9)

Try it out!

EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) Id epizody path integer

Response Messages

HTTP Status

Code Reason Response Model

404 Epizoda neexistuje

(10)

Try it out!

GET

/Api/Episodes/For-Day

Epizody vysílané v daný datum

Model

Model Schema

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional),

(11)

Try it out!

GET

/Api/Episodes/For-Day/{year}-{month}-{day}

Epizody vysílané v daný datum

Model

Model Schema Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

year Rok query integer

month Měsíc query integer

day Den query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Neplatný formát data

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody,

(12)

EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

(13)

Try it out!

GET

/Api/Episodes/For-Day/{year}-{month}-{day}/For-User

Epizody vysílané v daný datum pro uživatele

Model

Model Schema

Parameters

Parameter Value Description Parameter

Type Data Type

year Rok path integer

month Měsíc path integer

day Den path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Neplatný formát data

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

(14)

Try it out!

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

year Rok path integer

month Měsíc path integer

day Den path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Neplatný formát data

(15)

GET

/Api/Episodes/For-Day/For-User

Epizody vysílané v daný datum pro uživatele

Model

Model Schema

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional),

(16)

Try it out!

GET

/Api/Episodes/For-User

Vrací vyšlé epizody pro uživatele

Model

Model Schema HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

year Rok query integer

month Měsíc query integer

day Den query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Neplatný formát data

Response Class

EpisodesPagedDto {

Episodes (array[EpisodeDto]): Epizody, PageNumber (integer): Číslo stránky, PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody,

(17)

SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

(18)

Try it out!

GET

/Api/Episodes/For-User/page-{page}

Vrací vyšlé epizody pro uživatele

Model

Model Schema

Parameter Value Description Parameter

Type Data Type

page Stránka query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

EpisodesPagedDto {

Episodes (array[EpisodeDto]): Epizody, PageNumber (integer): Číslo stránky, PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

(19)

Try it out!

GET

/Api/Episodes/page-{page}

Vrací vyšlé epizody (odpovídá úvodní stránce SerialTrackeru) Obsahuje uživatelsky zohledněná data pokud je uživatel přihlášen

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

(20)

Model

Model Schema EpisodesPagedDto {

Episodes (array[EpisodeDto]): Epizody, PageNumber (integer): Číslo stránky, PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional),

(21)

Try it out!

DELETE

/Api/Episodes/Watched

Odebere zhlédnutí dané epizody

Model

Model Schema IsTemplated (boolean, optional)

}

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

string

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

episodeId (required)

Parameter content type:

application/json

Objekt s hodnotou ID

epizody

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

204 Záznam o zhlédnutí epizody byl

(22)

Try it out!

POST

/Api/Episodes/Watched

Nastaví epizodu jako zhlédnutou

Model

Model Schema

Model

Model Schema

Try it out!

Notification

Show/Hide List Operations Expand Operations Raw 204 Záznam o zhlédnutí epizody byl

odstraněn

404 Epizoda neexistuje

404 Záznam o zhlédnutí epizody uživatelem neexistuje

Response Class

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

episodeId (required)

Parameter content type:

application/json

Objekt s hodnotou ID

epizody

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

200 Epizoda byla nastavena jako zhlédnutá

400 Epizoda již je nastavená jako zhlédnutá

400 Epizoda nebyla ještě odvysílána 404 Epizoda neexistuje

(23)

GET

/Api/Notifications

Uživatelovi nepřečtené notifikace

Model

Model Schema

Try it out!

Response Class

NotificationsDto {

Notifications (array[NotificationDto]): Nepřečtené notifikace, Links (array[Link], optional)

}

NotificationDto { Id (integer): ID,

Code (integer): Kód notifikace,

CreatedAt (string): Datum a čas vytvoření, ViewedAt (string): Datum a čas přečtení, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

(24)

GET

/Api/Notifications/{id}

Notifikace

Model

Model Schema

Try it out!

GET

/Api/Notifications/Codes

Vrací typy notifikací a jejich kódy

Model

Model Schema

Response Class

NotificationDto { Id (integer): ID,

Code (integer): Kód notifikace,

CreatedAt (string): Datum a čas vytvoření, ViewedAt (string): Datum a čas přečtení, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) ID notifikace path integer

Response Messages

HTTP Status

Code Reason Response Model

404 Notifikace neexistuje

Response Class

(25)

Try it out!

GET

/Api/Notifications/page-{page}

Uživatelovi nepřečtené notifikace

Model

Model Schema NotificationCodesDto {

NotificationCodes (array[NotificationCode]): Typy notifikací, Links (array[Link], optional)

}

NotificationCode {

Code (integer): Kód notifikace, Name (string): Jméno notifikace }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

NotificationsDto {

Notifications (array[NotificationDto]): Nepřečtené notifikace, Links (array[Link], optional)

}

NotificationDto { Id (integer): ID,

Code (integer): Kód notifikace,

CreatedAt (string): Datum a čas vytvoření, ViewedAt (string): Datum a čas přečtení, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional),

(26)

Try it out!

POST

/Api/Notifications/Read

Nastaví notifikaci jako přečtenou

Model

Model Schema Href (string, optional),

Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

string

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

id (required)

Parameter content type:

application/json

Id

notifikace

body

IntParameterModel {

Value (integer) }

Response Messages

(27)

Try it out!

POST

/Api/Notifications/Read-Multiple

Nastaví několik notifikací jako přečtené

Try it out!

Playlist

Show/Hide List Operations Expand Operations Raw GET

/Api/Playlist

Vrací stránkované seriály pro Playlist

Model

Model Schema HTTP Status

Code Reason Response Model

204 Notifikace byla nastavena jako přečtená

400 Notifikace je již přečtená 404 Notifikace neexistuje

Response Class

string

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type ids (required)

Parameter content type:

application/json

ID

notifikací

body array[integer]

Response Messages

HTTP Status

Code Reason Response Model

404 Notifikace neexistují

Response Class

PlaylistPagedDto {

Serials (array[SerialDto]): Seriály, PageNumber (integer): Číslo stránky, PageCount (integer): Počet stránek,

(28)

PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka

playlistu

query integer

search Vyhledování

pomocí jména

query string

(29)

Try it out!

GET

/Api/Playlist/{serialId}/Next-Episodes

Vrácí následující nezhlédnutí epizody pro daný seriál

Model

Model Schema

seriálu v playlistu

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

(30)

Try it out!

GET

/Api/Playlist/page-{page}

Vrací stránkované seriály pro Playlist

Model

Model Schema

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

serialId (required) path integer

count query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Počet epizod je mimo rozsah (1 - 8)

Response Class

PlaylistPagedDto {

Serials (array[SerialDto]): Seriály, PageNumber (integer): Číslo stránky,

(31)

PageCount (integer): Počet stránek, PageSize (integer): Velikost stránky, Links (array[Link], optional)

}

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka

playlistu

path integer

search Vyhledování query string

(32)

Try it out!

Serial

Show/Hide List Operations Expand Operations Raw

GET

/Api/Serials

Všechny seriály

Model

Model Schema

pomocí jména seriálu v playlistu

string

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

SerialsDto {

Serials (array[SerialDto], optional): Seriály, Links (array[Link], optional)

}

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional),

(33)

Try it out!

GET

/Api/Serials/{id}

Informace o seriálu

Model

Model Schema Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka query integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

Response Class

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

(34)

Try it out!

GET

/Api/Serials/{id}/Episodes

Všechny epizody seriálu

Model

Model Schema

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) ID seriálu path integer

Response Messages

HTTP Status

Code Reason Response Model

404 Seriál neexistuje

Response Class

EpisodesDto {

Episodes (array[EpisodeDto], optional): Epizody, Links (array[Link], optional)

}

EpisodeDto {

Id (integer): Id epizody,

Serial (SerialDto): Seriál kterému epizoda patří, Name (string): Jméno epizody,

(35)

ReleasedAt (string): Datum vysílání epizody, EpisodeNumber (string): Číslo epizody, SeasonNumber (string): Číslo sezóny,

FormattedEpisodeNumber (string): Zformátováné číslo epizody (S01E01), UserData (EpisodeUserData, optional): Uživatelská data epizody,

Links (array[Link], optional) }

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

EpisodeUserData {

Watched (boolean): Informace o tom zda je epizoda zhlédnutá, WatchedDate (string, optional): Datum zhlédnutí epizody }

Response Content Type

application/json

(36)

Try it out!

GET

/Api/Serials/{id}/Images

Vrací cesty k obrázkům seriálu

Model

Model Schema

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) ID seriálu path integer

Response Messages

HTTP Status

Code Reason Response Model

404 Seriál neexistuje

Response Class

SerialImagesDto {

SerialId (integer, optional): ID seriálu,

SmallImageFilePath (string, optional): Cesta k malámu obrázku, BigImageFilePath (string, optional): Cesta k velkému obrázku, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

id (required) ID seriálu path integer

(37)

Try it out!

DELETE

/Api/Serials/Email-Notification

Zrušení emailové notifikace

Model

Model Schema

Model

Model Schema

Try it out!

POST

/Api/Serials/Email-Notification

Zapnutí emailové notifikace

Response Messages

HTTP Status

Code Reason Response Model

404 Seriál neexistuje

Response Class

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

serialId (required)

Parameter content type:

application/json

Objekt s hodnotou ID seriálu

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

200 Emailová notifikace byla vypnuta 400 Emailová notifikace není zapnutá

Response Class

(38)

Model

Model Schema

Model

Model Schema

Try it out!

GET

/Api/Serials/page-{page}

Všechny seriály

Model

Model Schema SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

serialId (required)

Parameter content type:

application/json

Objekt s hodnotou ID seriálu

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

200 Emailové notifikace byly zapnuty 400 Emailové notifikace na seriál jsou již

zapnuté

400 Seriál je ukončený a nelze na něj získat emailové upozornění 404 Seriál neexistuje

Response Class

SerialsDto {

Serials (array[SerialDto], optional): Seriály, Links (array[Link], optional)

}

SerialDto {

Id (integer): ID seriálu, Name (string): Jméno seriálu,

(39)

Try it out!

Year (integer, optional): Rok premiéry seriálu, EndYear (integer, optional): Rok derniéry seriály, CreatedAt (string): Datum přidání seriálu,

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku, BigImageFilePath (string): Ceste k velkému obrázku, Rating (number, optional): Hodnocení seriálu,

UserData (SerialUserData, optional): Uživatelská data o seriálu, Links (array[Link], optional)

}

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Parameters

Parameter Value Description Parameter

Type Data Type

page Stránka path integer

Response Messages

HTTP Status

Code Reason Response Model

400 Zadaná stránka je mimo rozsah

(40)

DELETE

/Api/Serials/Watching

Zruší sledování seriálu

Model

Model Schema

Model

Model Schema

Try it out!

POST

/Api/Serials/Watching

Zapne sledování seriálu

Model

Model Schema

Response Class

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

serialId (required)

Parameter content type:

application/json

Objekt s hodnotou ID seriálu

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

200 Sledování seriálu bylo zrušeno 400 Uživatel nesleduje seriál

Response Class

SerialUserData {

EmailNotification (boolean): Informace o tom zda uživatel má zaplé emailové notifikace na nové epizody, UserWatching (boolean): Informace o tom zda uživatel sleduje seriál,

Rating (integer, optional): Uživatelovo hodnocení seriálu,

LastWatchedDate (string, optional): Poslední zhlédnutí epizody, WatchedEpisodesCount (integer): Celkový počet zhlédnutých epizod }

(41)

Model

Model Schema

Try it out!

Statistics

Show/Hide List Operations Expand Operations Raw GET

/Api/Statistics/Most-Viewed-Episodes

Nejsledovanější epizody

Model

Model Schema

Response Content Type

application/json

Parameters

Parameter Value Description ParameterType Data Type

serialId (required)

Parameter content type:

application/json

body

IntParameterModel {

Value (integer) }

Response Messages

HTTP Status

Code Reason Response Model

200 Seriál byl nastaven jako sledovaný 400 Uživatel již sleduje seriál

404 Seriál neexistuje

Response Class

MostViewedEpisodesDto {

Episodes (array[EpisodesAndUserCount]): Epizody a jejich počty zhlédnutí, Links (array[Link], optional)

}

EpisodesAndUserCount {

SerialName (string): Jméno seriálu, EpisodeName (string): Jméno epizody, Count (integer): Počet zhlédnutí }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional),

(42)

Try it out!

GET

/Api/Statistics/Most-Viewed-Serials

Nejsledovanější seriály

Model

Model Schema

Try it out!

Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

MostViewedSerialsDto {

SerialsAndUserCount (array[SerialsAndUserCount]): Seriály a počty uživatelů, Links (array[Link], optional)

}

SerialsAndUserCount {

SerialName (string): Jméno seriálu, UserCount (integer): Počet uživatelů }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

(43)

GET

/Api/Statistics/Personal

Osobní statistika uživatele

Model

Model Schema

Try it out!

GET

/Api/Statistics/Top-Rated-Serials

Nejlépe hodnocené seriály

Model

Model Schema

Response Class

PersonalStatisticsDto {

SerialsCount (integer): Počet sledovaných seriálů, EpisodeCount (integer): Počet zhlédnutých epizod,

TimeWatched (integer): Čas strávený sledováním seriálů v minutách, EmailCount (integer): Počet seriálů s emailovým upozorněním, RatingsCount (integer): Počet hodnocených seriálů,

AverageRating (integer): Průměrné hodnocení seriálů v procentech, RequestCount (integer): Počet žádostí o přidání či opravu serálu, Links (array[Link], optional)

} Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

TopRatedSerialsDto {

Serials (array[SerialRating]): Seriály a jejich hodnocení, Links (array[Link], optional)

}

SerialRating {

SerialName (string): Jméno seriálu,

Percentage (number): Procentuální hodnocení seriálu,

(44)

Try it out!

GET

/Api/Statistics/Users-With-Most-Episodes

Uživatelé co mají zhlédnutý největší počet epizod

Model

Model Schema

Count (integer): Počet hodnocení tohoto seriálu }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

UsersWithMostEpisodesDto {

UsersAndEpisodes (array[UsersWithEpisodesCount]): Uživatelé s počty zhlédnutých epizod, Links (array[Link], optional)

}

UsersWithEpisodesCount {

UserName (string): Jméno uživatele,

EpisodesCount (integer): Počet zhlédnutých epizod }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

(45)

Try it out!

GET

/Api/Statistics/Users-With-Most-Requests

Uživatelé s největším počtem žádostí

Model

Model Schema

Try it out!

GET

/Api/Statistics/Users-With-Most-Shows

Uživatelé co sledují nejvíce seriálů CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

UsersWithMostRequestsDto {

UsersAndRequests (array[UsersWithRequestsCount]): Uživatelé s počty požadavků, Links (array[Link], optional)

}

UsersWithRequestsCount {

UserName (string): Jméno uživatele, RequestsCount (integer): Počet požadavků }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

Response Class

(46)

Model

Model Schema

Try it out!

UsersWithMostShowsDto {

UsersAndSerials (array[UsersWithSerialsCount]): Uživatelé s počty sledovaných seriálů, Links (array[Link], optional)

}

UsersWithSerialsCount {

UserName (string): Jméno uživatele,

SerialsCount (integer): Počet sledovaných seriálů }

Link {

Curie (CuriesLink, optional), Rel (string, optional), Href (string, optional), Title (string, optional), Type (string, optional),

Deprecation (string, optional), Name (string, optional), Profile (string, optional), HrefLang (string, optional), IsTemplated (boolean, optional) }

CuriesLink {

Name (string, optional), Href (string, optional) }

Response Content Type

application/json

[

BASEURL

: http://st-api.aspone.cz/swagger/api-docs ,

APIVERSION

: 1.0.0.1 ]

References

Related documents

Je třeba připomenout, že jako přírodní fraktály jsou označována tělesa, která z geometrického hlediska vykazují složitost (tzv. struktura na struktuře), jsou soběpodobné,

Pr6ce se zabyvit simulaci prouddni oleje v prostoru zubov1 mezery pastorku a ozuben6ho kola pii provozu ozuben6ho soukoli.. Je ie5ena problematika moZnosti

Relativní vlhkost φ pro ustálení (kondiciování) a zkoušení textilií by měla být 65% ± 2%. Při testování je možné použít i referenční tkaninu, která slouží k

I přesto že je hlavním tématem práce lokalita s centru města, nezůstává celé město a vlastně i širší okolí bez pozornosti diplomanta.. Koncentrace na

Svým složením se chová šetrně k životnímu prostředí a její provoz vede ke zlepšení pracovních podmínek a pracovního

( Přípravu obráběcí kapaliny je nutné provádět tak, aby byl emulgační olej za stálého míchání přiléván do vody, ne opačně)..

Do mapy je jako klíč předána konstanta, identifikující fragment. Hodnotou je řetě- zec, definovaný v souboru string.xml. V souboru jsou uloženy zdroje, použité pro

Hodnocen´ı navrhovan´ e vedouc´ım diplomov´ e pr´ ace: výborně Hodnocen´ı navrhovan´ e oponentem diplomov´ e pr´ ace: výborně.. Pr˚ ubˇ eh obhajoby diplomov´ e