shows

Shows (shows)

Shows are represented as objects with the following fields (NOTE: All fields are read-only).

Name

Type

Comment

id

integer

This show ID

series_id

integer

The unique IceTV series ID (See Series)

episode_id

integer

The unique IceTV episode ID

start

string

Start time of the show in ISO 8601 format in UTC

stop

string

End time of the show in ISO 8601 format in UTC

channel_id

integer

IceTV channel ID that the show is airing on (See Channel)

part_of_series

string

"Yes" is this show should be available for Series Recording (e.g. episodic shows or non-episodic shows like news bulletins), "No" if this is a once-off showing (e.g. Movie)

deleted_record

integer

Flag to say is this show has been deleted from the programme schedule. If present and set to "1" then any locally cached information for this show ID can be safely deleted

title

string

The title of the show

sub-title

string

The episode name for this show, if applicable

desc

string

The extended programme description of this show

credits

array

(See Credits)

date

integer

Four digit year of production for the series this show belongs to

category

array (JSON) elements (XML)

(See Category)

language

string

Language the show audio is in

country

string

Country the show originated from

episode-num

string

Season and episode number for this show if available (e.g. "S01E01" represents the first episode of the first season)

video

array

(See Video)

previously-shown

element

If present then this show has been broadcast on TV before

subtitles

array

(See Subtitles)

rating

array

(See Rating)

star-rating

array

(See Star Rating)

image

array

(See Image)

series_recording_id

integer

Series Recording's ID. Present if this show is part of a series recording

keyword_id

integer

Keyword's ID. Present if this show is part of a keyword

Category

Field

Type

Description

name

string

Category (Genre) name

eit

hexadecimal

Value as closest match to Table 28 in ETSI EN 300 468

Credits

Field

Type

Description

JSON

actors

XML

actor

JSON

Array of name objects

XML

string

Name of an actor featured in the programme

director

string

Name of the director for the programme

Video

Field

Type

Description

aspect

string

16:9

Widescreen

4:3

Pre-widescreen "standard" format

Subtitles

Field

Type

Description

type

string

Type of subtitle

Teletex

Not used

onscreen

Subtitles appear overlayed over programme video, also called "Closed Captions"

language

string

Language of subtitle

Rating

Field

Type

Description

value

string

The textual parental rating for the series (e.g. PG, M, MA)

Star Rating

Field

Type

Description

value

integer

Star rating of this show

Image

Field

Type

Description

src

string

URL source of the image

width

integer

Widget of the image in pixels

height

integer

Height of the image in pixels

The shows "Node" covers all show information including EPG and recordings.

URL

Description

shows

Covers the most common usage, this URL returns "EPG" and "Timers"

shows/timers

Allows management of timers

Get all shows

URL

https://api.icetv.com.au/shows

Method

GET

Query String

hide_channels=1

Exclude channel information from the response

hide_dvb_triplets=1

Exclude DVB triplet information from the channel objects in the response

hide_timers=1

Exclude timer records from the response

hide_shows=1

Exclude show records from the response

region_id=#

Get all shows for a given region

channel_id=#

Get all shows for a given channel

last_update_time=#

0

Full EPG request

> 0

Incremental EPG request

"last_update_time" included in response only if this query string is included in the request, if you are using incremental updates the first request must include "last_update_time=0" then further requests will send "last_update_time=#" where # is the last_update_time returned by the IceTV server in the most recent request

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Request
GET https://api.icetv.com.au/shows?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of response
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE shows SYSTEM "http://iceguide.icetv.com.au/iceguide/shows.dtd">
<shows>
<channel id="1">
<display-name lang="en">SBS ONE</display-name>
<dvb original_network_id="12802" transport_stream_id="768" service_id="769"/>
<dvb original_network_id="12802" transport_stream_id="768" service_id="772"/>
<lcn>3,33,34</lcn>
<icon src="http://images.icetv.com.au/channels/sbs-one.png" width="0" height="0"/>
<url/>
</channel>
 
 
--- truncated ---
 
