Keywords (keywords)

Keywords are represented as objects with the following fields

Name

Type

Read Only

Required for "Add"

Default if not included in "Add"

Comment

id

integer

yes

no

The keyword's ID.

match_pattern

string

no

yes

The keyword search pattern, without qualifiers this will search all available fields, else it is possible to use GMail™ style keywords to specify search fields (these fields include "actor, director, year, before, after, country and so on"). See Keyword Pattern Matching document for more information on the syntax.

type

enum

no

Record

Record	This specifies that this is a keyword recording and that recording timers will automatically be created for matching shows.
View	This specifies that this is a keyword favourite and the shows will just be marked in the guide and not automatically recorded.

device_id

integer

no

yes

The IceTV recording device ID. (See Device) NOTE: 'View' style keywords do not have a device associated with them.

device_label

string

yes

no

The label of the IceTV recording device the keyword is associated with

network_id

integer

no

-1

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

channel_id

integer

no

-1

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

recording_quality

enum

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 keyword.
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 keyword.

matches_per_day

integer

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

enum

no

First runs and re-runs

First runs and re-runs	All shows will be selected for this keyword 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 keyword.
Re-runs only	Only re-runs will be selected for this keyword.

marked_for_deletion

integer

yes

no

1 = Yes, 0 = No. If Yes then this particular keyword is in the process of being removed from the system, but is awaiting confirmations from recording devices

Keywords (keywords)
- Get all keywords
  - JSON - Structure of the response
- Get a specific keyword
  - JSON - Structure of the response
- Add a keyword recording or favourite
  - JSON - Structure of the request
  - JSON - Structure of the response
- Modify a keyword recording or favourite
  - JSON - Structure of the request
  - JSON - Structure of the response
- Deleting a keyword recording or favourite
- Get all shows for a keyword recording or favourite
  - JSON - Structure of the response
- Get all timers for a keyword recording
  - JSON - Structure of the response

The keywords "Node" covers all keyword based recording and favourites information.

URL	Description
keywords	Allows management of keyword-based recordings and favourites

Get all keywords

URL	https://api.icetv.com.au/keywords
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/keywords?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 keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
 
--- truncated ---
 
   <keyword id="18" match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" device_label="DEVICE1" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs and re-runs"  marked_for_deletion="0"/>
  <timer id="15783713959091372033" name="The Block" device_id="23" channel_id="4" show_id="103307719" start_time="2012-04-29T05:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="0" keyword_id="18"/>
 
--- truncated --- 
 
</keywords> 

JSON - Structure of the response

Name	Type	Description	Comment
shows	array	All the shows that match all the keywords for this account	Each show object contains a 'keyword_id'. This tells what keyword is responsible for the match.
keywords	array	All the keywords registered for this account
timers	array	All the timers created via the keywords for this account

JSON - Example of response

{
	"keywords": [
		{
			"airing": "First runs and re-runs",
			"device_id": "23",
			"device_label": "DEVICE1",
			"id": "18",
			"marked_for_deletion": "0",
			"match_pattern": "+title:\"the block\"",
			"matches_per_day": "0",
			"network_id": "-1",
			"recording_quality": "Prefer HD",
			"type": "Record"
		}
	],
	"shows": [
		{
			"category": [
				{
					"name": "Real Life"
				},
				{
					"name": "Renovation"
				}
			],
			"channel_id": "4",
			"country": "Australia",
			"date": "2003",
			"desc": "Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very,very) dirty. See how far they've got with that all-important first room. (Australia, English)",
			"episode-num": "",
			"episode_id": "136721",
			"icon": {
				"height": "1000",
				"src": "http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg",
				"width": "680"
			},
			"id": "103307719",
			"language": "English",
			"keyword_id": "18",
			"rating": "PG",
			"series_id": "26455",
			"star-rating": "",
			"start": "2012-04-29T05:30:00+00:00",
			"stop": "2012-04-29T06:00:00+00:00",
			"subtitle": "2012 - First Room Progress Review 27/04/12",
			"subtitles": {
				"onscreen": "English",
				"teletex": "YES"
			},
 
			"title": "The Block",
			"video": {
				"aspect": "16:9",
				"colour": "NO",
				"quality": "HDTV"
			}
		},
 
--- truncated ---
 
	],
	"timers": [
		{
			"action": "record",
			"channel_id": "4",
			"device_id": "23",
			"duration_minutes": "30",
			"id": "15783713959091372033",
			"keyword_id": "18",
			"message": "Scheduled to record by API",
			"name": "The Block",
			"series_recording_id": "0",
			"show_id": "103307719",
			"start_time": "2012-04-29T05:30:00+00:00",
			"state": "waiting"
		},
 
--- truncated ---
 
	]
}

