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.Mora

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
...	...	@@ -48,7 +48,7 @@
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	49	)))
50	50
51		-== **Interface Parameter Description** ==
	51	+== **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** ==
	75	+== **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** =
	86	+= **2 Basic API** =
87	87	)))
88	88
89		-== **{{id name="_Toc24963726"/}}Login operation** ==
	89	+== **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**
	106	+**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**
	146	+**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** =
	173	+= **3 Service data APIs** =
174	174	)))
175	175
176		-== **V-Box list** ==
	176	+== **3.1 V-Box list** ==
177	177
178		-**{{id name="_Toc24963732"/}}Parameters**
	178	+**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**
	183	+**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**
	207	+**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** ==
	336	+== **3.2 Real-time group list** ==
337	337
338		-**{{id name="_Toc24963736"/}} Parameters**
	338	+**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**
	350	+**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**
	377	+**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** ==
	423	+== **3.3 Real-time tags configuration list** ==
424	424
425		-**Parameters**
	425	+**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
	430	+|(% 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**
	467	+**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**
	500	+**3.3.3 Result**
502	502
503	503	{
504	504
...	...	@@ -581,23 +581,18 @@
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** ==
	583	+== (% 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}}
	585	+**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
	590	+|(% 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,7 +610,7 @@
610	610	|totalRecord|(% colspan="2" %)Total record
611	611	|currentPage|(% colspan="2" %)current page
612	612
613		-**~ {{id name="_Toc24963745"/}}Operating procedures**
	607	+**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
...	...	@@ -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**
	635	+**3.4.3 {{id name="_Toc24963746"/}}Result**
642	642
643	643	{
644	644
...	...	@@ -703,10 +703,10 @@
703	703	(% style="text-align:center" %)
704	704	[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
705	705
706		-== **Modify tag data** ==
	700	+== **3.5 Modify tag data** ==
707	707
708	708	(((
709		-**Parameters**
	703	+**3.5.1 Parameters**
710	710	)))
711	711
712	712	(% class="table-bordered" %)
...	...	@@ -717,7 +717,7 @@
717	717	|value|value
718	718	|**Return value**|(% colspan="2" %)None
719	719
720		-**Operating procedures**
	714	+**3.5.2 Operating procedures**
721	721
722	722	**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]]
723	723
...	...	@@ -746,7 +746,7 @@
746	746	(% style="text-align:center" %)
747	747	[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
748	748
749		-**Result**
	743	+**3.5.3 Result**
750	750
751	751	{
752	752
...	...	@@ -763,9 +763,9 @@
763	763	(% style="text-align:center" %)
764	764	[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
765	765
766		-== **Historical tags name list** ==
	760	+== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
767	767
768		-**Parameters**
	762	+**3.6.1 Parameters**
769	769
770	770	(% class="table-bordered" %)
771	771	|**acturl**|(% colspan="3" %)we-data/monitors
...	...	@@ -777,7 +777,7 @@
777	777	|monitorId|tag ID
778	778	|monitorName|tag name
779	779
780		-**Operating procedures**
	774	+**3.6.2 Operating procedures**
781	781
782	782	**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]]
783	783
...	...	@@ -804,7 +804,7 @@
804	804	(% style="text-align:center" %)
805	805	[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
806	806
807		-**Result**
	801	+**3.6.3 Result**
808	808
809	809	{
810	810
...	...	@@ -847,9 +847,9 @@
847	847	(% style="text-align:center" %)
848	848	[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
849	849
850		-== **Historical tag data list** ==
	844	+== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
851	851
852		-**~ {{id name="_Toc24963756"/}}Parameters**
	846	+**3.7.1 {{id name="_Toc24963756"/}}Parameters**
853	853
854	854	(% class="table-bordered" %)
855	855	|**acturl**|(% colspan="3" %)we-data/historydata
...	...	@@ -869,7 +869,7 @@
869	869	|totalRecord|(% colspan="2" %)Total records
870	870	|currentPage|(% colspan="2" %)Current page
871	871
872		-**Operating procedures**
	866	+**3.7.2 Operating procedures**
873	873
874	874	**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]]
875	875
...	...	@@ -904,7 +904,7 @@
904	904	(% style="text-align:center" %)
905	905	[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
906	906
907		-**Result**
	901	+**3.7.3 Result**
908	908
909	909	{
910	910
...	...	@@ -967,9 +967,9 @@
967	967	(% style="text-align:center" %)
968	968	[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
969	969
970		-== **Alarm tags data list** ==
	964	+== **3.8 Alarm tags data list** ==
971	971
972		-**{{id name="_Toc24963760"/}}Parameters**
	966	+**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
973	973
974	974	(% class="table-bordered" %)
975	975	|**acturl**|(% colspan="3" %)we-data/alarmdata
...	...	@@ -1004,7 +1004,7 @@
1004	1004	|totalRecord|(% colspan="2" %)Total records
1005	1005	|currentPage|(% colspan="2" %)Current page
1006	1006
1007		-**~ {{id name="_Toc24963761"/}}Operating procedures**
	1001	+**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1008	1008
1009	1009	**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]]
1010	1010
...	...	@@ -1041,7 +1041,7 @@
1041	1041	(% style="text-align:center" %)
1042	1042	[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1043	1043
1044		-**Result**
	1038	+**3.8.3 Result**
1045	1045
1046	1046	{
1047	1047
...	...	@@ -1120,9 +1120,9 @@
1120	1120	(% style="text-align:center" %)
1121	1121	[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1122	1122
1123		-== **Get device state** ==
	1117	+== **3.9 Get device state** ==
1124	1124
1125		-**~ {{id name="_Toc24963760"/}}Parameters**
	1119	+**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1126	1126
1127	1127	(% class="table-bordered" %)
1128	1128	|**acturl**|(% colspan="3" %)we-data/getDeviceState
...	...	@@ -1132,7 +1132,7 @@
1132	1132	|(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1133	1133	|state|(% colspan="2" %)vbox state: 1-online,  0-offline
1134	1134
1135		-== **Send switch to device** ==
	1129	+== **3.10 Send switch to device** ==
1136	1136
1137	1137	**3.10.1 {{id name="_Toc24963760"/}}Parameters**
1138	1138
...	...	@@ -1143,9 +1143,9 @@
1143	1143	|(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1144	1144	|(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1145	1145
1146		-= **Appendix** =
	1140	+= **4 Appendix** =
1147	1147
1148		-== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
	1142	+== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1149	1149
1150	1150	100: 16-bit binary
1151	1151