HTTP API - Query STK Frame ID: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
(Created page with "==== 9.1         Request ==== '''GET <nowiki>https://gateway_ip/GetSTKCurrFrameIndex</nowiki>''' ==== 9.2         Request Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Integer | |} ==== 9.3         Response Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- |frame_id |Integer | |} ==== 9.4         Example of Querying Frame I...")
 
No edit summary
Line 1: Line 1:
==== 9.1         Request ====
'''GET <nowiki>https://gateway_ip/GetSTKCurrFrameIndex</nowiki>'''
'''GET <nowiki>https://gateway_ip/GetSTKCurrFrameIndex</nowiki>'''


==== 9.2         Request Parameter ====
===== Request Parameters: =====
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 13: Line 12:
|Integer
|Integer
|
|
|}  
|}


==== 9.3         Response Parameter ====  
===== Response Parameters: =====
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 26: Line 25:
|}  
|}  


==== 9.4         Example of Querying Frame ID ====
==== Example of Querying Frame ID: ====


====== Request: ======
====== Request: ======
<nowiki>https://gateway_ip/GetSTKCurrFrameIndex?port=0</nowiki>  
<nowiki>https://gateway_ip/GetSTKCurrFrameIndex?port=0</nowiki>
 
 
====== Response: ======
====== Response: ======
{"frame_id":32}
{"frame_id":32}

Revision as of 14:55, 5 May 2024

GET https://gateway_ip/GetSTKCurrFrameIndex

Request Parameters:
Parameter Type Description
Required Parameter
port Integer
Response Parameters:
Parameter Type Description
frame_id Integer

Example of Querying Frame ID:

Request:

https://gateway_ip/GetSTKCurrFrameIndex?port=0

Response:

{"frame_id":32}