Page tree


Search


 Recently Updated



 Latest Releases

 MediaPortal 1.20 
            Releasenews | Download
 MediaPortal 2 2.2 
            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

Misc

Channels

TV

Radio

Timeshiftings

Schedule

Recording

EPG

Misc

GetActiveCards

URL /json/GetActiveCards Parameters none Returns List of WebVirtualCard

  • BitRateMode (int)
  • ChannelName (string)
  • Device (string)
  • Enabled (bool)
  • GetTimeshiftStoppedReason (int)
  • GrabTeletext (bool)
  • HasTeletext (bool)
  • Id (int)
  • ChannelId (int)
  • IsGrabbingEpg (bool)
  • IsRecording (bool)
  • IsScanning (bool)
  • IsScrambled (bool)
  • IsTimeShifting (bool)
  • IsTunerLocked (bool)
  • MaxChannel (int)
  • MinChannel (int)
  • Name (string)
  • QualityType (int)
  • RecordingFileName (string)
  • RecordingFolder (string)
  • RecordingFormat (int)
  • RecordingScheduleId (int)
  • RecordingStarted (DateTime)
  • RemoteServer (string)
  • RTSPUrl (string)
  • SignalLevel (int)
  • SignalQuality (int)
  • TimeShiftFileName (string)
  • TimeShiftFolder (string)
  • TimeShiftStarted (DateTime)
  • Type (WebCardType):
  • User (WebUser):
    • CardId (int)
    • HeartBeat (DateTime)
    • ChannelId (int)
    • IsAdmin (bool)
    • Name (string)
    • SubChannel (int)
    • TvStoppedReason (int)

GetActiveUsers

URL /json/GetActiveUsers Parameters none Returns List of WebUser

  • CardId (int)
  • HeartBeat (DateTime)
  • ChannelId (int)
  • IsAdmin (bool)
  • Name (string)
  • SubChannel (int)
  • TvStoppedReason (int)

GetCards

URL /json/GetCards Parameters none Returns List of WebCard

  • CAM (bool)
  • CamType (int)
  • DecryptLimit (int)
  • DevicePath (string)
  • Enabled (bool)
  • GrabEPG (bool)
  • Id (int)
  • IsChanged (bool)
  • LastEpgGrab (DateTime)
  • Name (string)
  • NetProvider (int)
  • PreloadCard (bool)
  • Priority (int)
  • RecordingFolder (string)
  • RecordingFormat (int)
  • SupportSubChannels (bool)
  • TimeShiftFolder (string)

GetExternalMediaInfo

URL /json/GetExternalMediaInfo Parameters

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

GetLocalDiskInformation

URL /json/GetLocalDiskInformation Parameters none Returns List of WebDiskSpaceInformation

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

GetServiceDescription

URL /json/GetServiceDescription Parameters none Returns WebTVServiceDescription

  • ApiVersion (int)
  • ServiceVersion (string)
  • HasConnectionToTVServer (bool)

GetStreamingClients

URL /json/GetStreamingClients Parameters none Returns List of WebRtspClient

  • DateTimeStarted (DateTime)
  • Description (string)
  • IpAdress (string)
  • IsActive (bool)
  • StreamName (string)

ReadSettingFromDatabase

URL /json/ReadSettingFromDatabase Parameters

  • tagName (string) Returns WebStringResult
  • Result (string)

URL /json/Search Parameters

SearchResultsByRange

URL /json/SearchResultsByRange Parameters

TestConnectionToTVService

URL /json/TestConnectionToTVService Parameters none Returns WebBoolResult

  • Result (bool)

WriteSettingToDatabase

URL /json/WriteSettingToDatabase Parameters

  • tagName (string)
  • value (string) Returns WebBoolResult
  • Result (bool)

Channels

ChannelState (enumeration)

Values

  • NotTunable: 0
  • Tunable: 1
  • Timeshifting: 2
  • Recording: 3
  • Unknown: -1

GetAllChannelStatesForGroup

URL /json/GetAllChannelStatesForGroup Parameters

  • groupId (int)
  • userName (string) Returns List of WebChannelState
  • ChannelId (int)
  • State (ChannelState)

