TVOpen Message Manager API Command - Get Variable

From Gvp-public
Jump to navigation Jump to search

URL STRUCTURE

http://{host}:{port}/msg_mng/commands/get_variable

HTTP METHOD

POST

PARAMETERS

Name Description Parameter Mandatory Type Format
Common Parameters
variable Name of local variable Specific true string string
scope Variable scope Specific true string - remote
- local

RESPONSES

Code Summary Response Type Description
200 Object Response status_code
message
int32
string
Identifier that indicates the operation is correct (0)
Message description response
400 Unrecognized mandatory fields status_code
message
int32
string
Error code from Message Manager
Error description response
500 Unexpected Error status_code
message
int32
string
Error code from Message Manager or destination server (Infopush/Sprayer)
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"}