series

In this context a series are the top level details for a show, every show in the IceTV database is based on a series whether it is a non-episodic show (like a news broadcast) or even a one off showing (like a movie or a special).

Series are represented as objects with the following fields (note: all fields are read-only)

Series

Name

Type

Comment

id

integer

The series ID

category

array

(See Category)

episode_count

integer

The number of episodes currently in the IceTV database for this series

title

string

The title of the series

desc

string

The series extended description

credits

array

(See Credits)

date

integer

Four digit year of production for the series

language

string

Language the series audio is in

country

string

The country of origin for the series

video

string

(See Video)

subtitles

array

(See Subtitles)

rating

array

(See Rating)

icon

array

(See Icon)

Category

Field

Type

Description

name

string

Category (Genre) name

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)

Icon

Field

Type

Description

url

string

URL for the icon file

width

int

Width of the icon (in pixels)

height

int

Height of the icon (in pixels)

The series "Node" covers all series information including New Shows, Most Popular and recordings.

URL

Description

series

Covers the most common usage, this URL returns "Favourites", "New Shows", "Most Popular" and "Series Recordings"

series/favourites

Allows management of series-based favourites

series/new_shows

Returns information on shows that are new this week or yet to start

series/most_popular

Returns information on the popularity of series based on user recording data

series/recordings

Allows management of series-based recordings

Get all series

URL

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

Method

GET

Query String

hide_series=1

Exclude series information from response

hide_favourites=1

Excludes series favourites information from response

hide_new_shows=1

Exclude New Shows information from response

hide_most_popular=1

Exclude Most Popular records from response

hide_series_recordings=1

Exclude Series Recordings from response, this also excludes Timer information and Show information

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Request
GET https://api.icetv.com.au/series?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 series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series min_hit_minutes="" total_rows="19" rows_per_page="" page="1">
<series_info id="213" episode_count="538">
<title lang="en">The Simpsons</title>
<desc lang="en">The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1989</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="teletext"/>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
</series_info>
<series_info id="33651" episode_count="0">
<title lang="en">Being Lara Bingle</title>
<desc lang="en">Join us as we follow the real life adventures, and misadventures, of Lara Bingle, the beautiful young fashion model and socialite who seems to find herself in the headlines of tabloids more often than not. Best known for her 2006 Tourism Australia campaign, Lara went on to grace the covers of numerous magazines and make television appearances. From personal relationships, like her engagement to cricket captain Michael Clarke, to working with the cancer foundation, we will discover the girl behind the glam. (Australia, English)</desc>
<credits>
<director>Ben Thompson</director>
<actor>Laura Bingle</actor>
</credits>
<date>2012</date>
<category lang="en">Real Life</category>
<language lang="en">English</language>
<country>Australia</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="teletext"/>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>PG</value>
</rating>
</series_info>
 
--- truncated ---
<show id="103334009" series_id="213" episode_id="790" start="2012-05-01T09:30:00+00:00" stop="2012-05-01T10:00:00+00:00" channel_id="1700">
<title lang="en">The Simpsons</title>
<sub-title lang="en">Homer the Smithers</sub-title>
<desc lang="en">Smithers screws up and an angry Mister Burns sends him on vacation. Smithers chooses Homer as his temporary replacement, hoping that Homer's incompetence will ensure Mr Burns misses him. The plan backfires when a fist fight forces Mr Burns to look after himself. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1996</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<previously-shown/>
<subtitles type="teletext"/>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
<icon src="http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg" width="680" height="1000"/>
</show>
 
--- truncated ---
<favourite series_id="213"/>
<series_recording id="41" series_id="213" device_id="23" device_label="DEVICE1" start_minutes="-1" network_id="-1" channel_id="-1" show_id="-1" recording_quality="Prefer HD" recordings_per_day="0" airings="First runs and re-runs" marked_for_deletion="0"/>
<new_show series_id="33651" start_date="" channel_id="0"/>
<timer id="15782309847862870017" name="The Simpsons" device_id="23" channel_id="1700" show_id="103679220" start_time="2012-05-23T08:00:00+00:00" duration_minutes="25" action="record" state="waiting" message="Accepted" series_recording_id="41" keyword_id="0"/>
 
--- truncated ---
</series>

JSON - Structure of the response

Name

Type

Description

Comment

header

table

 

total_rows is the number of series in series_info

favourites

array

Contains all the favourites of the account

This array is not present if the account has no favourites

Can be hidden with the query string 'hide_favourites=1'

new_shows

array

Contains new shows to be aired

