java110
2020-06-18 ee8dc999b11e59a994e6a3946a615c1ab15b6335
优化接口协议
4个文件已修改
5个文件已删除
906 ■■■■ 已修改文件
docs/document/_sidebar.md 23 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/capital/index.md 61 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/community/index.md 30 ●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/owner/editOwner.md 78 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/owner/queryOwnerMembers.md 88 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/owner/queryOwners.md 92 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/owner/saveOwner.md 71 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/user/index.md 400 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/api/user/uploadOwnerPhoto.md 63 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/document/_sidebar.md
@@ -14,19 +14,6 @@
  * [2.3小区商户类接口](api/community/index.md)
  * [2.4资产类接口](api/capital/index.md)
  * [2.5用户类接口](api/user/index.md)
  * [上传业主照片](api/user/uploadOwnerPhoto.md)
  * [查询已销售的房屋信息](api/room/queryRoomsWithSell.md)
  * [查询未销售的房屋信息](api/room/queryRoomsWithOutSell.md)
  * [查询业主房屋](api/room/queryRoomsByOwner.md)
  * [添加业主](api/owner/saveOwner.md)
  * [删除业主](api/owner/deleteOwner.md)
  * [编辑业主](api/owner/editOwner.md)
  * [查询业主](api/owner/queryOwners.md)
  * [查询业主成员](api/owner/queryOwnerMembers.md)
  * [业主绑定](api/owner/appUserBindingOwner.md)
  * [业主门禁](api/owner/listOwnerMachines.md)
  * [钥匙申请](api/machine/applicationKey.md)
  * [投诉建议](api/complaint/saveComplaint.md)
  * [查询投诉建议](api/complaint/listComplaints.md)
  * [删除投诉建议](api/complaint/deleteComplaint.md)
@@ -51,16 +38,6 @@
  * [申请访客密码](api/applicationKey/applyVisitorApplicationKey.md)
  * [手机端申请钥匙](api/applicationKey/applyApplicationKey.md)
  * [查询活动](api/activities/listActivitiess.md)
  * [保存文件](api/file/saveFile.md)
  * [查询文件](api/file/getFile.md)
  * [采购管理-删除审核人员](api/purchase/deleteAuditUser.md)
  * [采购管理-查询审核人员](api/purchase/listAuditUsers.md)
  * [采购管理-查询审核工单](api/purchase/listAuditOrders.md)
  * [采购管理-添加审核人员](api/purchase/saveAuditUser.md)
  * [采购管理-查询资源(物品)](api/resource/listResourceStores.md)
  * [采购管理-编辑资源(物品)](api/resource/updateResourceStore.md)
  * [采购管理-删除资源(物品)](api/resource/deleteResourceStore.md)
  * [采购管理-保存资源(物品)](api/resource/saveResourceStore.md)
  * [删除通知](api/notice/deleteNotice.md)
  * [查询通知](api/notice/notice.md)
  * [更新通知](api/notice/updateNotice.md)