GetAllRadioChannelStatesForGroup

URL /json/GetAllRadioChannelStatesForGroup Parameters

  • groupId (int)
  • userName (string) Returns List of WebChannelState
  • ChannelId (int)
  • State (ChannelState)

GetChannelState

URL /json/GetChannelState Parameters

  • channelId (int)
  • userName (string) Returns WebChannelState
  • ChannelId (int)
  • State (ChannelState)

TV

GetChannelBasicById

URL /json/GetChannelBasicById Parameters

  • channelId (int) Returns WebChannelBasic
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetChannelCount

URL /json/GetChannelCount Parameters

  • groupId (nullable Nullable`1) Returns WebIntResult
  • Result (int)

GetChannelDetailedById

URL /json/GetChannelDetailedById Parameters

  • channelId (int) Returns WebChannelDetailed
  • CurrentProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • NextProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • EpgHasGaps (bool)
  • ExternalId (string)
  • FreeToAir (int)
  • GrabEpg (bool)
  • GroupNames (list of string)
  • IsChanged (bool)
  • LastGrabTime (DateTime)
  • TimesWatched (int)
  • TotalTimeWatched (DateTime)
  • VisibleInGuide (bool)
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetChannelsBasic

URL /json/GetChannelsBasic Parameters

  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelBasic
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetChannelsBasicByRange

URL /json/GetChannelsBasicByRange Parameters

  • start (int)
  • end (int)
  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelBasic
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetChannelsDetailed

URL /json/GetChannelsDetailed Parameters

  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelDetailed
  • CurrentProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • NextProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • EpgHasGaps (bool)
  • ExternalId (string)
  • FreeToAir (int)
  • GrabEpg (bool)
  • GroupNames (list of string)
  • IsChanged (bool)
  • LastGrabTime (DateTime)
  • TimesWatched (int)
  • TotalTimeWatched (DateTime)
  • VisibleInGuide (bool)
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetChannelsDetailedByRange

URL /json/GetChannelsDetailedByRange Parameters

  • start (int)
  • end (int)
  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelDetailed
  • CurrentProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • NextProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • EpgHasGaps (bool)
  • ExternalId (string)
  • FreeToAir (int)
  • GrabEpg (bool)
  • GroupNames (list of string)
  • IsChanged (bool)
  • LastGrabTime (DateTime)
  • TimesWatched (int)
  • TotalTimeWatched (DateTime)
  • VisibleInGuide (bool)
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetGroupById

URL /json/GetGroupById Parameters

  • groupId (int) Returns WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

GetGroupCount

URL /json/GetGroupCount Parameters none Returns WebIntResult

  • Result (int)

GetGroups

URL /json/GetGroups Parameters

  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

GetGroupsByRange

URL /json/GetGroupsByRange Parameters

  • start (int)
  • end (int)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

Radio

GetRadioChannelCount

URL /json/GetRadioChannelCount Parameters

  • groupId (nullable Nullable`1) Returns WebIntResult
  • Result (int)

GetRadioChannelsBasic

URL /json/GetRadioChannelsBasic Parameters

  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelBasic
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioChannelsBasicByRange

URL /json/GetRadioChannelsBasicByRange Parameters

  • start (int)
  • end (int)
  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelBasic
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioChannelsDetailed

URL /json/GetRadioChannelsDetailed Parameters

  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelDetailed
  • CurrentProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • NextProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • EpgHasGaps (bool)
  • ExternalId (string)
  • FreeToAir (int)
  • GrabEpg (bool)
  • GroupNames (list of string)
  • IsChanged (bool)
  • LastGrabTime (DateTime)
  • TimesWatched (int)
  • TotalTimeWatched (DateTime)
  • VisibleInGuide (bool)
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioChannelsDetailedByRange

