Most Popular (series/most_popular)
Most Popular are represented as objects with the following fields. (NOTE: All fields are read-only)
|
Field |
Type |
Description |
|
series_id |
int |
Unique identifier for the series this popularity information is associated with (See Series) |
|
num_votes |
int |
Number of votes registered for this series |
|
popularity_ratio |
float |
Ratio of this series' popularity compared to the most popular series in the list |
Get all popularity information
|
URL |
https://api.icetv.com.au/series/most_popular |
|
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/most_popular?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="73" episode_count="0"> <title lang="en">Home and Away</title> <desc lang="en">The people who live in the beachside town of Summer Bay live the same kind of lives as as anybody else. Only more so. This is the chronicle of the fun and games, ins and outs, ups and downs and all the other shenanigans the denizens of Summer Bay get up to, day in and day out.</desc> <category lang="en">Soap Opera</category> <language lang="en">English</language> <country>Australia</country> <video> <aspect>16:9</aspect> </video> <rating> <value>PG</value> </rating> </series_info> <series_info id="160" episode_count="0"> <title lang="en">Seven News</title> <desc lang="en">Daily dose of international, national and local news, sport, weather and human interest stories. Up to the minute news about anything, anywhere, anytime.</desc> <category lang="en">News</category> <category lang="en">Live</category> <language lang="en">English</language> <country>Australia</country> <video> <aspect>16:9</aspect> </video> </series_info> <series_info id="213" episode_count="551"> <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>--- truncated --- <popular series_id="35934" num_votes="53182" popularity_ratio="1.00" /> <popular series_id="11961" num_votes="37671" popularity_ratio="0.71" /> <popular series_id="18427" num_votes="28790" popularity_ratio="0.54" />--- truncated --- </series>JSON - Structure of the response
|
Name |
Type |
Description |
|
series_info |
array |
Contains all the most popular series |
|
most_popular |
array |
Contains the number of votes, series id and popularity ratio for the 30 most popular series |
JSON - Example of response
{ "series_info": [ { "category": [ { "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 --- ], "most_popular": [ { "series_id": "213", "num_votes": "53182", "popularity_ratio": "1.00" }, { "series_id": "33651", "num_votes": "37671", "popularity_ratio": "0.71" }, { "series_id": "18427", "num_votes": "28790", "popularity_ratio": "0.54" },--- truncated --- ]}