Device Types (devices/types)
Device types are represented as objects with the following fields
|
Name |
Type |
Read Only |
Comment |
|
id |
integer |
yes |
The device type ID |
|
manufacturer_id |
integer |
yes |
The device type manufacturer's IceTV ID |
|
manufacturer_name |
string |
yes |
The device type manufacturer's name |
|
manufacturer_url |
string |
yes |
The device type manufacturer's URL |
|
model |
string |
yes |
The device type model name |
|
notes |
string |
yes |
Notes for the device, generally this is the full name and model of the device type |
|
visible |
integer |
yes |
1 = Yes, 0 = No |
|
can_have_device_sub |
string |
yes |
1 = Yes, 0 = No |
Get all device types
|
URL |
https://api.icetv.com.au/devices/types |
|
Method |
GET |
|
Query String |
|
|
Returns |
200 OK & Document (XML or JSON) |
|
|
404 Not Found |
|
|
503 Service Unavailable |
NOTE: As this information is required to be able to create a device during login, this node is not authenticated.
GET https://api.icetv.com.au/devices/types?api_key=API_KEY&application_version=APPLICATION_VERSION
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE devices SYSTEM "http://iceguide.icetv.com.au/iceguide/devices.dtd"><devices> <type id="2" manufacturer_id="2" manufacturer_name="Elgato" manufacturer_url="" model="EyeTV" notes="Elgato EyeTV" can_have_device_sub="0" /> <type id="4" manufacturer_id="4" manufacturer_name="Microsoft" manufacturer_url="" model="Windows XP MCE" notes="Microsoft Windows XP MCE" can_have_device_sub="0" /> <type id="5" manufacturer_id="6" manufacturer_name="Beyonwiz" manufacturer_url="" model="S1" notes="Beyonwiz S1" can_have_device_sub="0" />--- truncated --- <type id="19" manufacturer_id="10" manufacturer_name="Humax" manufacturer_url="" model="HDR 7500T" notes="Humax HDR 7500T" can_have_device_sub="1" /> <type id="20" manufacturer_id="11" manufacturer_name="Reycom" manufacturer_url="" model="Reycom" notes="Reycom R100" can_have_device_sub="1" /> <type id="21" manufacturer_id="9" manufacturer_name="Strong" manufacturer_url="" model="SRT 7000" notes="Strong SRT 7000" can_have_device_sub="0" /></devices>{ "types": [ { "id": 2, "manufacturer_id": 2, "manufacturer_name": "Elgato", "manufacturer_url": "", "model": "EyeTV", "notes": "Elgato EyeTV", "can_have_device_sub": 0 }, { "id": 4, "manufacturer_id": 4, "manufacturer_name": "Microsoft", "manufacturer_url": "", "model": "Windows XP MCE", "notes": "Microsoft Windows XP MCE", "can_have_device_sub": 0 }, { "id": 5, "manufacturer_id": 6, "manufacturer_name": "Beyonwiz", "manufacturer_url": "", "model": "S1", "notes": "Beyonwiz S1", "can_have_device_sub": 0 },--- truncated --- { "id": 19, "manufacturer_id": 10, "manufacturer_name": "Humax", "manufacturer_url": "", "model": "HDR 7500T", "notes": "Humax HDR 7500T", "can_have_device_sub": 1 }, { "id": 20, "manufacturer_id": 11, "manufacturer_name": "Reycom", "manufacturer_url": "", "model": "Reycom", "notes": "Reycom R100", "can_have_device_sub": 1 }, { "id": 21, "manufacturer_id": 9, "manufacturer_name": "Strong", "manufacturer_url": "", "model": "SRT 7000", "notes": "Strong SRT 7000", "can_have_device_sub": 0 } ]}Get a specific device type
|
URL |
https://api.icetv.com.au/devices/types/# |
|
Method |
GET |
|
Query String |
|
|
Returns |
200 OK & Document (XML or JSON) |
|
|
404 Not Found |
|
|
503 Service Unavailable |
GET https://api.icetv.com.au/devices/types/19?api_key=API_KEY&application_version=APPLICATION_VERSION
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE devices SYSTEM "http://iceguide.icetv.com.au/iceguide/devices.dtd"><devices> <type id="19" manufacturer_id="10" manufacturer_name="Humax" manufacturer_url="" model="HDR 7500T" notes="Humax HDR 7500T" can_have_device_sub="1" /></devices>{ "types": [ { "id": 19, "manufacturer_id": 10, "manufacturer_name": "Humax", "manufacturer_url": "", "model": "HDR 7500T", "notes": "Humax HDR 7500T", "can_have_device_sub": 1 } ]}