Skip to content

A
app-manage-console
提交 c7f01c64 authored 作者: vipcxj's avatar vipcxj
浏览文件
操作

更新文档模块

上级 faae0b77
显示空白字符变更
内嵌 并排
正在显示 包含 1681 行增加 和 424 行删除
src/routes/main/modules/api-doc/dynamic-interface/addFamily.md
浏览文件 @ c7f01c64
...@@ -2,63 +2,142 @@ ...@@ -2,63 +2,142 @@
新增两清数据，支持批量。批量能有效提高性能，所以能批量就批量。 新增两清数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须切换到基地这一级别 addFamily
>## 用法
- **URL：**/api/interface/user/addFamily/invoke
- **Method:** POST
> **Note:** <font color="#dd0000">Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分.</font>
## 参数 ## 参数
- data - 新增的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH002/XH002"，/XH 代表徐汇区，/XH/XH002代表某个项目，其中/XH002 是项目编号
- **params:**
- **data** 新增的数据，必须是数组，即使只有一条数据。
``` ```json
[{ [{
anZhiFangShi: string, beiChaiQianRen: string,----------------------被拆迁人
beiChaiQianRen: string, buWeiPingGuJieHeChongXinDanJia: string,------多房子，分开评估 如 房1：1700元/㎡，房2：1200元/㎡
buWeiPingGuJieHeChongXinDanJia: double, chongZhiJieHeChengXin: double,---------------多房子，评估成一个单价。
chongZhiJieHeChengXin: double, devices: [{----------------------------------设备
devices: [{ danJia:double,-----------------------------单价
danJia:double, jiLiang:double,----------------------------数量
jiLiang:double, name:string,-------------------------------名称
name:string, unit:string,-------------------------------单位，如个，平方米等
unit:string, zongJia:double-----------------------------总价
zongJia:double
}], }],
erTai: int, erTai: int,----------------------------------二胎
fangWuXingZhi: string, fangWuXingZhi: string,-----------------------房屋性质
fangWuZuoLuo: string, fangWuZuoLuo: string,------------------------房屋坐落
fuShuWuJinE: double, fuShuWuJinE: double,-----------------------附属物金额
fuShuWus: [{ fuShuWus: [{---------------------------------附属物
danJia:double, danJia:double,-----------------------------单价
jieGou:string, jieGou:string,-----------------------------结构
jiLiang:double, jiLiang:double,----------------------------数量
name:string, name:string,-------------------------------名称
type:string, type:string,-------------------------------类型
unit:string, unit:string,-------------------------------单位
usage:string, usage:string,------------------------------附属物用途
zongJia:double zongJia:double-----------------------------附属物总价
}], }],
heDingMianJi: double, heDingMianJi: double,------------------------核定面积
identityCard: string, identityCard: string,------------------------被补偿人身份证号
isLocked: string, juMinFenZu: string,--------------------------居民分组
jiXiRiQi: date, leiXing: string,-----------------------------如居民户，农民户
juMinFenZu: string, number: string,------------------------------征收编号，合同编号
juMinLeiXing: string, pingGuMianJi: double,------------------------评估面积
leiXing: string, shiCeMianJi: double,-------------------------实测面积
number: string, tuDiZhengHao: string,------------------------土地证号
pingGuMianJi: double, weiRenDingMianJi: double,--------------------未认定面积
shiCeMianJi: double, wuZhengMJ: double,---------------------------无证面积
tuDiZhengHao: string, yingJianWeiJianMianJi: string,---------------应建未建面积
weiRenDingMianJi: double, youZhengDuoYuMianJi: string,-----------------有证多余面积
wuZhengMJ: double, youZhengMianJi: string,----------------------有证面积
yingJianWeiJian: string, zhaiJiDiShiYongZheng: string-----------------宅基地使用证
yingJianWeiJianMJ: string,
youZhengDuoYuMianJi: string,
youZhengDuoYuMJ: string,
youZhengMianJi: string,
zhaiJiDiShiYongZheng: string
}] }]
``` ```
## 返回值 ## 返回值
`[int]` - 新增的两清的id `[int]` - 新增的两清的id
## 例子1
>**Note:** 测试时，例子中的参数token中的值不可以直接使用。
```json
{
"token": "r0GRdB_xSjijV8Um5mrAPIjOKzQM_V_MsBYAP26yH5utZnQkBQrki539pqV4eKcHj9q14mdFW4uZwlTabdYuRXjOQmOtc9DJV23KiWOrg1aNxTd_0UH6B9HieYIVG0lPSLUABQN6-B_ewlTdi7KxwCchO8iNAs7zCaz39UNc0Jg",
"dmPath": "/XH/XH002/XH002",
"params": {
"data": [
{
"erTai": 0,
"fuShuWus": [
{
"danJia": 9200,
"jiLiang": 1,
"name": "棚舍及附属物",
"zongJia": 9200
}
],
"number": "14HP0112",
"isLocked": false,
"beiChaiQianRen": "吴龙华(户)",
"identityCard": "310221195909183215",
"fangWuZuoLuo": "宅河头76号",
"leiXing": "农业户",
"fangWuXingZhi": "私房",
"youZhengMianJi": "178.0000",
"heDingMianJi": "301.0000",
"shiCeMianJi": "405.5000",
"chongZhiJieHeChengXin": "830.00",
"yingJianWeiJian": "0.00",
"youZhengDuoYuMianJi": "0.00",
"tuDiZhengHao": "",
"zhaiJiDiShiYongZheng": "沪集宅(上龙)字第华浦-330号",
"erCiDongQianMianJi": "0.00",
"heDingRenKou": "7.0000",
"zaiCeHuShu": "2.00"
}
]
}
}
```
## 例子2
```json
{
"token": "ZrFT8bbnQy-CkmL0_sGNModAE142dFiV5HmUcFA3Jm1yt3XZqjZa5Q8ifNvxi7EgInc46K4JnRwNodLbkSlSqO2v2UU7wdY24QwpDAjcBhzFQCXhwOYUVU8JKVCD85ps3PxnioIFuYkP6YZH_FdluTsl7siRin5yAxIMxCNWqI8",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [{
"erTai": 0,
"fuShuWus": [{
"danJia": 29051.0,
"jiLiang": 1.0,
"name": "",
"zongJia": 29051.0
}],
"number": "QPXQCJT-18",
"beiChaiQianRen": "杜进兴（户）",
"identityCard": "",
"fangWuZuoLuo": "新桥村51号",
"youZhengMianJi": "263.0600",
"heDingMianJi": "180.0000",
"juMinFenZu": "十一队",
"weiRenDingMianJi": "0.0000",
"pingGuMianJi": "263.06",
"buWeiPingGuJieHeChongXinDanJia": "主屋：758.00、附屋：673.00",
"fuShuWuJinE": "29051.00"
}]
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/addHouse.md
浏览文件 @ c7f01c64
...@@ -2,32 +2,84 @@ ...@@ -2,32 +2,84 @@
新增房屋数据，支持批量。批量能有效提高性能，所以能批量就批量。 新增房屋数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须切换到基地这一级别 addHouse
## 参数 >## 用法
- data - 新增的数据，必须是数组，即使只有一条数据。 - **URL：**/api/interface/user/addHouse/invoke
- **Method:** POST
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
``` ## 参数
- **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 新增的数据，必须是数组，即使只有一条数据。
```json
[{ [{
name:string, fid:int-----------------------------调用addFamily接口返回的ID，即房子归属于哪个合同
zhengZaiMianJi:double, name:string,------------------------名称（房屋的名称）
pingGuDanJia:double, zhengZaiMianJi:double,--------------证载面积
pingGuJiaGe:double, pingGuDanJia:double,----------------评估单价
fangWuYongTu:string, pingGuJiaGe:double,-----------------评估价格
shiFouRenDing:string, fangWuYongTu:string,----------------房屋用途
yangTaiMianJi:double, shiFouRenDing:string,---------------是否认定
pengSheMianJi:double, yangTaiMianJi:double,---------------阳台面积
chaoLing:string, pengSheMianJi:double,---------------棚舍面积
fangWuLeiXing:string, chaoLing:string,--------------------是否超龄老房
renDingMianJi:double, fangWuLeiXing:string,---------------房屋类型
ceHuiMianJi:double, renDingMianJi:double,---------------认定面积
tengKongShiJian:timestamp ceHuiMianJi:double,-----------------测绘面积
tengKongShiJian:timestamp-----------腾空时间
}] }]
``` ```
## 返回值 ## 返回值
`[int]` - 新增的房屋的id `[int]` - 新增的房屋的id
## 例子
```json
{
"token": "Y61Cp_zXDYTPYiGYUEmhD0a4uYu7-9NsetKtQaR7Gs0XEOJScQ9Lk1-kFIH_MgK0zZgu_6BMLqJRtUhnS4HDuB_YvNsMcIX5cALlfWHpW_Vetjn2VCL4_k-7hbMVXsEbvscZUfMO-CkA1wh0MpH40oFweZao6YWSZG3Qg4AuWg4",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [{
"fid": "18155",
"ceHuiMianJi": 0.0,
"fangWuLeiXing": "",
"fangWuYongTu": "居住",
"name": "主屋",
"pengSheMianJi": 0.0,
"pingGuDanJia": 758.0,
"pingGuJiaGe": 141124.44,
"renDingMianJi": 0.0,
"shiFouRenDing": "是",
"tengKongShiJian": "0001-01-01T00:00:00",
"yangTaiMianJi": 0.0,
"zhengZaiMianJi": 186.18
},
{
"fid": "18155",
"ceHuiMianJi": 0.0,
"fangWuLeiXing": "",
"fangWuYongTu": "居住",
"name": "附屋",
"pengSheMianJi": 0.0,
"pingGuDanJia": 673.0,
"pingGuJiaGe": 51740.24,
"renDingMianJi": 0.0,
"shiFouRenDing": "是",
"tengKongShiJian": "0001-01-01T00:00:00",
"yangTaiMianJi": 0.0,
"zhengZaiMianJi": 76.88
}]
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/addPeople.md
浏览文件 @ c7f01c64
# 新增People # 新增人口
新增People数据，支持批量。批量能有效提高性能，所以能批量就批量。 新增人口数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须切换到基地这一级别 addPeople
>## 用法
- **URL：**/api/interface/user/addPeople/invoke
- **Method:** POST
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 新增的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
``` - **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 新增的数据，必须是数组，即使只有一条数据。
```json
[{ [{
name:string, name: string,------------------------------------姓名
idCard:string, idCard: string,----------------------------------身份证号
sex:string, sex: string,-------------------------------------性别
age:int, age: int,----------------------------------------年龄
chanQuanRen:boolean, chanQuanRen: boolean,----------------------------是否产权人
relationWithChanQuanRen:string, relationWithChanQuanRen: string,-----------------与产权人关系
huZhu:boolean, huZhu: boolean,----------------------------------是否户主
relationWithHuZhu:string, relationWithHuZhu: string,-----------------------与户主关系
teKun:boolean, teKun: boolean,----------------------------------是否特困
daBing:boolean, daBing: boolean,---------------------------------是否大病
gaoLing:boolean, gaoLing: boolean,--------------------------------是否高龄
daLingWeiHun:boolean, daLingWeiHun: boolean,---------------------------是否大龄未婚
canJi:boolean, canJi: boolean,----------------------------------是否残疾
zaiCe:boolean, zaiCe: boolean,----------------------------------是否在册
anZhi:boolean, anZhi: boolean,----------------------------------是否安置
weiYun:boolean, weiYun: boolean,---------------------------------是否未孕
duShengZiNv:boolean, duShengZiNv: boolean,----------------------------是否独生子女
birthDay:date, birthDay: date,----------------------------------出生年月
cunZaiWeiHeDingPeiOu:boolean cunZaiWeiHeDingPeiOu: boolean--------------------是否存在未核定配偶
}] }]
``` ```
## 返回值 ## 返回值
`[int]` - 新增的people的id `[int]` - 新增的people的id
## 例子
```json
{
"token": "f_pIt_6oIF2qzNto6hw-hYqet8HdQKext5jvXnHa0omEgmNypxeYNbJRs3RJl7buITnUT3btpxgPiqajQe8Rrh01767hj-BFfo8ug-SDEUN9HU4JXI7x2B00S-4vE72w_k-8LAZ1wzBH3-a6ktXORSnq_kDAYIP7X3F3hvrxm48",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [
{
"fid": "18155",
"age": 0,
"birthDay": "1900/01/01",
"idCard": "410726199104048172",
"name": "吴某",
"relationWithChanQuanRen": "朋友",
"sex": "男",
"anZhi": "是",
"canJi": false,
"chanQuanRen": false,
"cunZaiWeiHeDingPeiOu": false,
"daBing": false,
"daLingWeiHun": false,
"duShengZiNv": false,
"huZhu": false,
"teKun": false,
"weiYun": false,
"zaiCe": "否",
"gaoLing": false
},
{
"fid": "18155",
"age": 0,
"birthDay": "1900/01/01",
"idCard": "37172419970404447X",
"name": "宇辰",
"relationWithChanQuanRen": "无",
"sex": "男",
"anZhi": "是",
"canJi": false,
"chanQuanRen": false,
"cunZaiWeiHeDingPeiOu": false,
"daBing": false,
"daLingWeiHun": false,
"duShengZiNv": false,
"huZhu": false,
"teKun": false,
"weiYun": false,
"zaiCe": "否",
"gaoLing": false
}
]
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/approveXieYi.md
浏览文件 @ c7f01c64
...@@ -2,20 +2,31 @@ ...@@ -2,20 +2,31 @@
报审协议支持批量报审 报审协议支持批量报审
## 前置条件 ## 接口名称
- 必须切换到基地这一级别 approveXieYi
>## 用法
- **URL：**/api/interface/user/approveXieYi/invoke
- **Method:** POST
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 报审要传的参数名格式如下,其中1 2 3 为协议的id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 报审要传的参数名格式如下,其中1 2 3 为Family的id,即addFamily接口 返回的ID
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
``` ```
## 返回值 ## 返回值
无 无
src/routes/main/modules/api-doc/dynamic-interface/bindClerks.md deleted 100755 → 0
浏览文件 @ faae0b77
# bindClerks
## 前置条件
- 必须切换到基地这一级别
## 参数
- data - 绑定经办人要传的参数名格式如下,其中1 2 3 为baseID
```
[{
1,2,3
}]
```
## 返回值
无
src/routes/main/modules/api-doc/dynamic-interface/generateXieYiPdf.md deleted 100755 → 0
浏览文件 @ faae0b77
# 生成pdf
生成协议的pdf
## 前置条件
- 必须切换到基地这一级别
## 参数
- data -生成pdf要传的参数名格式如下,其中1 2 3 为协议的id
```
[{
1,2,3
}]
```
## 返回值
无
src/routes/main/modules/api-doc/dynamic-interface/getClerks.md
浏览文件 @ c7f01c64
# getClerks # 获取工作人员(上岗人员)
## 接口名称
## 前置条件 getClerks
- 必须切换到基地这一级别 >## 用法
- **URL：**/api/interface/user/getClerks/invoke
- **Method:** Get
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 获取经办人要传的参数名格式如下,其中1 2 3 为baseID - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **{}** 无参数，但是{}一定要有。
``` 例如，用下面参数调用接口
[{
1,2,3 ```json
}] [{}]
``` ```
## 返回值 ## 返回值
无 接口的返回基本都是json格式，并且有如下形式:
```json
{
errorCode: long,---------------------为0表示成功
data: any,---------------------------返回的结果
message: string----------------------errorCode 为错误代码时候，显示错误信息
}
```
## 例子
>**note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
**Result**
```json
{
"errorCode": 0,
"data": [
{
"number": "222",
"name": "zhangsahou",
"id": 1095
},
{
"number": "333",
"name": "zhangsan",
"id": 1096
}
],
"message": ""
}
```
src/routes/main/modules/api-doc/dynamic-interface/getXieYiPdf.md
浏览文件 @ c7f01c64
# getXieYiPdf # 获取协议PDF
## 接口名称
## 前置条件 getXieYiPDF
- 必须切换到基地这一级别 >## 用法
- 必须指定XieYi id
- 已报审数据
## 参数 - **URL：**/api/interface/user/getXieYiPDF/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
- data - 获取XieYi PDF 要传的参数名格式如下,其中1 2 3 XieYi id ## 参数
``` - **token:** token是在登陆后获取的tokenId，加密后的结果。
[{ - **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
1,2,3 - **params:**
}] - **id** 是主数据Family的ID
```
## 返回值 ## 返回值
无 如果该id 对应的Family 已经报审，那么就会返回，合同的PDF文件下载路径。
如果参数id在系统中不存在或者数据未报审，才会返回错误。具体参看例子。
## 例子
### id存在且报审
>参数为`{"id":1348}`(省略了token,dmpath等参数)
- result
```json
{
"data": "http://222.73.234.155/bm/resource/vK6Yk1k94K7ZDrZmEFmyYwuWj8Nbg-_Hj79xzq-GQruyzZVoH6tVfKHBFGdtOHuH-95ZMZmON0OXyMpqUBrLi07Z09U5PYU9B2CvxW8QsAjgPXPIWT8kTh3rGd9PsvnbWO0SvnZ8TSJo3uLN9BfqApgtcUvIJ4YGC4oUajPFC30/emb%3A%2F%2F1508",
"errorCode": 0
}
```
- 特别注意：返回的链接是有时效性的，目前是半小时后失效。如时间失效，需要重新调用接口获取。
### id不存在
>参数为`{"id":1349}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 65536,
"message": "无效的id或协议未报审"
}
```
- 特别注意：返回的链接是有时效性的，目前是半小时后失效。如时间失效，需要重新调用接口获取。
### id存在，协议未报审
>参数为`{"id":1348}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 65536,
"message": "无效的id或协议未报审"
}
```
- 特别注意：返回的链接是有时效性的，目前是半小时后失效。如时间失效，需要重新调用接口获取。
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/importFangYuan.md
浏览文件 @ c7f01c64
# importFangYuan # 录入房源
importFangYuan数据 录入房源数据
## 前置条件 ## 接口名称
- 必须切换到基地这一级别 importFangYuan
>## 用法
- **URL：**/api/interface/user/getXieYiPDF/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - importFangYuan的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
``` - **params:**
[{ - **data** 是FangYuan的数据
number:string, - **bindPath** 把房子绑定到某个项目中.
type:string,
nature:string, ```json
peiTao:string, [{
qiOrXian:string, number:string,-------------------------------房源编号（主键，必须唯一）
laiYuan:string type:string,---------------------------------房源类别
huXing:string, nature:string,-------------------------------性质
taoXing:string, peiTao:string,-------------------------------是否配套
jieGou:string, qiOrXian:string,-----------------------------期房现房
usage:string, laiYuan:string,------------------------------来源
yuCeMianJi:double, huXing:string,-------------------------------户型
yuCeYangTaiMianJi:double, taoXing:string,------------------------------套型
shiCeMianJi:double, jieGou:string,-------------------------------房源结构
shiCeYangTaiMianJi:double, usage:string,--------------------------------用途
sheJiMianJi:double, yuCeMianJi:double,---------------------------预测面积
sheJiYangTaiMianJi:double, yuCeYangTaiMianJi:double,--------------------预测阳台面积
anZhiMianJi:double, shiCeMianJi:double,--------------------------实测面积
usedAreaType:string, shiCeYangTaiMianJi:double,-------------------实测阳台面积
usedArea:double, sheJiMianJi:double,--------------------------设计面积
danJia:double, sheJiYangTaiMianJi:double,-------------------设计阳台面积
youHuiDanJia:double, usedAreaType:string,-------------------------使用面积类型
zongJia:double, usedArea:double,-----------------------------使用面积
youHuiZongJia:double, danJia:double,-------------------------------单价
shiCeZongJia:double, youHuiDanJia:double,-------------------------优惠单价
district:string, zongJia:double,------------------------------房屋总价
subDistrict:string, youHuiZongJia:double,------------------------优惠总价
community:string, shiCeZongJia:double,-------------------------实测总价
lane:string, district:string,-----------------------------所属区域
building:string, subDistrict:string,--------------------------街道名
unit:string, community:string,----------------------------小区名称
no:string, lane:string,---------------------------------弄
floor:string, building:string,-----------------------------幢、栋
room:string, unit:string,---------------------------------单元
contractNumber:, no:string,-----------------------------------号
diKuai:string, floor:string,--------------------------------楼层
address:string, room:string,---------------------------------室号
jinHuRiQi:date, contractNumber:,-----------------------------联系电话
yuJiJiaoFangRiQi:date, diKuai:string,-------------------------------地块名称
shiJiJiaoFangRiQi:date, address:string,------------------------------地址
createDate:date jinHuRiQi:date,------------------------------进户日期
}] yuJiJiaoFangRiQi:date,-----------------------预计交房日期
``` shiJiJiaoFangRiQi:date,----------------------实际交房日期
}]
```
## 返回值 ## 返回值
无 无
## 例子
```json
{
"token": "RNZWJeF2n5pOlLPuHr8xFZNT5sH3HMEmD75axJ_n17swh6yv-oRV1Jr3GRhn1gLWpGGtQYvC9r9-yBteXmg-qDxp2Ln70R9gBEMo95vxcHShLPNWTp3USqUglRs2XqHKQrToyw5pwBjJsv_UxZzrT30DQPsr07cemMi99QBXVYY",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [
{
"anZhiMianJi": 0,
"building": "",
"community": "",
"danJia": 3400,
"district": "浦东新区",
"floor": "",
"huXing": "",
"jieGou": "",
"laiYuan": "",
"lane": "",
"nature": "",
"no": "",
"number": "cs-005",
"peiTao": "",
"qiOrXian": "期房",
"room": "",
"sheJiMianJi": 0,
"sheJiYangTaiMianJi": 0,
"shiCeMianJi": 0,
"shiCeYangTaiMianJi": 0,
"shiCeZongJia": 0,
"shiJiJiaoFangRiQi": "0001/01/01",
"subDistrict": "",
"taoXing": "中套",
"unit": "",
"usedArea": 85.12,
"usedAreaType": "预测面积",
"youHuiDanJia": 0,
"youHuiZongJia": 0,
"yuCeMianJi": 0,
"yuCeYangTaiMianJi": 0,
"yuJiJiaoFangRiQi": "1900/01/01",
"zongJia": 0
},
{
"anZhiMianJi": 0,
"building": "",
"community": "",
"danJia": 3400,
"district": "浦东新区",
"floor": "",
"huXing": "",
"jieGou": "",
"laiYuan": "",
"lane": "",
"nature": "",
"no": "",
"number": "cs-012",
"peiTao": "",
"qiOrXian": "期房",
"room": "",
"sheJiMianJi": 0,
"sheJiYangTaiMianJi": 0,
"shiCeMianJi": 0,
"shiCeYangTaiMianJi": 0,
"shiCeZongJia": 0,
"shiJiJiaoFangRiQi": "0001/01/01",
"subDistrict": "",
"taoXing": "小大套",
"unit": "",
"usedArea": 96.51,
"usedAreaType": "预测面积",
"youHuiDanJia": 0,
"youHuiZongJia": 0,
"yuCeMianJi": 0,
"yuCeYangTaiMianJi": 0,
"yuJiJiaoFangRiQi": "1900/01/01",
"zongJia": 0
}
],
"bindPath": "/XH/XH2018003/XH2018003-01"
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/index.js
浏览文件 @ c7f01c64
...@@ -9,8 +9,6 @@ export default (match) => { ...@@ -9,8 +9,6 @@ export default (match) => {
['addHouse', '新增房屋'], ['addHouse', '新增房屋'],
['addPeople', '新增人口'], ['addPeople', '新增人口'],
['approveXieYi', '协议报审'], ['approveXieYi', '协议报审'],
['bindClerks', '绑定经办人'],
['generateXieYiPdf', '生成协议pdf'],
['getClerks', '获取经办人'], ['getClerks', '获取经办人'],
['getXieYiPdf', '获取协议pdf'], ['getXieYiPdf', '获取协议pdf'],
['importFangYuan', '导入房源'], ['importFangYuan', '导入房源'],
...@@ -29,6 +27,8 @@ export default (match) => { ...@@ -29,6 +27,8 @@ export default (match) => {
['updateHouse', '更新房屋'], ['updateHouse', '更新房屋'],
['updatePeople', '更新人口'], ['updatePeople', '更新人口'],
['updateXieYi', '更新协议'], ['updateXieYi', '更新协议'],
['whetherCancelXieYi', '是否协议已撤销'],
['whetherUnLockLiangQing', '是否两清已解锁'],
].map(([name, showName]) => ({ ].map(([name, showName]) => ({
name, name,
showName, showName,
......
src/routes/main/modules/api-doc/dynamic-interface/index.md 100644 → 100755
浏览文件 @ c7f01c64
...@@ -7,42 +7,16 @@ ...@@ -7,42 +7,16 @@
不过一般情况下，进入生产环境配置好的接口不会轻易改动， 不过一般情况下，进入生产环境配置好的接口不会轻易改动，
除非有bug。 除非有bug。
## 验证前置条件 - **URL:** /api/interface/user/{name}/invoke
调用动态接口可能需要满足某些状态条件，使用这个api来事先进行检测。
改api如果检测满足前置条件，则没有返回值，如果不满足条件`errorCode`则不为0，
`errorCode`含义依赖于具体配置，另外`message`字段也可能包含错误信息，
`data`字段可能包含特定的错误数据。
- **URL**
/api/interface/user/{name}/invoke/validateState
- *name* - 动态接口的名称，可以认为是动态接口的唯一标识符。 - *name* - 动态接口的名称，可以认为是动态接口的唯一标识符。
- **Method**: - **Method:** POST
GET
- **query parameter** - **Accept:** application/json
- 无
- **Content-Type**:
application/json
- `null`
## 调用动态接口
执行动态接口，调用此接口，服务端仍然会进行前置条件验证。
- **URL**:
/api/interface/user/{name}/invoke
- *name* - 动态接口的名称，可以认为是动态接口的唯一标识符。
- **Method**:
POST
- **Accept**:
application/json
- *params* - **object** 动态接口的参数，类似函数的参数。 - *params* - **object** 动态接口的参数，类似函数的参数。
任意键值对，键为字符串，值为任意合法的**json**值类型。 任意键值对，键为字符串，值为任意合法的**json**值类型。
具体的形式依赖于当前动态接口的配置。 具体的形式依赖于当前动态接口的配置。
- **Content-Type**: - **Content-Type:** application/json
application/json
- \- **any** 返回值没有固定类型，完全依赖于配置。 - \- **any** 返回值没有固定类型，完全依赖于配置。
src/routes/main/modules/api-doc/dynamic-interface/isLiangQingLocked.md
浏览文件 @ c7f01c64
# isLiangQingLocked # 查询两清是否锁定
## 接口名称
## 前置条件 isLiangQingLocked
- 只能查询当前区域的数据 >## 用法
- 必须指定LiangQing id
- **URL：**/api/interface/user/isLiangQingLocked/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 判断两清是否锁定要传的参数名格式如下,其中1 2 3 LiangQing id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 查询两清是否锁定要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,4 +26,56 @@ ...@@ -18,4 +26,56 @@
## 返回值 ## 返回值
无 返回data 中的值
- 0 代表未锁定
- -1 代表数据不存在
- 1 代表已锁定
## 例子
### id存在
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0
],
"errorCode": 0
}
```
### id不存在
>参数为`{"data":[1815]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
-1
],
"errorCode": 0
}
```
### 多个id
>参数为`{"data":[18155,1]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0,
-1
],
"errorCode": 0
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/isXieYiApproved.md
浏览文件 @ c7f01c64
# isXieYiApproved # 查询协议是否审核
## 接口名称
## 前置条件 isXieYiApproved
- 只能查询当前区域的数据 >## 用法
- 必须指定XieYi id
- **URL：**/api/interface/user/isXieYiApproved/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 判断XieYi是否审核要传的参数名格式如下,其中1 2 3 XieYi id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 查询当前协议是不是报审状态要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,4 +26,56 @@ ...@@ -18,4 +26,56 @@
## 返回值 ## 返回值
无 返回data 中的值
- 0 代表未报审
- -1 代表数据不存在
- 1 代表已报审
## 例子
### id存在
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0
],
"errorCode": 0
}
```
### id不存在
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
-1
],
"errorCode": 0
}
```
### 多个id
>参数为`{"data":[18155,1]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0,
-1
],
"errorCode": 0
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/isXieYiLocked.md
浏览文件 @ c7f01c64
# isXieYiLocked # 查询协议是否锁定
## 接口名称
## 前置条件 isXieYiLocked
- 只能查询当前区域的数据 >## 用法
- 必须指定XieYi id
- **URL：**/api/interface/user/isXieYiLocked/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 判断XieYi是否锁定要传的参数名格式如下,其中1 2 3 XieYi id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 查询当前协议是不是锁定状态要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,4 +26,56 @@ ...@@ -18,4 +26,56 @@
## 返回值 ## 返回值
无 返回data 中的值
- 0 代表未锁定
- -1 代表数据不存在
- 1 代表已锁定
## 例子
### id存在
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0
],
"errorCode": 0
}
```
### id不存在
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
-1
],
"errorCode": 0
}
```
### 多个id
>参数为`{"data":[18155,1]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0,
-1
],
"errorCode": 0
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/lockLiangQing.md
浏览文件 @ c7f01c64
# LockLiangQing # 锁定两清
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 lockLiangQing
- 必须指定LiangQing id
>## 用法
- **URL：**/api/interface/user/lockLiangQing/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 锁定两清要传的参数名格式如下,其中1 2 3 LiangQing id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 锁定两清要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,3 +27,30 @@ ...@@ -18,3 +27,30 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 0
}
说明 锁定两清成功
```
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": 0,
"errorCode": 268435457,
"message": "无效的id：0"
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/lockXieYi.md
浏览文件 @ c7f01c64
# LockXieYi # 锁定协议
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 lockXieYi
- 必须指定XieYi id
>## 用法
- **URL：**/api/interface/user/lockXieYi/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 锁定XieYi要传的参数名格式如下,其中1 2 3 XieYi id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 锁定协议要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,3 +27,42 @@ ...@@ -18,3 +27,42 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 0
}
说明 锁定两清成功
```
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": 0,
"errorCode": 268435457,
"message": "无效的id：0"
}
```
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": 18155,
"errorCode": 268435458,
"message": "请先锁定两清，再锁定协议"
}
```
src/routes/main/modules/api-doc/dynamic-interface/removeFamily.md
浏览文件 @ c7f01c64
# 删除两清 # 删除两清
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 removeFamily
- 必须指定两清id
- 只有解锁的两清数据才能进行删除 >## 用法
- **URL：**/api/interface/user/removeFamily/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -删除两清要传的参数名格式如下,其中1 2 3 两清id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 删除两清要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -19,3 +27,30 @@ ...@@ -19,3 +27,30 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 65555,
"message": "两清信息已锁定,请申请解锁后再更改"
}
```
>参数为`{"data":222}`(省略了token,dmpath等参数)
- result
```json
{
"data": 222,
"errorCode": 268435457,
"message": "无效的id：222"
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/removeFangYuan.md
浏览文件 @ c7f01c64
# 删除房源 # 删除房源
## 前置条件 ## 接口名称
- 必须指定id removeFangYuan
- 已使用的房源不能删除
>## 用法
- **URL：**/api/interface/user/removeFangYuan/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -删除房源要传的参数名格式如下,其中1 2 3 房源id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 删除房源要传的参数名格式如下,其中1 2 3 是 房源 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -18,3 +27,20 @@ ...@@ -18,3 +27,20 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":"cs-005"}`(省略了token,dmpath等参数)
- result
```json
{
"data": 0,
"errorCode": 0
}
data 为0表示没有删除成功
```
src/routes/main/modules/api-doc/dynamic-interface/removeHouse.md
浏览文件 @ c7f01c64
# 删除House # 删除房源
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 removeHouse
- 必须指定House id
- 只有解锁的两清数据才能进行删除 >## 用法
- **URL：**/api/interface/user/removeHouse/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -删除House要传的参数名格式如下,其中1 2 3 House id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 删除被补偿房屋要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -19,3 +27,42 @@ ...@@ -19,3 +27,42 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": 18155,
"errorCode": 268435457,
"message": "无效的id: 18155"
}
```
>参数为`{"data":18251}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 65555,
"message": "两清信息已锁定,请申请解锁后再更改"
}
```
>参数为`{"data":18251}`(省略了token,dmpath等参数)
- result
```json
{
"data":0,
"errorCode": 0
}
删除成功
```
src/routes/main/modules/api-doc/dynamic-interface/removePeople.md
浏览文件 @ c7f01c64
# 删除人口 # 删除人口
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 removePeople
- 必须指定人口id
- 只有解锁的两清数据才能进行删除 >## 用法
- **URL：**/api/interface/user/removePeople/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -删除人口要传的参数名格式如下,其中1 2 3 人口id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 删除人口要传的参数名格式如下,其中1 2 3 是 两清 id
``` ```json
[{ [{
1,2,3 1,2,3
}] }]
...@@ -19,3 +27,31 @@ ...@@ -19,3 +27,31 @@
## 返回值 ## 返回值
无 无
## 例子
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"errorCode": 65555,
"message": "两清信息已锁定,请申请解锁后再更改"
}
```
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": 222,
"errorCode": 268435457,
"message": "无效的id：18155"
}
```
src/routes/main/modules/api-doc/dynamic-interface/requestCancelXieYi.md
浏览文件 @ c7f01c64
# requestCancelXieYi # 申请撤销协议
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 requestCancleXieYi
- 必须指定XieYi id
>## 用法
- **URL：**/api/interface/user/requestCancleXieYi/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -requestCancelXieYi要传的参数名格式如下,其中1 2 3 XieYi id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data**
- **what** 申请的两清的id
- **why** 申请的理由
- **applier** 申请人
- **extra** 备注
## 返回值
返回生成的申请记录的ID
## 例子
### waht存在
>参数为
``` ```json
[{ {
1,2,3 "data": [{
"what": 18155,
"why": "接口测试",
"applier": "操作员",
"extra": "测试"
}] }]
``` }
(省略了token,dmpath等参数)
```
## 返回值 - result
```json
{
"data": [
18351
],
"errorCode": 0
}
```
- 特别注意：data里面的值是申请记录的id
### what 中的值不存在
>参数为
```json
{
"data": [{
"what": 1814,
"why": "接口测试",
"applier": "操作员",
"extra": "测试"
}]
}
(省略了token,dmpath等参数)
```
- result
无 ```json
{
"data": 1814,
"errorCode": 268435457,
"message": "无效的id：1814"
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/requestUnLockLiangQing.md
浏览文件 @ c7f01c64
# requestUnLockLiangQing # 申请解锁两清
## 前置条件 ## 接口名称
- 只能查询当前区域的数据 requestUnLockLiangQing
- 必须指定LiangQing id
- 只有解锁的两清数据才能进行操作 >## 用法
- **URL：**/api/interface/user/requestUnLockLiangQing/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data -requestUnLockLiangQingi要传的参数名格式如下,其中1 2 3 LiangQing id - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data**
- **what** 申请的两清的id
- **why** 申请的理由
- **applier** 申请人
- **extra** 备注
## 返回值
返回生成的申请记录的ID
## 例子
### waht存在
>参数为
``` ```json
[{ {
1,2,3 "data": [{
"what": 18155,
"why": "接口测试",
"applier": "操作员",
"extra": "测试"
}] }]
``` }
(省略了token,dmpath等参数)
```
## 返回值 - result
```json
{
"data": [
18351
],
"errorCode": 0
}
```
- 特别注意：data里面的值是申请记录的id
### what 中的值不存在
>参数为
```json
{
"data": [{
"what": 1814,
"why": "接口测试",
"applier": "操作员",
"extra": "测试"
}]
}
(省略了token,dmpath等参数)
```
- result
无 ```json
{
"data": 1814,
"errorCode": 268435457,
"message": "无效的id：1814"
}
```
src/routes/main/modules/api-doc/dynamic-interface/updateFamily.md
浏览文件 @ c7f01c64
...@@ -2,64 +2,156 @@ ...@@ -2,64 +2,156 @@
更新两清数据，支持批量。批量能有效提高性能，所以能批量就批量。 更新两清数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须指定两清id updateFamily
- 只有解锁的两清数据才能进行修改
>## 用法
- **URL：**/api/interface/user/updateFamily/invoke
- **Method:** POST
> **Note:** <font color="#dd0000">Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分.</font>
## 参数 ## 参数
- data - 更新的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH002/XH002"，/XH 代表徐汇区，/XH/XH002代表某个项目，其中/XH002 是项目编号
- **params:**
- **data** 新增的数据，必须是数组，即使只有一条数据。
``` ```json
[{ [{
id: int, beiChaiQianRen: string,----------------------被拆迁人
anZhiFangShi: string, buWeiPingGuJieHeChongXinDanJia: string,------多房子，分开评估 如 房1：1700元/㎡，房2：1200元/㎡
beiChaiQianRen: string, chongZhiJieHeChengXin: double,---------------多房子，评估成一个单价。
buWeiPingGuJieHeChongXinDanJia: double, devices: [{----------------------------------设备
chongZhiJieHeChengXin: double, danJia:double,-----------------------------单价
devices: [{ jiLiang:double,----------------------------数量
danJia:double, name:string,-------------------------------名称
jiLiang:double, unit:string,-------------------------------单位，如个，平方米等
name:string, zongJia:double-----------------------------总价
unit:string,
zongJia:double
}], }],
erTai: string, erTai: int,----------------------------------二胎
fangWuXingZhi: string, fangWuXingZhi: string,-----------------------房屋性质
fangWuZuoLuo: string, fangWuZuoLuo: string,------------------------房屋坐落
fuShuWuJinE: double, fuShuWuJinE: double,-----------------------附属物金额
fuShuWus: [{ fuShuWus: [{---------------------------------附属物
danJia:double, danJia:double,-----------------------------单价
jieGou:string, jieGou:string,-----------------------------结构
jiLiang:double, jiLiang:double,----------------------------数量
name:string, name:string,-------------------------------名称
type:string, type:string,-------------------------------类型
unit:string, unit:string,-------------------------------单位
usage:string, usage:string,------------------------------附属物用途
zongJia:double zongJia:double-----------------------------附属物总价
}], }],
heDingMianJi: double, heDingMianJi: double,------------------------核定面积
identityCard: string, identityCard: string,------------------------被补偿人身份证号
isLocked: string, juMinFenZu: string,--------------------------居民分组
jiXiRiQi: date, leiXing: string,-----------------------------如居民户，农民户
juMinFenZu: string, number: string,------------------------------征收编号，合同编号
juMinLeiXing: string, pingGuMianJi: double,------------------------评估面积
leiXing: string, shiCeMianJi: double,-------------------------实测面积
number: string, tuDiZhengHao: string,------------------------土地证号
pingGuMianJi: double, weiRenDingMianJi: double,--------------------未认定面积
shiCeMianJi: double, wuZhengMJ: double,---------------------------无证面积
tuDiZhengHao: string, yingJianWeiJianMianJi: string,---------------应建未建面积
weiRenDingMianJi: double, youZhengDuoYuMianJi: string,-----------------有证多余面积
wuZhengMJ: double, youZhengMianJi: string,----------------------有证面积
yingJianWeiJian: string, zhaiJiDiShiYongZheng: string-----------------宅基地使用证
yingJianWeiJianMJ: string,
youZhengDuoYuMianJi: string,
youZhengDuoYuMJ: string,
youZhengMianJi: string,
zhaiJiDiShiYongZheng: string
}] }]
``` ```
## 返回值 ## 返回值
无 无
## 例子1
```json
{
"token": "r0GRdB_xSjijV8Um5mrAPIjOKzQM_V_MsBYAP26yH5utZnQkBQrki539pqV4eKcHj9q14mdFW4uZwlTabdYuRXjOQmOtc9DJV23KiWOrg1aNxTd_0UH6B9HieYIVG0lPSLUABQN6-B_ewlTdi7KxwCchO8iNAs7zCaz39UNc0Jg",
"dmPath": "/XH/XH002/XH002",
"params": {
"data": [
{
"id":18155,
"erTai": 0,
"fuShuWus": [
{
"danJia": 9200,
"jiLiang": 1,
"name": "棚舍及附属物",
"zongJia": 9200
}
],
"number": "14HP0112",
"isLocked": false,
"beiChaiQianRen": "吴龙华(户)",
"identityCard": "310221195909183215",
"fangWuZuoLuo": "宅河头76号",
"leiXing": "农业户",
"fangWuXingZhi": "私房",
"youZhengMianJi": "178.0000",
"heDingMianJi": "301.0000",
"shiCeMianJi": "405.5000",
"chongZhiJieHeChengXin": "830.00",
"yingJianWeiJian": "0.00",
"youZhengDuoYuMianJi": "0.00",
"tuDiZhengHao": "",
"zhaiJiDiShiYongZheng": "沪集宅(上龙)字第华浦-330号",
"erCiDongQianMianJi": "0.00",
"heDingRenKou": "7.0000",
"zaiCeHuShu": "2.00"
}
]
}
}
```
>**Note:** 测试时，例子中的参数token中的值不可以直接使用。本接口在使用时，最好调用一下isLiangQingLocked 接口，判断两情数据是否已锁定，如果数据状态是已锁定状态，那么数据更新会失败，
result
```json
{
"errorCode": 65555,
"message": "两清信息已锁定,请申请解锁后再更改"
}
```
## 例子2
```json
{
"token": "ZrFT8bbnQy-CkmL0_sGNModAE142dFiV5HmUcFA3Jm1yt3XZqjZa5Q8ifNvxi7EgInc46K4JnRwNodLbkSlSqO2v2UU7wdY24QwpDAjcBhzFQCXhwOYUVU8JKVCD85ps3PxnioIFuYkP6YZH_FdluTsl7siRin5yAxIMxCNWqI8",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [
{
"id": 18155,
"erTai": 0,
"fuShuWus": [
{
"danJia": 29051,
"jiLiang": 1,
"name": "",
"zongJia": 29051
}
],
"number": "QPXQCJT-18",
"beiChaiQianRen": "杜进兴（户）",
"identityCard": "",
"fangWuZuoLuo": "新桥村51号",
"youZhengMianJi": "263.0600",
"heDingMianJi": "180.0000",
"juMinFenZu": "十一队",
"weiRenDingMianJi": "0.0000",
"pingGuMianJi": "263.06",
"buWeiPingGuJieHeChongXinDanJia": "主屋：758.00、附屋：673.00",
"fuShuWuJinE": "29051.00"
}
]
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/updateHouse.md
浏览文件 @ c7f01c64
...@@ -2,32 +2,84 @@ ...@@ -2,32 +2,84 @@
更新房屋数据，支持批量。批量能有效提高性能，所以能批量就批量。 更新房屋数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须指定房屋id updateHouse
- 只有解锁的两清数据才能进行修改
>## 用法
- **URL：**/api/interface/user/updateHouse/invoke
- **Method:** POST
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 更新的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
``` - **params:**
[{ - **data** 新增的数据，必须是数组，即使只有一条数据。
name:string,
zhengZaiMianJi:double, ```json
pingGuDanJia:double, [{
pingGuJiaGe:double, id:int-----------------------------House（被补偿房屋）的ID
fangWuYongTu:string, name:string,------------------------名称（房屋的名称）
shiFouRenDing:string, zhengZaiMianJi:double,--------------证载面积
yangTaiMianJi:double, pingGuDanJia:double,----------------评估单价
pengSheMianJi:double, pingGuJiaGe:double,-----------------评估价格
chaoLing:string, fangWuYongTu:string,----------------房屋用途
fangWuLeiXing:string, shiFouRenDing:string,---------------是否认定
renDingMianJi:double, yangTaiMianJi:double,---------------阳台面积
ceHuiMianJi:double, pengSheMianJi:double,---------------棚舍面积
tengKongShiJian:timestamp chaoLing:string,--------------------是否超龄老房
}] fangWuLeiXing:string,---------------房屋类型
``` renDingMianJi:double,---------------认定面积
ceHuiMianJi:double,-----------------测绘面积
tengKongShiJian:timestamp-----------腾空时间
}]
```
## 返回值 ## 返回值
无 无
## 例子
```json
{
"token": "Y61Cp_zXDYTPYiGYUEmhD0a4uYu7-9NsetKtQaR7Gs0XEOJScQ9Lk1-kFIH_MgK0zZgu_6BMLqJRtUhnS4HDuB_YvNsMcIX5cALlfWHpW_Vetjn2VCL4_k-7hbMVXsEbvscZUfMO-CkA1wh0MpH40oFweZao6YWSZG3Qg4AuWg4",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [{
"id": "18251",
"ceHuiMianJi": 0.0,
"fangWuLeiXing": "",
"fangWuYongTu": "居住",
"name": "主屋",
"pengSheMianJi": 0.0,
"pingGuDanJia": 758.0,
"pingGuJiaGe": 141124.44,
"renDingMianJi": 0.0,
"shiFouRenDing": "是",
"tengKongShiJian": "1900/01/01",
"yangTaiMianJi": 0.0,
"zhengZaiMianJi": 186.18
},
{
"id": "18155",
"ceHuiMianJi": 0.0,
"fangWuLeiXing": "",
"fangWuYongTu": "居住",
"name": "附屋",
"pengSheMianJi": 0.0,
"pingGuDanJia": 673.0,
"pingGuJiaGe": 51740.24,
"renDingMianJi": 0.0,
"shiFouRenDing": "是",
"tengKongShiJian": "2017/01/08",
"yangTaiMianJi": 0.0,
"zhengZaiMianJi": 76.88
}]
}
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/updatePeople.md
浏览文件 @ c7f01c64
# 更新People # 更新人口
更新People数据，支持批量。批量能有效提高性能，所以能批量就批量。 更新人口数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 前置条件 ## 接口名称
- 必须指定 People id updatePeople
- 只有解锁的两清数据才能进行修改 >## 用法
- **URL：**/api/interface/user/addPeople/invoke
- **Method:** POST
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数 ## 参数
- data - 更新的数据，必须是数组，即使只有一条数据。 - **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 新增的数据，必须是数组，即使只有一条数据。
``` ```json
[{ [{
name:string, fid: string,-------------------------------------Family(两清)的ID
idCard:string, name: string,------------------------------------姓名
sex:string, idCard: string,----------------------------------身份证号
age:int, sex: string,-------------------------------------性别
chanQuanRen:boolean, age: int,----------------------------------------年龄
relationWithChanQuanRen:string, chanQuanRen: boolean,----------------------------是否产权人
huZhu:boolean, relationWithChanQuanRen: string,-----------------与产权人关系
relationWithHuZhu:string, huZhu: boolean,----------------------------------是否户主
teKun:boolean, relationWithHuZhu: string,-----------------------与户主关系
daBing:boolean, teKun: boolean,----------------------------------是否特困
gaoLing:boolean, daBing: boolean,---------------------------------是否大病
daLingWeiHun:boolean, gaoLing: boolean,--------------------------------是否高龄
canJi:boolean, daLingWeiHun: boolean,---------------------------是否大龄未婚
zaiCe:boolean, canJi: boolean,----------------------------------是否残疾
anZhi:boolean, zaiCe: boolean,----------------------------------是否在册
weiYun:boolean, anZhi: boolean,----------------------------------是否安置
duShengZiNv:boolean, weiYun: boolean,---------------------------------是否未孕
birthDay:date, duShengZiNv: boolean,----------------------------是否独生子女
cunZaiWeiHeDingPeiOu:boolean birthDay: date,----------------------------------出生年月
}] cunZaiWeiHeDingPeiOu: boolean--------------------是否存在未核定配偶
}]
``` ```
## 返回值 ## 返回值
无 无
## 例子
```json
{
"token": "f_pIt_6oIF2qzNto6hw-hYqet8HdQKext5jvXnHa0omEgmNypxeYNbJRs3RJl7buITnUT3btpxgPiqajQe8Rrh01767hj-BFfo8ug-SDEUN9HU4JXI7x2B00S-4vE72w_k-8LAZ1wzBH3-a6ktXORSnq_kDAYIP7X3F3hvrxm48",
"dmPath": "/XH/XH2018003/XH2018003-01",
"params": {
"data": [
{
"id": "18301",
"age": 0,
"birthDay": "1900/01/01",
"idCard": "410726199104048172",
"name": "吴某",
"relationWithChanQuanRen": "朋友",
"sex": "男",
"anZhi": "是",
"canJi": false,
"chanQuanRen": false,
"cunZaiWeiHeDingPeiOu": false,
"daBing": false,
"daLingWeiHun": false,
"duShengZiNv": false,
"huZhu": false,
"teKun": false,
"weiYun": false,
"zaiCe": "否",
"gaoLing": false
},
{
"id": "18302",
"age": 0,
"birthDay": "1900/01/01",
"idCard": "37172419970404447X",
"name": "宇辰",
"relationWithChanQuanRen": "无",
"sex": "男",
"anZhi": "是",
"canJi": false,
"chanQuanRen": false,
"cunZaiWeiHeDingPeiOu": false,
"daBing": false,
"daLingWeiHun": false,
"duShengZiNv": false,
"huZhu": false,
"teKun": false,
"weiYun": false,
"zaiCe": "否",
"gaoLing": false
}
]
}
}
```
>**Note:** 测试时，例子中的参数token中的值不可以直接使用。本接口在使用时，最好调用一下isLiangQingLocked 接口，判断两情数据是否已锁定，如果数据状态是已锁定状态，那么数据更新会失败，
result
```json
{
"errorCode": 65555,
"message": "两清信息已锁定,请申请解锁后再更改"
}
```
\ No newline at end of file
src/routes/main/modules/api-doc/dynamic-interface/updateXieYi.md
浏览文件 @ c7f01c64
# 更新XieYi # 更新协议
更新XieYi数据，支持批量。批量能有效提高性能，所以能批量就批量。
更新协议数据，支持批量。批量能有效提高性能，所以能批量就批量。
## 接口名称
updateXieYi
## 前置条件 ## 前置条件
- 必须指定fid - 必须指定fid
......
src/routes/main/modules/api-doc/dynamic-interface/whetherCancelXieYi.md 0 → 100755
浏览文件 @ c7f01c64
# 是否协议已撤销
## 接口名称
whetherCancelXieYi
>## 用法
- **URL：**/api/interface/user/whetherCancelXieYi/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数
- **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 查询当前协议申请协议撤销市局人员是否已经处理，要传的参数名格式如下,其中1 2 3 是 申请记录的ID id
```json
[1,2,3]
```
## 返回值
返回data 中的值
- 0 代表协议撤销申请中
- -1 代表该条申请撤销不存在
- 1 协议撤销审核通过
- 2 协议撤销审核不通过
## 例子
### id存在
>参数为`{"data":18155}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0
],
"errorCode": 0
}
```
### id不存在
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
-1
],
"errorCode": 0
}
```
### 多个id
>参数为`{"data":[18155,1]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0,
-1
],
"errorCode": 0
}
```
src/routes/main/modules/api-doc/dynamic-interface/whetherUnLockLiangQing.md 0 → 100755
浏览文件 @ c7f01c64
# 是否两清已解锁
## 接口名称
whetherUnLockLiangQing
>## 用法
- **URL：**/api/interface/user/whetherUnLockLiangQing/invoke
- **Method:** Post
> **Note:** Domain 必须切换到基地这一作用域,切换作用域，参照“作用域”部分
## 参数
- **token:** token是在登陆后获取的tokenId，加密后的结果。
- **dmPath:** 作用域路径 例如 "/XH/XH2018003/XH2018003-01"，/XH 代表徐汇区，/XH/XH2018003代表某个项目，其中XH2018003 是项目编号
- **params:**
- **data** 查询当前两清申请解锁市局人员是否已经处理，要传的参数名格式如下,其中1 2 3 是 申请记录的ID id
```json
[{
1,2,3
}]
```
## 返回值
返回data 中的值
- 0 代表两清解锁申请中
- -1 代表该条两情申请不存在
- 1 两情解锁审核通过
- 2 两清解锁审核不通过
## 例子
### id存在
>参数为`{"data":18352}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0
],
"errorCode": 0
}
```
### id不存在
>参数为`{"data":0}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
-1
],
"errorCode": 0
}
```
### 多个id
>参数为`{"data":[18352,1]}`(省略了token,dmpath等参数)
- result
```json
{
"data": [
0,
-1
],
"errorCode": 0
}
```
webpack.dev.js
浏览文件 @ c7f01c64
...@@ -17,7 +17,7 @@ module.exports = merge(common, { ...@@ -17,7 +17,7 @@ module.exports = merge(common, {
pathinfo: true, pathinfo: true,
}, },
mode: 'development', mode: 'development',
devtool: 'inline-source-map', devtool: 'inline-cheap-source-map',
devServer: { devServer: {
disableHostCheck: true, disableHostCheck: true,
publicPath: config.dev.publicPath, publicPath: config.dev.publicPath,
......
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论