<show id="103741164" series_id="8194" episode_id="138693" start="2012-05-28T12:30:00+00:00" stop="2012-05-28T14:45:00+00:00" channel_id="104">
<title lang="en">Motor Sport: Formula One Grand Prix</title>
<sub-title lang="en">2012 - Round 6 - Monaco Grand Prix - Main Race</sub-title>
<desc lang="en">The main Race of the Monaco Grand Prix which takes place on the twisting, winding roads (which took the life of Princess Grace) of the Circuit de Monaco at Monte Carlo. With six wins, Ayrton Senna holds the record for the most wins of this event. In 2011 Sebastian Vettel took it in his Red Bull-Renault. (Australia, English)</desc>
<category lang="en">Sport</category>
<category lang="en">Motor Sport</category>
<language lang="en">English</language>
<country>Australia</country>
<video>
<aspect>16:9</aspect>
<quality>HDTV</quality>
</video>
<previously-shown/>
<subtitles type="teletext"/>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<image src=""/>
</show>
 
 
--- truncated ---
 
 
<timer id="15784000841381576705" name="The Simpsons" device_id="23" channel_id="1700" show_id="103458207" start_time="2012-05-09T09:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by
API" series_recording_id="51" keyword_id="0"/>
 
--- truncated ---
 
 
</shows>

JSON - Structure of the response

Name

Type

Description

Comment

header

object

 

 

last_update_time

string field

unix UTC timestamp

Only present when using the query string 'last_update_time=#'

channels

array of channels

Contains all the channels from all the networks unless filtered

Can be filtered with the query string 'channel_id=#'

shows

array of shows

Contains all the shows to be aired in the next 7 days

Can be hidden with query string 'hide_shows=1'

Can be filtered per channel with query string 'channel_id=#'

Shows that are part of series recording or keyword (view or recording) will have a field "keyword_id" and/or 'series_recording_id'

timers

array of timers

Contains all the timers of the account

Can be hidden with query string 'hide_timers=1'

JSON - Example of response
{
header: {
page: "1"
rows_per_page: "0"
total_rows: "0"
},
"channels": [
{
"dvb_triplets": [
{
"frequency": "",
"lcn": "",
"original_network_id": "12802",
"service_id": "769",
"transport_stream_id": "768"
},
{
"frequency": "",
"lcn": "",
"original_network_id": "12802",
"service_id": "772",
"transport_stream_id": "768"
}
],
"icon": {
"height": "0",
"src": "http://images.icetv.com.au/channels/sbs-one.png",
"width": "0"
},
"id": "1",
"lcn": "3,33,34",
"name": "SBS ONE",
"url": ""
}
 
--- truncated ---
 
],
"shows": [
{
"category": [
{
"name": "Action"
},
{
"name": "Fantasy"
},
{
"name": "Movie"
}
],
"channel_id": "2393",
"country": "United States",
"credits": {
"actors": [
{
"name": "Ron Perlman"
},
{
"name": "Rupert Evans"
}
],
"director": "Guillermo del Toro"
},
"date": "2004",
"desc": "Given Hellboy's antecedents, he could have been forgiven for choosing the dark side. After all, he was spawned from Nazi ambition and desperation as they tried any avenue to resuscitate their fortunes - even Satanism. But amazingly, Hellboy has turned out to be a good demon, if that isn't a contradiction in terms. (United States, English)",
"episode-num": "",
"episode_id": "0",
"id": "103759297",
"language": "English",
"previously-shown": {
"channel_id": "",
"start": ""
},
"rating": "M",
"series_id": "14269",
"star-rating": "",
"start": "2012-05-29T11:40:00+00:00",
"stop": "2012-05-29T14:10:00+00:00",
"subtitle": "",
"subtitles": {
"onscreen": "English",
"teletex": "YES"
},
"title": "Movie: Hellboy",
"video": {
"aspect": "16:9",
"colour": "NO",
"quality": "HDTV"
}
}
 
--- truncated ----
 
],
"timers": [
{
"action": "record",
"channel_id": "1700",
"device_id": "23",
"duration_minutes": "30",
"id": "15784000841381576705",
"keyword_id": "0",
"message": "Scheduled to record by API",
"name": "The Simpsons",
"series_recording_id": "51",
"show_id": "103458207",
"start_time": "2012-05-09T09:30:00+00:00",
"state": "waiting"
}
 
--- truncated ---
 
]
}

