Page tree


Search

  Wiki Navigation

    Loading...


 Recently Updated


 Latest Releases

 MediaPortal 1.22 
            Releasenews | Download
 MediaPortal 2 2.2.1 
            Releasenews | Download

This page contains the API documentation for this MPExtended service, as automatically generated on 18 Sep 2012 19:45 for version 0.5.0.0 (build 0.4.99.0). Please do not edit, as your changes will be overwritten.

Navigation

General

Filter

Movie

Music

Playlist

Picture

TVShow

FileSystem

General

GetExternalMediaInfo

URL /json/GetExternalMediaInfo Parameters

  • provider (nullable int)
  • type (WebMediaType)
  • id (string) Returns WebDictionary

GetFileInfo

URL /json/GetFileInfo Parameters

  • provider (nullable int)
  • mediatype (WebMediaType)
  • filetype (WebFileType)
  • id (string)
  • offset (int) Returns WebFileInfo
  • IsLocalFile (bool)
  • Size (long)
  • Name (string)
  • Path (string)
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Extension (string)
  • IsReadOnly (bool)
  • Exists (bool)
  • OnNetworkDrive (bool)
  • PID (int)

GetLocalDiskInformation

URL /json/GetLocalDiskInformation Parameters none Returns List of WebDiskSpaceInformation

  • Disk (string)
  • Size (float)
  • Available (float)
  • Used (float)
  • PercentageUsed (float)

GetMediaItem

URL /json/GetMediaItem Parameters

  • provider (nullable int)
  • type (WebMediaType)
  • id (string) Returns WebMediaItem
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Type (WebMediaType):
  • PID (int)

GetPathList

URL /json/GetPathList Parameters

  • provider (nullable int)
  • mediatype (WebMediaType)
  • filetype (WebFileType)
  • id (string) Returns List of string

GetServiceDescription

URL /json/GetServiceDescription Parameters none Returns WebMediaServiceDescription

  • ApiVersion (int)
  • ServiceVersion (string)
  • AvailableMovieLibraries (list of WebBackendProvider):
    • Name (string)
    • Version (string)
    • Id (int)
  • AvailableMusicLibraries (list of WebBackendProvider):
    • Name (string)
    • Version (string)
    • Id (int)
  • AvailablePictureLibraries (list of WebBackendProvider):
    • Name (string)
    • Version (string)
    • Id (int)
  • AvailableTvShowLibraries (list of WebBackendProvider):
    • Name (string)
    • Version (string)
    • Id (int)
  • AvailableFileSystemLibraries (list of WebBackendProvider):
    • Name (string)
    • Version (string)
    • Id (int)
  • DefaultMovieLibrary (int)
  • DefaultMusicLibrary (int)
  • DefaultPictureLibrary (int)
  • DefaultTvShowLibrary (int)
  • DefaultFileSystemLibrary (int)

IsLocalFile

URL /json/IsLocalFile Parameters

  • provider (nullable int)
  • mediatype (WebMediaType)
  • filetype (WebFileType)
  • id (string)
  • offset (int) Returns WebBoolResult
  • Result (bool)

RetrieveFile

URL /json/RetrieveFile Parameters

  • provider (nullable int)
  • mediatype (WebMediaType)
  • filetype (WebFileType)
  • id (string)
  • offset (int) Returns Raw data

URL /json/Search Parameters

  • text (string) Returns List of WebSearchResult
  • Type (WebMediaType):
  • Id (string)
  • Title (string)
  • Score (int)
  • Details (WebDictionary):
    • Item (string)
    • Keys (list of string)
    • Values (list of string)
    • Count (int)
  • PID (int)

SearchResultsByRange

URL /json/SearchResultsByRange Parameters

  • text (string)
  • start (int)
  • end (int) Returns List of WebSearchResult
  • Type (WebMediaType):
  • Id (string)
  • Title (string)
  • Score (int)
  • Details (WebDictionary):
    • Item (string)
    • Keys (list of string)
    • Values (list of string)
    • Count (int)
  • PID (int)

TestConnection

URL /json/TestConnection Parameters none Returns WebBoolResult

  • Result (bool)

Filter

CreateFilterString

URL /json/CreateFilterString Parameters

  • field (string)
  • op (string)
  • value (string)
  • conjunction (string) Returns WebStringResult
  • Result (string)

GetFilterOperators