Can be hidden with the query string 'hide_new_shows=1'

most_popular

array

Contains the top 25 most recorded series among all the IceTV users

Can be hidden with the query string 'hide_most_popular=1'

recordings

array

Contains all the series recordings of the account

The array is not present if the account has no series recordings

Can be hidden with the query string 'hide_series_recordings=1'

series_info

array

Contains the series part of 'favourites', 'new_shows', 'most_popular' and 'recordings'

Can be hidden with the query string 'hide_series=1'

shows

array

Contains the shows to be aired in the next 7 days that are part of a series recordings or favourites

This array is not present if there are no shows that match the criteria

Can be hidden with the query string 'hide_series_recordings=1'

timers

array

Contains all the timers that are part of a series recordings

This array is not present if the account has no series recordings

Can be hidden with the query string 'hide_series_recordings=1'

JSON - Example of response
{
"header": {
"page": "1",
"rows_per_page": "19",
"total_rows": "19"
},
"favourites": [
{
"series_id": "3903"
}
], 
"new_shows": [
{
"series_id": "40561",
"start_date": "Fri, 20 Mar 2015"
},
{
"series_id": "40558",
"start_date": "Wed, 18 Mar 2015"
},
 
--- truncated ---
], 
"most_popular": [
{
"series_id": "23989",
"num_votes": "13612",
"popularity_ratio": "1.00"
},
{
"series_id": "40248",
"num_votes": "7835",
"popularity_ratio": "0.58"
},
 
--- truncated ---
 
],
"recordings": [
{
"airing": "First runs and re-runs", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "41", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"series_info": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1989", 
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)", 
"episode_count": "538", 
"id": "213", 
"language": "English", 
"rating": "G", 
"star-rating": "", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9"
}
}, 
{
"category": [
{
"name": "Real Life"
}
], 
"country": "Australia", 
"credits": {
"actors": [
{
"name": "Laura Bingle"
}
], 
"director": "Ben Thompson"
}, 
"date": "2012", 
"desc": "Join us as we follow the real life adventures, and misadventures, of Lara Bingle, the beautiful young fashion model and socialite who seems to find herself in the headlines of tabloids more often than not. Best known for her 2006 Tourism Australia campaign, Lara went on to grace the covers of numerous magazines and make television appearances. From personal relationships, like her engagement to cricket captain Michael Clarke, to working with the cancer foundation, we will discover the girl behind the glam. (Australia, English)", 
"episode_count": "0", 
"id": "33651", 
"language": "English", 
"rating": "PG", 
"star-rating": "", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "Being Lara Bingle", 
"video": {
"aspect": "16:9"
}
}
 
--- truncated ---
], 
"shows": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Animation"
}
], 
"channel_id": "1700", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1996", 
"desc": "Smithers screws up and an angry Mister Burns sends him on vacation. Smithers chooses Homer as his temporary replacement, hoping that Homer's incompetence will ensure Mr Burns misses him. The plan backfires when a fist fight forces Mr Burns to look after himself. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)", 
"episode-num": "", 
"episode_id": "790", 
"icon": {
"height": "1000", 
"src": "http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg", 
"width": "680"
}, 
"id": "103334009", 
"language": "English", 
"pimp_series_id": "41", 
"rating": "G", 
"series_id": "213", 
"star-rating": "", 
"start": "2012-05-01T09:30:00+00:00", 
"stop": "2012-05-01T10:00:00+00:00", 
"subtitle": "Homer the Smithers", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
 
--- truncated ---
], 
"timers": [
{
"action": "record", 
"channel_id": "1700", 
"device_id": "23", 
"duration_minutes": "25", 
"id": "15782309847862870017", 
"keyword_id": "0", 
"message": "Accepted", 
"name": "The Simpsons", 
"series_recording_id": "41", 
"show_id": "103679220", 
"start_time": "2012-05-23T08:00:00+00:00", 
"state": "waiting"
}
 
--- truncated ---
]
}
 

Get a specific series

URL

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

Method

GET

