Regions (regions)

Regions are represented as objects with the following fields (NOTE: All fields are read-only).

Name	Type	Comment
id	integer	The region's ID
name	string	The region's name
city	string	The city the region is based from
state	string	The state the region is in
country	string	The country the region is in
timezone	string	The timezone for the region (can also be provided as POSIX timezone string, email IceTV for details)

Regions (regions)
- Get all regions
  - JSON - Structure of the response
- Get a specific region
  - JSON - Structure of the response

The regions "Node" covers all region information and includes facilities for channels and DVB information.

The regions "Node" is the only node that can be accessed without authentication as it is required to gather region id's to use when creating accounts.

URL	Description
regions	Retrieve a list of all EPG regions
regions/ID	Retrieve a specific region
regions/channels	Retrieve a list of all channels in all regions
regions/ID/channels	Retrieve a list of channels for the selected region

Get all regions

URL	https://api.icetv.com.au/regions
Method	GET
Query String
Returns	200 OK & Document (XML or JSON)
	404 Not Found
	503 Service Unavailable

Request - URL

GET https://api.icetv.com.au/regions?api_key=API_KEY&application_version=APPLICATION_VERSION

XML - Example of response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE regions SYSTEM "http://iceguide.icetv.com.au/iceguide/regions.dtd">
<regions">
  <region id="1" name="NSW - Sydney" city="Sydney" state="NSW" country="Australia" timezone="Australia/Sydney" />
 
--- truncated ---
   
  <region id="49" name="QLD - Wide Bay" city="Wide Bay" state="QLD" country="Australia" timezone="Australia/Brisbane" />
</regions>

JSON - Structure of the response

Name	Type	Description
regions	array	All the regions info

JSON - Example of response

{
    "regions": [
        {
            "id":1,
			"name":"NSW - Sydney",
			"city":"Sydney",
			"state":"NSW",
			"country":"Australia",
			"timezone":"Australia/Sydney"
        },
 
--- truncated ---
    
        {
            "id":49,
			"name":"QLD - Wide Bay",
			"city":"Wide Bay",
			"state":"QLD",
			"country":"Australia",
			"timezone":"Australia/Brisbane"
        }
    ]
}  

Get a specific region

URL	https://api.icetv.com.au/regions/#
Method	GET
Query String
Returns	200 OK & Document (XML or JSON)
	404 Not Found
	503 Service Unavailable

Request - URL

GET https://api.icetv.com.au/regions/REGION_ID?api_key=API_KEY&application_version=APPLICATION_VERSION

XML - Example of response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE regions SYSTEM "http://iceguide.icetv.com.au/iceguide/regions.dtd">
<regions">
  <region id="1" name="NSW - Sydney" city="Sydney" state="NSW" country="Australia" timezone="Australia/Sydney" />
</regions>

JSON - Structure of the response

Name	Type	Description
regions	array	The requested region info

JSON - Example of response

{
	"regions": [
		{
			"id":1,
			"name":"NSW - Sydney",
			"city":"Sydney",
			"state":"NSW",
			"country":"Australia",
			"timezone":"Australia/Sydney"
		}
	]
}