Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/05/06 11:44
From version 26.1
edited by Devin Chen
on 2025/05/06 11:44
Change comment: There is no comment for this version
To version 2.1
edited by Leo Wei
on 2022/06/16 16:22
Change comment: Renamed from xwiki:V-BOX.V-Net.1\.User Manual.V-BOX HTTP manual.WebHome

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -07 HTTP API
1 +05 V-BOX HTTP manual
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.Manual.WebHome
1 +V-BOX.V-Net.1\.User Manual.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.DevinChen
1 +XWiki.admin
Content
... ... @@ -1,4 +1,4 @@
1 -= **General** =
1 += **1 General** =
2 2  
3 3  This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
4 4  
... ... @@ -19,7 +19,7 @@
19 19  [[http:~~/~~/api.eu.v-box.net>>url:http://api.v-box.net/]]
20 20  
21 21  (% style="text-align:center" %)
22 -[[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||height="361" width="800" class="img-thumbnail"]]
22 +[[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||class="img-thumbnail" height="361" width="800"]]
23 23  
24 24  For **ASEAN server** V-BOX, now can use http, the server address is api.asean.v-box.net.
25 25  
... ... @@ -43,19 +43,14 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
46 -(% class="box infomessage" %)
47 -(((
48 -**✎Note:** If it is for Virtual Deployment, the comid and comkey would not be the same with values above. Try to get the actual value from HTTP access (V-NET~-~-Services~-~-HTTP access)
49 -)))
46 +== 1.1 Interface parameter description ==
50 50  
51 -== **Interface Parameter Description** ==
52 -
53 53  **Global parameters**
54 54  
55 55  The following acturls need to have global parameters (The global parameter client is put into the JSON format and placed in the common parameters of the Headers)
56 56  
57 57  (% style="text-align:center" %)
58 -[[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
53 +[[image:企业微信截图_20210531172144.png||class="img-thumbnail" height="467" width="800"]]
59 59  
60 60  **The returned result represented by Json and case sensitive:**
61 61  
... ... @@ -67,12 +67,12 @@
67 67  
68 68  {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
69 69  
70 -**Status Code**
65 +**State code description**
71 71  
72 72  (% style="text-align:center" %)
73 -[[image:1.png||height="141" width="500" class="img-thumbnail"]]
68 +[[image:1.png||class="img-thumbnail" height="141" width="500"]]
74 74  
75 -== **Example key and value** ==
70 +== **1.2 Example key and value** ==
76 76  
77 77  1).**comid**=2
78 78  
... ... @@ -83,67 +83,56 @@
83 83  4).**ts**=1573897380
84 84  
85 85  (((
86 -= **Basic API** =
81 += **2 Basic API** =
87 87  )))
88 88  
89 -== **{{id name="_Toc24963726"/}}Login operation** ==
84 +== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
90 90  
91 91  (((
92 92  **2.1.1 Parameters**
93 93  )))
94 94  
95 -(% class="table-bordered" style="width:888px" %)
96 -|**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
97 -|**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
98 -|(% colspan="1" rowspan="4" %)**Parameters**|Items|(% style="width:535px" %)Description
99 -|alias|(% style="width:535px" %)Must be username, registered email will fail to login
100 -|password|(% style="width:535px" %)32bit password (MD5 encryption)
101 -|domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
102 -|(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
103 -|utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
104 -|sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
90 +(% class="table-bordered" %)
91 +|**Acturl**|(% colspan="2" %)we-data/login
92 +|**Function**|(% colspan="2" %)Login with username, email, phone number
93 +|(% rowspan="3" %)**Parameters**|Items|Description
94 +|alias|Username, email, phone number
95 +|password|Password (Encrypted with md5)
96 +|(% rowspan="3" %)**Return value**|Items|Description
97 +|utype|User Type: 1-Manage Account, 2-Viewer Account
98 +|sid|User session ID
105 105  
106 -**Operating procedures**
100 +**2.1.2 Operating procedures**
107 107  
108 108  **Setp1: ** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/login>>url:http://api.v-box.net/box-data/api/we-data/login]]
109 109  
110 110  (% style="text-align:center" %)
111 -[[image:V-BOX HTTP manual_html_78fa6b0e5f03b2f2.png||height="63" width="800" class="img-thumbnail"]]
105 +[[image:V-BOX HTTP manual_html_78fa6b0e5f03b2f2.png||class="img-thumbnail" height="63" width="800"]]
112 112  
113 113  **Setp2: ** Set parameters on Params
114 114  
115 115   alias: weconuser
116 116  
117 - password: 599a3c736c04e196c58a29f43778f7ea(The md5 encryption result of Wecon159)
111 + password: 599a3c736c04e196c58a29f43778f7ea(Wecon159)
118 118  
119 119  (% style="text-align:center" %)
120 -[[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
114 +[[image:V-BOX HTTP manual_html_563261d83c8f3530.png||class="img-thumbnail" height="250" width="700"]]
121 121  
122 122  **Step3:**  Get sign
123 123  
124 124  alias=weconuser&comid=2&compvtkey=589625dce895454dbff9782c299db156&password=599a3c736c04e196c58a29f43778f7ea&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
125 125  
126 -Put the whole string above encrypted by MD5, so will get the value of "sign"
120 +MD5 value: 997513ff1320862f0cbb9ce19d0bd253
127 127  
128 -"sign":"997513ff1320862f0cbb9ce19d0bd253"
129 -
130 -{{info}}
131 -**✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
132 -
133 -alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
134 -
135 -The timestamp must be unit as Millisecond level
136 -{{/info}}
137 -
138 138  **Step4: ** Set common of header
139 139  
140 140  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
141 141  
142 142  (% style="text-align:center" %)
143 -[[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
127 +[[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||class="img-thumbnail" height="230" width="700"]]
144 144  
145 145  (((
146 -**Result**
130 +**2.1.3 Result**
147 147  )))
148 148  
149 149  {
... ... @@ -167,25 +167,25 @@
167 167  }
168 168  
169 169  (% style="text-align:center" %)
170 -[[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
154 +[[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||class="img-thumbnail" height="291" width="500"]]
171 171  
172 172  (((
173 -= **Service data APIs** =
157 += **3 Service data APIs** =
174 174  )))
175 175  
176 -== **V-Box list** ==
160 +== **3.1 V-Box list** ==
177 177  
178 -**{{id name="_Toc24963732"/}}Parameters**
162 +**3.1.1 {{id name="_Toc24963732"/}}Parameters**
179 179  
180 180  (% style="text-align:center" %)
181 -[[image:X.png||height="412" width="700" class="img-thumbnail"]]
165 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
182 182  
183 -**~ {{id name="_Toc24963733"/}}Operating procedures**
167 +**3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
184 184  
185 185  **Step1:**  Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/boxs>>url:http://api.v-box.net/box-data/api/we-data/boxs]]
186 186  
187 187  (% style="text-align:center" %)
188 -[[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
172 +[[image:V-BOX HTTP manual_html_7555868f6d398292.png||class="img-thumbnail" height="48" width="700"]]
189 189  
190 190  **Step2:**  Set parameters on Params
191 191  
... ... @@ -202,9 +202,9 @@
202 202  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
203 203  
204 204  (% style="text-align:center" %)
205 -[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
189 +[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||class="img-thumbnail" height="232" width="700"]]
206 206  
207 -**Result**
191 +**3.1.3 Result**
208 208  
209 209  {
210 210  
... ... @@ -331,11 +331,11 @@
331 331  }
332 332  
333 333  (% style="text-align:center" %)
334 -[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
318 +[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||class="img-thumbnail" height="348" width="600"]]
335 335  
336 -== **Real-time group list** ==
320 +== **3.2 Real-time group list** ==
337 337  
338 -**{{id name="_Toc24963736"/}} Parameters**
322 +**3.2.1{{id name="_Toc24963736"/}} Parameters**
339 339  
340 340  (% class="table-bordered" %)
341 341  |**acturl**|(% colspan="3" %)we-data/realgroups
... ... @@ -347,12 +347,12 @@
347 347  |groupId|Group ID
348 348  |groupName|Group name
349 349  
350 -**Operating procedures**
334 +**3.2.2 Operating procedures**
351 351  
352 352  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realgroups>>url:http://api.v-box.net/box-data/api/we-data/realgroups]]
353 353  
354 354  (% style="text-align:center" %)
355 -[[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
339 +[[image:V-BOX HTTP manual_html_abb2159981171c6.png||class="img-thumbnail" height="46" width="700"]]
356 356  
357 357  **Step2: **Set parameters on Params
358 358  
... ... @@ -359,7 +359,7 @@
359 359  "boxId": "973"
360 360  
361 361  (% style="text-align:center" %)
362 -[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
346 +[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||class="img-thumbnail" height="151" width="800"]]
363 363  
364 364  **Step3: **Get sign
365 365  
... ... @@ -372,9 +372,9 @@
372 372  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
373 373  
374 374  (% style="text-align:center" %)
375 -[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
359 +[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||class="img-thumbnail" height="172" width="800"]]
376 376  
377 -**Result**
361 +**3.2.3 Result**
378 378  
379 379  {
380 380  
... ... @@ -420,19 +420,18 @@
420 420  
421 421  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422 422  
423 -== **Real-time tags configuration list** ==
407 +== **3.3 Real-time tags configuration list** ==
424 424  
425 -**Parameters**
409 +**3.3.1 Parameters**
426 426  
427 427  (% class="table-bordered" %)
428 428  |**acturl**|(% colspan="3" %)we-data/realcfgs
429 429  |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
430 -|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
414 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 431  |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 432  |groupId|(% colspan="2" %)Group ID (Required)
433 433  |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 434  |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
436 436  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
437 437  |(% rowspan="11" %)cfgList|monitorId|Tags ID
438 438  |monitorName|Tags name
... ... @@ -465,12 +465,12 @@
465 465  |totalRecord|(% colspan="2" %)Total record number
466 466  |currentPage|(% colspan="2" %)Current page number
467 467  
468 -**Operating procedures**
451 +**3.3.2 Operating procedures**
469 469  
470 470  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realcfgs>>url:http://api.v-box.net/box-data/api/we-data/realcfgs]]
471 471  
472 472  (% style="text-align:center" %)
473 -[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
456 +[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||class="img-thumbnail" height="44" width="700"]]
474 474  
475 475  **Step2: **Set parameters on Params
476 476  
... ... @@ -483,7 +483,7 @@
483 483  "pageIndex":"2"
484 484  
485 485  (% style="text-align:center" %)
486 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
469 +[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||class="img-thumbnail" height="273" width="700"]]
487 487  
488 488  **Step3:** Get sign
489 489  
... ... @@ -496,9 +496,9 @@
496 496  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
497 497  
498 498  (% style="text-align:center" %)
499 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
482 +[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||class="img-thumbnail" height="288" width="800"]]
500 500  
501 -**Result**
484 +**3.3.3 Result**
502 502  
503 503  {
504 504  
... ... @@ -579,25 +579,20 @@
579 579  }
580 580  
581 581  (% style="text-align:center" %)
582 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
565 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||class="img-thumbnail" height="644" width="800"]]
583 583  
584 -== **Tags data list** ==
567 +== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
585 585  
586 -{{warning}}
587 -This API is not for getting the real-time data all the time.If you need to get the continuously updated real-time monitoring point data values,you need to use **[[Send switch to device>>https://docs.we-con.com.cn/bin/view/V-BOX/V-Net/Manual/6%20HTTP%20API/#HSendswitchtodevice]] **API with this API
588 -{{/warning}}
569 +**3.4.1 {{id name="_Toc24963744"/}}Parameters**
589 589  
590 -**~ {{id name="_Toc24963744"/}}Parameters**
591 -
592 592  (% class="table-bordered" %)
593 593  |**acturl**|(% colspan="3" %)we-data/realdata
594 594  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
595 -|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
574 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
596 596  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
597 597  |groupId|(% colspan="2" %)Group ID (Required)
598 598  |pageSize|(% colspan="2" %)Number of each page, 10 by default
599 599  |pageIndex|(% colspan="2" %)Number of current page, start from 1
600 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
601 601  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
602 602  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
603 603  |com|Communication port ID
... ... @@ -610,12 +610,12 @@
610 610  |totalRecord|(% colspan="2" %)Total record
611 611  |currentPage|(% colspan="2" %)current page
612 612  
613 -**~ {{id name="_Toc24963745"/}}Operating procedures**
591 +**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
614 614  
615 615  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realdata>>url:http://api.v-box.net/box-data/api/we-data/realdata]]
616 616  
617 617  (% style="text-align:center" %)
618 -[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
596 +[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||class="img-thumbnail" height="45" width="700"]]
619 619  
620 620  **Step2: **Set parameters on Params
621 621  
... ... @@ -628,7 +628,7 @@
628 628  "pageIndex":"2"
629 629  
630 630  (% style="text-align:center" %)
631 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
609 +[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||class="img-thumbnail" height="272" width="700"]]
632 632  
633 633  **Step3:** Get sign
634 634  
... ... @@ -638,7 +638,7 @@
638 638  
639 639  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
640 640  
641 -**~ {{id name="_Toc24963746"/}}Result**
619 +**3.4.3 {{id name="_Toc24963746"/}}Result**
642 642  
643 643  {
644 644  
... ... @@ -701,55 +701,52 @@
701 701  }
702 702  
703 703  (% style="text-align:center" %)
704 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
682 +[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||class="img-thumbnail" height="651" width="800"]]
705 705  
706 -== **Modify tag data** ==
684 +== **3.5 Modify tag data** ==
707 707  
708 708  (((
709 -**Parameters**
687 +**3.5.1 Parameters**
710 710  )))
711 711  
712 712  (% class="table-bordered" %)
713 713  |**acturl**|(% colspan="2" %)we-data/updrealdata
714 714  |**Functions**|(% colspan="2" %)Modify tag data
715 -|(% rowspan="5" %)**Parameters**|Parameter|Description
716 -|boxId|Box ID
693 +|(% rowspan="3" %)**Parameters**|Parameter|Description
717 717  |monitorId|Tag ID
718 718  |value|value
719 -|devType|Device type (0:Box, 1:HMI)
720 720  |**Return value**|(% colspan="2" %)None
721 721  
722 -**Operating procedures**
698 +**3.5.2 Operating procedures**
723 723  
724 724  **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/updrealdata>>url:http://api.v-box.net/box-data/api/we-data/updrealdata]]
725 725  
726 726  (% style="text-align:center" %)
727 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
703 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
728 728  
729 729  **Step2:** Set parameters on Params
730 730  
731 -boxId:6397578
732 -monitorId:1001
733 -value:66
734 -devType:1
707 +"monitorId":"91541"
735 735  
709 +"value":"60"
710 +
736 736  (% style="text-align:center" %)
737 -[[image:1746502882467-849.png]]
712 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||class="img-thumbnail" height="246" width="800"]]
738 738  
739 739  **Step3:** Get sign
740 740  
741 -boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
716 +comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
742 742  
743 -MD5 sign: 4802a362fde2ca5053ad79fe4d272200
718 +MD5 sign: 4119b1abc9176a187f781bece04a5296
744 744  
745 745  **Step4: **Set common of header
746 746  
747 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
722 +{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
748 748  
749 749  (% style="text-align:center" %)
750 -[[image:1746503047845-902.png]]
725 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||class="img-thumbnail" height="244" width="700"]]
751 751  
752 -**Result**
727 +**3.5.3 Result**
753 753  
754 754  {
755 755  
... ... @@ -764,29 +764,28 @@
764 764  }
765 765  
766 766  (% style="text-align:center" %)
767 -[[image:1746503002289-932.png]]
742 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||class="img-thumbnail" height="425" width="700"]]
768 768  
769 -== **Historical tags name list** ==
744 +== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
770 770  
771 -**Parameters**
746 +**3.6.1 Parameters**
772 772  
773 773  (% class="table-bordered" %)
774 774  |**acturl**|(% colspan="3" %)we-data/monitors
775 775  |**Functions**|(% colspan="3" %)Get a list of historical tags
776 -|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
777 -|boxId|(% colspan="2" %)Box ID (Not required)
778 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
751 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
752 +|boxId|(% colspan="2" %)VBoxID (Not required)
779 779  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
780 780  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
781 781  |monitorId|tag ID
782 782  |monitorName|tag name
783 783  
784 -**Operating procedures**
758 +**​​​​​​​3.6.2 Operating procedures**
785 785  
786 786  **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/monitors>>url:http://api.v-box.net/box-data/api/we-data/monitors]]
787 787  
788 788  (% style="text-align:center" %)
789 -[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
763 +[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||class="img-thumbnail" height="45" width="700"]]
790 790  
791 791  **Step2: **Set parameters on Params
792 792  
... ... @@ -793,7 +793,7 @@
793 793  "boxId":"973"
794 794  
795 795  (% style="text-align:center" %)
796 -[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
770 +[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||class="img-thumbnail" height="185" width="700"]]
797 797  
798 798  **Step3:** Get sign
799 799  
... ... @@ -806,9 +806,9 @@
806 806  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
807 807  
808 808  (% style="text-align:center" %)
809 -[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
783 +[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||class="img-thumbnail" height="228" width="700"]]
810 810  
811 -**Result**
785 +**​​​​​​​3.6.3 Result**
812 812  
813 813  {
814 814  
... ... @@ -849,11 +849,11 @@
849 849  }
850 850  
851 851  (% style="text-align:center" %)
852 -[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
826 +[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||class="img-thumbnail" height="400" width="700"]]
853 853  
854 -== **Historical tag data list** ==
828 +== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
855 855  
856 -**~ {{id name="_Toc24963756"/}}Parameters**
830 +**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
857 857  
858 858  (% class="table-bordered" %)
859 859  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -873,12 +873,12 @@
873 873  |totalRecord|(% colspan="2" %)Total records
874 874  |currentPage|(% colspan="2" %)Current page
875 875  
876 -**Operating procedures**
850 +​​​​​​​**3.7.2 Operating procedures**
877 877  
878 878  **Step:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/historydata>>url:http://api.v-box.net/box-data/api/we-data/historydata]]
879 879  
880 880  (% style="text-align:center" %)
881 -[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
855 +[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||class="img-thumbnail" height="47" width="700"]]
882 882  
883 883  **Step2:** Set parameters on Params
884 884  
... ... @@ -893,7 +893,7 @@
893 893  "pageIndex":"2"
894 894  
895 895  (% style="text-align:center" %)
896 -[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
870 +[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||class="img-thumbnail" height="302" width="700"]]
897 897  
898 898  **Step3: **Get sign
899 899  
... ... @@ -906,9 +906,9 @@
906 906  {"monitorId":"91577","monitorBeginTime":"2019-11-16 10:45:44.000","monitorEndTime":"2019-11-16 20:45:44.000","pageSize":"10","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"feeae8ddb4014951cfc2c02de4744bc4"}
907 907  
908 908  (% style="text-align:center" %)
909 -[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
883 +[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||class="img-thumbnail" height="291" width="700"]]
910 910  
911 -**Result**
885 +**3.7.3 Result**
912 912  
913 913  {
914 914  
... ... @@ -969,16 +969,16 @@
969 969  }
970 970  
971 971  (% style="text-align:center" %)
972 -[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
946 +[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||class="img-thumbnail" height="476" width="700"]]
973 973  
974 -== **Alarm tags data list** ==
948 +== **3.8 Alarm tags data list** ==
975 975  
976 -**{{id name="_Toc24963760"/}}Parameters**
950 +**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
977 977  
978 978  (% class="table-bordered" %)
979 979  |**acturl**|(% colspan="3" %)we-data/alarmdata
980 980  |**Function**|(% colspan="3" %)Get alarm data
981 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
955 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
982 982  |boxId|(% colspan="2" %)VBoxID, (Required)
983 983  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
984 984  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -995,7 +995,6 @@
995 995  
996 996  (Not necessary)
997 997  )))
998 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
999 999  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
1000 1000  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1001 1001  |monitorId|tag ID
... ... @@ -1009,12 +1009,12 @@
1009 1009  |totalRecord|(% colspan="2" %)Total records
1010 1010  |currentPage|(% colspan="2" %)Current page
1011 1011  
1012 -**~ {{id name="_Toc24963761"/}}Operating procedures**
985 +**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1013 1013  
1014 1014  **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/alarmdata>>url:http://api.v-box.net/box-data/api/we-data/alarmdata]]
1015 1015  
1016 1016  (% style="text-align:center" %)
1017 -[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
990 +[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||class="img-thumbnail" height="45" width="700"]]
1018 1018  
1019 1019  **Step2:** Set parameters on Params
1020 1020  
... ... @@ -1031,7 +1031,7 @@
1031 1031  "state":"2"
1032 1032  
1033 1033  (% style="text-align:center" %)
1034 -[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1007 +[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||class="img-thumbnail" height="327" width="700"]]
1035 1035  
1036 1036  **Step3:** Get sign
1037 1037  
... ... @@ -1044,9 +1044,9 @@
1044 1044  {"monitorId":"91931","monitorBeginTime":"2019-11-16 20:30:44.000","monitorEndTime":"2019-11-16 21:30:44.000","pageSize":"10","pageIndex":"1","state":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4056006bbc71bd80a3c632987626e15b"}
1045 1045  
1046 1046  (% style="text-align:center" %)
1047 -[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1020 +[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||class="img-thumbnail" height="269" width="700"]]
1048 1048  
1049 -**Result**
1022 +**3.8.3 Result**
1050 1050  
1051 1051  {
1052 1052  
... ... @@ -1123,11 +1123,11 @@
1123 1123  }
1124 1124  
1125 1125  (% style="text-align:center" %)
1126 -[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1099 +[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||class="img-thumbnail" height="475" width="700"]]
1127 1127  
1128 -== **Get device state** ==
1101 +== **3.9 Get device state** ==
1129 1129  
1130 -**~ {{id name="_Toc24963760"/}}Parameters**
1103 +**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1131 1131  
1132 1132  (% class="table-bordered" %)
1133 1133  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1137,7 +1137,7 @@
1137 1137  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1138 1138  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1139 1139  
1140 -== **Send switch to device** ==
1113 +== **3.10 Send switch to device** ==
1141 1141  
1142 1142  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1143 1143  
... ... @@ -1148,9 +1148,9 @@
1148 1148  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1149 1149  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1150 1150  
1151 -= **Appendix** =
1124 += **4 Appendix** =
1152 1152  
1153 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1126 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1154 1154  
1155 1155  100: 16-bit binary
1156 1156  
1746502870811-166.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -42.1 KB
Content