Difference between revisions of "Guide Service"

From MythTV Official Wiki
Jump to: navigation, search
(Intro)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 +
=What is this?=
 +
See [[Services API]]
 +
 +
 
=Guide Service API List=
 
=Guide Service API List=
  
Line 214: Line 218:
  
 
The return for this command is a ''binary file'' which will be interpreted by your browser and downloaded or displayed as appropriate.
 
The return for this command is a ''binary file'' which will be interpreted by your browser and downloaded or displayed as appropriate.
 +
 +
[[Category:Services_API]]

Latest revision as of 11:47, 19 July 2013

What is this?

See Services API


Guide Service API List

API Command POST Required? Description
GetProgramGuide No The the guide information for a particular time period and set of channels
GetProgramDetails No Get the detailed guide information for a particular program starting at a particular time on a particular channel.
GetChannelIcon No Get the icon file for a given channel.

Guide APIs

GetProgramGuide

The GetProgramGuide API takes the following arguments:

StartTime (Required)
Parameter Type: String
The start time for the guide. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.
EndTime (Required)
Parameter Type: String
The end time for the guide. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.
StartChanId (Optional)
Parameter Type: Integer
The starting channel id for the guide information.
NumChannels (Optional)
Parameter Type: Integer
The number of channels to return in the guide information.
Details (Optional)
Parameter Type: Boolean
Return extensive details about the program data.

Example Query:

http://BackendServerIP:6544/Guide/GetProgramGuide?StartTime=2011-10-03T19:00:00&EndTime=2011-10-03T20:00:00&StartChanId=2066&NumChannels=10

Example Return:

<?xml version="1.0" encoding="UTF-8"?>
<ProgramGuide version="1.0" serializerVersion="1.1">
    <StartTime>2011-10-03T19:00:00</StartTime>
    <EndTime>2011-10-03T20:00:00</EndTime>
    <StartChanId>2066</StartChanId>
    <EndChanId>2066</EndChanId>
    <NumOfChannels>1</NumOfChannels>
    <Details>false</Details>
    <Count>3</Count>
    <AsOf>2011-10-02T17:01:34</AsOf>
    <Version>0.25.20110928-1</Version>
    <ProtoVer>69</ProtoVer>
    <Channels>
        <Channel>
            <ChanId>2066</ChanId>
            <ChanNum>185</ChanNum>
            <CallSign>HLMRK</CallSign>
            <IconURL></IconURL>
            <ChannelName>Hallmark Channel (Pacific)</ChannelName>
            <Programs>
                <Program>
                    <StartTime>2011-10-03T19:00:00</StartTime>
                    <EndTime>2011-10-03T20:00:00</EndTime>
                    <Title>Little House on the Prairie</Title>
                    <SubTitle>Make a Joyful Noise</SubTitle>
                    <Category>Drama</Category>
                    <CatType>series</CatType>
                    <Repeat>true</Repeat>
                    <Recording>
                        <Status>0</Status>
                        <Priority>0</Priority>
                        <StartTs></StartTs>
                        <EndTs></EndTs>
                        <RecordId>0</RecordId>
                        <RecGroup></RecGroup>
                        <PlayGroup></PlayGroup>
                        <RecType>0</RecType>
                        <DupInType>1</DupInType>
                        <DupMethod>1</DupMethod>
                        <EncoderId>0</EncoderId>
                        <Profile></Profile>
                    </Recording>
                </Program>
                 ...
            </Programs>
        </Channel>
    </Channels>
</ProgramGuide>

GetProgramDetails

The GetProgramDetails API takes the following arguments:

ChanId (Required)
Parameter Type: Integer
The database channel id for the guide item.
StartTime (Required)
Parameter Type: String
The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.

Example Query:

http://BackendServerIP:6544/Guide/GetProgramDetails?StartTime=2011-10-03T19:00:00&ChanId=2066

Example Return:

<?xml version="1.0" encoding="UTF-8"?>
<Program version="1.1" serializerVersion="1.1">
    <StartTime>2011-10-03T19:00:00</StartTime>
    <EndTime>2011-10-03T20:00:00</EndTime>
    <Title>Little House on the Prairie</Title>
    <SubTitle>Make a Joyful Noise</SubTitle>
    <Category>Drama</Category>
    <CatType>series</CatType>
    <Repeat>true</Repeat>
    <SeriesId>EP00002633</SeriesId>
    <ProgramId>EP000026330155</ProgramId>
    <Stars>0</Stars>
    <FileSize>0</FileSize>
    <LastModified>2011-10-03T19:00:00</LastModified>
    <ProgramFlags>4096</ProgramFlags>
    <Hostname></Hostname>
    <Airdate>1981-01-26</Airdate>
     Joe Kagan works up the courage to court Hester Sue, and learns she plans to marry an undertaker (Mel Stewart).
    <Inetref></Inetref>
    <Season>0</Season>
    <Episode>0</Episode>
    <Channel>
        <ChanId>2066</ChanId>
        <ChanNum>185</ChanNum>
        <CallSign>HLMRK</CallSign>
        <IconURL></IconURL>
        <ChannelName>Hallmark Channel (Pacific)</ChannelName>
        <MplexId>0</MplexId>
        <TransportId>0</TransportId>
        <ServiceId>0</ServiceId>
        <NetworkId>0</NetworkId>
        <ATSCMajorChan>0</ATSCMajorChan>
        <ATSCMinorChan>0</ATSCMinorChan>
        <Format></Format>
        <Modulation></Modulation>
        <Frequency>0</Frequency>
        <FrequencyId></FrequencyId>
        <FrequencyTable></FrequencyTable>
        <FineTune>0</FineTune>
        <SIStandard></SIStandard>
        <ChanFilters></ChanFilters>
        <SourceId>0</SourceId>
        <InputId>0</InputId>
        <CommFree>0</CommFree>
        <UseEIT>false</UseEIT>
        <Visible>false</Visible>
        <XMLTVID></XMLTVID>
        <DefaultAuth></DefaultAuth>
        <Programs/>
    </Channel>
    <Recording>
        <Status>0</Status>
        <Priority>0</Priority>
        <StartTs></StartTs>
        <EndTs></EndTs>
        <RecordId>0</RecordId>
        <RecGroup></RecGroup>
        <PlayGroup></PlayGroup>
        <RecType>0</RecType>
        <DupInType>1</DupInType>
        <DupMethod>1</DupMethod>
        <EncoderId>0</EncoderId>
        <Profile></Profile>
    </Recording>
</Program>

GetChannelIcon

The GetChannelIcon API takes the following arguments:

ChanId (Required)
Parameter Type: Integer
The database channel id for the icon you desire.
Width (Optional)
Parameter Type: Integer
The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
Height (Optional)
Parameter Type: Integer
The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.

Example Query:

http://BackendServerIP:6544/Guide/GetChannelIcon?ChanId=3736

Example Return:

The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.