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

优化查询业主信息接口文档

mrzcc лет назад: 6
Родитель
Сommit
9d60b280b8
1 измененных файлов с 40 добавлено и 24 удалено
  1. 40 24
      docs/document/api/owner/queryOwners.md

+ 40 - 24
docs/document/api/owner/queryOwners.md

@@ -1,11 +1,11 @@
 
 
-**1\. 查询业主成员信息**
+**1\. 查询业主信息**
 ###### 接口功能
-> 用户通过web端或APP查询业主成员信息
+> 查询业主信息接口
 
 ###### URL
-> [http://api.java110.com:8008/api/owner.queryOwnerMembers](http://api.java110.com:8008/api/owner.queryOwnerMembers)
+> [http://api.java110.com:8008/api/owner.queryOwners](http://api.java110.com:8008/api/owner.queryOwners)
 
 ###### 支持格式
 > JSON
@@ -35,19 +35,13 @@
 
 |父参数名称|参数名称|约束|类型|长度|描述|取值说明|
 | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
-|-|unitId|1|String|30|单元ID|-|
-|-|floorId|1|String|200|小区楼ID|-|
-|-|unitNum|1|String|12|单元编码|如 001 002|
-|-|layerCount|1|String|12|楼总层数|如 34|
-|-|lift|1|String|4|是否有电梯|如 1010 有 2020 无|
-|-|userName|1|String|50|创建者名称|如 张三 李四|
-|-|remark|?|String|200|备注|-|
-|-|createTime|1|String|30|创建时间|如:2018-04-09 12:00:34|
-
-
+|-|communityId|1|String|30|小区ID|-|
+|-|ownerTypeCd|1|String|30|业主ID|-|
+|-|page|1|int|-|页数|-|
+|-|row|1|int|-|没有行数|-|
 
 ###### 举例
-> 地址:[http://api.java110.com:8008/api/owner.queryOwnerMembers?ownerId=12312313&communityId=7020181217000002](http://api.java110.com:8008/api/owner.queryOwnerMembers?ownerId=12312313&communityId=7020181217000002)
+> 地址:[http://api.java110.com:8008/api/owner.queryOwners?ownerTypeCd=1001&floorId=-1&unitId=-1&page=1&row=10&communityId=7020181217000001](http://api.java110.com:8008/api/owner.queryOwners?ownerTypeCd=1001&floorId=-1&unitId=-1&page=1&row=10&communityId=7020181217000001)
 
 ``` javascript
 请求头信息:
@@ -62,15 +56,37 @@ SIGN:aabdncdhdbd878sbdudn898
 
 返回报文:
-[{
-		"unitId": "732019042181450002",
-		"floorId": "732019042181450002",
-		"layerCount": "30",
-		"lift": "1010",
-		"unitNum": "01",
-		"remark": "填写具体值",
-		"userName": "毛彬彬",
-		"createTime": "2018-04-09 12:00:34",
-	}]
+    {
+    	"owners": [{
+    		"age": "28",
+    		"createTime": "2019-09-25 09:03:22",
+    		"idCard": "632126199109162011",
+    		"link": "18999999999",
+    		"memberId": "772019092507000013",
+    		"name": "吴学文",
+    		"ownerId": "772019092507000013",
+    		"ownerTypeCd": "1001",
+    		"ownerTypeName": "业主",
+    		"sex": "0",
+    		"userName": "wuxw"
+    	},{
+    		"age": "23",
+    		"createTime": "2019-10-29 08:56:50",
+    		"idCard": "-1",
+    		"link": "15987097564",
+    		"memberId": "772019102956970002",
+    		"name": "张三",
+    		"ownerId": "772019102956970002",
+    		"ownerTypeCd": "1001",
+    		"ownerTypeName": "业主",
+    		"remark": "",
+    		"sex": "0",
+    		"userName": "wuxw"
+    	}],
+    	"page": 0,
+    	"records": 7,
+    	"rows": 0,
+    	"total": 63
+    }
 
 ```