URL /json/GetRadioChannelsDetailedByRange Parameters

  • start (int)
  • end (int)
  • groupId (nullable Nullable`1)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelDetailed
  • CurrentProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • NextProgram (WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)
  • EpgHasGaps (bool)
  • ExternalId (string)
  • FreeToAir (int)
  • GrabEpg (bool)
  • GroupNames (list of string)
  • IsChanged (bool)
  • LastGrabTime (DateTime)
  • TimesWatched (int)
  • TotalTimeWatched (DateTime)
  • VisibleInGuide (bool)
  • Title (string)
  • Id (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioGroupById

URL /json/GetRadioGroupById Parameters

  • groupId (int) Returns WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioGroupCount

URL /json/GetRadioGroupCount Parameters none Returns WebIntResult

  • Result (int)

GetRadioGroups

URL /json/GetRadioGroups Parameters

  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

GetRadioGroupsByRange

URL /json/GetRadioGroupsByRange Parameters

  • start (int)
  • end (int)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebChannelGroup
  • GroupName (string)
  • Id (int)
  • IsChanged (bool)
  • SortOrder (int)
  • IsRadio (bool)
  • IsTv (bool)

Timeshiftings

CancelCurrentTimeShifting

URL /json/CancelCurrentTimeShifting Parameters

  • userName (string) Returns WebBoolResult
  • Result (bool)

SendHeartbeat

URL /json/SendHeartbeat Parameters

  • userName (string) Returns WebBoolResult
  • Result (bool)

SwitchTVServerToChannelAndGetStreamingUrl

URL /json/SwitchTVServerToChannelAndGetStreamingUrl Parameters

  • userName (string)
  • channelId (int) Returns WebStringResult
  • Result (string)

SwitchTVServerToChannelAndGetTimeshiftFilename

URL /json/SwitchTVServerToChannelAndGetTimeshiftFilename Parameters

  • userName (string)
  • channelId (int) Returns WebStringResult
  • Result (string)

SwitchTVServerToChannelAndGetVirtualCard

URL /json/SwitchTVServerToChannelAndGetVirtualCard Parameters

  • userName (string)
  • channelId (int) Returns WebVirtualCard
  • BitRateMode (int)
  • ChannelName (string)
  • Device (string)
  • Enabled (bool)
  • GetTimeshiftStoppedReason (int)
  • GrabTeletext (bool)
  • HasTeletext (bool)
  • Id (int)
  • ChannelId (int)
  • IsGrabbingEpg (bool)
  • IsRecording (bool)
  • IsScanning (bool)
  • IsScrambled (bool)
  • IsTimeShifting (bool)
  • IsTunerLocked (bool)
  • MaxChannel (int)
  • MinChannel (int)
  • Name (string)
  • QualityType (int)
  • RecordingFileName (string)
  • RecordingFolder (string)
  • RecordingFormat (int)
  • RecordingScheduleId (int)
  • RecordingStarted (DateTime)
  • RemoteServer (string)
  • RTSPUrl (string)
  • SignalLevel (int)
  • SignalQuality (int)
  • TimeShiftFileName (string)
  • TimeShiftFolder (string)
  • TimeShiftStarted (DateTime)
  • Type (WebCardType):
  • User (WebUser):
    • CardId (int)
    • HeartBeat (DateTime)
    • ChannelId (int)
    • IsAdmin (bool)
    • Name (string)
    • SubChannel (int)
    • TvStoppedReason (int)

Schedule

AddSchedule

URL /json/AddSchedule Parameters

  • channelId (int)
  • title (string)
  • startTime (DateTime)
  • endTime (DateTime)
  • scheduleType (WebScheduleType) Returns WebBoolResult
  • Result (bool)

AddScheduleDetailed

URL /json/AddScheduleDetailed Parameters

  • channelId (int)
  • title (string)
  • startTime (DateTime)
  • endTime (DateTime)
  • scheduleType (WebScheduleType)
  • preRecordInterval (int)
  • postRecordInterval (int)
  • directory (string)
  • priority (int) Returns WebBoolResult
  • Result (bool)

CancelSchedule

URL /json/CancelSchedule Parameters

  • programId (int) Returns WebBoolResult
  • Result (bool)

DeleteSchedule

URL /json/DeleteSchedule Parameters

  • scheduleId (int) Returns WebBoolResult
  • Result (bool)

GetProgramIsScheduled

URL /json/GetProgramIsScheduled Parameters

  • programId (int) Returns WebBoolResult
  • Result (bool)

GetProgramIsScheduledOnChannel

URL /json/GetProgramIsScheduledOnChannel Parameters

  • channelId (int)
  • programId (int) Returns WebBoolResult
  • Result (bool)

GetScheduleById

URL /json/GetScheduleById Parameters

  • scheduleId (int) Returns WebScheduleBasic
  • BitRateMode (int)
  • Canceled (DateTime)
  • Directory (string)
  • DoesUseEpisodeManagement (bool)
  • EndTime (DateTime)
  • ChannelId (int)
  • ParentScheduleId (int)
  • Id (int)
  • IsChanged (bool)
  • IsManual (bool)
  • KeepDate (DateTime)
  • KeepMethod (WebScheduleKeepMethod):
  • MaxAirings (int)
  • PostRecordInterval (int)
  • PreRecordInterval (int)
  • Priority (int)
  • Title (string)
  • Quality (int)
  • QualityType (int)
  • RecommendedCard (int)
  • ScheduleType (WebScheduleType):
  • Series (bool)
  • StartTime (DateTime)

GetScheduleCount

URL /json/GetScheduleCount Parameters none Returns WebIntResult

  • Result (int)

GetScheduledRecordingsForDate

URL /json/GetScheduledRecordingsForDate Parameters

  • date (DateTime)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebScheduledRecording
  • StartTime (DateTime)
  • EndTime (DateTime)
  • Title (string)
  • ChannelName (string)
  • ChannelId (int)
  • ScheduleId (int)
  • ProgramId (int)

GetScheduledRecordingsForToday

URL /json/GetScheduledRecordingsForToday Parameters

  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebScheduledRecording
  • StartTime (DateTime)
  • EndTime (DateTime)
  • Title (string)
  • ChannelName (string)
  • ChannelId (int)
  • ScheduleId (int)
  • ProgramId (int)

GetSchedules

URL /json/GetSchedules Parameters

  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebScheduleBasic
  • BitRateMode (int)
  • Canceled (DateTime)
  • Directory (string)
  • DoesUseEpisodeManagement (bool)
  • EndTime (DateTime)
  • ChannelId (int)
  • ParentScheduleId (int)
  • Id (int)
  • IsChanged (bool)
  • IsManual (bool)
  • KeepDate (DateTime)
  • KeepMethod (WebScheduleKeepMethod):
  • MaxAirings (int)
  • PostRecordInterval (int)
  • PreRecordInterval (int)
  • Priority (int)
  • Title (string)
  • Quality (int)
  • QualityType (int)
  • RecommendedCard (int)
  • ScheduleType (WebScheduleType):
  • Series (bool)
  • StartTime (DateTime)

GetSchedulesByRange

URL /json/GetSchedulesByRange Parameters

  • start (int)
  • end (int)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebScheduleBasic
  • BitRateMode (int)
  • Canceled (DateTime)
  • Directory (string)
  • DoesUseEpisodeManagement (bool)
  • EndTime (DateTime)
  • ChannelId (int)
  • ParentScheduleId (int)
  • Id (int)
  • IsChanged (bool)
  • IsManual (bool)
  • KeepDate (DateTime)
  • KeepMethod (WebScheduleKeepMethod):
  • MaxAirings (int)
  • PostRecordInterval (int)
  • PreRecordInterval (int)
  • Priority (int)
  • Title (string)
  • Quality (int)
  • QualityType (int)
  • RecommendedCard (int)
  • ScheduleType (WebScheduleType):
  • Series (bool)
  • StartTime (DateTime)

WebScheduleKeepMethod (enumeration)

Values

  • UntilSpaceNeeded: 0
  • UntilWatched: 1
  • TillDate: 2
  • Always: 3

WebScheduleType (enumeration)

Values

  • Once: 0
  • Daily: 1
  • Weekly: 2
  • EveryTimeOnThisChannel: 3
  • EveryTimeOnEveryChannel: 4
  • Weekends: 5
  • WorkingDays: 6
  • WeeklyEveryTimeOnThisChannel: 7

Recording

GetAllRecordingDiskInformation

URL /json/GetAllRecordingDiskInformation Parameters none Returns List of WebDiskSpaceInformation

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

GetRecordingById

URL /json/GetRecordingById Parameters

  • id (int) Returns WebRecordingBasic
  • Description (string)
  • EndTime (DateTime)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • FileName (string)
  • Genre (string)
  • ChannelId (int)
  • Id (int)
  • ScheduleId (int)
  • IsChanged (bool)
  • IsManual (bool)
  • IsRecording (bool)
  • KeepUntil (int)
  • KeepUntilDate (DateTime)
  • SeriesNum (string)
  • ShouldBeDeleted (bool)
  • StartTime (DateTime)
  • StopTime (int)
  • TimesWatched (int)
  • Title (string)
  • ChannelName (string)
  • Type (WebMediaType):

GetRecordingCount

URL /json/GetRecordingCount Parameters none Returns WebIntResult

  • Result (int)

GetRecordingDiskInformationForCard

URL /json/GetRecordingDiskInformationForCard Parameters

  • id (int) Returns WebDiskSpaceInformation
  • Disk (string)
  • Size (float)
  • Available (float)
  • Used (float)
  • PercentageUsed (float)

GetRecordingFileInfo

URL /json/GetRecordingFileInfo Parameters

  • id (int) Returns WebRecordingFileInfo
  • IsLocalFile (bool)
  • Size (long)
  • Name (string)
  • Path (string)
  • LastAccessTime (DateTime)
  • LastModifiedTime (DateTime)
  • Extension (string)
  • IsReadOnly (bool)
  • Exists (bool)
  • OnNetworkDrive (bool)

GetRecordings

URL /json/GetRecordings Parameters

  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebRecordingBasic
  • Description (string)
  • EndTime (DateTime)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • FileName (string)
  • Genre (string)
  • ChannelId (int)
  • Id (int)
  • ScheduleId (int)
  • IsChanged (bool)
  • IsManual (bool)
  • IsRecording (bool)
  • KeepUntil (int)
  • KeepUntilDate (DateTime)
  • SeriesNum (string)
  • ShouldBeDeleted (bool)
  • StartTime (DateTime)
  • StopTime (int)
  • TimesWatched (int)
  • Title (string)
  • ChannelName (string)
  • Type (WebMediaType):

GetRecordingsByRange

URL /json/GetRecordingsByRange Parameters

  • start (int)
  • end (int)
  • sort (nullable WebSortField)
  • order (nullable WebSortOrder) Returns List of WebRecordingBasic
  • Description (string)
  • EndTime (DateTime)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • FileName (string)
  • Genre (string)
  • ChannelId (int)
  • Id (int)
  • ScheduleId (int)
  • IsChanged (bool)
  • IsManual (bool)
  • IsRecording (bool)
  • KeepUntil (int)
  • KeepUntilDate (DateTime)
  • SeriesNum (string)
  • ShouldBeDeleted (bool)
  • StartTime (DateTime)
  • StopTime (int)
  • TimesWatched (int)
  • Title (string)
  • ChannelName (string)
  • Type (WebMediaType):

ReadRecordingFile

URL /json/ReadRecordingFile Parameters

  • id (int) Returns Raw data

StartRecordingManual

URL /json/StartRecordingManual Parameters

  • userName (string)
  • channelId (int)
  • title (string) Returns WebBoolResult
  • Result (bool)

EPG

GetCurrentProgramOnChannel

URL /json/GetCurrentProgramOnChannel Parameters

  • channelId (int) Returns WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetNextProgramOnChannel

URL /json/GetNextProgramOnChannel Parameters

  • channelId (int) Returns WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetNowNextWebProgramBasicForChannel

URL /json/GetNowNextWebProgramBasicForChannel Parameters

  • channelId (int) Returns List of WebProgramBasic
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetNowNextWebProgramDetailedForChannel

URL /json/GetNowNextWebProgramDetailedForChannel Parameters

  • channelId (int) Returns List of WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetProgramBasicById

URL /json/GetProgramBasicById Parameters

  • programId (int) Returns WebProgramBasic
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetProgramDetailedById

URL /json/GetProgramDetailedById Parameters

  • programId (int) Returns WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetProgramsBasicForChannel

URL /json/GetProgramsBasicForChannel Parameters

  • channelId (int)
  • startTime (DateTime)
  • endTime (DateTime) Returns List of WebProgramBasic
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetProgramsBasicForGroup

URL /json/GetProgramsBasicForGroup Parameters

  • groupId (int)
  • startTime (DateTime)
  • endTime (DateTime) Returns List of WebChannelPrograms`1
  • ChannelId (int)
  • Programs (list of WebProgramBasic):
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)