Get a specific keyword

URL	https://api.icetv.com.au/keywords/#
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/keywords/KEYWORD_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 keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
 
--- truncated ---
 
   <keyword id="18" match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" device_label="DEVICE1" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs and re-runs"  marked_for_deletion="0"/>
  <timer id="15783713959091372033" name="The Block" device_id="23" channel_id="4" show_id="103307719" start_time="2012-04-29T05:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="0" keyword_id="18"/>
 
--- truncated --- 
 
</keywords> 

JSON - Structure of the response

Name	Type	Description	Comment
shows	array	The shows that match the requested keyword	The show object contains a 'keyword_id'
keywords	array	The requested keywords
timers	array	All the timers created via the requested keyword

JSON - Example of response

{
	"keywords": [
		{
			"airing": "First runs and re-runs",
			"device_id": "23",
			"device_label": "DEVICE1",
			"id": "18",
			"marked_for_deletion": "0",
			"match_pattern": "title:\"the block\"",
			"matches_per_day": "0",
			"network_id": "-1",
			"recording_quality": "Prefer HD",
			"type": "Record"
		}
	],
	"shows": [
		{
			"category": [
				{
					"name": "Real Life"
				},
				{
					"name": "Renovation"
				}
			],
			"channel_id": "4",
			"country": "Australia",
			"date": "2003",
			"desc": "Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very,very) dirty. See how far they've got with that all-important first room. (Australia, English)",
			"episode-num": "",
			"episode_id": "136721",
			"icon": {
				"height": "1000",
				"src": "http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg",
				"width": "680"
			},
			"id": "103307719",
			"language": "English",
			"keyword_id": "18",
			"rating": "PG",
			"series_id": "26455",
			"star-rating": "",
			"start": "2012-04-29T05:30:00+00:00",
			"stop": "2012-04-29T06:00:00+00:00",
			"subtitle": "2012 - First Room Progress Review 27/04/12",
			"subtitles": {
				"onscreen": "English",
				"teletex": "YES"
			},
			"title": "The Block",
			"video": {
				"aspect": "16:9",
				"colour": "NO",
				"quality": "HDTV"
			}
		},
 
--- truncated ---
 
	],
	"timers": [
		{
			"action": "record",
			"channel_id": "4",
			"device_id": "23",
			"duration_minutes": "30",
			"id": "15783713959091372033",
			"keyword_id": "18",
			"message": "Scheduled to record by API",
			"name": "The Block",
			"series_recording_id": "0",
			"show_id": "103307719",
			"start_time": "2012-04-29T05:30:00+00:00",
			"state": "waiting"
		},
 
--- truncated ---
 
	]
}

Add a keyword recording or favourite

URL	https://api.icetv.com.au/keywords/
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

Request - URL

POST https://api.icetv.com.au/keywords?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN

XML - Example of request

<keywords>
	<keyword match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs only" />
</keywords>

XML - Example of response

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
 
--- truncated ---
 
   <keyword id="18" match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" device_label="DEVICE1" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs and re-runs"  marked_for_deletion="0"/>
  <timer id="15783713959091372033" name="The Block" device_id="23" channel_id="4" show_id="103307719" start_time="2012-04-29T05:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="0" keyword_id="18"/>
 
--- truncated --- 
 
</keywords> 

JSON - Structure of the request

Name	Type	Description	Comment
	table	The keyword to add	Only the match_pattern field and the device_id field are mandatory to add a keyword. All the other fields will get assigned default values if they are not specified.

JSON - Example of request

{
	"device_id": "23",
	"match_pattern": "the block",
	"matches_per_day": "0",
	"network_id": "-1",
	"recording_quality": "Prefer HD",
	"type": "Record"
}

JSON - Structure of the response

Name	Type	Description	Comment
shows	array	The shows that are a match for the just added keyword	If there is no match this array will be empty
keywords	array	The keyword that was just added	This keyword object will have an "id" that can be cached by the application or retrieved later
timers	array	The timers created for the just added keyword	If there is no match or if this is a "favourite keyword" this array will be empty

JSON - Example of response

