recordings

Series Recordings (series/recordings)

Series Recordings are represented as objects with the following fields.

Field

Type

Read-Only

Required for "Add"

Default if not included in "Add"

Description

id

int

Yes

No

 

Unique identifier for this Series Recording

series_id

int

No

Yes

 

Unique identifier for the series to be recorded (See Series)

series_name

string

Yes

No

 

Name of the series to be recorded

device_id

int

No

Yes

 

Unique identifier for the TV Recorder that the Series Recording is associated with (See Device)

device_label

string

Yes

No

 

The label of the device the Series Recording is associated with (cannot be changed)

start_minutes

int

No

No

-1

Filter programmes based on the start time, expressed in minutes after midnight.

-1

Any start time (no filtering)

>= 0

Only programmes that start this number of minutes after midnight. e.g. A programme showing at 7:00pm would be matched by a start_minutes value of 1140

network_id

int

No

No

-1

The IceTV network ID to restrict this Series Recording to, if set to "-1" then all networks will be used. (See Channel)

channel_id

int

No

No

-1

The IceTV channel ID to restrict this Series Recording to, if set to "-1" then all channels will be used. (See Channel)

show_id

int

No

No

-1

The IceTV Show ID to restrict this Series Recording to. (See Show)

<= 0

Any show (no filtering)

> 0

Filtered for a specific show, this is used for a one-time recording

recording_quality

string

No

No

Prefer HD

Prefer HD

If the same show is on both a High Definition (HD) channel and Standard Definition (SD) channel at the same time (simulcast) then the HD version will be selected.

HD Only

Only shows on HD channels will be selected for this Series Recording.

Prefer SD

If the same show is on both a HD and SD channel at the same time (simulcast) then the SD version will be selected.

SD Only

Only shows on SD channels will be selected for this Series Recording.

recordings_per_day

int

No

No

0

The number of matches per day, this can be set to a maximum of 5, however a value of 0 refers to unlimited matches per day.

airings

string

No

No

First runs and re-runs

First runs and re-runs

All shows will be selected for this Series Recording whether they have been shown on TV before (a re-run) or if they are first runs.

First runs only

Only first run shows will be selected for this Series Recording.

Re-runs only

Only re-runs will be selected for this Series Recording.

Get all series recording information

URL

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

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/recordings?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
Response - XML
<?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>
 
--- truncated ---
<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"/>
 
--- truncated ---
</series>
 

Structure of the response - JSON

Name

Type

Description

Comment

header

object

 

 

series_info

array

Contains the series info for each series recording

 

shows

array

Contains all the shows to be recorded via all the series recordings for this account

There should be as many shows as timers

recordings

array

Contains all the series recording for this account

 

timers

array

Contains all the series recording timers for this account

There should be as many timers as shows

Reponse - JSON
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"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": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"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",  
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "The Simpsons", 
"video": {
"aspect": "16:9"
}
}
], 
"shows": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Animation"
}
], 
"channel_id": "1700", 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
}, 
{
"name": "Nancy Cartwright"
}, 
{
"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": "24", 
"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 a specific series recording

URL

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

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/recordings/SERIES_RECORDING_ID?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
Response - XML
<?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>
 
--- truncated ---
<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"/>
 
--- truncated ---
</series>

Structure of the response - JSON

Name

Type

Description

Comment

header

header object

 

 

series_info

array

Contains the series info for the requested series recording

 

shows

array

Contains all the shows to be recorded via the requested series recordings

There should be as many shows as timers

recordings

array

Contains the requested series recording information

 

timers

array

Contains the timers for the requested series recording

There should be as many timers as shows

Response - JSON
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"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": "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"
}
}
], 
"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", 
"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 ---
]
}  

Add a series recording

URL

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

Method

POST

Query String

 

Returns

201 Created & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

406 Not Acceptable

 

415 Unsupported Media Type

 

503 Service Unavailable

A document containing the new series recording record must be sent as part of the request.

The document to be sent to the server omits the "id" field as this is generated by the server.

The server response will include the newly created series recording record as it would appear in a single series recording GET which allows the caller to update their local cache with the recording id.

Request - URL
POST https://api.icetv.com.au/series/recordings?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of request
<?xml version="1.0"?>
<series>
<series_recording series_id="213" device_id="23" 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" />
</series>
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="75" episode_count="0">
<title lang="en">Home Shopping</title>
<desc lang="en">Home shopping. (Australia, English)</desc>
<category lang="en">Shopping</category>
<language lang="en">English</language>
<country>Australia</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles lang="en" type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
</series_info>
<show id="103357882" series_id="75" episode_id="0" start="2012-04-28T16:00:00+00:00" stop="2012-04-28T18:00:00+00:00" channel_id="5">
<title lang="en">Home Shopping</title>
<desc lang="en">Home shopping. (Australia, English)</desc>
<category lang="en">Shopping</category>
<language lang="en">English</language>
<country>Australia</country>
<video>
<aspect>16:9</aspect>
</video>
<subtitles type="onscreen">
<language lang="en">English</language>
</subtitles>
<rating>
<value>G</value>
</rating>
<icon src=""/>
</show>
 