GetProgramsDetailedForChannel

URL /json/GetProgramsDetailedForChannel Parameters

  • channelId (int)
  • startTime (DateTime)
  • endTime (DateTime) Returns List of WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

GetProgramsDetailedForGroup

URL /json/GetProgramsDetailedForGroup Parameters

  • groupId (int)
  • startTime (DateTime)
  • endTime (DateTime) Returns List of WebChannelPrograms`1
  • ChannelId (int)
  • Programs (list of WebProgramDetailed):
    • Classification (string)
    • EpisodeName (string)
    • EpisodeNum (string)
    • EpisodeNumber (string)
    • EpisodePart (string)
    • Genre (string)
    • HasConflict (bool)
    • IsChanged (bool)
    • IsPartialRecordingSeriesPending (bool)
    • IsRecording (bool)
    • IsRecordingManual (bool)
    • IsRecordingOnce (bool)
    • IsRecordingOncePending (bool)
    • IsRecordingSeries (bool)
    • IsRecordingSeriesPending (bool)
    • Notify (bool)
    • OriginalAirDate (DateTime)
    • ParentalRating (int)
    • SeriesNum (string)
    • StarRating (int)
    • Description (string)
    • EndTime (DateTime)
    • ChannelId (int)
    • Id (int)
    • StartTime (DateTime)
    • Title (string)
    • DurationInMinutes (int)
    • IsScheduled (bool)

SearchProgramsBasic

URL /json/SearchProgramsBasic Parameters

  • searchTerm (string) Returns List of WebProgramBasic
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

SearchProgramsBasicByRange

URL /json/SearchProgramsBasicByRange Parameters

  • searchTerm (string)
  • start (int)
  • end (int) Returns List of WebProgramBasic
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

SearchProgramsCount

URL /json/SearchProgramsCount Parameters

  • searchTerm (string) Returns WebIntResult
  • Result (int)

SearchProgramsDetailed

URL /json/SearchProgramsDetailed Parameters

  • searchTerm (string) Returns List of WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

SearchProgramsDetailedByRange

URL /json/SearchProgramsDetailedByRange Parameters

  • searchTerm (string)
  • start (int)
  • end (int) Returns List of WebProgramDetailed
  • Classification (string)
  • EpisodeName (string)
  • EpisodeNum (string)
  • EpisodeNumber (string)
  • EpisodePart (string)
  • Genre (string)
  • HasConflict (bool)
  • IsChanged (bool)
  • IsPartialRecordingSeriesPending (bool)
  • IsRecording (bool)
  • IsRecordingManual (bool)
  • IsRecordingOnce (bool)
  • IsRecordingOncePending (bool)
  • IsRecordingSeries (bool)
  • IsRecordingSeriesPending (bool)
  • Notify (bool)
  • OriginalAirDate (DateTime)
  • ParentalRating (int)
  • SeriesNum (string)
  • StarRating (int)
  • Description (string)
  • EndTime (DateTime)
  • ChannelId (int)
  • Id (int)
  • StartTime (DateTime)
  • Title (string)
  • DurationInMinutes (int)
  • IsScheduled (bool)

   

 

This page has no comments.