Query String

 

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Request - URL
GET https://api.icetv.com.au/series/SERIES_ID?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 series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series total_rows="1" rows_per_page="" page="1">
<series_info id="213" episode_count="538">
<title lang="en">The Simpsons</title>
<desc lang="en">The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1989</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="teletext"/>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
</series_info>
<show id="103334009" series_id="213" episode_id="790" start="2012-05-01T09:30:00+00:00" stop="2012-05-01T10:00:00+00:00" channel_id="1700">
<title lang="en">The Simpsons</title>
<sub-title lang="en">Homer the Smithers</sub-title>
<desc lang="en">Smithers screws up and an angry Mister Burns sends him on vacation. Smithers chooses Homer as his temporary replacement, hoping that Homer's incompetence will ensure Mr Burns misses him. The plan backfires when a fist fight forces Mr Burns to look after himself. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1996</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<previously-shown/>
<subtitles type="teletext"/>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
<icon src="http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg" width="680" height="1000"/>
</show>
<favourite series_id="213"/>
<series_recording id="41" series_id="213" device_id="23" device_label="DEVICE1" start_minutes="-1" network_id="-1" channel_id="-1" show_id="-1" recording_quality="Prefer HD" recordings_per_day="0" airings="First runs and re-runs" marked_for_deletion="0"/>
<timer id="15782309847862870017" name="The Simpsons" device_id="23" channel_id="1700" show_id="103679220" start_time="2012-05-23T08:00:00+00:00" duration_minutes="25" action="record" state="waiting" message="Accepted" series_recording_id="41" keyword_id="0"/>
</series>

JSON - Structure of the response

Name

Type

Description

Comment

header

table

 

total_rows is the number of series in series_info

series_info

array

Contains one element, the requested series info

 

shows

array

Contains the shows to be aired in the next 7 days that are part of the requested series

This array is not present if there are no shows that match the criteria

most_popular

array

Contains one most popular object, indicates the number of votes the requested series recently got

 

recordings

array

Contains one recordings object only if the requested series is a series recording for this account

This array is not present if the series is not a series recording for the account

timers

array

Contains all the timers for the series if the requested series is a series recording and if it has shows to be aired

This array is not present if the series is not a series recording and/or if the series does not have any shows to be aired in the next 7 days

favourites

array

Contains the series_id only if the requested series is part of the favourites of the account

 

JSON - Example of response
{
"header": {
"page": "1",
"rows_per_page": "1",
"total_rows": "1"
},
"favourites": [
{
"series_id": "213"
}
], 
"recordings": [
{
"airing": "First runs and re-runs", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "41", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"series_info": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1989", 
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)", 
"episode_count": "538", 
"id": "213", 
"language": "English", 
"rating": "G", 
"star-rating": "", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9"
}
}
], 
"shows": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"channel_id": "1700", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1996", 
"desc": "Smithers screws up and an angry Mister Burns sends him on vacation. Smithers chooses Homer as his temporary replacement, hoping that Homer's incompetence will ensure Mr Burns misses him. The plan backfires when a fist fight forces Mr Burns to look after himself. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)", 
"episode-num": "", 
"episode_id": "790", 
"icon": {
"height": "1000", 
"src": "http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg", 
"width": "680"
}, 
"id": "103334009", 
"language": "English", 
"pimp_series_id": "41", 
"previously-shown": {
"channel_id": "", 
"start": ""
}, 
"rating": "G", 
"series_id": "213", 
"star-rating": "", 
"start": "2012-05-01T09:30:00+00:00", 
"stop": "2012-05-01T10:00:00+00:00", 
"subtitle": "Homer the Smithers", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
 
--- truncated ---
], 
"timers": [
{
"action": "record", 
"channel_id": "1700", 
"device_id": "23", 
"duration_minutes": "25", 
"id": "15782309847862870017", 
"keyword_id": "0", 
"message": "Accepted", 
"name": "The Simpsons", 
"series_recording_id": "41", 
"show_id": "103679220", 
"start_time": "2012-05-23T08:00:00+00:00", 
"state": "waiting"
}
 
--- truncated ---
]
}

Get all shows for a specific series

URL

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

Method

GET

Query String

 

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Request - URL
GET https://api.icetv.com.au/series/SERIES_ID/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 series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series total_rows="1" rows_per_page="" page="1">
<series_info id="213" episode_count="538">
<title lang="en">The Simpsons</title>
<desc lang="en">The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1989</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="teletext"/>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
</series_info>
<show id="103754147" series_id="213" episode_id="2124" start="2012-05-29T08:00:00+00:00" stop="2012-05-29T08:25:00+00:00" channel_id="1700">
<title lang="en">The Simpsons</title>
<sub-title lang="en">Das Bus</sub-title>
<desc lang="en">In a cute send-up of Lord Of The Flies, Lisa and her classmates become stranded on an island. They become increasingly savage and want to kill Milhouse for eating all their snacks. Back in Springfield, Homer tries to start an internet company but Bill Gates uses his tough guys to shut it down. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1998</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<previously-shown/>
<subtitles type="teletext"/>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
<icon src="http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg" width="680" height="1000"/>
</show>
 
