优化接口协议

docs/document/_sidebar.md

@@ -11,6 +11,7 @@
 
   * [接口清单](api/Readme.md)
   * [调用流程](api/apiStart.md)
+  * [资产类接口](api/community/index.md)
   * [用户类接口](api/user/index.md)
   * [访客登记](api/user/saveVisit.md)
   * [访客登记变更](api/user/updateVisit.md)
@@ -39,8 +40,6 @@
   * [保存单元信息](api/unit/saveUnit.md)
   * [修改单元信息](api/unit/updateUnit.md)
   * [删除单元信息](api/unit/deleteUnit.md)
-  * [保存房屋信息](api/room/saveRoom.md)
-  * [修改房屋信息](api/room/updateRoom.md)
   * [删除房屋信息](api/room/deleteRoom.md)
   * [退房](api/room/exitRoom.md)
   * [查询已销售的房屋信息](api/room/queryRoomsWithSell.md)

docs/document/api/community/index.md

@@ -0,0 +1,149 @@
+## 说明
+
+资产类接口主要包括小区内的资产信息，如果楼栋 单元 房屋等信息
+
+## 添加楼栋
+
+未整理
+
+## 修改楼栋
+
+未整理
+
+## 添加单元
+
+未整理
+
+## 修改单元
+
+未整理
+
+## 添加房屋
+
+#### 接口说明
+
+#### 请求地址及方式
+
+>https://ip:port/api/room.saveRoom
+
+>http post
+
+#### 请求参数说明
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|unitPrice|1|String|4|房屋单价|-|
+|section|1|String|4|房间数|-|
+|remark|1|String|200|备注|-|
+|userId|1|String|30|用户ID|-|
+|communityId|1|String|30|小区ID|-|
+|layer|1|String|30|房屋楼层|-|
+|builtUpArea|1|String|30|建筑面积| 如 97.98|
+|roomNum|1|String|12|房间编号|1123|
+|unitId|1|String|30|小区单元ID|-|
+|state|1|String|12|房屋状态|2002 空闲状态|
+|apartment|1|String|4|户型|1010 一室一厅 1020 一室两厅 2010 两室一厅 2020 两室两厅 3020 三室两厅|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功，body内容为返回内容，
+
+成功
+
+
+###### 举例
+> 地址：[http://api.java110.com:8008/api/room.saveRoom](http://api.java110.com:8008/api/room.saveRoom)
+
+``` javascript
+请求头信息：
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文：
+
+{
+    "communityId":"小区ID",
+    "unitPrice":"填写具体值",
+    "section":"填写具体值",
+    "remark":"填写具体值",
+    "layer":"填写具体值",
+    "builtUpArea":"填写具体值",
+    "roomNum":"填写具体值",
+    "unitId":"填写具体值",
+    "apartment":"填写具体值"
+}
+
+返回报文：
+成功
+
+```
+
+
+## 修改房屋
+
+#### 接口说明
+
+#### 请求地址及方式
+
+>https://ip:port/api/room.updateRoom
+
+>http get
+
+#### 请求参数说明
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|roomId|1|String|30|房间ID|12312313|
+|unitPrice|1|String|4|房屋单价|-|
+|section|1|String|4|房间数|-|
+|remark|1|String|200|备注|-|
+|userId|1|String|30|用户ID|-|
+|communityId|1|String|30|小区ID|-|
+|layer|1|String|30|房屋楼层|-|
+|builtUpArea|1|String|30|建筑面积| 如 97.98|
+|roomNum|1|String|12|房间编号|1123|
+|unitId|1|String|30|小区单元ID|-|
+|apartment|1|String|4|户型|1010 一室一厅 1020 一室两厅 2010 两室一厅 2020 两室两厅 3020 三室两厅|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功，body内容为返回内容，
+
+成功
+
+
+###### 举例
+> 地址：[http://api.java110.com:8008/api/room.updateRoom](http://api.java110.com:8008/api/room.updateRoom)
+
+``` javascript
+请求头信息：
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文：
+
+{
+    "roomId":"12313",
+    "communityId":"小区ID",
+    "unitPrice":"填写具体值",
+    "section":"填写具体值",
+    "remark":"填写具体值",
+    "layer":"填写具体值",
+    "builtUpArea":"填写具体值",
+    "roomNum":"填写具体值",
+    "unitId":"填写具体值",
+    "apartment":"填写具体值"
+}
+
+返回报文：
+成功
+
+```