Get a specific show

URL

https://api.icetv.com.au/shows/#

Method

GET

Query String

hide_channels=1

Exclude channel information from the response

hide_dvb_triplets=1

Exclude DVB triplet information from the response

hide_timers=1

Exclude timer records from the response

hide_shows=1

Exclude show records from the response

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Request
GET https://api.icetv.com.au/shows/103759297?api_key=API_KEY&application_verision=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of response
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE shows SYSTEM "http://iceguide.icetv.com.au/iceguide/shows.dtd">
<shows>
<channel id="2393">
<display-name lang="en">GO!</display-name>
<dvb original_network_id="4114" transport_stream_id="1056" service_id="1059"/>
<dvb original_network_id="12915" transport_stream_id="12925" service_id="2"/>
<dvb original_network_id="12915" transport_stream_id="12924" service_id="2"/>
<dvb original_network_id="12915" transport_stream_id="12923" service_id="2"/>
<dvb original_network_id="4117" transport_stream_id="12927" service_id="2"/>
<lcn>99</lcn>
<icon src="http://images.icetv.com.au/channels/go.png" width="0" height="0"/>
<url/>
</channel>
<show id="103759297" series_id="14269" episode_id="0" start="2012-05-29T11:40:00+00:00" stop="2012-05-29T14:10:00+00:00" channel_id="2393">
<title lang="en">Movie: Hellboy</title>
<desc lang="en">Given Hellboy's antecedents, he could have been forgiven for choosing the dark side. After all, he was spawned from Nazi ambition and desperation as they tried any avenue to resuscitate their fortunes - even Satanism. But amazingly, Hellboy has turned out to be a good demon, if that isn't a contradiction in terms. (United States, English)</desc>
<credits>
<director>Guillermo del Toro</director>
<actor>Ron Perlman</actor>
<actor>John Hurt</actor>
<actor>Selma Blair</actor>
<actor>Rupert Evans</actor>
</credits>
<date>2004</date>
<category lang="en">Action</category>
<category lang="en">Fantasy</category>
<category lang="en">Adventure</category>
<category lang="en">Movie</category>
<language lang="en">English</language>
<country>United States</country>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>M</value>
</rating>
<image src=""/>
</show>
</shows>

JSON - Structure of the response

Name

Type

Description

channels

array of channels

Contains the channel the show is on

shows

array of shows

Contains the one show requested

JSON - Example of response
{
"channels": [
{
"dvb_triplets": [
{
"frequency": "", 
"lcn": "", 
"original_network_id": "4114", 
"service_id": "1059", 
"transport_stream_id": "1056"
}, 
{
"frequency": "", 
"lcn": "", 
"original_network_id": "12915", 
"service_id": "2", 
"transport_stream_id": "12925"
}
], 
"icon": {
"height": "0", 
"src": "http://images.icetv.com.au/channels/go.png", 
"width": "0"
}, 
"id": "2393", 
"lcn": "99", 
"name": "GO!", 
"url": ""
}
], 
"shows": [
{
"category": [
{
"name": "Action"
}, 
{
"name": "Movie"
}
], 
"channel_id": "2393", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Ron Perlman"
}, 
{
"name": "John Hurt"
}, 
{
"name": "Rupert Evans"
}
], 
"director": "Guillermo del Toro"
}, 
"date": "2004", 
"desc": "Given Hellboy's antecedents, he could have been forgiven for choosing the dark side. After all, he was spawned from Nazi ambition and desperation as they tried any avenue to resuscitate their fortunes - even Satanism. But amazingly, Hellboy has turned out to be a good demon, if that isn't a contradiction in terms. (United States, English)", 
"episode-num": "", 
"episode_id": "0", 
"id": "103759297", 
"language": "English", 
"previously-shown": {
"channel_id": "", 
"start": ""
}, 
"rating": "M", 
"series_id": "14269", 
"star-rating": "", 
"start": "2012-05-29T11:40:00+00:00", 
"stop": "2012-05-29T14:10:00+00:00", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "Movie: Hellboy", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
]
}