getLivetvSeriestimers

Gets live tv series timers

Requires authentication as user

Request
get /LiveTv/SeriesTimers
Parameters
Name In Type Default Notes
SortBy query

Optional. Sort by SortName or Priority
SortOrder query

Optional. Sort in Ascending or Descending order
StartIndex query

Optional. The record index to start at. All items with a lower index will be dropped from the results.
Limit query

Optional. The maximum number of records to return
Responses
Status Code Type Description Samples
200 SeriesTimerInfoDto

Operation successful. Returning a QueryResult object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

SeriesTimerInfoDto

QueryResult_LiveTv.SeriesTimerInfoDto
Name Type Notes
Items SeriesTimerInfoDto[]
TotalRecordCount integer (int32)

SeriesTimerInfoDto

Name Type Notes
RecordAnyTime boolean

A value indicating whether [record any time].
SkipEpisodesInLibrary boolean
MatchExistingItemsWithAnyLibrary boolean
RecordAnyChannel boolean

A value indicating whether [record any channel].
KeepUpTo integer (int32)
MaxRecordingSeconds integer (int32)
RecordNewOnly boolean

A value indicating whether [record new only].
ChannelIds array
Days DayOfWeek[]

The days.
ImageTags object

The image tags.
ParentThumbItemId string

The parent thumb item id.
ParentThumbImageTag string

The parent thumb image tag.
ParentPrimaryImageItemId string

The parent primary image item identifier.
ParentPrimaryImageTag string

The parent primary image tag.
SeriesId string
Keywords KeywordInfo[]
TimerType TimerType
Id string

Id of the recording.
Type string
ServerId string

The server identifier.
ChannelId string

ChannelId of the recording.
ChannelName string

ChannelName of the recording.
ChannelNumber string
ChannelPrimaryImageTag string
ProgramId string

The program identifier.
Name string

Name of the recording.
Overview string

Description of the recording.
ParentFolderId string
StartDate string (date-time)

The start date of the recording, in UTC.
EndDate string (date-time)

The end date of the recording, in UTC.
Priority integer (int32)

The priority.
PrePaddingSeconds integer (int32)

The pre padding seconds.
PostPaddingSeconds integer (int32)

The post padding seconds.
IsPrePaddingRequired boolean

A value indicating whether this instance is pre padding required.
ParentBackdropItemId string

If the item does not have any backdrops, this will hold the Id of the Parent that has one.
ParentBackdropImageTags array

The parent backdrop image tags.
IsPostPaddingRequired boolean

A value indicating whether this instance is post padding required.
KeepUntil KeepUntil

DayOfWeek

System.DayOfWeek

KeywordInfo

Name Type Notes
KeywordType KeywordType
Keyword string

KeywordType

Enum Values
  • Name
  • EpisodeTitle
  • Overview
  • Actor
  • Director

TimerType

Enum Values
  • Program
  • DateTime
  • Keyword

KeepUntil

Enum Values
  • UntilDeleted
  • UntilSpaceNeeded
  • UntilWatched
  • UntilDate