docs/document/api/capital/index.md
@@ -597,6 +597,67 @@
## 2.4.13查询业主房屋
###### 接口功能
> 查询业主房屋接口
###### URL
> [待补充]()
###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|ownerId|1|String|30|业主ID|-|
|communityId|1|String|30|小区ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|-|-|-|-|-|-|
###### 举例
> 地址:[待补充]()
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
返回报文:
{
    待更新
}
```
## 2.4.14查询楼栋
###### 接口功能
docs/document/api/community/index.md
@@ -1,8 +1,8 @@
## 说明
## 2.3.1 说明
小区商户类接口 主要包含 小区添加 审核 商户入驻审核等功能接口
## 添加小区
## 2.3.2 添加小区
###### 接口功能
> 添加小区接口
@@ -69,7 +69,7 @@
```
## 查询未审核小区
## 2.3.3 查询未审核小区
###### 接口功能
> 查询未审核入驻小区接口
@@ -165,7 +165,7 @@
```
## 审核小区
## 2.3.4 审核小区
###### 接口功能
> 小区审核接口
@@ -228,7 +228,7 @@
```
## 查询小区
## 2.3.5 查询小区
###### 接口功能
> 查询小区接口
@@ -329,7 +329,7 @@
}
```
## 商户入驻小区
## 2.3.6 商户入驻小区
###### 接口功能
> 用户通过web端或APP物业代理商等加入到小区中接口
@@ -392,7 +392,7 @@
```
## 商户入驻审核
## 2.3.7 商户入驻审核
###### 接口功能
> 小区审核接口
@@ -453,7 +453,7 @@
```
## 查询小区商户
## 2.3.8 查询小区商户
###### 接口功能
> 查询小区商户接口
@@ -527,7 +527,7 @@
```
## 查询组织
## 2.3.9 查询组织
###### 接口功能
> 用户通过web端或APP查询组织信息接口
@@ -626,7 +626,7 @@
```
## 添加组织
## 2.3.10 添加组织
###### 接口功能
> 用户通过web端或APP保存组织接口
@@ -705,7 +705,7 @@
```
## 编辑组织
## 2.3.11 编辑组织
###### 接口功能
> 用户通过web端或APP编辑组织接口
@@ -786,7 +786,7 @@
```
## 删除组织
## 2.3.12 删除组织
###### 接口功能
> 用户通过web端或APP编辑组织接口
@@ -858,7 +858,7 @@
```
## 添加员工
## 2.3.13 添加员工
###### 接口功能
> 用户通过web端或APP添加添加员工信息接口
@@ -931,7 +931,7 @@
```
## 删除员工
## 2.3.14 删除员工
###### 接口功能
> 用户通过web端或APP添加添加员工信息接口
@@ -996,7 +996,7 @@
返回报文:
## 查询员工
## 2.3.15 查询员工
###### 接口功能
> 用户通过web端或APP搜索员工信息接口
docs/document/api/owner/editOwner.md
File was deleted
docs/document/api/owner/queryOwnerMembers.md
File was deleted
docs/document/api/owner/queryOwners.md
File was deleted
docs/document/api/owner/saveOwner.md
File was deleted
docs/document/api/user/index.md
@@ -1,4 +1,4 @@
## 1.0 用户注册
## 2.5.1 用户注册
###### 接口功能
> 用户通过web端或APP注册用户接口
@@ -67,7 +67,7 @@
```
## 2.0 用户登录
## 2.5.2 用户登录
###### 接口功能
> 用户通过web端或APP登录系统
@@ -130,7 +130,7 @@
```
## 3.0 用户退出登录
## 2.5.3 用户退出登录
###### 接口功能
> 用户通过web端或APP退出系统
@@ -185,7 +185,7 @@
退出登录成功
```
## 4.0 校验用户是否登录
## 2.5.4 校验用户是否登录
###### 接口功能
> 用户通过web端或APP判断是否有权限操作相应操作接口
@@ -241,3 +241,395 @@
```
## 2.5.5 添加业主(或家庭成员)
###### 接口功能
> 用户通过web端或APP保存业主信息信息接口
###### URL
> [http://api.java110.com:8008/api/owner.saveOwner](http://api.java110.com:8008/api/owner.saveOwner)
###### 支持格式
> JSON
###### HTTP请求方式
> POST
###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配                      |
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
###### 请求参数
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|name|1|String|12|业主名称|-|
|userId|1|String|30|用户ID|-|
|age|1|int|11|年龄|-|
|link|1|String|11|联系人手机号|-|
|sex|1|int|11|性别|-|
|ownerTypeCd|1|String|4|默认1001|1001 业主本人 1002 家庭成员|
|communityId|1|String|30|小区ID|-|
|ownerId|1|String|30|业主ID|在添加业主时该字段不传,家庭成员时传业主ID|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
成功
###### 举例
> 地址:[http://api.java110.com:8008/api/owner.saveOwner](http://api.java110.com:8008/api/owner.saveOwner)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
    "sex":"填写具体值",
            "name":"填写具体值",
            "link":"填写具体值",
            "remark":"填写具体值",
            "userId":"填写具体值",
            "ownerTypeCd":"1001",
            "age":"填写具体值"
}
返回报文:
成功
```
## 2.5.6 编辑业主
###### 接口功能
> 编辑业主信息接口
###### URL
> [http://api.java110.com:8008/api/owner.editOwner](http://api.java110.com:8008/api/owner.editOwner)
###### 支持格式
> JSON
###### HTTP请求方式
> POST
###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配|
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
###### 请求参数(body部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|memberId|1|String|30|业主成员ID|-|
|name|1|String|12|业主名称|-|
|userId|1|String|30|用户ID|-|
|age|1|int|11|年龄|-|
|link|1|String|11|联系人手机号|-|
|sex|1|int|11|性别|-|
|ownerTypeCd|1|String|4|默认1001|1001 业主本人 1002 家庭成员|
|communityId|1|String|30|小区ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容
###### 举例
> 地址:[http://api.java110.com:8008/api/owner.editOwner](http://api.java110.com:8008/api/owner.editOwner)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
    "ownerPhoto": "data:image/webp;base64,UklGRgQ1AABAA=",
    "idCard": "-1",
    "sex": "0",
    "ownerTypeCd": "1001",
    "link": "15987097564",
    "remark": "",
    "ownerId": "772019102956970002",
    "userId": "30518940136629616640",
    "componentTitle": "业主",
    "name": "张三",
    "videoPlaying": true,
    "communityId": "7020181217000001",
    "age": "23",
    "memberId": "772019102956970002"
}
返回报文:
成功
```
## 2.5.7 查询业主
###### 接口功能
> 查询业主信息接口
###### URL
> [http://api.java110.com:8008/api/owner.queryOwners](http://api.java110.com:8008/api/owner.queryOwners)
###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|ownerId|1|String|30|业主ID|-|
|communityId|1|String|30|小区ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|communityId|1|String|30|小区ID|-|
|-|ownerTypeCd|1|String|30|业主ID|-|
|-|page|1|int|-|页数|-|
|-|row|1|int|-|没有行数|-|
###### 举例
> 地址:[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
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
返回报文:
    {
        "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
    }
```
## 2.5.8 查询家庭成员
###### 接口功能
> 用户通过web端或APP查询业主成员信息
###### URL
> [http://api.java110.com:8008/api/owner.listOwnerMachines](http://api.java110.com:8008/api/owner.listOwnerMachines)
###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|ownerId|1|String|30|业主ID|-|
|communityId|1|String|30|小区ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|owners|1|Array|-|业主成员对象|-|
|owners|age|1|int|-|年龄|-|
|owners|idCard|1|String|20|身份证号|-|
|owners|link|1|String|11|手机号|-|
|owners|memberId|1|String|30|成员ID|-|
|owners|name|1|String|100|成员名称|-|
|owners|ownerId|?|String|30|业主ID|-|
|owners|ownerTypeCd|?|String|12|业主成员1002|-|
|owners|remark|?|String|200|备注|-|
|owners|sex|?|String|1|性别|0男 1女|
|owners|createTime|1|String|30|创建时间|如:2018-04-09 12:00:34|
###### 举例
> 地址:[http://hc.demo.winqi.cn:8012/appApi/owner.queryOwnerMembers?ownerTypeCd=1002&ownerId=772019091360360003&communityId=7020181217000001]( http://hc.demo.winqi.cn:8012/appApi/owner.queryOwnerMembers?ownerTypeCd=1002&ownerId=772019091360360003&communityId=7020181217000001)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
返回报文:
{
    "owners": [{
        "age": "1",
        "createTime": "2019-12-25 13:31:33",
        "idCard": "1",
        "link": "18888888888",
        "memberId": "772019122571010003",
        "name": "12222",
        "ownerId": "772019091360360003",
        "ownerTypeCd": "1002",
        "remark": "1",
        "sex": "0",
        "userName": "wuxw"
    }],
    "page": 0,
    "records": 1,
    "rows": 0,
    "total": 1
}
```
## 2.5.9 上传业主照片
###### 接口功能
> 上传业主照片接口
###### URL
> [http://order-service/orderApi/service](http://order-service/orderApi/service)
###### 支持格式
> JSON
###### HTTP请求方式
> POST
###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配                      |
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
###### 请求参数(body部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|memberId|1|-|-|-|-|
|photo|1|longtext|-|文件内容|-|
|communityId|1|String|128|小区ID|-|
###### 返回协议
当http返回状态不为200 时请求处理失败 body内容为失败的原因
当http返回状态为200时请求处理成功,body内容为返回内容,
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|-|-|-|-|-|-|
###### 举例
> 地址:[http://order-service/orderApi/service](http://order-service/orderApi/service)
``` javascript
请求头信息:
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
    待补充
}
返回报文:
    成功
```
docs/document/api/user/uploadOwnerPhoto.md
File was deleted