优化技术文档

java110

2020-06-18 cb93a577e0a047903e60c7d08c069a019c86466b

优化技术文档

 docs/document/_sidebar.md

@@ -1,34 +1,21 @@

* 入门
* 1.入门

  * [快速开始](README.md)
  * [环境搭建](start/installHc.md)
  * [视频教程](start/vedio.md)
  * [功能列表](func/funcation.md)
  * [常见问题](start/question.md)
  * [1.1快速开始](README.md)
  * [1.2环境搭建](start/installHc.md)
  * [1.3视频教程](start/vedio.md)
  * [1.4功能列表](func/funcation.md)
  * [1.5常见问题](start/question.md)

* 接口能力
* 2.接口能力

  * [接口清单](api/Readme.md)
  * [调用流程](api/apiStart.md)
  * [小区商户类接口](api/community/index.md)
  * [资产类接口](api/capital/index.md)
  * [用户类接口](api/user/index.md)
  * [2.1接口清单](api/Readme.md)
  * [2.2调用流程](api/apiStart.md)
  * [2.3小区商户类接口](api/community/index.md)
  * [2.4资产类接口](api/capital/index.md)
  * [2.5用户类接口](api/user/index.md)
  * [上传业主照片](api/user/uploadOwnerPhoto.md)
  * [保存商户](api/store/saveStore.md)
  * [删除用户权限](api/privilege/deleteStaffPrivilege.md)
  * [查询已入驻的小区](api/community/queryMyCommunity.md)
  * [查询未入驻的小区](api/community/queryNoEnterCommunity.md)
  * [查询小区商户](api/community/listStoresByCommunity.md)
  * [小区审核](api/community/auditCommunity.md)
  * [更新小区](api/community/updateCommunity.md)
  * [添加小区](api/community/saveCommunity.md)
  * [查询小区](api/community/listCommunitys.md)
  * [审核入驻小区状态](api/community/auditEnterCommunity.md)
  * [查询未审核入驻小区](api/community/listAuditEnterCommunitys.md)
  * [小区成员入驻](api/community/communityMemberJoined.md)
  * [小区成员退出](api/community/communityMemberQuit.md)
  * [检查用户权限](api/user/checkUserHasPrivilege.md)
  * [查询小区楼信息](api/floor/queryFloors.md)
  * [添加小区楼信息](api/floor/saveFloor.md)
  * [编辑小区楼信息](api/floor/editFloor.md)

 docs/document/api/community/auditCommunity.md

File was deleted

 docs/document/api/community/auditEnterCommunity.md

File was deleted

 docs/document/api/community/communityMemberJoined.md

File was deleted

 docs/document/api/community/index.md

@@ -4,20 +4,529 @@

## 添加小区

未整理
###### 接口功能
> 添加小区接口

