Responses are wrapped in a simple REST block. A successful request will return:
<?xml version="1.0" encoding="utf-8" ?> <rsp stat="ok"> [xml-payload-here] </rsp>If an error occurs, the following is returned:
<?xml version="1.0" encoding="utf-8" ?> <rsp stat="fail"> <err code="[error-code]" msg="[error-message]" /> </rsp>HTML transform information is provided through an XSL file and is linked in the XML file header:
<xml-css/docheet title="XSL_formatting" type="text/xsl" href="format.xsl"?>
The response format of methods can be specified using the format parameter.
simple
(default) Responses are formatted as simple XML
tvanytime
Responses are formatted as TV-Anytime compliant XML where appropriate
Please note: the TV-Anytime standard specifies parameters which do not match those specified in this API:
| API input and simple response | TV-Anytime response | Description |
| programme_id | programId | Programme identifier |
| channel_id | serviceId | Channel identifier |
| genre_id | reference | Genre identifier |
| group_id | groupId | Group identifier |
Unfortunately things don't always work out the way you hope. We have defined a short list of error codes which may be thrown by the API.
| Code | Description |
| 1 | programme_id "xxx" not found |
| 2 | channel_id "xxx" not found |
| 3 | genre_id "xxx" not found |
| 4 | group_id "xxx" not found |
| 105 | Sorry, service currently unavailable |
| 111 | format "xxx" not found |
| 112 | Method "xxx" not found |
| 113 | detail "xxx" not found |
| 150 | Required argument "xxx" not found |
| 151 | date malformed |
