HTTP API - Query STK Info - Revision history

Administrator at 14:52, 5 May 2024

2024-05-05T14:52:41Z

← Older revision		Revision as of 14:52, 5 May 2024
Line 1:		Line 1:
	'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''		'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''

	Request Parameters:		'''Request Parameters:'''
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 14:		Line 14:
	\|}		\|}

	Response Parameters:		'''Response Parameters:'''
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''

Administrator at 14:46, 5 May 2024

2024-05-05T14:46:26Z

← Older revision		Revision as of 14:46, 5 May 2024
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}

Administrator at 14:37, 5 May 2024

2024-05-05T14:37:51Z

← Older revision		Revision as of 14:37, 5 May 2024
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}

Administrator at 14:37, 5 May 2024

2024-05-05T14:37:04Z

← Older revision		Revision as of 14:37, 5 May 2024
Line 1:		Line 1:
	'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''		'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''

	~~====~~ Request Parameters: ~~====~~		Request Parameters:
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 14:		Line 14:
	\|}		\|}

	~~====~~ Response Parameters: ~~====~~		Response Parameters:
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
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}

Administrator at 14:33, 5 May 2024

2024-05-05T14:33:54Z

← Older revision		Revision as of 14:33, 5 May 2024
Line 49:		Line 49:
	\|Integer		\|Integer
	\|The frame id of current STK view		\|The frame id of current STK view
	\|}		\|-


	~~{\| class="wikitable"~~
	\|item		\|item
	\|Object		\|Object
Line 63:		Line 60:
	\|Item .item_string		\|Item .item_string
	\|String		\|String
	\|The name of item		\|The name of item.
	\|}		\|}

	~~==== 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}

Administrator at 12:50, 5 May 2024

2024-05-05T12:50:22Z

← Older revision		Revision as of 12:50, 5 May 2024
Line 1:		Line 1:
	~~==== 9.1 Request ====~~
	'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''		'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''

	==== ~~9.2~~ Request Parameters ====		==== Request Parameters: ====
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 15:		Line 14:
	\|}		\|}

	==== ~~9.3~~ Response ~~Parameter~~ ====		==== Response Parameters: ====
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 67:		Line 66:
	\|}		\|}

	==== ~~9.4~~ 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}

Administrator: Created page with "==== 9.1 Request ==== '''GET https://gateway_ip/GetSTKView''' ==== 9.2 Request Parameters ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Integer | |} ==== 9.3 Response Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- |title |String |The title of STK |- |text |String |The content of prompt during th..."

2024-05-02T22:29:03Z

Created page with "==== 9.1 Request ==== '''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>''' ==== 9.2 Request Parameters ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Integer | |} ==== 9.3 Response Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- |title |String |The title of STK |- |text |String |The content of prompt during th..."

New page

==== 9.1 Request ====
'''GET <nowiki>https://gateway_ip/GetSTKView</nowiki>'''

==== 9.2 Request Parameters ====
{| class="wikitable"
|'''Parameter'''
|'''Type'''
|'''Description'''
|-
| colspan="3" |'''Required Parameter'''
|-
|port
|Integer
|
|}

==== 9.3 Response Parameter ====
{| class="wikitable"
|'''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
|}

{| class="wikitable"
|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
|}

==== 9.4 Example of Querying STK Info ====

====== Request: ======
<nowiki>http://gateway_ip/GetSTKView?port=0</nowiki>

====== 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}