Bureaucrats, editor
1,487
edits
Changes
Jump to navigation
Jump to search
TVOpen Message Manager API Command - Get Variable (view source)
Revision as of 12:37, 30 April 2020
, 12:37, 30 April 2020Created page with "== URL STRUCTURE == <big>http://{host}:{port}/msg_mng/commands/get_variable</big> == HTTP METHOD == POST == PARAMETERS == {| class="wikitable" |- ! Name !! Description !! Pa..."
== URL STRUCTURE ==
<big>http://{host}:{port}/msg_mng/commands/get_variable</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>'''
|-
| variable || Name of local variable || Specific || true || string || string
|-
| scope || Variable scope || Specific || true || string || - remote<br>- local
|}
== 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=25&device_type=802&command_id=inh70eozkjxpw7jsqjtel9er&start_time=2017-01-03T12:10:00Z&end_time=2017-01-03T12:18:00Z&target_type=stb_id&stb_id=keke&source_id=0&variable=OPCH/VideoFormat&scope=local" http://localhost:8585/msg_mng/commands/get_variable
=== Response ===
{"status_code": 0, "message": "Operation successful. Info push message: Message inserted into database"}
<big>http://{host}:{port}/msg_mng/commands/get_variable</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>'''
|-
| variable || Name of local variable || Specific || true || string || string
|-
| scope || Variable scope || Specific || true || string || - remote<br>- local
|}
== 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=25&device_type=802&command_id=inh70eozkjxpw7jsqjtel9er&start_time=2017-01-03T12:10:00Z&end_time=2017-01-03T12:18:00Z&target_type=stb_id&stb_id=keke&source_id=0&variable=OPCH/VideoFormat&scope=local" http://localhost:8585/msg_mng/commands/get_variable
=== Response ===
{"status_code": 0, "message": "Operation successful. Info push message: Message inserted into database"}
