Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 25.1
edited by Devin Chen
on 2025/04/10 16:16
Change comment: There is no comment for this version
To version 3.1
edited by Hunter
on 2022/07/11 10:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -07 HTTP API
1 +05 HTTP API
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.Hunter
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,27 +83,26 @@
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, 32bit)
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  
... ... @@ -114,7 +114,7 @@
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 120  [[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
... ... @@ -123,18 +123,8 @@
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"}
... ... @@ -143,7 +143,7 @@
143 143  [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
144 144  
145 145  (((
146 -**Result**
130 +**2.1.3 Result**
147 147  )))
148 148  
149 149  {
... ... @@ -170,22 +170,22 @@
170 170  [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
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,30 +701,28 @@
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  
... ... @@ -733,7 +733,7 @@
733 733  "value":"60"
734 734  
735 735  (% style="text-align:center" %)
736 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
712 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||class="img-thumbnail" height="246" width="800"]]
737 737  
738 738  **Step3:** Get sign
739 739  
... ... @@ -746,9 +746,9 @@
746 746  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
747 747  
748 748  (% style="text-align:center" %)
749 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
725 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||class="img-thumbnail" height="244" width="700"]]
750 750  
751 -**Result**
727 +**3.5.3 Result**
752 752  
753 753  {
754 754  
... ... @@ -763,29 +763,28 @@
763 763  }
764 764  
765 765  (% style="text-align:center" %)
766 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
742 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||class="img-thumbnail" height="425" width="700"]]
767 767  
768 -== **Historical tags name list** ==
744 +== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
769 769  
770 -**Parameters**
746 +**3.6.1 Parameters**
771 771  
772 772  (% class="table-bordered" %)
773 773  |**acturl**|(% colspan="3" %)we-data/monitors
774 774  |**Functions**|(% colspan="3" %)Get a list of historical tags
775 -|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
776 -|boxId|(% colspan="2" %)Box ID (Not required)
777 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
751 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
752 +|boxId|(% colspan="2" %)VBoxID (Not required)
778 778  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
779 779  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
780 780  |monitorId|tag ID
781 781  |monitorName|tag name
782 782  
783 -**Operating procedures**
758 +**​​​​​​​3.6.2 Operating procedures**
784 784  
785 785  **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]]
786 786  
787 787  (% style="text-align:center" %)
788 -[[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"]]
789 789  
790 790  **Step2: **Set parameters on Params
791 791  
... ... @@ -792,7 +792,7 @@
792 792  "boxId":"973"
793 793  
794 794  (% style="text-align:center" %)
795 -[[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"]]
796 796  
797 797  **Step3:** Get sign
798 798  
... ... @@ -805,9 +805,9 @@
805 805  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
806 806  
807 807  (% style="text-align:center" %)
808 -[[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"]]
809 809  
810 -**Result**
785 +**​​​​​​​3.6.3 Result**
811 811  
812 812  {
813 813  
... ... @@ -848,11 +848,11 @@
848 848  }
849 849  
850 850  (% style="text-align:center" %)
851 -[[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"]]
852 852  
853 -== **Historical tag data list** ==
828 +== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
854 854  
855 -**~ {{id name="_Toc24963756"/}}Parameters**
830 +**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
856 856  
857 857  (% class="table-bordered" %)
858 858  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -872,12 +872,12 @@
872 872  |totalRecord|(% colspan="2" %)Total records
873 873  |currentPage|(% colspan="2" %)Current page
874 874  
875 -**Operating procedures**
850 +​​​​​​​**3.7.2 Operating procedures**
876 876  
877 877  **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]]
878 878  
879 879  (% style="text-align:center" %)
880 -[[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"]]
881 881  
882 882  **Step2:** Set parameters on Params
883 883  
... ... @@ -892,7 +892,7 @@
892 892  "pageIndex":"2"
893 893  
894 894  (% style="text-align:center" %)
895 -[[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"]]
896 896  
897 897  **Step3: **Get sign
898 898  
... ... @@ -905,9 +905,9 @@
905 905  {"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"}
906 906  
907 907  (% style="text-align:center" %)
908 -[[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"]]
909 909  
910 -**Result**
885 +**3.7.3 Result**
911 911  
912 912  {
913 913  
... ... @@ -968,16 +968,16 @@
968 968  }
969 969  
970 970  (% style="text-align:center" %)
971 -[[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"]]
972 972  
973 -== **Alarm tags data list** ==
948 +== **3.8 Alarm tags data list** ==
974 974  
975 -**{{id name="_Toc24963760"/}}Parameters**
950 +**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
976 976  
977 977  (% class="table-bordered" %)
978 978  |**acturl**|(% colspan="3" %)we-data/alarmdata
979 979  |**Function**|(% colspan="3" %)Get alarm data
980 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
955 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
981 981  |boxId|(% colspan="2" %)VBoxID, (Required)
982 982  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
983 983  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -994,7 +994,6 @@
994 994  
995 995  (Not necessary)
996 996  )))
997 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
998 998  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
999 999  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1000 1000  |monitorId|tag ID
... ... @@ -1008,12 +1008,12 @@
1008 1008  |totalRecord|(% colspan="2" %)Total records
1009 1009  |currentPage|(% colspan="2" %)Current page
1010 1010  
1011 -**~ {{id name="_Toc24963761"/}}Operating procedures**
985 +**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1012 1012  
1013 1013  **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]]
1014 1014  
1015 1015  (% style="text-align:center" %)
1016 -[[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"]]
1017 1017  
1018 1018  **Step2:** Set parameters on Params
1019 1019  
... ... @@ -1030,7 +1030,7 @@
1030 1030  "state":"2"
1031 1031  
1032 1032  (% style="text-align:center" %)
1033 -[[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"]]
1034 1034  
1035 1035  **Step3:** Get sign
1036 1036  
... ... @@ -1043,9 +1043,9 @@
1043 1043  {"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"}
1044 1044  
1045 1045  (% style="text-align:center" %)
1046 -[[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"]]
1047 1047  
1048 -**Result**
1022 +**3.8.3 Result**
1049 1049  
1050 1050  {
1051 1051  
... ... @@ -1122,11 +1122,11 @@
1122 1122  }
1123 1123  
1124 1124  (% style="text-align:center" %)
1125 -[[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"]]
1126 1126  
1127 -== **Get device state** ==
1101 +== **3.9 Get device state** ==
1128 1128  
1129 -**~ {{id name="_Toc24963760"/}}Parameters**
1103 +**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1130 1130  
1131 1131  (% class="table-bordered" %)
1132 1132  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1136,7 +1136,7 @@
1136 1136  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1137 1137  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1138 1138  
1139 -== **Send switch to device** ==
1113 +== **3.10 Send switch to device** ==
1140 1140  
1141 1141  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1142 1142  
... ... @@ -1147,9 +1147,9 @@
1147 1147  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1148 1148  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1149 1149  
1150 -= **Appendix** =
1124 += **4 Appendix** =
1151 1151  
1152 -== (% 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**(%%) ==
1153 1153  
1154 1154  100: 16-bit binary
1155 1155