Media Browser Integration

[UncleJohnsBand]

Maybe this helps....

The epgEventJSONObject can contain up to 4 segments.

epgEvent - This is the event itself. It has two boolean attributes HasSchedule an ScheduleIsRecurring that tell you if there is a schd and/or recurring segment. If the HasSchedule element is false there will be no schedule segment present. Likewise if the ScheduleIsRecurring element is false there will be no recur segment.

schd - This contains the info about the how the epgEvent is scheduled and the various attributes about the schedule and the status of that schedule (i.e. pending, in-progress, etc)

recurr - This segment contains the info about the recurring schedule entry that continually generates schedules for a targeted epgEvent

rtn - This segment contains any error info in regards to the epgEvent if the Error element is True.

Code:

"epgEventJSONObject":{
               "epgEvent":{
                  "OID":6532962,
                  "UniqueId":"EP007537960210",
                  "ChannelOid":7166,
                  "StartTime":"2013-12-17T01:00:00Z",
                  "EndTime":"2013-12-17T01:30:00Z",
                  "Title":"How I Met Your Mother",
                  "Subtitle":"Bass Player Wanted",
                  "Desc":"A man at the wedding intentionally stirs up trouble; Marshall finally arrives at the Farhampton Inn.",
                  "Rating":"TV-14",
                  "Quality":"HDTV",
                  "StarRating":"",
                  "Aspect":"",
                  "Audio":"stereo",
                  "OriginalAirdate":"2013-12-16T00:00:00",
                  "FanArt":"public/download.aspx?rid=_wEC9f___w8*&path=_wEFOkQ6XFVzZXJzXFB1YmxpY1xOUFZSXE1lZGlhXFNob3dzXEhvdyBJIE1ldCBZb3VyIE1vdGhlci5qcGc*&mode=1",
                  "Genres":[
                     "Sitcom"
                  ],
                  "FirstRun":true,
                  "HasSchedule":true,
                  "ScheduleIsRecurring":true
               },
               "schd":{
                  "OID":19208,
                  "ChannelOid":7166,
                  "Priority":0,
                  "Name":"How I Met Your Mother",
                  "Quality":"Best",
                  "Type":"Multiple",
                  "Day":"Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday",
                  "StartTime":"2013-12-17T01:00:00Z",
                  "EndTime":"2013-12-17T01:30:00Z",
                  "Status":"Pending",
                  "FailureReason":"",
                  "PrePadding":"0",
                  "PostPadding":"0",
                  "MaxRecordings":"0",
                  "DownloadURL":"",
                  "RecordingFileName":"",
                  "PlaybackPosition":0,
                  "PlaybackDuration":0,
                  "LastWatched":"0001-01-01T00:00:00",
                  "OnlyNew":false,
                  "Blue":false,
                  "Green":false,
                  "Red":false,
                  "Yellow":false,
                  "FanArt":"public/download.aspx?rid=_wEC9f___w8*&path=_wEFOkQ6XFVzZXJzXFB1YmxpY1xOUFZSXE1lZGlhXFNob3dzXEhvdyBJIE1ldCBZb3VyIE1vdGhlci5qcGc*&mode=1"
               },
               "recurr":{
                  "Type":"Recurring",
                  "OID":143,
                  "RecurringName":"How I Met Your Mother",
                  "PeriodDescription":"All New Episodes",
                  "EPGTitle":"How I Met Your Mother",
                  "ChannelOid":7166,
                  "StartTime":"2012-01-10T01:00:00Z",
                  "EndTime":"2012-01-10T01:30:00Z",
                  "RecordingDirectoryID":null,
                  "Priority":0,
                  "Quality":"Best",
                  "PrePadding":"0",
                  "PostPadding":"0",
                  "MaxRecordings":"0",
                  "allChannels":false,
                  "OnlyNew":true,
                  "Day":"Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday",
                  "AdvancedRules":null,
                  "RulesXmlDoc":{
                     "Rules":{
                        "EPGTitle":"How I Met Your Mother",
                        "ChannelOID":"7166",
                        "ChannelName":"72.1624-WHPDT",
                        "StartTime":"2012-01-10T01:00:00.0000000Z",
                        "EndTime":"2012-01-10T01:30:00.0000000Z",
                        "PrePadding":"0",
                        "PostPadding":"0",
                        "Quality":"3",
                        "Keep":"0",
                        "OnlyNewEpisodes":"true"
                     }
                  }
               },
               "rtn":{
                  "Error":false,
                  "Message":""
               }
            }
         },

[UncleJohnsBand]

truthfully, from the client perspective i think that's pretty trivial and doesn't really matter. A lot of our list endpoints return objects that use this:

public class QueryResult<T>
{
/// <summary>
/// Gets or sets the items.
/// </summary>
/// <value>The items.</value>
public T[] Items { get; set; }

/// <summary>
/// The total number of records available
/// </summary>
/// <value>The total record count.</value>
public int TotalRecordCount { get; set; }

/// <summary>
/// Initializes a new instance of the <see cref="ItemsResult" /> class.
/// </summary>
public QueryResult()
{
Items = new T[] { };
}
}

Some services subclass it to add additional info. But whether you call the result set Items, Results, or something particular to the method, i don't think it really matters.

The only thing I would suggest on the topic of return data is to use natural http response codes as much as you possibly can. In other words, remove the error properties and just have the server throw an error. As it is now clients have to both handle errors and check the error property.

Thanks for the feedback. I can look into setting a different response code if an error is found....

[lukemb3]

I just uploaded it as is

https://www.dropbox.com/s/8tehpwjp03vzxal/npvr.db3

[lukemb3]

Thanks for the feedback. I can look into setting a different response code if an error is found....

Thanks, yea we use response codes in our api and it's worked out well. the most common ones are 500 for an internal server error, 404 if the client asks for something that doesn't exist, 401/403 for authentication-related issues, and 400 for bad input arguments. service stack actually does it for us, but even before we started using it I knew it was something that i wanted.

[mvallevand]

I just uploaded it as is

https://www.dropbox.com/s/8tehpwjp03vzxal/npvr.db3

It looks like dummy schd records aren't being created for manual recordings that don't have epg_event xml

Martin

[lukemb3]

It looks like dummy schd records aren't being created for manual recordings that don't have epg_event xml

Martin

yea i was playing around and setup some manual recordings so that might be those

[lukemb3]

is it possible to add a channel id filter for GuideService/Listing ?

[mvallevand]

is it possible to add a channel id filter for GuideService/Listing ?

sub's xml does provide the listing by selected channel. I prefer channel groups for filtering myself.

Martin

[UncleJohnsBand]

Thanks, yea we use response codes in our api and it's worked out well. the most common ones are 500 for an internal server error, 404 if the client asks for something that doesn't exist, 401/403 for authentication-related issues, and 400 for bad input arguments. service stack actually does it for us, but even before we started using it I knew it was something that i wanted.

Thanks.

[UncleJohnsBand]

is it possible to add a channel id filter for GuideService/Listing ?

sub's xml does provide the listing by selected channel. I prefer channel groups for filtering myself.

Martin

I can add a channel query parameter....