Channel Information
Countries
Use this API to obtain a list of all available countries supported by the Digiguide database.
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
{
"success": true,
"countries": [
{
"name": "United Kingdom",
},
{
"name": "Ireland",
}
]
}
Providers
Use this API to obtain a list of all available providers supported by the Digiguide database for the given country provided.
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
| country=<string> |
Valid country as returned from the "Countries" API |
Successful Response
{
"success": true,
"regions": [
{
"name": "Terrestrial",
},
{
"name": "Sky Digital",
},
{
"name": "Virgin Media",
}
]
}
Regions
Use this API to obtain a list of all available regions supported by the Digiguide database for the given country provided.
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
| country=<string> |
Valid country as returned from the "Countries" API |
Successful Response
{
"success": true,
"regions": [
{
"name": "Anglia",
},
{
"name": "London",
},
{
"name": "WestCountry",
}
]
}
Channels
Use this API to obtain or set a list of channels for the given authenticated user, or return a list of channels for the given country, provider and region.
If no user authentication provided, this end point will return a list of channels for specified country, provider and region.
If user authentication provided and a GET request is made, this end point will return a list of channels for the authenticated user.
If user authentication provided and a POST request is made, this end point will set a specified list of channels for the authenticated user.
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
| If user authentication provided AND GET request made... |
|
No additional required parameters |
| If user authentication provided AND POST request made... |
| channels=<string> |
Valid list of channel IDs separated by comma's in the order required by the customer |
| If no user authentication provided... |
| country=<string> |
Valid country name as returned by the "Countries" API |
| provider=<string> |
Valid channel provider name as returned by the "Providers" API |
| region=<string> |
Valid region name as returned by the "Region" API |
Optional Parameters
| If user authentication provided AND GET request made... |
| what=available |
When supplied will return the user's selected channels first, and then all others after (use the "selected" property to determine a selected user channel). This allows clients to easily list the selected channels and not break any custom sort order. |
Successful Response
{
"success": true,
"channels": [
{
"id": 51035,
"name": "BBC 1 HD",
"category": "Entertainment",
"epg": "143",
"shortName": "BBC1HD",
"selected": true
},
{
"id": 65,
"name": "Sky 1 HD",
"category": "Entertainment",
"epg": "106",
"shortName": "Sky1HD",
"selected": false
}
]
}