--- truncated ---
</series>

JSON - Structure of the response

Name

Type

Description

header

table

 

series_info

array

Contains one element, the requested series info

shows

array

Contains the shows to be aired in the next 7 days that are part of the requested series

JSON - Example of reponse
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"series_info": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1989", 
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)", 
"episode_count": "538", 
"id": "213", 
"language": "English", 
"rating": "G", 
"star-rating": "", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9"
}
}
], 
"shows": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"channel_id": "1700", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1998", 
"desc": "In a cute send-up of Lord Of The Flies, Lisa and her classmates become stranded on an island. They become increasingly savage and want to kill Milhouse for eating all their snacks. Back in Springfield, Homer tries to start an internet company but Bill Gates uses his tough guys to shut it down. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)", 
"episode-num": "", 
"episode_id": "2124", 
"icon": {
"height": "1000", 
"src": "http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg", 
"width": "680"
}, 
"id": "103754147", 
"language": "English", 
"previously-shown": {
"channel_id": "", 
"start": ""
}, 
"rating": "G", 
"series_id": "213", 
"star-rating": "", 
"start": "2012-05-29T08:00:00+00:00", 
"stop": "2012-05-29T08:25:00+00:00", 
"subtitle": "Das Bus", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
 
--- truncated ---
]
}

Get a specific show for a specific series

URL

https://api.icetv.com.au/series/213/shows/103754147

Method

GET

Query String

 

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Sample

series

DTD

series

Request - URL
 GET https://api.icetv.com.au/series/SERIES_ID/shows/SHOW_ID
XML - Example of response
 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series total_rows="1" rows_per_page="" page="1">
<series_info id="213" episode_count="538">
<title lang="en">The Simpsons</title>
<desc lang="en">The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1989</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="teletext"/>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
</series_info>
<show id="103754147" series_id="213" episode_id="2124" start="2012-05-29T08:00:00+00:00" stop="2012-05-29T08:25:00+00:00" channel_id="1700">
<title lang="en">The Simpsons</title>
<sub-title lang="en">Das Bus</sub-title>
<desc lang="en">In a cute send-up of Lord Of The Flies, Lisa and her classmates become stranded on an island. They become increasingly savage and want to kill Milhouse for eating all their snacks. Back in Springfield, Homer tries to start an internet company but Bill Gates uses his tough guys to shut it down. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)</desc>
<credits>
<actor>Julie Kavner</actor>
<actor>Hank Azaria</actor>
<actor>Nancy Cartwright</actor>
<actor>Dan Castellaneta</actor>
<actor>Yeardley Smith</actor>
<actor>Harry Shearer</actor>
</credits>
<date>1998</date>
<category lang="en">Cartoon</category>
<category lang="en">Comedy</category>
<category lang="en">Animation</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<previously-shown/>
<subtitles type="teletext"/>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
<icon src="http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg" width="680" height="1000"/>
</show>
</series>

JSON - Structure of the response

Name

Type

Description

header

table

 

series_info

array

Contains one element, the requested series info

shows

array

Contains the requested show part of the requested series

JSON - Example of response
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"series_info": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1989", 
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. (United States, English)", 
"episode_count": "538", 
"id": "213", 
"language": "English", 
"rating": "G", 
"star-rating": "", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9"
}
}
], 
"shows": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Comedy"
}, 
{
"name": "Animation"
}
], 
"channel_id": "1700", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"name": "Dan Castellaneta"
}, 
{
"name": "Yeardley Smith"
}, 
{
"name": "Harry Shearer"
}
]
}, 
"date": "1998", 
"desc": "In a cute send-up of Lord Of The Flies, Lisa and her classmates become stranded on an island. They become increasingly savage and want to kill Milhouse for eating all their snacks. Back in Springfield, Homer tries to start an internet company but Bill Gates uses his tough guys to shut it down. Julie Kavner, Hank Azaria, Nancy Cartwright (United States, English)", 
"episode-num": "", 
"episode_id": "2124", 
"icon": {
"height": "1000", 
"src": "http://images.icetv.com.au/38bc-0d14-dfd7-22cf.jpg", 
"width": "680"
}, 
"id": "103754147", 
"language": "English", 
"previously-shown": {
"channel_id": "", 
"start": ""
}, 
"rating": "G", 
"series_id": "213", 
"star-rating": "", 
"start": "2012-05-29T08:00:00+00:00", 
"stop": "2012-05-29T08:25:00+00:00", 
"subtitle": "Das Bus", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
]
}