URL /json/GetFilterOperators Parameters none Returns List of WebFilterOperator

  • Operator (string)
  • Title (string)
  • SuitableTypes (list of string)

GetFilterValues

URL /json/GetFilterValues Parameters

  • provider (nullable int)
  • mediaType (WebMediaType)
  • filterField (string)
  • op (nullable string)
  • limit (nullable Nullable`1)
  • order (nullable WebSortOrder) Returns List of string

GetFilterValuesByRange

URL /json/GetFilterValuesByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • mediaType (WebMediaType)
  • filterField (string)
  • op (nullable string)
  • limit (nullable Nullable`1)
  • order (nullable WebSortOrder) Returns List of string

GetFilterValuesCount

URL /json/GetFilterValuesCount Parameters

  • provider (nullable int)
  • mediaType (WebMediaType)
  • filterField (string)
  • op (nullable string)
  • limit (nullable Nullable`1) Returns WebIntResult
  • Result (int)

Movie

GetMovieActorCount

URL /json/GetMovieActorCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetMovieActors

URL /json/GetMovieActors Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebActor
  • Title (string)
  • PID (int)

GetMovieActorsByRange

URL /json/GetMovieActorsByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebActor
  • Title (string)
  • PID (int)

GetMovieBasicById

URL /json/GetMovieBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebMovieBasic
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMovieCategories

URL /json/GetMovieCategories Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: none)
  • order (nullable WebSortOrder) Returns List of WebCategory
  • Id (string)
  • Title (string)
  • PID (int)

GetMovieCount

URL /json/GetMovieCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetMovieDetailedById

URL /json/GetMovieDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebMovieDetailed
  • Directors (list of string)
  • Writers (list of string)
  • Summary (string)
  • Tagline (string)
  • Language (string)
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMovieGenres

URL /json/GetMovieGenres Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetMovieGenresByRange

URL /json/GetMovieGenresByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetMovieGenresCount

URL /json/GetMovieGenresCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetMoviesBasic

URL /json/GetMoviesBasic Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMovieBasic
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMoviesBasicByRange

URL /json/GetMoviesBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMovieBasic
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMoviesDetailed

URL /json/GetMoviesDetailed Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMovieDetailed
  • Directors (list of string)
  • Writers (list of string)
  • Summary (string)
  • Tagline (string)
  • Language (string)
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMoviesDetailedByRange

URL /json/GetMoviesDetailedByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMovieDetailed
  • Directors (list of string)
  • Writers (list of string)
  • Summary (string)
  • Tagline (string)
  • Language (string)
  • IsProtected (bool)
  • Genres (list of string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Year (int)
  • Rating (float)
  • Runtime (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

Music

GetMusicAlbumBasicById

URL /json/GetMusicAlbumBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebMusicAlbumBasic
  • Id (string)
  • Title (string)
  • Genres (list of string)
  • AlbumArtist (string)
  • AlbumArtistId (string)
  • Artists (list of string)
  • ArtistsId (list of string)
  • Composer (list of string)
  • DateAdded (DateTime)
  • Year (int)
  • Rating (float)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicAlbumCount

URL /json/GetMusicAlbumCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetMusicAlbumsBasic

URL /json/GetMusicAlbumsBasic Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicComposer = 7)
  • order (nullable WebSortOrder) Returns List of WebMusicAlbumBasic
  • Id (string)
  • Title (string)
  • Genres (list of string)
  • AlbumArtist (string)
  • AlbumArtistId (string)
  • Artists (list of string)
  • ArtistsId (list of string)
  • Composer (list of string)
  • DateAdded (DateTime)
  • Year (int)
  • Rating (float)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicAlbumsBasicByRange

URL /json/GetMusicAlbumsBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicComposer = 7)
  • order (nullable WebSortOrder) Returns List of WebMusicAlbumBasic
  • Id (string)
  • Title (string)
  • Genres (list of string)
  • AlbumArtist (string)
  • AlbumArtistId (string)
  • Artists (list of string)
  • ArtistsId (list of string)
  • Composer (list of string)
  • DateAdded (DateTime)
  • Year (int)
  • Rating (float)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicAlbumsBasicForArtist

URL /json/GetMusicAlbumsBasicForArtist Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicComposer = 7)
  • order (nullable WebSortOrder) Returns List of WebMusicAlbumBasic
  • Id (string)
  • Title (string)
  • Genres (list of string)
  • AlbumArtist (string)
  • AlbumArtistId (string)
  • Artists (list of string)
  • ArtistsId (list of string)
  • Composer (list of string)
  • DateAdded (DateTime)
  • Year (int)
  • Rating (float)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistBasicById

URL /json/GetMusicArtistBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebMusicArtistBasic
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistCount

URL /json/GetMusicArtistCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetMusicArtistDetailedById

URL /json/GetMusicArtistDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebMusicArtistDetailed
  • Biography (string)
  • Tones (string)
  • Styles (string)
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistsBasic

URL /json/GetMusicArtistsBasic Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebMusicArtistBasic
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistsBasicByRange

URL /json/GetMusicArtistsBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebMusicArtistBasic
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistsDetailed

URL /json/GetMusicArtistsDetailed Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebMusicArtistDetailed
  • Biography (string)
  • Tones (string)
  • Styles (string)
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicArtistsDetailedByRange

URL /json/GetMusicArtistsDetailedByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebMusicArtistDetailed
  • Biography (string)
  • Tones (string)
  • Styles (string)
  • Id (string)
  • Title (string)
  • HasAlbums (bool)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicCategories

URL /json/GetMusicCategories Parameters

  • provider (nullable int) Returns List of WebCategory
  • Id (string)
  • Title (string)
  • PID (int)

GetMusicGenres

URL /json/GetMusicGenres Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetMusicGenresByRange

URL /json/GetMusicGenresByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetMusicGenresCount

URL /json/GetMusicGenresCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetMusicTrackBasicById

URL /json/GetMusicTrackBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebMusicTrackBasic
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTrackCount

URL /json/GetMusicTrackCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetMusicTrackDetailedById

URL /json/GetMusicTrackDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebMusicTrackDetailed
  • Artists (list of WebMusicArtistBasic):
    • Id (string)
    • Title (string)
    • HasAlbums (bool)
    • Artwork (list of WebArtwork):
      • Type (WebFileType):
      • Id (string)
      • Rating (int)
      • Filetype (string)
      • Offset (int)
    • PID (int)
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksBasic

URL /json/GetMusicTracksBasic Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackBasic
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksBasicByRange

URL /json/GetMusicTracksBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackBasic
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksBasicForAlbum

URL /json/GetMusicTracksBasicForAlbum Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackBasic
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksBasicForArtist

URL /json/GetMusicTracksBasicForArtist Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackBasic
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksDetailed

URL /json/GetMusicTracksDetailed Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackDetailed
  • Artists (list of WebMusicArtistBasic):
    • Id (string)
    • Title (string)
    • HasAlbums (bool)
    • Artwork (list of WebArtwork):
      • Type (WebFileType):
      • Id (string)
      • Rating (int)
      • Filetype (string)
      • Offset (int)
    • PID (int)
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksDetailedByRange

URL /json/GetMusicTracksDetailedByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackDetailed
  • Artists (list of WebMusicArtistBasic):
    • Id (string)
    • Title (string)
    • HasAlbums (bool)
    • Artwork (list of WebArtwork):
      • Type (WebFileType):
      • Id (string)
      • Rating (int)
      • Filetype (string)
      • Offset (int)
    • PID (int)
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksDetailedForAlbum

URL /json/GetMusicTracksDetailedForAlbum Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackDetailed
  • Artists (list of WebMusicArtistBasic):
    • Id (string)
    • Title (string)
    • HasAlbums (bool)
    • Artwork (list of WebArtwork):
      • Type (WebFileType):
      • Id (string)
      • Rating (int)
      • Filetype (string)
      • Offset (int)
    • PID (int)
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetMusicTracksDetailedForArtist

URL /json/GetMusicTracksDetailedForArtist Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4, MusicTrackNumber = 6, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebMusicTrackDetailed
  • Artists (list of WebMusicArtistBasic):
    • Id (string)
    • Title (string)
    • HasAlbums (bool)
    • Artwork (list of WebArtwork):
      • Type (WebFileType):
      • Id (string)
      • Rating (int)
      • Filetype (string)
      • Offset (int)
    • PID (int)
  • Artist (list of string)
  • ArtistId (list of string)
  • Album (string)
  • AlbumId (string)
  • TrackNumber (int)
  • Year (int)
  • Duration (int)
  • Rating (float)
  • Genres (list of string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

Playlist

AddPlaylistItem

URL /json/AddPlaylistItem Parameters

  • provider (nullable int)
  • playlistId (string)
  • type (WebMediaType)
  • id (string)
  • position (nullable int) Returns WebBoolResult
  • Result (bool)

AddPlaylistItems

URL /json/AddPlaylistItems Parameters

  • provider (nullable int)
  • playlistId (string)
  • type (WebMediaType)
  • position (nullable int)
  • ids (string) Returns WebBoolResult
  • Result (bool)

CreatePlaylist

URL /json/CreatePlaylist Parameters

  • provider (nullable int)
  • playlistName (string) Returns WebStringResult
  • Result (string)

DeletePlaylist

URL /json/DeletePlaylist Parameters

  • provider (nullable int)
  • playlistId (string) Returns WebBoolResult
  • Result (bool)

GetPlaylistItems

URL /json/GetPlaylistItems Parameters

  • provider (nullable int)
  • playlistId (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebPlaylistItem
  • Duration (int)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Type (WebMediaType):
  • PID (int)

GetPlaylistItemsByRange

URL /json/GetPlaylistItemsByRange Parameters

  • provider (nullable int)
  • playlistId (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebPlaylistItem
  • Duration (int)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Type (WebMediaType):
  • PID (int)

GetPlaylistItemsCount

URL /json/GetPlaylistItemsCount Parameters

  • provider (nullable int)
  • playlistId (string) Returns WebIntResult
  • Result (int)

GetPlaylists

URL /json/GetPlaylists Parameters

  • provider (nullable int) Returns List of WebPlaylist
  • ItemCount (int)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

MovePlaylistItem

URL /json/MovePlaylistItem Parameters

  • provider (nullable int)
  • playlistId (string)
  • oldPosition (int)
  • newPosition (int) Returns WebBoolResult
  • Result (bool)

RemovePlaylistItem

URL /json/RemovePlaylistItem Parameters

  • provider (nullable int)
  • playlistId (string)
  • position (int) Returns WebBoolResult
  • Result (bool)

RemovePlaylistItems

URL /json/RemovePlaylistItems Parameters

  • provider (nullable int)
  • playlistId (string)
  • positions (string) Returns WebBoolResult
  • Result (bool)

Picture

GetPictureBasicById

URL /json/GetPictureBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebPictureBasic
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPictureCategories

URL /json/GetPictureCategories Parameters

  • provider (nullable int) Returns List of WebCategory
  • Id (string)
  • Title (string)
  • PID (int)

GetPictureCount

URL /json/GetPictureCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetPictureDetailedById

URL /json/GetPictureDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebPictureDetailed
  • Subject (string)
  • Comment (string)
  • CameraManufacturer (string)
  • CameraModel (string)
  • Copyright (string)
  • Mpixel (float)
  • Height (string)
  • Width (string)
  • Dpi (string)
  • Author (string)
  • Rating (float)
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPicturesBasic

URL /json/GetPicturesBasic Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, PictureDateTaken = 10, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebPictureBasic
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPicturesBasicByCategory

URL /json/GetPicturesBasicByCategory Parameters

  • provider (nullable int)
  • id (string) Returns List of WebPictureBasic
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPicturesDetailed

URL /json/GetPicturesDetailed Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, PictureDateTaken = 10, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebPictureDetailed
  • Subject (string)
  • Comment (string)
  • CameraManufacturer (string)
  • CameraModel (string)
  • Copyright (string)
  • Mpixel (float)
  • Height (string)
  • Width (string)
  • Dpi (string)
  • Author (string)
  • Rating (float)
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPicturesDetailedByCategory

URL /json/GetPicturesDetailedByCategory Parameters

  • provider (nullable int)
  • id (string) Returns List of WebPictureDetailed
  • Subject (string)
  • Comment (string)
  • CameraManufacturer (string)
  • CameraModel (string)
  • Copyright (string)
  • Mpixel (float)
  • Height (string)
  • Width (string)
  • Dpi (string)
  • Author (string)
  • Rating (float)
  • Categories (list of WebCategory):
    • Id (string)
    • Title (string)
    • PID (int)
  • DateTaken (DateTime)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetPictureSubCategories

URL /json/GetPictureSubCategories Parameters

  • provider (nullable int)
  • id (string) Returns List of WebCategory
  • Id (string)
  • Title (string)
  • PID (int)

TVShow

GetTVEpisodeBasicById

URL /json/GetTVEpisodeBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodeCount

URL /json/GetTVEpisodeCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetTVEpisodeCountForSeason

URL /json/GetTVEpisodeCountForSeason Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

GetTVEpisodeCountForTVShow

URL /json/GetTVEpisodeCountForTVShow Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

GetTVEpisodeDetailedById

URL /json/GetTVEpisodeDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesBasic

URL /json/GetTVEpisodesBasic Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesBasicByRange

URL /json/GetTVEpisodesBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesBasicForSeason

URL /json/GetTVEpisodesBasicForSeason Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesBasicForTVShow

URL /json/GetTVEpisodesBasicForTVShow Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesBasicForTVShowByRange

URL /json/GetTVEpisodesBasicForTVShowByRange Parameters

  • provider (nullable int)
  • id (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeBasic
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesDetailed

URL /json/GetTVEpisodesDetailed Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesDetailedByRange

URL /json/GetTVEpisodesDetailedByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesDetailedForSeason

URL /json/GetTVEpisodesDetailedForSeason Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesDetailedForTVShow

URL /json/GetTVEpisodesDetailedForTVShow Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVEpisodesDetailedForTVShowByRange

URL /json/GetTVEpisodesDetailedForTVShowByRange Parameters

  • provider (nullable int)
  • id (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Rating = 4, TVEpisodeNumber = 8, TVDateAired = 11, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebTVEpisodeDetailed
  • GuestStars (list of string)
  • Directors (list of string)
  • Writers (list of string)
  • Show (string)
  • Summary (string)
  • ShowId (string)
  • EpisodeNumber (int)
  • SeasonNumber (int)
  • SeasonId (string)
  • IsProtected (bool)
  • Watched (bool)
  • Rating (float)
  • FirstAired (DateTime)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • Type (WebMediaType):
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVSeasonBasicById

URL /json/GetTVSeasonBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVSeasonBasic
  • Id (string)
  • Title (string)
  • ShowId (string)
  • SeasonNumber (int)
  • IsProtected (bool)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • DateAdded (DateTime)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVSeasonCountForTVShow

URL /json/GetTVSeasonCountForTVShow Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

GetTVSeasonDetailedById

URL /json/GetTVSeasonDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVSeasonDetailed
  • Id (string)
  • Title (string)
  • ShowId (string)
  • SeasonNumber (int)
  • IsProtected (bool)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • DateAdded (DateTime)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVSeasonsBasicForTVShow

URL /json/GetTVSeasonsBasicForTVShow Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, TVSeasonNumber = 9)
  • order (nullable WebSortOrder) Returns List of WebTVSeasonBasic
  • Id (string)
  • Title (string)
  • ShowId (string)
  • SeasonNumber (int)
  • IsProtected (bool)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • DateAdded (DateTime)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVSeasonsDetailedForTVShow

URL /json/GetTVSeasonsDetailedForTVShow Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, TVSeasonNumber = 9)
  • order (nullable WebSortOrder) Returns List of WebTVSeasonDetailed
  • Id (string)
  • Title (string)
  • ShowId (string)
  • SeasonNumber (int)
  • IsProtected (bool)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • DateAdded (DateTime)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetTVShowActorCount

URL /json/GetTVShowActorCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetTVShowActors

URL /json/GetTVShowActors Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebActor
  • Title (string)
  • PID (int)

GetTVShowActorsByRange

URL /json/GetTVShowActorsByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebActor
  • Title (string)
  • PID (int)

GetTVShowBasicById

URL /json/GetTVShowBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVShowBasic
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

GetTVShowCategories

URL /json/GetTVShowCategories Parameters

  • provider (nullable int) Returns List of WebCategory
  • Id (string)
  • Title (string)
  • PID (int)

GetTVShowCount

URL /json/GetTVShowCount Parameters

  • provider (nullable int)
  • filter (nullable string) Returns WebIntResult
  • Result (int)

GetTVShowDetailedById

URL /json/GetTVShowDetailedById Parameters

  • provider (nullable int)
  • id (string) Returns WebTVShowDetailed
  • Summary (string)
  • Status (string)
  • Network (string)
  • AirsDay (string)
  • AirsTime (string)
  • Runtime (int)
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

GetTVShowGenres

URL /json/GetTVShowGenres Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetTVShowGenresByRange

URL /json/GetTVShowGenresByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0)
  • order (nullable WebSortOrder) Returns List of WebGenre
  • Title (string)
  • PID (int)

GetTVShowGenresCount

URL /json/GetTVShowGenresCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetTVShowsBasic

URL /json/GetTVShowsBasic Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4)
  • order (nullable WebSortOrder) Returns List of WebTVShowBasic
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

GetTVShowsBasicByRange

URL /json/GetTVShowsBasicByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4)
  • order (nullable WebSortOrder) Returns List of WebTVShowBasic
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

GetTVShowsDetailed

URL /json/GetTVShowsDetailed Parameters

  • provider (nullable int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4)
  • order (nullable WebSortOrder) Returns List of WebTVShowDetailed
  • Summary (string)
  • Status (string)
  • Network (string)
  • AirsDay (string)
  • AirsTime (string)
  • Runtime (int)
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

GetTVShowsDetailedByRange

URL /json/GetTVShowsDetailedByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • filter (nullable string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Year = 2, Genre = 3, Rating = 4)
  • order (nullable WebSortOrder) Returns List of WebTVShowDetailed
  • Summary (string)
  • Status (string)
  • Network (string)
  • AirsDay (string)
  • AirsTime (string)
  • Runtime (int)
  • Id (string)
  • IsProtected (bool)
  • DateAdded (DateTime)
  • Genres (list of string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Actors (list of WebActor):
    • Title (string)
    • PID (int)
  • Title (string)
  • Year (int)
  • EpisodeCount (int)
  • UnwatchedEpisodeCount (int)
  • Rating (float)
  • ContentRating (string)
  • ExternalId (list of WebExternalId):
    • Site (string)
    • Id (string)
  • PID (int)

FileSystem

GetFileSystemDriveBasicById

URL /json/GetFileSystemDriveBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebDriveBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemDriveCount

URL /json/GetFileSystemDriveCount Parameters

  • provider (nullable int) Returns WebIntResult
  • Result (int)

GetFileSystemDrives

URL /json/GetFileSystemDrives Parameters

  • provider (nullable int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebDriveBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemDrivesByRange

URL /json/GetFileSystemDrivesByRange Parameters

  • provider (nullable int)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebDriveBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFileBasicById

URL /json/GetFileSystemFileBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebFileBasic
  • Size (long)
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFiles

URL /json/GetFileSystemFiles Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFileBasic
  • Size (long)
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFilesAndFolders

URL /json/GetFileSystemFilesAndFolders Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFilesystemItem
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Type (WebMediaType):
  • PID (int)

GetFileSystemFilesAndFoldersByRange

URL /json/GetFileSystemFilesAndFoldersByRange Parameters

  • provider (nullable int)
  • id (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFilesystemItem
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • Type (WebMediaType):
  • PID (int)

GetFileSystemFilesAndFoldersCount

URL /json/GetFileSystemFilesAndFoldersCount Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

GetFileSystemFilesByRange

URL /json/GetFileSystemFilesByRange Parameters

  • provider (nullable int)
  • id (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFileBasic
  • Size (long)
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFilesCount

URL /json/GetFileSystemFilesCount Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

GetFileSystemFolderBasicById

URL /json/GetFileSystemFolderBasicById Parameters

  • provider (nullable int)
  • id (string) Returns WebFolderBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFolders

URL /json/GetFileSystemFolders Parameters

  • provider (nullable int)
  • id (string)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFolderBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFoldersByRange

URL /json/GetFileSystemFoldersByRange Parameters

  • provider (nullable int)
  • id (string)
  • start (int)
  • end (int)
  • sort (nullable WebSortField; valid values: Title = 0, DateAdded = 1, Type = 12)
  • order (nullable WebSortOrder) Returns List of WebFolderBasic
  • Type (WebMediaType):
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Id (string)
  • Path (list of string)
  • DateAdded (DateTime)
  • Title (string)
  • Artwork (list of WebArtwork):
    • Type (WebFileType):
    • Id (string)
    • Rating (int)
    • Filetype (string)
    • Offset (int)
  • PID (int)

GetFileSystemFoldersCount

URL /json/GetFileSystemFoldersCount Parameters

  • provider (nullable int)
  • id (string) Returns WebIntResult
  • Result (int)

   

 

This page has no comments.