{
	"keywords": [
		{
			"airing": "First runs and re-runs",
			"device_id": "23",
			"device_label": "DEVICE1",
			"id": "18",
			"marked_for_deletion": "0",
			"match_pattern": "the block",
			"matches_per_day": "0",
			"network_id": "-1",
			"recording_quality": "Prefer HD",
			"type": "Record"
		}
	],
	"shows": [
		{
			"category": [
				{
					"name": "Real Life"
				},
				{
					"name": "Renovation"
				}
			],
			"channel_id": "4",
			"country": "Australia",
			"date": "2003",
			"desc": "Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very,very) dirty. See how far they've got with that all-important first room. (Australia, English)",
			"episode_id": "136721",
			"icon": {
				"height": "1000",
				"src": "http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg",
				"width": "680"
			},
			"id": "103307719",
			"language": "English",
			"keyword_id": "18",
			"rating": "PG",
			"series_id": "26455",
			"star-rating": "",
			"start": "2012-04-29T05:30:00+00:00",
			"stop": "2012-04-29T06:00:00+00:00",
			"subtitle": "2012 - First Room Progress Review 27/04/12",
			"subtitles": {
				"onscreen": "English",
				"teletex": "YES"
			},
			"title": "The Block",
			"video": {
				"aspect": "16:9",
				"colour": "NO",
				"quality": "HDTV"
			}
		},
 
--- truncated ---
 
	],
	"timers": [
		{
			"action": "record",
			"channel_id": "4",
			"device_id": "23",
			"duration_minutes": "30",
			"id": "15783713959091372033",
			"keyword_id": "18",
			"message": "Scheduled to record by API",
			"name": "The Block",
			"series_recording_id": "0",
			"show_id": "103307719",
			"start_time": "2012-04-29T05:30:00+00:00",
			"state": "waiting"
		},
 
--- truncated ---
 
	]
}

Modify a keyword recording or favourite

URL	https://api.icetv.com.au/keywords/#
Method	PUT
Query String
Returns	200 OK
	401 Unauthorized
	404 Not Found
	406 Not Acceptable
	415 Unsupported Media Type
	503 Service Unavailable

A device_id must be included for a keyword recording, but is not required for the keyword favourite.

Request - URL

PUT https://api.icetv.com.au/keywords/KEYWORD_ID?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN

XML - Example of request

 <keywords>
	<keyword match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs only" />
</keywords>

XML Example of response

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
 
--- truncated ---
 
   <keyword id="18" match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" device_label="DEVICE1" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs and re-runs"  marked_for_deletion="0"/>
  <timer id="15783713959091372033" name="The Block" device_id="23" channel_id="4" show_id="103307719" start_time="2012-04-29T05:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="0" keyword_id="18"/>
 
--- truncated --- 
 
</keywords> 

JSON - Structure of the request

Name	Type	Description	Comment
-	table	The keyword you're modifying	Only the device_id is mandatory to do an edit. All the other fileds if not specified will be replaced by the default values. Make sure to give a value to the match_pattern

JSON - Example of request

{
	"airing": "First runs only",
	"device_id": "23",
    "device_label": "DEVICE1"
	"match_pattern": "title:\"the block\"",
	"matches_per_day": "0",
	"network_id": "-1",
	"recording_quality": "Prefer HD",
	"type": "Record"
}

JSON - Structure of the response

Name	Type	Description	Comment
shows	array	The shows that are a match for the just modified keyword	If there is no match this array will be empty
keywords	array	The keyword that was just modified	This keyword object will have an "id" that can be cached by the application or retrieved later
timers	array	The timers created for the just modified keyword	If there is no match or if this is a "favourite keyword" this array will be empty

JSON - Example of response

{
	"keywords": [
		{
			"airing": "First runs only",
			"device_id": "23",
			"device_label": "DEVICE1",
			"id": "18",
			"marked_for_deletion": "0",
			"match_pattern": "title:\"the block\"",
			"matches_per_day": "0",
			"network_id": "-1",
			"recording_quality": "Prefer HD",
			"type": "Record"
		}
	],
	"shows": [
		{
			"category": [
				{
					"name": "Real Life"
				},
				{
					"name": "Renovation"
				}
			],
			"channel_id": "4",
			"country": "Australia",
			"date": "2003",
			"desc": "Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very,very) dirty. See how far they've got with that all-important first room. (Australia, English)",
			"episode-num": "",
			"episode_id": "136721",
			"icon": {
				"height": "1000",
				"src": "http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg",
				"width": "680"
			},
			"id": "103307719",
			"language": "English",
			"keyword_id": "18",
			"previously-shown": {
				"channel_id": "",
				"start": ""
			},
			"rating": "PG",
			"series_id": "26455",
			"star-rating": "",
			"start": "2012-04-29T05:30:00+00:00",
			"stop": "2012-04-29T06:00:00+00:00",
			"subtitle": "2012 - First Room Progress Review 27/04/12",
			"subtitles": {
				"onscreen": "English",
				"teletex": "YES"
			},
 
			"title": "The Block",
			"video": {
				"aspect": "16:9",
				"colour": "NO",
				"quality": "HDTV"
			}
		},
 
--- truncated ---
 
	],
	"timers": [
		{
			"action": "record",
			"channel_id": "4",
			"device_id": "23",
			"duration_minutes": "30",
			"id": "15783713959091372033",
			"keyword_id": "18",
			"message": "Scheduled to record by API",
			"name": "The Block",
			"series_recording_id": "0",
			"show_id": "103307719",
			"start_time": "2012-04-29T05:30:00+00:00",
			"state": "waiting"
		},
 
--- truncated ---
 
	]
}

