management function
root document
- management function
- confirm
- get_accaunt_info
- get_favorites_tv
- get_options
- get_settings
- set
- set_favorites_tv
- set_options
confirm
Query
/confirm?sid=<sid>&answer=<answer>&id=<id>
Require parameters
| answer | 0(no) or 1(Yes) |
| id | ID of error confirm ([error][confirm_id]) |
Description
command message with the error confirm(see errors)
Return section
| OK | message if everything is in order |
get_account_info
Query
/get_account_info?sid=<sid>
Description
Returns are stored on the server characteristics of client account
package type
1 Primary(Basic)
2 Promotional(Bonus)
3 Dealerships(Dealers)
4 Free(Free)
5 Developer(Developer)
6 Additional(Additional)
package type
1 Primary(Basic)
2 Promotional(Bonus)
3 Dealerships(Dealers)
4 Free(Free)
5 Developer(Developer)
6 Additional(Additional)
Return section
| id | the contract Number (account) of the client |
| title | this contract (the account) of the client |
| balance | Condition “of wallet” (the amount in your wallet) |
| acc_level | the Status of an account:0 - the admin/tester, 2 - basic client 3-demo-client |
| Preaching | subscriptions active subscriptions of a client |
| title | the brightness of the image on the box (0..100) |
| contents_type | content Type subscription: 0 – random, 1 – TV, 2 - radio |
| continuous | Auto-renewable subscription (0 | 1) |
| begin_date | beginning date of the subscription (in timezone UTC+01 DST) |
| end_date | the end date of your subscription (in timezone UTC+01 DST) |
| rest_of_days | the Number of days remaining until the end of your subscription |
| type_id the type ID of the package | |
| type_ru | package type RU |
| type_en | package type EN |
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><id>26</id><title>client
1</title><balance>160.2000</balance><acc_level>0</acc_level><subscriptions><item><title>подписка
1</title><contents_type>0</contents_type><continuous>1</continuous><begin_date>2011-03-07</begin_date><end_date>2011-03-18</end_date><rest_of_days>11</rest_of_days></item></subscriptions></response>
get_account_info
Query
/get_account_info?sid=<sid>
Description
Returns are stored on the server characteristics of client account
package type
1 Primary(Basic)
2 Promotional(Bonus)
3 Dealerships(Dealers)
4 Free(Free)
5 Developer(Developer)
6 Additional(Additional)
package type
1 Primary(Basic)
2 Promotional(Bonus)
3 Dealerships(Dealers)
4 Free(Free)
5 Developer(Developer)
6 Additional(Additional)
Return section
| id | the contract Number (account) of the client |
| title | this contract (the account) of the client |
| balance | Condition “of wallet” (the amount in your wallet) |
| acc_level | the Status of an account:0 - the admin/tester, 2 - basic client 3-demo-client |
| Preaching | subscriptions active subscriptions of a client |
| title | the brightness of the image on the box (0..100) |
| contents_type | content Type subscription: 0 – random, 1 – TV, 2 - radio |
| continuous | Auto-renewable subscription (0 | 1) |
| begin_date | beginning date of the subscription (in timezone UTC+01 DST) |
| end_date | the end date of your subscription (in timezone UTC+01 DST) |
| rest_of_days | the Number of days remaining until the end of your subscription |
| type_id the type ID of the package | |
| type_ru | package type RU |
| type_en | package type EN |
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><id>26</id><title>client
1</title><balance>160.2000</balance><acc_level>0</acc_level><subscriptions><item><title>подписка
1</title><contents_type>0</contents_type><continuous>1</continuous><begin_date>2011-03-07</begin_date><end_date>2011-03-18</end_date><rest_of_days>11</rest_of_days></item></subscriptions></response>
get_favorites_tv
Query
/get_favorites_tv?sid=<sid>
Description
Returns are stored on the server an ordered list of favorite channels of the client
Return section
| favorites | the String ID of TV channels sorted in order of preference |
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><favorites>11,33,56,180</favorites><servertime>1292870500</servertime></response>
get_options
Query
/get_options?sid=<sid>
Description
Returns its settings in json format , size limited to 4kb.
Be courteous to other programs that can save your settings here too.
Be courteous to other programs that can save your settings here too.
Answer
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response>
<options>{"size":12}</options>
<servertime>1372156094</servertime>
</response>
<options>{"size":12}</options>
<servertime>1372156094</servertime>
</response>
get_settings
Query
/get_settings?sid=<sid>
Description
Returns are stored on the server client settings
Return section
| time_zone | contains the time zone of the client (minutes, (-12 ... 12) * 60) |
| time_shift | time Shift of the broadcasting (hours, positive integer (0... 24) ) |
| interface_lng | the interface Language (two letter code: 'ru','ua') |
| parental_pass | Parental password (8 characters, preferably numbers only) |
| stb_volume | the Volume on the box (0..100) |
| media_server_id | the broadcasting Server |
| stb_bright | the brightness of the image on the box (0..100) |
| media_servers | the broadcast Server are available for selection by the customer |
| stb_contrast | the Contrast of the image on the box (0..100) |
| stb_saturation | Color saturation on the box (0..100) |
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><time_zone>180</time_zone><time_shift>0</time_shift><interface_lng>ua</interface_lng><parental_pass>12345</parental_pass><stb_volume>100</stb_volume><stb_bright>100</stb_bright><stb_contrast>90</stb_contrast><stb_saturation>90</stb_saturation><media_servers><item><id>0</id><title>Авто
(Main
Server)</title></item></media_servers><servertime>1292870500</servertime></response>
set
Query
/set?sid=<sid>&var=<var>&val=<val>&protect_code=<protect_code>
/set?sid=<sid>&var=<var1>,<var2>,<var3>&val=<val1>,<val2>,<val3>&protect_code=<protect_code>
Other parameters
| var | (var1, var2...)-the parameter Name: • time_zone contains the time zone of the client in minutes,( (-12 ... +12)*60) • time_shift - shift of the broadcasting back in time (hours, positive value (0...24)) • interface_lng - language (two letter code: 'ru','ua') • parental_pass - parent password (8 characters, preferably only numbers, MUST NOT BE EMPTY) • media_server_id – broadcasting server • stb_volume - sound volume on the box (0..100) • stb_bright - the brightness of the image on the box (0..100) • stb_contrast - contrast image on the box (0..100) • stb_saturation - color saturation on the box (0..100) |
| val | (val1, val2...) the New parameter value |
| protect_code | the Old value of the parent password (parental_pass). Optional parameter. Only needed when you change the parental password. In this case, even if it is empty. (/set?var=parental_pass&val=.......) |
Description
Sets stored on the CAS server settings specified values.
The answer is similar to answer a call to a function get_settings.
The answer is similar to answer a call to a function get_settings.
Return section
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><time_zone>180</time_zone><time_shift>0</time_shift><interface_lng>ua</interface_lng><parental_pass>12345</parental_pass><media_server_id>0</media_server_id><stb_volume>100</stb_volume><stb_bright>100</stb_bright><stb_contrast>90</stb_contrast><stb_saturation>90</stb_saturation><media_servers></media_servers><servertime>1292870500</servertime></response>
set_favorites_tv
Query
/set_favorites_tv?sid=<sid>&val=11,24,55,66
Require parameters
| val | 11,24,55,66 the channel ID with a comma |
Description
The server maintains an ordered list of favorite channels of the client
Return section
| favorites | the String ID of TV channels sorted in order of preference |
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><favorites>11,24,55,66</favorites><servertime>1375132749</servertime></response>
set_options
Query
/set_options?sid=<sid>&val={"size":2}
Description
To save your settings, only in json format.
The maximum size of 4kb.
The maximum size of 4kb.
Answer
<?xml
version="1.0" encoding="UTF-8"
standalone="yes"?><response><servertime>1375132211</servertime></response>
в Израиле
в США
в Канаде
