Changes for page 07 HTTP API

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.DevinChen
	1	+XWiki.AiXia

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
...	...	@@ -43,12 +43,9 @@
43	43
44	44	screctkey=f1cd9351930d4e589922edbcf3b09a7c
45	45
46		-(% class="box infomessage" %)
47		-(((
48	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		-)))
50	50
51		-== **Interface Parameter Description** ==
	48	+== **1.1 Interface Parameter Description** ==
52	52
53	53	**Global parameters**
54	54
...	...	@@ -72,7 +72,7 @@
72	72	(% style="text-align:center" %)
73	73	[[image:1.png||height="141" width="500" class="img-thumbnail"]]
74	74
75		-== **Example key and value** ==
	72	+== **1.2 Example key and value** ==
76	76
77	77	1).**comid**=2
78	78
...	...	@@ -83,10 +83,10 @@
83	83	4).**ts**=1573897380
84	84
85	85	(((
86		-= **Basic API** =
	83	+= **2 Basic API** =
87	87	)))
88	88
89		-== **{{id name="_Toc24963726"/}}Login operation** ==
	86	+== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
90	90
91	91	(((
92	92	**2.1.1 Parameters**
...	...	@@ -103,7 +103,7 @@
103	103	|utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
104	104	|sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
105	105
106		-**Operating procedures**
	103	+**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
...	...	@@ -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**
	143	+**2.1.3 Result**
147	147	)))
148	148
149	149	{
...	...	@@ -170,17 +170,17 @@
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** =
	170	+= **3 Service data APIs** =
174	174	)))
175	175
176		-== **V-Box list** ==
	173	+== **3.1 V-Box list** ==
177	177
178		-**{{id name="_Toc24963732"/}}Parameters**
	175	+**3.1.1 {{id name="_Toc24963732"/}}Parameters**
179	179
180	180	(% style="text-align:center" %)
181	181	[[image:X.png||height="412" width="700" class="img-thumbnail"]]
182	182
183		-**~ {{id name="_Toc24963733"/}}Operating procedures**
	180	+**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
