Bureaucrats, editor
1,487
edits
Changes
Jump to navigation
Jump to search
TVOpen Message Manager API Command - Client Software Upgrade (view source)
Revision as of 12:25, 30 April 2020
, 12:25, 30 April 2020Created page with "== URL STRUCTURE == <big>http://{host}:{port}/msg_mng/commands/client_software_upgrade</big> == HTTP METHOD == POST == PARAMETERS == {| class="wikitable" |- ! Name !! Descri..."
== URL STRUCTURE ==
<big>http://{host}:{port}/msg_mng/commands/client_software_upgrade</big>
== HTTP METHOD ==
POST
== PARAMETERS ==
{| class="wikitable"
|-
! Name !! Description !! Parameter !! Mandatory !! Type !! Format
|-
| colspan=6 align="center" | '''<big>[[TVOpen Message Manager API Common Parameters|Common Parameters]]</big>'''
|-
| custom_spread_time || Time value (in seconds) that STBs will use to randomly spread in time their dowload requests.<br>If this value is empty, it will be used the spreadTime value received from OPCH || Specific || false || int32|| integer
|-
| version || JSON with list of versions by STB model in string format<br><br>Sample for CDN HTTP Donwload:<br>[{"version_name":"2016.06.20.09.00.00","version_model":"VIP4242H"},<br>{"version_name":"2016.06.20.09.03.00","version_model":"VIP5262W"},<br>...<br>]<br><br>Force OPCH Download:<br>[{"version_name":"OPCH","version_model":"VIP4242H"},<br>...<br>] || Specific || false || string || string
|}
== RESPONSES ==
{| class="wikitable"
|-
! Code !! Summary !! Response !! Type !! Description
|-
| 200 || Object Response || status_code <br> message || int32 <br> string || Identifier that indicates the operation is correct (0) <br> Message description response
|-
| 400 || Unrecognized mandatory fields|| status_code <br> message || int32 <br> string || Error code from Message Manager <br> Error description response
|-
| 500 || Unexpected Error || status_code <br> message || int32 <br> string || Error code from Message Manager or destination server (Infopush/Sprayer) <br> Error description response
|}
== SAMPLE ==
=== Request ===
curl --data "instance_id=22&device_type=802&command_id=8asu0e12ke51b1jshjtel9er&start_time=2018-12-16T12:15:00Z&end_time=2018-12-18T12:18:00Z&target_type=stb_id&stb_id=0000124490&source_id=0&custom_spread_time=30&version=[{\"version_model\":\"VIP4242W\",\"version_name\":\"OPCH\"}]" http://localhost:8585/msg_mng/commands/client_software_upgrade
=== Response ===
{"status_code": 0, "message": "Operation successful. Info push message: Message inserted into database"}
<big>http://{host}:{port}/msg_mng/commands/client_software_upgrade</big>
== HTTP METHOD ==
POST
== PARAMETERS ==
{| class="wikitable"
|-
! Name !! Description !! Parameter !! Mandatory !! Type !! Format
|-
| colspan=6 align="center" | '''<big>[[TVOpen Message Manager API Common Parameters|Common Parameters]]</big>'''
|-
| custom_spread_time || Time value (in seconds) that STBs will use to randomly spread in time their dowload requests.<br>If this value is empty, it will be used the spreadTime value received from OPCH || Specific || false || int32|| integer
|-
| version || JSON with list of versions by STB model in string format<br><br>Sample for CDN HTTP Donwload:<br>[{"version_name":"2016.06.20.09.00.00","version_model":"VIP4242H"},<br>{"version_name":"2016.06.20.09.03.00","version_model":"VIP5262W"},<br>...<br>]<br><br>Force OPCH Download:<br>[{"version_name":"OPCH","version_model":"VIP4242H"},<br>...<br>] || Specific || false || string || string
|}
== RESPONSES ==
{| class="wikitable"
|-
! Code !! Summary !! Response !! Type !! Description
|-
| 200 || Object Response || status_code <br> message || int32 <br> string || Identifier that indicates the operation is correct (0) <br> Message description response
|-
| 400 || Unrecognized mandatory fields|| status_code <br> message || int32 <br> string || Error code from Message Manager <br> Error description response
|-
| 500 || Unexpected Error || status_code <br> message || int32 <br> string || Error code from Message Manager or destination server (Infopush/Sprayer) <br> Error description response
|}
== SAMPLE ==
=== Request ===
curl --data "instance_id=22&device_type=802&command_id=8asu0e12ke51b1jshjtel9er&start_time=2018-12-16T12:15:00Z&end_time=2018-12-18T12:18:00Z&target_type=stb_id&stb_id=0000124490&source_id=0&custom_spread_time=30&version=[{\"version_model\":\"VIP4242W\",\"version_name\":\"OPCH\"}]" http://localhost:8585/msg_mng/commands/client_software_upgrade
=== Response ===
{"status_code": 0, "message": "Operation successful. Info push message: Message inserted into database"}
