#Series

#Series

All the routes related to series

#Routes

GET Get all series
#http://ip:port/getAllSeries/:librarieName

Parameters in the path

#Parameters


#Path

NameTypeDescriptionRequired
librarieNamestringThe librarie nametrue

#Responses


StatusDescription
200: OKAll the series
404: Not FoundThe librarie was not found
GET Get a serie data
#http://ip:port/getSerieData/:serieId

Parameters in the path

#Parameters


#Path

NameTypeDescriptionRequired
serieIdstringThe serie id (from TMDB)true

#Responses


StatusDescription
200: OKThe serie data
404: Not FoundThe serie was not found

#Data returned


NameTypeDescription
idstringThe serie id
namestringThe serie name
originalNamestringThe serie original name
genresstring[]The serie genres
durationstringThe serie duration (hh or hh:mm or hh:mm:ss)
descriptionstringThe serie description
castJSONThe serie cast
bandeAnnonceUrlstringThe serie bande annonce url
serieCoverPathstringThe serie cover path
bannierestringThe serie banniere
notefloatThe serie note
datestringThe serie date (yyyy-mm-dd)
serieModifiedTimefloatThe serie folder modified time
libraryNamestringThe serie library name
adultbooleanThe serie adult
seasonsJSONThe serie seasons
GET Get a season data
#http://ip:port/getSeasonData/:seasonId

Parameters in the path

#Parameters


#Path

NameTypeDescriptionRequired
seasonIdstringThe season id (from TMDB)true

#Responses


StatusDescription
200: OKThe season data
404: Not FoundThe season was not found

#Data returned

NameTypeDescription
serieintThe serie id
seasonIdintThe season id
seasonNumberintThe season number
releasestringThe season release date (yyyy-mm-dd)
episodesNumberintThe season episodes number
seasonNamestringThe season name
seasonDescriptionstringThe season description
seasonCoverPathstringThe season cover path
modifiedTimefloatThe season folder modified time
numberOfEpisodesInFolderintThe number of episodes in the season folder (only used for the scans)
episodesJSONThe season episodes
GET Get an episode data
#http://ip:port/getEpisodeData/:seasonId/:episodeId

Parameters in the path

#Parameters


#Path

NameTypeDescriptionRequired
seasonIdstringThe season id (from TMDB)true
episodeIdstringThe episode id (from TMDB)true

#Responses

StatusDescription
200: OKThe episode data
404: Not FoundThe episode was not found

#Data returned

NameTypeDescription
seasonIdintThe season id
episodeIdintThe episode id
episodeNamestringThe episode name
episodeNumberintThe episode number
episodeDescriptionstringThe episode description
episodeCoverPathstringThe episode cover path
releaseDatestringThe episode release date (yyyy-mm-dd)
slugstringThe episode slug
introStartfloatThe episode intro start timecode (default: 0.0)
introEndfloatThe episode intro end timecode (default: 0.0)