更新文档模块

src/routes/main/modules/api-doc/dynamic-interface/addPeople.md

@@ -22,6 +22,7 @@ addPeople
 
  ```json
 [{
+    fid: int ----------------------------------------Family表的ID,调用addFamily返回的
     name: string,------------------------------------姓名
     idCard: string,----------------------------------身份证号
     sex: string,-------------------------------------性别

src/routes/main/modules/api-doc/dynamic-interface/approveXieYi.md

 # 协议报审
 
 报审协议支持批量报审
+当数据全部进入系统，并锁定后，调用该接口，生成合同PDF 。
 
 ## 接口名称
 

src/routes/main/modules/api-doc/dynamic-interface/importFangYuan.md

 # 录入房源
 
-录入房源数据
+录入、更新房源数据。在选房之前，房子数据要进入系统。系统中房源以房源编号（number）为唯一标识。
 
 ## 接口名称
 
@@ -8,7 +8,7 @@ importFangYuan
 
 >## 用法
 
-- **URL：**/api/interface/user/getXieYiPDF/invoke
+- **URL：**/api/interface/user/importFangYuan/invoke
 
 - **Method:** Post
 > **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分

src/routes/main/modules/api-doc/dynamic-interface/isXieYiApproved.md

-# 查询协议是否审核
+# 查询协议是否正式协议
 
 ## 接口名称
 
@@ -28,9 +28,9 @@ isXieYiApproved
 
 返回data 中的值
 
-- 0 代表未报审
+- 0 代表未报审（非正式协议，无法获取合同pdf 文件）
 - -1 代表数据不存在
-- 1 代表已报审
+- 1 代表已报审（正式协议）
 
 ## 例子
 

src/routes/main/modules/api-doc/dynamic-interface/removeFamily.md

 # 删除两清
 
+删除两清是将系统中对应的两清数据以及关联数据，全部删除。
+
 ## 接口名称
 
 removeFamily

src/routes/main/modules/api-doc/dynamic-interface/removeHouse.md

-# 删除房源
+# 删除被补偿房屋
+
+删除被补偿房屋数据，这里的被补偿房屋，就是要征收或拆迁的房子，不是安置房屋。
 
 ## 接口名称
 

src/routes/main/modules/api-doc/dynamic-interface/updateHouse.md

-# 更新房屋
+# 更新被补偿房屋
 
-更新房屋数据，支持批量。批量能有效提高性能，所以能批量就批量。
+更新被补偿房屋数据，支持批量。被补偿房屋指的是将要征收或拆迁的房子，不是安置房源
 
 ## 接口名称
 

src/routes/main/modules/api-doc/dynamic-interface/updatePeople.md

@@ -7,7 +7,7 @@
 updatePeople
 >## 用法
 
-- **URL：**/api/interface/user/addPeople/invoke
+- **URL：**/api/interface/user/updatePeople/invoke
 
 - **Method:** POST
 > **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分

src/routes/main/modules/api-doc/dynamic-interface/updateXieYi.md

 # 更新协议
 
-更新协议数据，支持批量。批量能有效提高性能，所以能批量就批量。
+更新协议数据，支持批量。
+用来更新补偿数据，包括房屋价值补偿款，奖励补贴，安置房源等数据。如果补偿数据锁定，调用接口会更新不成功。
+调用该接口，数据需要是未锁定的
+
 ## 接口名称
+
 updateXieYi
+
 ## 前置条件
 
 - 必须指定fid
-- 只有解锁的两清数据才能进行修改
+- 只有未锁定的补偿数据才能进行修改
 
 ## 参数
 
 - data - 更新的数据，必须是数组，即使只有一条数据。
 
-  ```
+  ```json
   [{
-    anZhiFangShi:string, 
-	zhuangHuangBuTie:double, 
-	zhuangHuangBuTieGongShi:string, 
-	fangWuJiaZhiBuChangKuan:double, 
-	fangWuJiaZhiBuChangKuanGongShi:string, 
-	weiRenDingMianJiZongJia:double, 
-	weiRenDingMianJiZongJiaGongShi:string, 
-	fuShuWuJinE:double, 
-	fuShuWuGongShi:string,
-	tingChanTingYeBuTie:double,
-	tingChanTingYeBuTieGongShi:string,
-	qianYueRiQi:date,
-	jiXiRiQi:date,
-	banQianRiQi:date,
-	zuiHouJinE:double,
-	daiLiRens:string,
-    chaJiaJieSuan:double,
-	clauses:[{
-        content:string,
-        title:string
+    fid:int--------------------------------------------FamilyID ,就是调用addFamily 返回的那个ID
+    anZhiFangShi:string,-------------------------------安置方式
+    zhuangHuangBuTie:double, --------------------------装潢补贴
+    zhuangHuangBuTieGongShi:string, -------------------装潢补贴公式
+    fangWuJiaZhiBuChangKuan:double, -------------------房屋价值补偿款
+    fangWuJiaZhiBuChangKuanGongShi:string, ------------房屋价值补偿款公式
+    weiRenDingMianJiZongJia:double, -------------------未认定面积总价
+    weiRenDingMianJiZongJiaGongShi:string, ------------未认定面积总价公式
+    fuShuWuJinE:double, -------------------------------附属物金额
+    fuShuWuGongShi:string,-----------------------------附属物
+    tingChanTingYeBuTie:double,------------------------停产停业补贴
+    tingChanTingYeBuTieGongShi:string,-----------------停产停业补贴公式
+    qianYueRiQi:date,----------------------------------签约日期
+    banQianRiQi:date,----------------------------------搬迁日期
+    zuiHouJinE:double,---------------------------------合同最后金额
+    daiLiRens:string,----------------------------------代理人
+    chaJiaJieSuan:double,------------------------------差价结算（房屋价值补偿款和安置房源的接口）
+    clauses:[{-----------------------------------------附加条款
+        content:string,--------------------------------附加条款内容
+        title:string-----------------------------------附加条款标题
     }],
-	jiangLiBuTies:[{
-        formula:string,
-        money:double,
-        name:string,
-        order:int,
-        type:string
+    jiangLiBuTies:[{-----------------------------------奖励补贴
+        formula:string,--------------------------------奖励补贴公式
+        money:double,----------------------------------奖励补贴金额
+        name:string,-----------------------------------奖励补贴名称
+        order:int,-------------------------------------奖励补贴顺序
+        type:string------------------------------------奖励补贴类型（奖励or补助）
+    }],
+    anZhiFangWus:[{------------------------------------安置房屋
+        'order',int------------------------------------序号
+        'address',string-------------------------------地址
+        'area',double----------------------------------面积
+        'areaType',------------------------------------面积类型（建筑面积，预测面积，设计面积）
+        'fangWuDanJia',--------------------------------房屋单价
+        'fangWuZongJia',-------------------------------房屋总价
+        'youHuiDanJia',--------------------------------优惠单价
+        'youHuiZongJia',-------------------------------优惠总价
+        'shiChangDanJia',------------------------------市场单价
+        'shiChangZongJia',-----------------------------市场总价
+        'yuJiJiaoFangRiQi',----------------------------预计交房日期
+        'fangJiaGongShi',------------------------------房价公式（每套房子的钱可能是根据口径一套一套算出的金额）
+        'sheJiYangTaiMianJi',--------------------------设计阳台面积
+        'shiCeYangTaiMianJi',--------------------------实测阳台面积
+        'yuCeYangTaiMianJi'----------------------------预测阳台面积
+    }],
+    jingBanRens:[{
+      id:int------------------------------------------经办人的ID
     }]
   }]
+
   ```
 
 ## 返回值
+
 无

src/routes/main/modules/api-doc/dynamic-interface/whetherCancelXieYi.md

-# 是否协议已撤销
+# 申请撤销协议的处理状态
+
+申请撤销协议发出后，由市局工作人员，进行处理，同意撤销或者不同意撤销。
 
 ## 接口名称
 
@@ -19,7 +21,9 @@ whetherCancelXieYi
   - **data**  查询当前协议申请协议撤销市局人员是否已经处理，要传的参数名格式如下,其中1 2 3 是 申请记录的ID id
 
   ```json
-  [1,2,3]
+  [{
+      1,2,3
+  }]
   ```
 
 ## 返回值
@@ -77,4 +81,4 @@ whetherCancelXieYi
     ],
     "errorCode": 0
 }
-```
+```
\ No newline at end of file

src/routes/main/modules/api-doc/dynamic-interface/whetherUnLockLiangQing.md

-# 是否两清已解锁
+# 申请解锁两清是否处理
+
+申请解锁两清后，市局人员进行相关处理，同意解锁，或者不同意。返回处理的状态。
 
 ## 接口名称
 
@@ -79,4 +81,4 @@ whetherUnLockLiangQing
     ],
     "errorCode": 0
 }
-```
+```
\ No newline at end of file