HTTP API - Query STK Info: Difference between revisions
Jump to navigation
Jump to search
No edit summary Tag: 2017 source edit |
No edit summary Tag: 2017 source edit |
||
Line 64: | Line 64: | ||
'''Example of Querying STK Info:''' | '''Example of Querying STK Info:''' | ||
Request: | '''Request:''' | ||
<nowiki>http://gateway_ip/GetSTKView?port=0</nowiki> | <nowiki>http://gateway_ip/GetSTKView?port=0</nowiki> | ||
Response: | '''Response:''' | ||
{"title":"神州行天地 ","item":[{"item_id":1,"item_string":"item1_text"},{"item_id": 2,"item_string":"itme2_text"},{"item_id":3,"item_string":"item 3_text"}],"input_type":"2,"frame_id":750} | {"title":"神州行天地 ","item":[{"item_id":1,"item_string":"item1_text"},{"item_id": 2,"item_string":"itme2_text"},{"item_id":3,"item_string":"item 3_text"}],"input_type":"2,"frame_id":750} |
Revision as of 14:37, 5 May 2024
GET https://gateway_ip/GetSTKView
Request Parameters:
Parameter | Type | Description |
Required Parameter | ||
port | Integer |
Response Parameters:
Parameter | Type | Description |
title | String | The title of STK |
text | String | The content of prompt during the query of STK information |
input_type | Integer | 0: display only
1: desktop 2: select item 3. require "yes" or "no" response 4: require one digit input 5: require one character input 8: require input of only digit(s) 9: require input of digit(s) without echo 10: require input of character(s) 11: require input of character(s) without echo 12: locked status |
frame_id | Integer | The frame id of current STK view |
item | Object | It is included only when input_type is 1 or 2 |
Item. item_id | Integer | The id of item |
Item .item_string | String | The name of item. |
Example of Querying STK Info: Request: http://gateway_ip/GetSTKView?port=0 Response: {"title":"神州行天地 ","item":[{"item_id":1,"item_string":"item1_text"},{"item_id": 2,"item_string":"itme2_text"},{"item_id":3,"item_string":"item 3_text"}],"input_type":"2,"frame_id":750}