GetProgramGuide (MythXML)

From MythTV Official Wiki
Jump to: navigation, search

Description

Pull guide data within the given parameters. Provides maximum of 1000 programs at a time.

Inputs

  • StartTime - start of block in CCYY-MM-DDTHH:MM format
  • EndTime - end of block
  • StartChanId - (optional) start of block
  • NumOfChannels - (optional) defaults to 1, use -1 for all
  • Details - (optional) boolean for verbosity, defaults to False

Success

With Details=0:

<?xml version="1.0" encoding="utf-8"?>
<GetProgramGuideResponse>
    <StartTime>2010-09-08T00:00</StartTime>
    <EndTime>2010-09-08T02:00</EndTime>
    <StartChanId>2059</StartChanId>
    <EndChanId>2059</EndChanId>
    <NumOfChannels>1</NumOfChannels>
    <Details>0</Details>
    <Count>2</Count>
    <AsOf>2010-09-08T00:51:05</AsOf>
    <Version>0.23.20100830-2</Version>
    <ProtoVer>59</ProtoVer>
    <ProgramGuide>
        <Channels>
            <Channel channelName="USA Network" chanId="2059" chanNum="59" callSign="USA">
                <Program title="Psych" subTitle="Shawn 2.0" category="Crime" catType="series" repeat="0" endTime="2010-09-08T00:00:00" startTime="2010-09-07T23:00:00"/>
                <Program title="White Collar" subTitle="Point Blank" category="Crime drama" catType="series" repeat="0" endTime="2010-09-08T01:00:00" startTime="2010-09-08T00:00:00">
                    <Recording recPriority="0" recStatus="3" recStartTs="2010-09-08T00:00:00" recEndTs="2010-09-08T01:00:00"/>
                </Program>
            </Channel>
        </Channels>
    </ProgramGuide>
</GetProgramGuideResponse>

With Details=1:

            <Channel inputId="0" chanFilters="" commFree="0" channelName="USA Network" sourceId="0" chanId="2059" chanNum="59" callSign="USA">
                <Program title="White Collar" subTitle="Point Blank" programFlags="0" category="Crime drama" fileSize="0" seriesId="EP01177578" hostname="" catType="series" programId="EP011775780023" repeat="0" stars="0" endTime="2010-09-08T01:00:00" airdate="2010-09-07" startTime="2010-09-08T00:00:00" lastModified="2010-09-08T00:00:00">Neal orchestrates an elaborate con to bring himself face to face with Kate's murderer.
                    <Recording recPriority="0" playGroup="Default" recStatus="3" recStartTs="2010-09-08T00:00:00" recGroup="Default" dupMethod="6" recType="3" encoderId="0" recProfile="Default" recEndTs="2010-09-08T01:00:00" recordId="490" dupInType="15"/>
                </Program>
            </Channel>

Failure