Schedules: Digiguide.tv API Documentation

Schedules

Channel Schedules

Use this API to obtain a list of channel schedule events for the given channel and date range.

End Point	http://api.digiguide.tv/1.2/tv/schedules/
Supported Responses	JSON
Supported Methods	GET
URI Scheme	Either HTTP or HTTPS requests are supported.
User Authentication	Optional If no authenticated user then only schedules for the current day are returned. If the user is not subscribed to any Digiguide services then the synopsis, qualifiers, episodeTitle, seasonNumber, episodeNumber, specialEpisode and image properties are not returned.

Required Parameters

appid=<yourappid>	Your unique and secret Application ID
channel=<unsigned integer>	Valid channel ID as returned from the "Channels" API or "Channels" property of "User" object. Multiple "channel" parameters can be requested.
from=<utcjulian>	Valid UTC Julian time as represented by number of milliseconds since the Epoch. This value is the standard value returned by the JavaScript "getTime()" method of Date object.
to=<utcjulian>	Valid UTC Julian time as represented by number of milliseconds since the Epoch. This value is the standard value returned by the JavaScript "getTime()" method of Date object.

Successful Response

This API will return the start and end time of the programmes being returned in UTC (Julian seconds) format and a "channels" property containing an array of channel schedules for each channel requested. Within each 'channel' will be a "schedules" property containing an array of schedules for that channel.

{
  "success": true,
  "startUTC": 1305176443,
  "endUTC": 1305262843,
  "channels": [
    {
      "name": "BBC 1 HD",
      "epg": "143",
      "id": 51035,
      "schedules": [
        {
          "name": "Breakfast",
          "id": 14167,
          "categoryID": 18,
          "startUTC": 1305176400,
          "endUTC": 1305188100,
          "episodeTitle": "",
          "seriesNum": 0,
          "episodeNum": 0,
          "synopsis": "",
          "qualifiers": "Subtitles, High Definition",
          "progID": 37691
        },
        {
          "name": "Missing 2011",
          "id": 14168,
          "categoryID": 5,
          "startUTC": 1305188100,
          "endUTC": 1305190800,
          "episodeTitle": "",
          "seriesNum": 0,
          "episodeNum": 0,
          "synopsis": "",
          "qualifiers": "Subtitles ",
          "progID": 799868
        },
        {
          "name": "Homes Under the Hammer",
          "id": 14169,
          "categoryID": 22,
          "startUTC": 1305190800,
          "endUTC": 1305194400,
          "episodeTitle": "",
          "synopsis": "",
          "progID": 209479
        },
        {
          "name": "Don&#39;t Get Done, Get Dom",
          "id": 14170,
          "categoryID": 22,
          "startUTC": 1305194400,
          "endUTC": 1305197100,
          "episodeTitle": "",
          "seriesNum": 0,
          "episodeNum": 0,
          "synopsis": "",
          "qualifiers": "Subtitles, High Definition",
          "progID": 564367
        }
      ]
    }
  ]
}

Schedule Event

Use this API to obtain information on a specific schedule event.

End Point	http://api.digiguide.tv/1.2/tv/scheduleevent/
Supported Responses	JSON
Supported Methods	GET
URI Scheme	Either HTTP or HTTPS requests are supported.
User Authentication	Optional If no authenticated user or the user is not subscribed to any Digiguide services then the synopsis, qualifiers, episodeTitle, seasonNumber, episodeNumber, specialEpisode, directors and cast properties are not returned.

Required Parameters

appid=<yourappid>	Your unique and secret Application ID
Then one of the following two set of parameters: 1. The following option will return a schedule event object for a given specific broadcast schedule event ID.
id=<unsigned int>	Valid schedule ID as returned by the "Schedules" or "Search" APIs.

2. The following option will return a schedule event object for a given specific broadcast schedule event on a given channel at a specific date/time.
channel=<unsigned int>	Valid channel ID as returned by "Schedules" or "Search" APIs.
datetimeutc=<utcjulian>	Valid schedule broadcast time as returned by "Schedules" or "Search" APIs. UTC Julian time is represented by number of milli-seconds since the Epoch as returned by the JavaScript "getTime()" method of Date object.

Successful Response

