HTTP API - Query STK Info

From Ultiroam User Docs
Revision as of 22:29, 2 May 2024 by Administrator (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

9.1         Request

GET https://gateway_ip/GetSTKView

9.2         Request Parameters

Parameter Type Description
Required Parameter
port Integer

9.3         Response Parameter

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

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