###### URL
> [http://api.java110.com:8008/api/community.saveCommunity](http://api.java110.com:8008/api/community.saveCommunity)

###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|name|1|String|100|小区名称|-|
|address|1|String|200|小区地址|-|
|nearbyLandmarks|1|String|200|地标|如王府井北60米|


###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，



###### 举例
> 地址：[http://api.java110.com:8008/api/community.saveCommunity](http://api.java110.com:8008/api/community.saveCommunity)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
    "address": "北京省北京市东城区zcasd",
    "nearbyLandmarks": "aodiai",
    "storeTypeCd": "800900000002",
    "cityCode": "110101",
    "name": "zccccc",
    "areaAddress": "北京省北京市东城区",
    "storeId": "402019062754960011",
    "mapY": "101.33",
    "mapX": "101.33"
}
返回报文：

成功

```

## 查询未审核小区

###### 接口功能
> 查询未审核入驻小区接口

###### URL
> [http://api.java110.com:8008/api/community.listAuditEnterCommunitys](http://api.java110.com:8008/api/community.listAuditEnterCommunitys)

###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|page|1|int|-|页数|-|
|row|1|int|-|每页行数|-|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，

|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|communitys|1|Array|30|小区节点|-|
|communitys|communityId|1|String|30|小区ID|-|
|communitys|name|1|String|50|小区名称|-|
|communitys|address|1|String|200|小区地址|-|
|communitys|nearbyLandmarks|1|String|200|小区地标|-|
|communitys|cityCode|1|String|12|城市编码|-|
|communitys|mapX|1|String|12|精度|-|
|communitys|mapY|1|String|12|维度|-|




###### 举例
> 地址：[http://api.java110.com:8008/api/community.listAuditEnterCommunitys?page=1&row=10](http://api.java110.com:8008/api/community.listAuditEnterCommunitys?page=1&row=10)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

无

返回报文：
{
    "communitys": [{
        "address": "城南格兰小镇",
        "communityId": "702019070583460001",
        "communityMemberId": "722019120844120035",
        "memberId": "402019032924930007",
        "name": "安心亚燕（城中1）",
        "stateName": "待审核",
        "storeName": "小吴工作室",
        "storeTypeCd": "800900000003",
        "storeTypeName": "物业",
        "tel": "17797173942"
    }, {
        "address": "城南格兰小镇",
        "communityId": "702019121822890017",
        "communityMemberId": "722019122220460001",
        "memberId": "402019032924930007",
        "name": "青岛国信",
        "stateName": "待审核",
        "storeName": "小吴工作室",
        "storeTypeCd": "800900000003",
        "storeTypeName": "物业",
        "tel": "17797173942"
    }],
    "page": 0,
    "records": 1,
    "rows": 0,
    "total": 6
}

```

## 审核小区

###### 接口功能
> 小区审核接口

###### URL
> [http://api.java110.com:8008/api/community.auditEnterCommunity](http://api.java110.com:8008/api/community.auditEnterCommunity)

###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|communityMemberId|1|String|30|小区成员ID|-|
|remark|1|String|-|审核原因|-|
|state|1|String|4|审核状态|业务状态 1000 为待审核 1200审核拒绝|


###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，



###### 举例
> 地址：[http://api.java110.com:8008/api/community.auditEnterCommunity](http://api.java110.com:8008/api/community.auditEnterCommunity)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

{
    "remark": "怎会灰尘",
    "state": "1100",
    "communityMemberId": "722019120844120035"
}

返回报文：

成功

```

## 查询小区

###### 接口功能
> 查询小区接口

###### URL
> [http://api.java110.com:8008/api/community.listCommunitys](http://api.java110.com:8008/api/community.listCommunitys)

###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|page|1|int|-|分页|-|
|row|1|int|-|分页|-|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，

|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|communitys|1|Array|30|小区节点|-|
|communitys|communityId|1|String|30|小区ID|-|
|communitys|name|1|String|50|小区名称|-|
|communitys|address|1|String|200|小区地址|-|
|communitys|nearbyLandmarks|1|String|200|小区地标|-|
|communitys|cityCode|1|String|12|城市编码|-|
|communitys|mapX|1|String|12|精度|-|
|communitys|mapY|1|String|12|维度|-|
|communitys|memberId|1|String|30|小区成员ID|-|
|communitys|memberTypeCd|1|String|12|编码|-|
|communitys|statusCd|1|String|2|数据状态|详细参考c_status表，S 保存|
|communitys|cityName|1|String|50|城市名称|-|
|communitys|state|1|String|4|业务状态|1000 为待审核 1200审核拒绝|
|communitys|stateName|1|String|20|状态名称|-|




###### 举例
> 地址：[http://api.java110.com:8008/api/community.listCommunitys?page=1&row=10](http://api.java110.com:8008/api/community.listCommunitys?page=1&row=10)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

无

返回报文：
{
    "communitys": [{
        "address": "西安市",
        "cityCode": "0971",
        "cityName": "未知",
        "communityId": "702019073109590004",
        "mapX": "101.33",
        "mapY": "101.33",
        "name": "江林新城",
        "nearbyLandmarks": "子午大道南三环",
        "state": "1100",
        "stateName": "审核完成"
    }, {
        "address": "青海省西宁市城中区五四大街",
        "cityCode": "0971",
        "cityName": "未知",
        "communityId": "702019070408660001",
        "mapX": "101.33",
        "mapY": "101.33",
        "name": "万方城（城中区）",
        "nearbyLandmarks": "青紫大厦",
        "state": "1100",
        "stateName": "审核完成"
    }],
    "page": 0,
    "records": 3,
    "rows": 0,
    "total": 27
}
```

## 商户入驻小区

###### 接口功能
> 用户通过web端或APP物业代理商等加入到小区中接口

###### URL
> [http://api.java110.com:8008/api/member.join.community](http://api.java110.com:8008/api/member.join.community)

###### 支持格式
> 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|-|
|communityId|1|String|30|小区ID|-|
|memberTypeCd|1|String|12|成员角色|-|
|auditStatusCd|1|String|4|审核状态|不需要审核时写0000|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，



###### 举例
> 地址：[http://api.java110.com:8008/api/member.join.community](http://api.java110.com:8008/api/member.join.community)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

{
    "memberId": "390001200001",
    "communityId": "1234444",
    "memberTypeCd": "12221222"
}

返回报文：

成功

```

## 商户入驻审核

###### 接口功能
> 小区审核接口

###### URL
> [待补充]()

###### 支持格式
> 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|communityMemberId|1|String|30|小区成员ID|-|
|remark|1|String|-|审核原因|-|
|state|1|String|4|审核状态|业务状态 1000 为待审核 1200审核拒绝|


###### 返回协议

当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
请求报文：

{
    待补充
}

返回报文：

成功

```

## 查询小区商户

###### 接口功能
> 查询小区商户接口

###### 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部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|page|1|-|-|页数|-|
|row|1|-|-|每页行数|-|
|communityId|1|String|12|小区ID|-|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，

|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|-|communitys|1|Array|30|小区节点|-|
|communitys|communityId|1|String|30|小区ID|-|
|communitys|name|1|String|50|小区名称|-|
|communitys|address|1|String|200|小区地址|-|
|communitys|nearbyLandmarks|1|String|200|小区地标|-|
|communitys|cityCode|1|String|12|城市编码|-|
|communitys|mapX|1|String|12|精度|-|
|communitys|mapY|1|String|12|维度|-|
|communitys|memberId|1|String|30|小区成员ID|-|
|communitys|memberTypeCd|1|String|30|小区成员类型|-|
|communitys|statusCd|1|String|4|状态|0 有效状态 1 失效状态 1000 入驻审核状态|




###### 举例
> 地址：[待补充]()

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

无

返回报文：
{
    待补充
}

```

## 查询组织

###### 接口功能

 docs/document/api/community/listAuditEnterCommunitys.md

File was deleted

 docs/document/api/community/listCommunitys.md

File was deleted

 docs/document/api/community/listStoresByCommunity.md

File was deleted