--- truncated ---
<series_recording id="42" series_id="75" 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="15783996570841907201" name="Home Shopping" device_id="23" channel_id="5" show_id="103357882" start_time="2012-04-28T16:00:00+00:00" duration_minutes="120" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="42" keyword_id="0"/>
 
--- truncated ---
</series>

JSON - Structure of the request

Name

Type

Description

Comment

-

table

The series recording to be added

Only the device id and the series id are mandatory to create a series recording. All the other fields will get assigned a default value if not specified

JSON - Example of request
{
"airing": "First runs and re-runs", 
"channel_id": "-1", 
"device_id": "23", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "75", 
"show_id": "-1", 
"start_minutes": "-1",
"device_label": "DEVICE1"
}

JSON - Structure of the response

Name

Type

Description

Comment

header

table

 

 

series_info

array

Contains the series info for the just created series recording

 

shows

array

Contains all the shows to be recorded via the just created series recordings

There should be as many shows as timers

If the series does not have any shows coming in the next 7 days this array will be empty

recordings

array

Contains the just created series recording information

The series recording id can now be cached or can be retrieved later with a get_all_series_recording

timers

array

Contains the timers for the just created series recording

There should be as many timers as shows

If the series does not have any shows in the next 7 days no timers will be created

JSON - Example of response
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"series_info": [
{
"id": "75"
"episode_count": "0"
"title": "Home Shopping"
"desc": "Home shopping"
"date": "0"
"category": [
{
"name": "Shopping"
"eit": "0xa6"
}
]
"language": "English"
"country": "Australia"
"rating": ""
}
"recordings": [
{
"airing": "First runs and re-runs", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "42", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "75", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"shows": [
{
"category": [
{
"name": "Shopping"
}
], 
"channel_id": "5", 
"country": "Australia", 
"date": "0", 
"desc": "Home shopping. (Australia, English)", 
"episode-num": "", 
"episode_id": "0", 
"id": "103357882", 
"language": "English", 
"pimp_series_id": "42", 
"previously-shown": {
"channel_id": "", 
"start": ""
}, 
"rating": "G", 
"series_id": "75", 
"star-rating": "", 
"start": "2012-04-28T16:00:00+00:00", 
"stop": "2012-04-28T18:00:00+00:00", 
"subtitle": "", 
"subtitles": {
"onscreen": "English", 
"teletex": "YES"
}, 
"title": "Home Shopping", 
"video": {
"aspect": "16:9", 
"colour": "NO", 
"quality": "HDTV"
}
}
 
--- truncated ---
], 
"timers": [
{
"action": "record", 
"channel_id": "5", 
"device_id": "23", 
"duration_minutes": "120", 
"id": "15783996570841907201", 
"keyword_id": "0", 
"message": "Scheduled to record by API", 
"name": "Home Shopping", 
"series_recording_id": "42", 
"show_id": "103357882", 
"start_time": "2012-04-28T16:00:00+00:00", 
"state": "waiting"
}
 
--- truncated ---
]
}

Modify a series recording

URL

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

Method

PUT

Query String

 

Returns

200 OK

 

401 Unauthorized

 

404 Not Found

 

406 Not Acceptable

 

415 Unsupported Media Type

 

503 Service Unavailable

Request - URL
PUT https://api.icetv.com.au/series/recordings/SERIES_RECORDING_ID?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of request
<?xml version="1.0"?>
<series>
<series_recording id="42" 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 only" marked_for_deletion="0"/>
</series>
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>
 
--- truncated ---
<series_recording id="42" 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 only" marked_for_deletion="0"/>
<timer id="15783997482767482881" name="The Simpsons" device_id="23" channel_id="0" show_id="103458207" start_time="1970-01-01T00:00:00+00:00" duration_minutes="0" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="42" keyword_id="0"/>
 
--- truncated ---
</series>

JSON - Structure of the request

Name

Type

Description

Comment

-

table

The info of the series recording to be modified

The device_id the series_id are mandatory to modify a series recording but note that all the other fields if not specified will be changed to a default value.

JSON - Example of request
{
"device_id": "23", 
"series_id": "213",
"start_minutes": "-1",
"network_id": "-1",
"channel_id": "-1",
"show_id": "-1",
"airing": "First runs only",
"recording_quality": "HD only",
"device_label": "DEVICE1"
}

JSON - Structure of the response

Name

Type

Description

Comment

header

table

 

 

series_info

array

Contains the series info for the just modifed series recording

 

shows

array

Contains all the shows to be recorded via the just modified series recordings

This array will be empty if no shows matches the criterias of the series recording. There should be as many shows as timers

recordings

array

Contains the just modified series recording information

The series recording id can now be cached or can be retrieve later with a get_all_series_recording

timers

array

Contains the timers for the just modified series recording

This array will be empty if no shows matches the criterias of the series recording. There should be as many timers as shows

JSON - Example of response
{
"header": {
"page": "1", 
"rows_per_page": "", 
"total_rows": "1"
}, 
"recordings": [
{
"airing": "First runs only", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "42", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "HD only", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"series_info": [
{
"category": [
{
"name": "Cartoon"
}, 
{
"name": "Animation"
}
], 
"country": "United States", 
"credits": {
"actors": [
{
"name": "Julie Kavner"
}, 
{
"name": "Hank Azaria"
},  
{
"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": "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": "51", 
"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": "0", 
"device_id": "23", 
"duration_minutes": "0", 
"id": "15783997482767482881", 
"keyword_id": "0", 
"message": "Scheduled to record by API", 
"name": "The Simpsons", 
"series_recording_id": "42", 
"show_id": "103458207", 
"start_time": "1970-01-01T00:00:00+00:00", 
"state": "waiting"
}
 
--- truncated ---
]
}  

Deleting a series recording

URL

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

Method

DELETE

Query String

 

Returns

200 OK

 

401 Unauthorized

 

405 Method Not Allowed

 

503 Service Unavailable

Request - URL
DELETE https://api.icetv.com.au/series/recordings/SERIES_RECORDING_ID?api_key=API_KEY&application_version=APPLICATION_VERSION=email_address=EMAIL_ADDRESS&token=TOKEN

Get all shows for a series recording

URL

https://api.icetv.com.au/series/recordings/#/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/recordings/SERIES_RECORDING_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>
<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 ---
<series_recording id="42" 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 only" marked_for_deletion="0"/>
</series>

JSON - Structure of the response

Name

Type

Description

header

table

 

shows

array

Contains all the shows to be recorded via the requested series recordings

recordings

array

Contains the series recording information for the requested id

JSON - Example of response
{
"header": {}, 
"recordings": [
{
"airing": "First runs only", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "42", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"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": "51", 
"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 ---
]
}

Get a specific show for a specific series recording

URL

https://api.icetv.com.au/series/recordings/#/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/recordings/SERIES_RECORDING_ID/shows/SHOW_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>
<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>
<series_recording id="42" 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 only" marked_for_deletion="0"/>
</series>

JSON - Structure of the response

Name

Type

Description

header

table

 

shows

array

Contains all the specific shows to be recorded via the requested series recordings

recordings

array

Contains the series recording information for the requested id

JSON - Example of response
{
"header": {}, 
"recordings": [
{
"airing": "First runs only", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "42", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"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": "51", 
"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"
}
}
]
}

Get all timers for a series recording

URL

https://api.icetv.com.au/recordings/#/timers

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/recordings/SERIES_RECORDING_ID/timers?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>
<series_recording id="42" 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 only" marked_for_deletion="0"/>
<timer id="15783997482767482881" name="The Simpsons" device_id="23" channel_id="0" show_id="103458207" start_time="1970-01-01T00:00:00+00:00" duration_minutes="0" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="42" keyword_id="0"/>
 
--- truncated ---
</series>

JSON - Structure of the response

Name

Type

Description

header

table

 

recordings

array

Contains the requested series recording information

timers

array

Contains the timers for the requested series recording

JSON - Example of response
{
"header": {}, 
"recordings": [
{
"airing": "First runs only", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "51", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"timers": [
{
"action": "record", 
"channel_id": "0", 
"device_id": "23", 
"duration_minutes": "0", 
"id": "15783997482767482881", 
"keyword_id": "0", 
"message": "Scheduled to record by API", 
"name": "The Simpsons", 
"series_recording_id": "42", 
"show_id": "103458207", 
"start_time": "1970-01-01T00:00:00+00:00", 
"state": "waiting"
}
 
--- truncated ---
]
}

Get a specific timer for a specific series recording

URL

https://api.icetv.com.au/recordings/#/timers/#

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/recordings/SERIES_RECORDING_ID/timers/TIMER_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>
<series_recording id="42" 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 only" marked_for_deletion="0"/>
<timer id="15783997482767482881" name="The Simpsons" device_id="23" channel_id="0" show_id="103458207" start_time="1970-01-01T00:00:00+00:00" duration_minutes="0" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="42" keyword_id="0"/>
</series>

JSON - Structure of the response

Name

Type

Description

header

header object

 

recordings

array

Contains the requested series recording information

timers

array

Contains the specific timer for the requested series recording

JSON - Example of response
{
"header": {}, 
"recordings": [
{
"airing": "First runs only", 
"channel_id": "-1", 
"device_id": "23", 
"device_label": "DEVICE1", 
"id": "42", 
"marked_for_deletion": "0", 
"network_id": "-1", 
"recording_quality": "Prefer HD", 
"recordings_per_day": "0", 
"series_id": "213", 
"show_id": "-1", 
"start_minutes": "-1"
}
], 
"timers": [
{
"action": "record", 
"channel_id": "0", 
"device_id": "23", 
"duration_minutes": "0", 
"id": "15783997482767482881", 
"keyword_id": "0", 
"message": "Scheduled to record by API", 
"name": "The Simpsons", 
"series_recording_id": "42", 
"show_id": "103458207", 
"start_time": "1970-01-01T00:00:00+00:00", 
"state": "waiting"
}
]
}