{
  "success" : true,
  "responseRestricted" : false,
  "progID" : 874181,
  "name" : "Wrath of the Titans",
  "categoryID" : 2,
  "category" : "Film",
  "channelID" : 50643,
  "startUTC" : 1375297200,
  "endUTC" : 1375303500,
  "directors" : [
    {
      "id" : 112710,
      "name" : "Jonathan Liebesman"
    }
  ],
  "cast" : [
    {
      "id" : 35082,
      "name" : "Sam Worthington",
      "role" : "Perseus"
    },
    {
      "id" : 880,
      "name" : "Liam Neeson",
      "role" : "Zeus"
    },
    {
      "id" : 70,
      "name" : "Ralph Fiennes",
      "role" : "Hades"
    },
    {
      "id" : 241465,
      "name" : "Édgar Ramírez",
      "role" : "Ares"
    },
    {
      "id" : 184872,
      "name" : "Toby Kebbell",
      "role" : "Agenor"
    },
    {
      "id" : 26333,
      "name" : "Rosamund Pike",
      "role" : "Andromeda"
    },
    {
      "id" : 7888,
      "name" : "Bill Nighy",
      "role" : "Hephaestus"
    },
    {
      "id" : 7842,
      "name" : "Danny Huston",
      "role" : "Poseidon"
    },
    {
      "id" : 33370,
      "name" : "John Bell",
      "role" : "Helius"
    },
    {
      "id" : 294530,
      "name" : "Lily James",
      "role" : "Korrina"
    },
    {
      "id" : 311335,
      "name" : "Alejandro Naranjo",
      "role" : "Mantius"
    },
    {
      "id" : 311336,
      "name" : "Freddy Drabble",
      "role" : "Apollo"
    },
    {
      "id" : 311337,
      "name" : "Kathryn Carpenter",
      "role" : "Athena"
    },
    {
      "id" : 309278,
      "name" : "Matt Milne",
      "role" : "Elite Guard No. 1"
    },
    {
      "id" : 37183,
      "name" : "Kett Turton",
      "role" : "Elite Guard No. 2"
    }
  ],
  "writers" : [
    {
      "id" : 311338,
      "name" : "Dan Mazeau"
    },
    {
      "id" : 30913,
      "name" : "David Johnson"
    }
  ],
  producers: [
    {
      "id" : 326040,
      "name" : "Basil Iwanyk",
      "role" : "Producer"
    },
    {
      "id" : 326041,
      "name" : "Polly Johnsen",
      "role" : "Producer"
    },
    {
      "id" : 326042,
      "name" : "Kevin De La Noy",
      "role" : "Executive Producer"
    },
    {
      "id" : 326043,
      "name" : "Jon Jashni",
      "role" : "Executive Producer"
    },
    {
      "id" : 118569,
      "name" : "Louis Leterrier",
      "role" : "Executive Producer"
    },
    {
      "id" : 326044,
      "name" : "Callum McDougall",
      "role" : "Executive Producer"
    },
    {
      "id" : 326045,
      "name" : "Thomas Tull",
      "role" : "Executive Producer"
    },
    {
      "id" : 326046,
      "name" : "Karl McMillan",
      "role" : "Associate Producer"
    }
  ],
  "presenters" : [],
  "narrators" : [],
  "guestCast" : [],
  "synopsis" : "Sam Worthington is again thrown into action as demi-god Perseus, charged with saving Ancient Greece from the monstrous Kronos. Action with Liam Neeson and Ralph Fiennes.",
  "qualifiers" : "Widescreen, High Definition, Subtitles, Dolby Digital 5.1",
  "imageMain" :
  {
    "url" : "http://i.digiguide.tv/up/1307/1374865200-874181-Wrathoft-13740598640.jpg",
    "height" : 196,
    "width" : 350
  },
  "imageThumb" :
  {
    "url" : "http://i.digiguide.tv/up/1307/tn-1374865200-874181-Wrathoft-13740598640.jpg",
    "height" : 150,
    "width" : 150
  },
  "imageTinyThumb" :
  {
    "url" : "http://i.digiguide.tv/up/1307/ttn-1374865200-874181-Wrathoft-13740598640.jpg",
    "height" : 75,
    "width" : 75
  }
}