Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 7.1
edited by Hunter
on 2023/01/07 09:52
Change comment: There is no comment for this version
To version 29.1
edited by Devin Chen
on 2025/06/30 14:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -7 HTTP API
1 +07 HTTP API
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Hunter
1 +XWiki.DevinChen
Content
... ... @@ -1,4 +1,4 @@
1 -= **1 General** =
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  
... ... @@ -25,9 +25,9 @@
25 25  
26 26  The common KEY is:
27 27  
28 -**comid=2**
28 +**comid=128**
29 29  
30 -**comkey=589625dce895454dbff9782c299db156**
30 +**comkey=7e421dd30a394d74b7b9c079e67e272c**
31 31  
32 32  screctkey=f1cd9351930d4e589922edbcf3b09a7c
33 33  
... ... @@ -43,9 +43,12 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
46 +(% class="box infomessage" %)
47 +(((
46 46  **✎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 +)))
47 47  
48 -== **1.1 Interface Parameter Description** ==
51 +== **Interface Parameter Description** ==
49 49  
50 50  **Global parameters**
51 51  
... ... @@ -69,7 +69,7 @@
69 69  (% style="text-align:center" %)
70 70  [[image:1.png||height="141" width="500" class="img-thumbnail"]]
71 71  
72 -== **1.2 Example key and value** ==
75 +== **Example key and value** ==
73 73  
74 74  1).**comid**=2
75 75  
... ... @@ -80,10 +80,10 @@
80 80  4).**ts**=1573897380
81 81  
82 82  (((
83 -= **2 Basic API** =
86 += **Basic API** =
84 84  )))
85 85  
86 -== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
89 +== **{{id name="_Toc24963726"/}}Login operation** ==
87 87  
88 88  (((
89 89  **2.1.1 Parameters**
... ... @@ -93,14 +93,14 @@
93 93  |**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
94 94  |**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
95 95  |(% colspan="1" rowspan="4" %)**Parameters**|Items|(% style="width:535px" %)Description
96 -|alias|(% style="width:535px" %)Username, email, phone number
99 +|alias|(% style="width:535px" %)Must be username, registered email will fail to login
97 97  |password|(% style="width:535px" %)32bit password (MD5 encryption)
98 98  |domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
99 99  |(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
100 100  |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
101 -|sid|(% style="width:535px" %)User session ID
104 +|sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
102 102  
103 -**2.1.2 Operating procedures**
106 +**Operating procedures**
104 104  
105 105  **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]]
106 106  
... ... @@ -124,10 +124,14 @@
124 124  
125 125  "sign":"997513ff1320862f0cbb9ce19d0bd253"
126 126  
130 +{{info}}
127 127  **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
128 128  
129 129  alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
130 130  
135 +The timestamp must be unit as Millisecond level
136 +{{/info}}
137 +
131 131  **Step4: ** Set common of header
132 132  
133 133  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -136,7 +136,7 @@
136 136  [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
137 137  
138 138  (((
139 -**2.1.3 Result**
146 +**Result**
140 140  )))
141 141  
142 142  {
... ... @@ -163,17 +163,17 @@
163 163  [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
164 164  
165 165  (((
166 -= **3 Service data APIs** =
173 += **Service data APIs** =
167 167  )))
168 168  
169 -== **3.1 V-Box list** ==
176 +== **V-Box list** ==
170 170  
171 -**3.1.1 {{id name="_Toc24963732"/}}Parameters**
178 +**{{id name="_Toc24963732"/}}Parameters**
172 172  
173 173  (% style="text-align:center" %)
174 174  [[image:X.png||height="412" width="700" class="img-thumbnail"]]
175 175  
176 -**3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
183 +**~ {{id name="_Toc24963733"/}}Operating procedures**
177 177  
178 178  **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]]
179 179  
... ... @@ -197,7 +197,7 @@
197 197  (% style="text-align:center" %)
198 198  [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
199 199  
200 -**3.1.3 Result**
207 +**Result**
201 201  
202 202  {
203 203  
... ... @@ -326,9 +326,9 @@
326 326  (% style="text-align:center" %)
327 327  [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
328 328  
329 -== **3.2 Real-time group list** ==
336 +== **Real-time group list** ==
330 330  
331 -**3.2.1{{id name="_Toc24963736"/}} Parameters**
338 +**{{id name="_Toc24963736"/}} Parameters**
332 332  
333 333  (% class="table-bordered" %)
334 334  |**acturl**|(% colspan="3" %)we-data/realgroups
... ... @@ -340,7 +340,7 @@
340 340  |groupId|Group ID
341 341  |groupName|Group name
342 342  
343 -**3.2.2 Operating procedures**
350 +**Operating procedures**
344 344  
345 345  **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]]
346 346  
... ... @@ -367,7 +367,7 @@
367 367  (% style="text-align:center" %)
368 368  [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
369 369  
370 -**3.2.3 Result**
377 +**Result**
371 371  
372 372  {
373 373  
... ... @@ -413,18 +413,19 @@
413 413  
414 414  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
415 415  
416 -== **3.3 Real-time tags configuration list** ==
423 +== **Real-time tags configuration list** ==
417 417  
418 -**3.3.1 Parameters**
425 +**Parameters**
419 419  
420 420  (% class="table-bordered" %)
421 421  |**acturl**|(% colspan="3" %)we-data/realcfgs
422 422  |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
423 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
430 +|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
424 424  |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
425 425  |groupId|(% colspan="2" %)Group ID (Required)
426 426  |pageSize|(% colspan="2" %)Number of each page, 10 by default
427 427  |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
428 428  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
429 429  |(% rowspan="11" %)cfgList|monitorId|Tags ID
430 430  |monitorName|Tags name
... ... @@ -457,7 +457,7 @@
457 457  |totalRecord|(% colspan="2" %)Total record number
458 458  |currentPage|(% colspan="2" %)Current page number
459 459  
460 -**3.3.2 Operating procedures**
468 +**Operating procedures**
461 461  
462 462  **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]]
463 463  
... ... @@ -470,101 +470,185 @@
470 470  
471 471  "groupId":"7325"
472 472  
481 +"devType":"0"
482 +
473 473  "pageSize":"5"
474 474  
475 475  "pageIndex":"2"
476 476  
477 477  (% style="text-align:center" %)
478 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
488 +[[image:1751263596452-675.png||height="222" width="555"]]
479 479  
480 480  **Step3:** Get sign
481 481  
482 -boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
492 +boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263335125&key=f1cd9351930d4e589922edbcf3b09a7c
483 483  
484 -MD5 sign: 0769228e66c945eed5431c41a96949f2
494 +MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
485 485  
486 486  **Step4:** Set common of header
487 487  
488 -{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
498 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"27a89c93a4990d0497a8bd47dea4aed3","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263335125}
489 489  
490 490  (% style="text-align:center" %)
491 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
501 +[[image:1751263680622-643.png]]
492 492  
493 -**3.3.3 Result**
503 +**Result**
494 494  
495 495  {
496 496  
497 - "code": 200,
507 + "code": 200,
498 498  
499 - "msg": "ok",
509 + "msg": "ok",
500 500  
501 - "reqId": "1573903822419",
511 + "reqId": "1751263500705",
502 502  
503 - "result": {
513 + "result": {
504 504  
505 - "cfgList": [
515 + "cfgList": [
506 506  
507 507   {
508 508  
509 - "monitorId": 91545,
519 + "monitorId": 2276374,
510 510  
511 - "dataId": 105,
521 + "monitorName": "x0",
512 512  
513 - "monitorName": "Temp_9",
523 + "digitBinary": "",
514 514  
515 - "updTime": 1571965761000,
525 + "float_point": -1,
516 516  
517 - "dataLimit": "0 7999",
527 + "rid": "X",
518 518  
519 - "digitBinary": "十进制",
529 + "roleType": 1,
520 520  
521 - "addr": "9",
531 + "string_point": -1,
522 522  
523 - "rid": "D",
533 + "dataId": 105,
524 524  
525 - "roleType": 3,
535 + "addr_stat_no": -1,
526 526  
527 - "digitCount": "5,0",
537 + "updTime": 1745481123000,
528 528  
529 - "addrType": 2
539 + "dataLimit": "0 1",
530 530  
541 + "addr": "0",
542 +
543 + "digitCount": "",
544 +
545 + "boxId": 763,
546 +
547 + "addrType": 0
548 +
531 531   },
532 532  
533 - ……………
551 + {
534 534  
553 + "monitorId": 2276373,
554 +
555 + "monitorName": "y0",
556 +
557 + "digitBinary": "",
558 +
559 + "float_point": -1,
560 +
561 + "rid": "Y",
562 +
563 + "roleType": 3,
564 +
565 + "string_point": -1,
566 +
567 + "dataId": 105,
568 +
569 + "addr_stat_no": -1,
570 +
571 + "updTime": 1745480354000,
572 +
573 + "dataLimit": "0 1",
574 +
575 + "addr": "0",
576 +
577 + "digitCount": "",
578 +
579 + "boxId": 763,
580 +
581 + "addrType": 0
582 +
583 + },
584 +
535 535   {
536 536  
537 - "monitorId": 91541,
587 + "monitorId": 2276367,
538 538  
539 - "dataId": 105,
589 + "monitorName": "okg",
540 540  
541 - "monitorName": "Temp_5",
591 + "digitBinary": "",
542 542  
543 - "updTime": 1571965761000,
593 + "float_point": 1,
544 544  
545 - "dataLimit": "0 7999",
595 + "rid": "HDW",
546 546  
547 - "digitBinary": "十进制",
597 + "roleType": 3,
548 548  
549 - "addr": "5",
599 + "string_point": -1,
550 550  
551 - "rid": "D",
601 + "dataId": 105,
552 552  
553 - "roleType": 3,
603 + "addr_stat_no": -1,
554 554  
555 - "digitCount": "5,0",
605 + "updTime": 1745475213000,
556 556  
557 - "addrType": 2
607 + "dataLimit": "0 299999",
558 558  
609 + "addr": "10",
610 +
611 + "digitCount": "5,0",
612 +
613 + "boxId": 763,
614 +
615 + "addrType": 2
616 +
617 + },
618 +
619 + {
620 +
621 + "monitorId": 2276366,
622 +
623 + "monitorName": "hjdfh",
624 +
625 + "digitBinary": "",
626 +
627 + "float_point": -1,
628 +
629 + "rid": "HDX",
630 +
631 + "roleType": 3,
632 +
633 + "string_point": -1,
634 +
635 + "dataId": 105,
636 +
637 + "addr_stat_no": -1,
638 +
639 + "updTime": 1745475139000,
640 +
641 + "dataLimit": "0 299999,0 15",
642 +
643 + "addr": "0,0",
644 +
645 + "digitCount": "",
646 +
647 + "boxId": 763,
648 +
649 + "addrType": 0
650 +
559 559   }
560 560  
561 561   ],
562 562  
563 - "totalPage": 3,
655 + "totalPage": 1,
564 564  
565 - "totalRecord": 15,
657 + "totalRecord": 4,
566 566  
567 - "currentPage": 2
659 + "currentPage": 1
568 568  
569 569   }
570 570  
... ... @@ -571,20 +571,25 @@
571 571  }
572 572  
573 573  (% style="text-align:center" %)
574 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
666 +[[image:1751263773173-191.png]]
575 575  
576 -== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
668 +== **Tags data list** ==
577 577  
578 -**3.4.1 {{id name="_Toc24963744"/}}Parameters**
670 +{{warning}}
671 +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
672 +{{/warning}}
579 579  
674 +**~ {{id name="_Toc24963744"/}}Parameters**
675 +
580 580  (% class="table-bordered" %)
581 581  |**acturl**|(% colspan="3" %)we-data/realdata
582 582  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
583 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
679 +|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
584 584  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
585 585  |groupId|(% colspan="2" %)Group ID (Required)
586 586  |pageSize|(% colspan="2" %)Number of each page, 10 by default
587 587  |pageIndex|(% colspan="2" %)Number of current page, start from 1
684 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
588 588  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
589 589  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
590 590  |com|Communication port ID
... ... @@ -597,7 +597,7 @@
597 597  |totalRecord|(% colspan="2" %)Total record
598 598  |currentPage|(% colspan="2" %)current page
599 599  
600 -**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
697 +**~ {{id name="_Toc24963745"/}}Operating procedures**
601 601  
602 602  **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]]
603 603  
... ... @@ -608,6 +608,8 @@
608 608  
609 609  "boxId":"973"
610 610  
708 +"devType":"0"
709 +
611 611  "groupId":"7325"
612 612  
613 613  "pageSize":"5"
... ... @@ -615,73 +615,149 @@
615 615  "pageIndex":"2"
616 616  
617 617  (% style="text-align:center" %)
618 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
717 +[[image:1751264089450-269.png||height="221" width="607"]]
619 619  
620 620  **Step3:** Get sign
621 621  
622 -boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
721 +boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263921050&key=f1cd9351930d4e589922edbcf3b09a7c
623 623  
624 -MD5 sign: 0769228e66c945eed5431c41a96949f2
723 +MD5 sign: 19191b155e92f800f4db086bf06f8367
625 625  
626 -{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
725 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"19191b155e92f800f4db086bf06f8367","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263921050}
627 627  
628 -**3.4.3 {{id name="_Toc24963746"/}}Result**
727 +**~ {{id name="_Toc24963746"/}}Result**
629 629  
630 630  {
631 631  
632 - "code": 200,
731 + "code": 200,
633 633  
634 - "msg": "ok",
733 + "msg": "ok",
635 635  
636 - "reqId": "1573905679365",
735 + "reqId": "1751264055206",
637 637  
638 - "result": {
737 + "result": {
639 639  
640 - "totalPage": 3,
739 + "totalPage": 1,
641 641  
642 - "list": [
741 + "list": [
643 643  
644 644   {
645 645  
646 - "com": 2939,
745 + "com": 0,
647 647  
648 - "monitorId": 91545,
747 + "string_point": -1,
649 649  
650 - "monitorName": "Temp_9",
749 + "monitorId": 2276374,
651 651  
652 - "groupId": 0,
751 + "addr_stat_no": -1,
653 653  
654 - "state": "1",
753 + "actAuth": 1,
655 655  
656 - "value": "90"
755 + "monitorName": "x0",
657 657  
757 + "groupId": 211608,
758 +
759 + "state": 0,
760 +
761 + "float_point": -1,
762 +
763 + "templateId": 0,
764 +
765 + "value": "0",
766 +
767 + "boxId": 763
768 +
658 658   },
659 659  
660 - …………
771 + {
661 661  
773 + "com": 0,
774 +
775 + "string_point": -1,
776 +
777 + "monitorId": 2276373,
778 +
779 + "addr_stat_no": -1,
780 +
781 + "actAuth": 3,
782 +
783 + "monitorName": "y0",
784 +
785 + "groupId": 211608,
786 +
787 + "state": 0,
788 +
789 + "float_point": -1,
790 +
791 + "templateId": 0,
792 +
793 + "value": "0",
794 +
795 + "boxId": 763
796 +
662 662   },
663 663  
664 664   {
665 665  
666 - "com": 2939,
801 + "com": 0,
667 667  
668 - "monitorId": 91541,
803 + "string_point": -1,
669 669  
670 - "monitorName": "Temp_5",
805 + "monitorId": 2276367,
671 671  
672 - "groupId": 0,
807 + "addr_stat_no": -1,
673 673  
674 - "state": "1",
809 + "actAuth": 3,
675 675  
676 - "value": "87"
811 + "monitorName": "okg",
677 677  
813 + "groupId": 211608,
814 +
815 + "state": 0,
816 +
817 + "float_point": 1,
818 +
819 + "templateId": 0,
820 +
821 + "value": "0",
822 +
823 + "boxId": 763
824 +
825 + },
826 +
827 + {
828 +
829 + "com": 0,
830 +
831 + "string_point": -1,
832 +
833 + "monitorId": 2276366,
834 +
835 + "addr_stat_no": -1,
836 +
837 + "actAuth": 3,
838 +
839 + "monitorName": "hjdfh",
840 +
841 + "groupId": 211608,
842 +
843 + "state": 0,
844 +
845 + "float_point": -1,
846 +
847 + "templateId": 0,
848 +
849 + "value": "0",
850 +
851 + "boxId": 763
852 +
678 678   }
679 679  
680 680   ],
681 681  
682 - "totalRecord": 15,
857 + "totalRecord": 4,
683 683  
684 - "currentPage": 2
859 + "currentPage": 1
685 685  
686 686   }
687 687  
... ... @@ -688,23 +688,25 @@
688 688  }
689 689  
690 690  (% style="text-align:center" %)
691 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
866 +[[image:1751264191566-865.png]]
692 692  
693 -== **3.5 Modify tag data** ==
868 +== **Modify tag data** ==
694 694  
695 695  (((
696 -**3.5.1 Parameters**
871 +**Parameters**
697 697  )))
698 698  
699 699  (% class="table-bordered" %)
700 700  |**acturl**|(% colspan="2" %)we-data/updrealdata
701 701  |**Functions**|(% colspan="2" %)Modify tag data
702 -|(% rowspan="3" %)**Parameters**|Parameter|Description
877 +|(% rowspan="5" %)**Parameters**|Parameter|Description
878 +|boxId|Box ID
703 703  |monitorId|Tag ID
704 704  |value|value
881 +|devType|Device type (0:Box, 1:HMI)
705 705  |**Return value**|(% colspan="2" %)None
706 706  
707 -**3.5.2 Operating procedures**
884 +**Operating procedures**
708 708  
709 709  **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]]
710 710  
... ... @@ -713,27 +713,28 @@
713 713  
714 714  **Step2:** Set parameters on Params
715 715  
716 -"monitorId":"91541"
893 +boxId:6397578
894 +monitorId:1001
895 +value:66
896 +devType:1
717 717  
718 -"value":"60"
719 -
720 720  (% style="text-align:center" %)
721 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
899 +[[image:1746502882467-849.png]]
722 722  
723 723  **Step3:** Get sign
724 724  
725 -comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
903 +boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
726 726  
727 -MD5 sign: 4119b1abc9176a187f781bece04a5296
905 +MD5 sign: 4802a362fde2ca5053ad79fe4d272200
728 728  
729 729  **Step4: **Set common of header
730 730  
731 -{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
909 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
732 732  
733 733  (% style="text-align:center" %)
734 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
912 +[[image:1746503047845-902.png]]
735 735  
736 -**3.5.3 Result**
914 +**Result**
737 737  
738 738  {
739 739  
... ... @@ -748,23 +748,24 @@
748 748  }
749 749  
750 750  (% style="text-align:center" %)
751 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
929 +[[image:1746503002289-932.png]]
752 752  
753 -== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
931 +== **Historical tags name list** ==
754 754  
755 -**3.6.1 Parameters**
933 +**Parameters**
756 756  
757 757  (% class="table-bordered" %)
758 758  |**acturl**|(% colspan="3" %)we-data/monitors
759 759  |**Functions**|(% colspan="3" %)Get a list of historical tags
760 -|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
761 -|boxId|(% colspan="2" %)VBoxID (Not required)
938 +|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
939 +|boxId|(% colspan="2" %)Box ID (Not required)
940 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
762 762  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
763 763  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
764 764  |monitorId|tag ID
765 765  |monitorName|tag name
766 766  
767 -**3.6.2 Operating procedures**
946 +**Operating procedures**
768 768  
769 769  **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]]
770 770  
... ... @@ -791,7 +791,7 @@
791 791  (% style="text-align:center" %)
792 792  [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
793 793  
794 -**3.6.3 Result**
973 +**Result**
795 795  
796 796  {
797 797  
... ... @@ -834,9 +834,9 @@
834 834  (% style="text-align:center" %)
835 835  [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
836 836  
837 -== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
1016 +== **Historical tag data list** ==
838 838  
839 -**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
1018 +**~ {{id name="_Toc24963756"/}}Parameters**
840 840  
841 841  (% class="table-bordered" %)
842 842  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -856,7 +856,7 @@
856 856  |totalRecord|(% colspan="2" %)Total records
857 857  |currentPage|(% colspan="2" %)Current page
858 858  
859 -​​​​​​​**3.7.2 Operating procedures**
1038 +**Operating procedures**
860 860  
861 861  **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]]
862 862  
... ... @@ -891,7 +891,7 @@
891 891  (% style="text-align:center" %)
892 892  [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
893 893  
894 -**3.7.3 Result**
1073 +**Result**
895 895  
896 896  {
897 897  
... ... @@ -954,14 +954,14 @@
954 954  (% style="text-align:center" %)
955 955  [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
956 956  
957 -== **3.8 Alarm tags data list** ==
1136 +== **Alarm tags data list** ==
958 958  
959 -**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
1138 +**{{id name="_Toc24963760"/}}Parameters**
960 960  
961 961  (% class="table-bordered" %)
962 962  |**acturl**|(% colspan="3" %)we-data/alarmdata
963 963  |**Function**|(% colspan="3" %)Get alarm data
964 -|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1143 +|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
965 965  |boxId|(% colspan="2" %)VBoxID, (Required)
966 966  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
967 967  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -978,6 +978,7 @@
978 978  
979 979  (Not necessary)
980 980  )))
1160 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
981 981  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
982 982  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
983 983  |monitorId|tag ID
... ... @@ -991,7 +991,7 @@
991 991  |totalRecord|(% colspan="2" %)Total records
992 992  |currentPage|(% colspan="2" %)Current page
993 993  
994 -**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1174 +**~ {{id name="_Toc24963761"/}}Operating procedures**
995 995  
996 996  **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]]
997 997  
... ... @@ -1028,7 +1028,7 @@
1028 1028  (% style="text-align:center" %)
1029 1029  [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1030 1030  
1031 -**3.8.3 Result**
1211 +**Result**
1032 1032  
1033 1033  {
1034 1034  
... ... @@ -1107,9 +1107,9 @@
1107 1107  (% style="text-align:center" %)
1108 1108  [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1109 1109  
1110 -== **3.9 Get device state** ==
1290 +== **Get device state** ==
1111 1111  
1112 -**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1292 +**~ {{id name="_Toc24963760"/}}Parameters**
1113 1113  
1114 1114  (% class="table-bordered" %)
1115 1115  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1119,7 +1119,7 @@
1119 1119  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1120 1120  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1121 1121  
1122 -== **3.10 Send switch to device** ==
1302 +== **Send switch to device** ==
1123 1123  
1124 1124  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1125 1125  
... ... @@ -1130,9 +1130,9 @@
1130 1130  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1131 1131  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1132 1132  
1133 -= **4 Appendix** =
1313 += **Appendix** =
1134 1134  
1135 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1315 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1136 1136  
1137 1137  100: 16-bit binary
1138 1138  
1746502870811-166.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +42.1 KB
Content
1751263559328-234.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +14.7 KB
Content
1751263596452-675.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +22.9 KB
Content
1751263680622-643.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +27.1 KB
Content
1751263773173-191.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +28.5 KB
Content
1751264089450-269.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +23.2 KB
Content
1751264191566-865.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +26.1 KB
Content