...	...	@@ -204,7 +204,7 @@
204	204	(% style="text-align:center" %)
205	205	[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
206	206
207		-**Result**
	204	+**3.1.3 Result**
208	208
209	209	{
210	210
...	...	@@ -333,9 +333,9 @@
333	333	(% style="text-align:center" %)
334	334	[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
335	335
336		-== **Real-time group list** ==
	333	+== **3.2 Real-time group list** ==
337	337
338		-**{{id name="_Toc24963736"/}} Parameters**
	335	+**3.2.1{{id name="_Toc24963736"/}} Parameters**
339	339
340	340	(% class="table-bordered" %)
341	341	|**acturl**|(% colspan="3" %)we-data/realgroups
...	...	@@ -347,7 +347,7 @@
347	347	|groupId|Group ID
348	348	|groupName|Group name
349	349
350		-**Operating procedures**
	347	+**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
...	...	@@ -374,7 +374,7 @@
374	374	(% style="text-align:center" %)
375	375	[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
376	376
377		-**Result**
	374	+**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** ==
	420	+== **3.3 Real-time tags configuration list** ==
424	424
425		-**Parameters**
	422	+**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
	427	+|(% 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,7 +465,7 @@
465	465	|totalRecord|(% colspan="2" %)Total record number
466	466	|currentPage|(% colspan="2" %)Current page number
467	467
468		-**Operating procedures**
	464	+**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
...	...	@@ -498,7 +498,7 @@
498	498	(% style="text-align:center" %)
499	499	[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
500	500
501		-**Result**
	497	+**3.3.3 Result**
502	502
503	503	{
504	504
...	...	@@ -581,14 +581,10 @@
581	581	(% style="text-align:center" %)
582	582	[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
583	583
584		-== **Tags data list** ==
	580	+== (% 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}}
	582	+**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.
...	...	@@ -609,7 +609,7 @@
609	609	|totalRecord|(% colspan="2" %)Total record
610	610	|currentPage|(% colspan="2" %)current page
611	611
612		-**~ {{id name="_Toc24963745"/}}Operating procedures**
	604	+**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
613	613
614	614	**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]]
615	615
...	...	@@ -637,7 +637,7 @@
637	637
638	638	{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
639	639
640		-**~ {{id name="_Toc24963746"/}}Result**
	632	+**3.4.3 {{id name="_Toc24963746"/}}Result**
641	641
642	642	{
643	643
...	...	@@ -702,10 +702,10 @@
702	702	(% style="text-align:center" %)
703	703	[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
704	704
705		-== **Modify tag data** ==
	697	+== **3.5 Modify tag data** ==
706	706
707	707	(((
708		-**Parameters**
	700	+**3.5.1 Parameters**
709	709	)))
710	710
711	711	(% class="table-bordered" %)
...	...	@@ -716,7 +716,7 @@
716	716	|value|value
717	717	|**Return value**|(% colspan="2" %)None
718	718
719		-**Operating procedures**
	711	+**3.5.2 Operating procedures**
720	720
721	721	**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]]
722	722
...	...	@@ -745,7 +745,7 @@
745	745	(% style="text-align:center" %)
746	746	[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
747	747
748		-**Result**
	740	+**3.5.3 Result**
749	749
750	750	{
751	751
...	...	@@ -762,9 +762,9 @@
762	762	(% style="text-align:center" %)
763	763	[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
764	764
765		-== **Historical tags name list** ==
	757	+== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
766	766
767		-**Parameters**
	759	+**3.6.1 Parameters**
768	768
769	769	(% class="table-bordered" %)
770	770	|**acturl**|(% colspan="3" %)we-data/monitors
...	...	@@ -776,7 +776,7 @@
776	776	|monitorId|tag ID
777	777	|monitorName|tag name
778	778
779		-**Operating procedures**
	771	+**3.6.2 Operating procedures**
780	780
781	781	**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]]
782	782
...	...	@@ -803,7 +803,7 @@
803	803	(% style="text-align:center" %)
804	804	[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
805	805
806		-**Result**
	798	+**3.6.3 Result**
807	807
808	808	{
809	809
...	...	@@ -846,9 +846,9 @@
846	846	(% style="text-align:center" %)
847	847	[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
848	848
849		-== **Historical tag data list** ==
	841	+== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
850	850
851		-**~ {{id name="_Toc24963756"/}}Parameters**
	843	+**3.7.1 {{id name="_Toc24963756"/}}Parameters**
852	852
853	853	(% class="table-bordered" %)
854	854	|**acturl**|(% colspan="3" %)we-data/historydata
...	...	@@ -868,7 +868,7 @@
868	868	|totalRecord|(% colspan="2" %)Total records
869	869	|currentPage|(% colspan="2" %)Current page
870	870
871		-**Operating procedures**
	863	+​​​​​​​**3.7.2 Operating procedures**
872	872
873	873	**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]]
874	874
...	...	@@ -903,7 +903,7 @@
903	903	(% style="text-align:center" %)
904	904	[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
905	905
906		-**Result**
	898	+**3.7.3 Result**
907	907
908	908	{
909	909
...	...	@@ -966,9 +966,9 @@
966	966	(% style="text-align:center" %)
967	967	[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
968	968
969		-== **Alarm tags data list** ==
	961	+== **3.8 Alarm tags data list** ==
970	970
971		-**{{id name="_Toc24963760"/}}Parameters**
	963	+**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
972	972
973	973	(% class="table-bordered" %)
974	974	|**acturl**|(% colspan="3" %)we-data/alarmdata
...	...	@@ -1003,7 +1003,7 @@
1003	1003	|totalRecord|(% colspan="2" %)Total records
1004	1004	|currentPage|(% colspan="2" %)Current page
1005	1005
1006		-**~ {{id name="_Toc24963761"/}}Operating procedures**
	998	+**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1007	1007
1008	1008	**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]]
1009	1009
...	...	@@ -1040,7 +1040,7 @@
1040	1040	(% style="text-align:center" %)
1041	1041	[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1042	1042
1043		-**Result**
	1035	+**3.8.3 Result**
1044	1044
1045	1045	{
1046	1046
...	...	@@ -1119,9 +1119,9 @@
1119	1119	(% style="text-align:center" %)
1120	1120	[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1121	1121
1122		-== **Get device state** ==
	1114	+== **3.9 Get device state** ==
1123	1123
1124		-**~ {{id name="_Toc24963760"/}}Parameters**
	1116	+**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1125	1125
1126	1126	(% class="table-bordered" %)
1127	1127	|**acturl**|(% colspan="3" %)we-data/getDeviceState
...	...	@@ -1131,7 +1131,7 @@
1131	1131	|(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1132	1132	|state|(% colspan="2" %)vbox state: 1-online,  0-offline
1133	1133
1134		-== **Send switch to device** ==
	1126	+== **3.10 Send switch to device** ==
1135	1135
1136	1136	**3.10.1 {{id name="_Toc24963760"/}}Parameters**
1137	1137
...	...	@@ -1142,9 +1142,9 @@
1142	1142	|(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1143	1143	|(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1144	1144
1145		-= **Appendix** =
	1137	+= **4 Appendix** =
1146	1146
1147		-== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
	1139	+== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1148	1148
1149	1149	100: 16-bit binary
1150	1150