Favourites (series/favourites)

Favourites are represented as objects with the following fields.

Field

Type

Required for Add

Description

series_id

int

Yes

The unique IceTV series ID of the series that is marked as a favourite (See Series)

Get all series-based favourites

URL

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

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/favourites?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of response
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series>
<series_info id="213" episode_count="550">
<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. </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>
<rating>
<value>G</value>
</rating>
</series_info>
<series_info id="884" episode_count="260">
<title lang="en">Mythbusters</title>
<desc lang="en">Many of us live by beliefs that collapse under the weight of investigation. Popular conceptions are either revealed as misconceptions or enshrined in truth. </desc>
<credits>
<actor>Jamie Hynemam</actor>
<actor>Adam Savage</actor>
</credits>
<date>2003</date>
<category lang="en">Documentary</category>
<category lang="en">Science &amp; Tech</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<rating>
<value>PG</value>
</rating>
</series_info>
<series_info id="24076" episode_count="64">
<title lang="en">Cougar Town</title>
<desc lang="en">Recently divorced single mother Jules Cobb is busy raising a teenage boy and managing a (completely useless) ex husband. She's also working on re-entering the scary world of dating, with a little help from her enthusiastic assistant. Jules isn't young as she used be and neither is her body but that's no reason to let the younger generation have all the fun. </desc>
<credits>
<actor>Courteney Cox</actor>
<actor>Busy Philipps</actor>
<actor>Josh Hopkins</actor>
<actor>Christa Miller</actor>
<actor>Ian Gomez</actor>
<actor>Brian Van Holt</actor>
</credits>
<date>2009</date>
<category lang="en">Sitcom</category>
<category lang="en">Comedy</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<rating>
<value>M</value>
</rating>
</series_info>
<favourite series_id="884" />
<favourite series_id="213" />
</series>

JSON - Structure of the response

Name

Type

Description

Comment

favourites

array

Contains all the series_id of all the favourites for the account

The response is empty if the account has no favourites

series_info

array

Contains the series info for each favourite

The response is empty if the account has no favourites

JSON - Example of response
{
"favourites": [
  {
"series_id": "213",
},
{
"series_id": "884"
}
],
"series_info": [
{
"id": "213",
"episode_count": "550",
"title": "The Simpsons",
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. ",
"credits": {
"actors":[
{
"name": "Julie Kavner"
},
{
"name": "Hank Azaria"
},
{
"name": "Nancy Cartwright"
}
]
},
"date": "1989",
"category": [
{
"name": "Cartoon"
},
{
"name": "Comedy"
}
],
"language": "English",
"country": "United States",
"video": {
"aspect": "16:9"
},
"subtitles": {
"onscreen": "English",
"teletex": "YES"
}
"rating": "G"
},
 
--- truncated ---
]
}

Get a specific series-based favourite

URL

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

Method

GET

Query String

 

Returns

200 OK & Document (XML or JSON)

 

401 Unauthorized

 

404 Not Found

 

503 Service Unavailable

Sample

series_favourite.xml

DTD

favourites

Request - URL
GET https://api.icetv.com.au/series/favourites/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="UTF-8" standalone="no"?>
<!DOCTYPE series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series>
<series_info id="213" episode_count="550">
<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. </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>
<rating>
<value>G</value>
</rating>
</series_info>
<favourite series_id="213" />
</series>

JSON - Structure of the response

Name

Type

Description

favourites

array

Contains the series id of the requested favourite

series_info

array

Contains the series info of the requested favourite

JSON - Example of response
{
"favourites": [
{
"series_id": "213",
}
],
"series_info": [
{
"id": "213",
"episode_count": "550",
"title": "The Simpsons",
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. ",
"credits": {
"actors":[
{
"name": "Julie Kavner"
},
{
"name": "Hank Azaria"
},
{
"name": "Nancy Cartwright"
}
]
},
"date": "1989",
"category": [
{
"name": "Cartoon"
},
{
"name": "Comedy"
}
],
"language": "English",
"country": "United States",
"video": {
"aspect": "16:9"
},
"subtitles": {
"onscreen": "English",
"teletex": "YES"
}
"rating": "G"
}
]
}

Add a series-based favourite

URL

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

Method

POST

Query String

 

Returns

201 Created

 

401 Unauthorized

 

404 Not Found

 

406 Not Acceptable

 

415 Unsupported Media Type

 

503 Service Unavailable

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

NOTE: You can send multiple favourites in the one document, but at least one is required.

Request - URL
POST https://api.icetv.com.au/series/favourites?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN
XML - Example of request
<series>
<favourite series_id="213"/>
<favourite series_id="884"/>
</series>  

JSON - Structure of the request

Name

Type

Description

series_id

array of series id

Contains all the index of the favourites you want to add

JSON - Example of request
{
"series_id": [
"213",
"884"
]
}
XML - Example of response
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE series SYSTEM "http://iceguide.icetv.com.au/iceguide/series.dtd">
<series>
<series_info id="213" episode_count="550">
<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. </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>
<rating>
<value>G</value>
</rating>
</series_info>
<series_info id="884" episode_count="260">
<title lang="en">Mythbusters</title>
<desc lang="en">Many of us live by beliefs that collapse under the weight of investigation. Popular conceptions are either revealed as misconceptions or enshrined in truth. </desc>
<credits>
<actor>Jamie Hynemam</actor>
<actor>Adam Savage</actor>
</credits>
<date>2003</date>
<category lang="en">Documentary</category>
<category lang="en">Science &amp; Tech</category>
<language lang="en">English</language>
<country>United States</country>
<video>
<aspect>16:9</aspect>
</video>
<rating>
<value>PG</value>
</rating>
</series_info>
<favourite series_id="884" />
<favourite series_id="213" />
</series>

JSON - Structure of the response

Name

Type

Description

favourites

array

Contains the series id of the favourite(s) just added

series_info

array

Contains the series info of the favourite(s) just added

JSON - Example of response
{
"favourites": [
{
"series_id": "213"
},
{
"series_id": "884"
}
],
"series_info": [
{
"id": "213",
"episode_count": "550",
"title": "The Simpsons",
"desc": "The little yellow family continues to reign supreme, ruling Springfield subversively from their lower middle class, blue collar roots. ",
"credits": {
"actors":[
{
"name": "Julie Kavner"
},
{
"name": "Hank Azaria"
},
{
"name": "Nancy Cartwright"
}
]
},
"date": "1989",
"category": [
{
"name": "Cartoon"
},
{
"name": "Comedy"
}
],
"language": "English",
"country": "United States",
"video": {
"aspect": "16:9"
},
"subtitles": {
"onscreen": "English",
"teletex": "YES"
}
"rating": "G"
},
 
--- truncated ---
]
}

Delete a series-based favourite

URL

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

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/favourites/213?api_key=API_KEY?application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN