Просмотр исходного кода

查询首页统计信息接口接口文档

mrzcc лет назад: 6
Родитель
Сommit
87bddeb0c3
1 измененных файлов с 65 добавлено и 0 удалено
  1. 65 0
      docs/document/api/count/queryIndexStatistic.md

+ 65 - 0
docs/document/api/count/queryIndexStatistic.md

@@ -0,0 +1,65 @@
+
+
+**1\. 查询首页统计信息**
+###### 接口功能
+> 查询首页统计信息接口
+
+###### URL
+> [http://api.java110.com:8008/api/index.queryIndexStatistic](http://api.java110.com:8008/api/index.queryIndexStatistic)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> GET
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数(url部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|communityId|1|-|30|小区ID|-|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容
+
+
+
+
+###### 举例
+> 地址:[http://api.java110.com:8008/api/index.queryIndexStatistic?communityId=7020181217000001](http://api.java110.com:8008/api/index.queryIndexStatistic?communityId=7020181217000001)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+
+无
+
+返回报文:
+ {
+		"freeParkingSpaceCount": "1",
+		"freeRoomCount": "1",
+		"freeShopCount": "0",
+		"noEnterRoomCount": "45",
+		"ownerCount": "58",
+		"parkingSpaceCount": "10",
+		"roomCount": "26",
+		"shopCount": "0"
+	}
+
+```