Deleting a keyword recording or favourite

URL	https://api.icetv.com.au/keywords/#
Method	DELETE
Query String
Returns	200 OK
	401 Unauthorized
	405 Method Not Allowed
	503 Service Unavailable

Request - URL

DELETE https://api.icetv.com.au/keywords/KEYWORD_ID?api_key=API_KEY&application_version=APPLICATION_VERSION&email_address=EMAIL_ADDRESS&token=TOKEN

Get all shows for a keyword recording or favourite

URL	https://api.icetv.com.au/keywords/#/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/keywords/KEYWORD_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 keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
</keywords> 

JSON - Structure of the response

Name	Type	Description	Comment
shows	array	The shows that are a match for the requested keyword	If the keyword has no match this array is empty

JSON - Example of response

{
	"shows": [
		{
			"channel_id": "4",
			"country": "Australia",
			"date": "2003",
			"desc": "Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very,very) dirty. See how far they've got with that all-important first room. (Australia, English)",
			"episode-num": "0",
			"episode_id": "136721",
			"icon": {
				"height": "1000",
				"src": "http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg",
				"width": "680"
			},
			"id": "103307719",
			"language": "English",
			"keyword_id": "18",
			"rating": "PG",
			"series_id": "26455",
			"start": "2012-04-29T05:30:00+00:00",
			"stop": "2012-04-29T06:00:00+00:00",
			"subtitle": "2012 - First Room Progress Review 27/04/12",
			"subtitles": {
				"onscreen": "English",
				"teletex": "YES"
			},
			"category": [
				{
					"name": "Real Life"
				},
				{
					"name": "Renovation"
				}
			],
			"title": "The Block",
			"video": {
				"aspect": "16:9",
				"colour": "NO",
				"quality": "HDTV"
			}
		},
 
--- truncated ---
	]
}

Get all timers for a keyword recording

URL	https://api.icetv.com.au/keywords/#/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/keywords/KEYWORD_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 keyword SYSTEM "http://iceguide.icetv.com.au/iceguide/keyword.dtd">
<keywords>
  <show id="103307719" series_id="26455" episode_id="136721" start="2012-04-29T05:30:00+00:00" stop="2012-04-29T06:00:00+00:00" channel_id="4" keyword_id="18">
    <title lang="en">The Block</title>
    <sub-title lang="en">2012 - First Room Progress Review 27/04/12</sub-title>
    <desc lang="en">Having been allotted to their houses and gone through the plans, it's time for the contestants to get down and (very, very) dirty. See how far they've got with that all-important first room. (Australia, English) </desc>
    <date>2003</date>
    <category lang="en">Real Life</category>
    <category lang="en">Renovation</category>
    <language lang="en">English</language>
    <country>Australia</country>
    <video>
      <aspect>16:9</aspect>
    </video>
    <previously-shown/>
    <subtitles type="teletext"/>
    <subtitles type="onscreen">
      <language lang="en">English</language>
    </subtitles>
    <rating>
      <value>PG</value>
    </rating>
    <icon src="http://images.icetv.com.au/ad28-3e6b-8d2f-7f6b.jpg" width="680" height="1000"/>
  </show>
 
--- truncated ---
 
   <keyword id="18" match_pattern="+title:&quot;the block&quot;" type="Record" device_id="23" device_label="DEVICE1" network_id="-1" recording_quality="Prefer HD" matches_per_day="0" airings="First runs and re-runs"  marked_for_deletion="0"/>
  <timer id="15783713959091372033" name="The Block" device_id="23" channel_id="4" show_id="103307719" start_time="2012-04-29T05:30:00+00:00" duration_minutes="30" action="record" state="waiting" message="Scheduled to record by API" series_recording_id="0" keyword_id="18"/>
 
--- truncated --- 
 
</keywords> 

JSON - Structure of the response

Name	Type	Description	Comment
timers	array	The timers that were created via the requested keyword	If there is no match or if this is a "favourite keyword" this array will be empty

JSON - Example of response

{
	"timers": [
		{
			"action": "record",
			"channel_id": "4",
			"device_id": "23",
			"duration_minutes": "30",
			"id": "15783713959091372033",
			"keyword_id": "18",
			"message": "Scheduled to record by API",
			"name": "The Block",
			"series_recording_id": "0",
			"show_id": "103307719",
			"start_time": "2012-04-29T05:30:00+00:00",
			"state": "waiting"
		},
 
--- truncated ---
 
	]
}