睿智云平台主数据API
说明: 睿智云平台主数据的前身请参见:主数据PI , 本API集部分API来源于主数据PI , 如两者有重复的地方,请以本API为准 。 由于部分接口延用了之前的API, 故返回结果需要严格按照实际的结果处理。
相关的SQL语句:
https://confluence.mideazy.com/pages/viewpage.action?pageId=222625816
http://arch.smartmideazy.com/apidoc/main-entry/any-pay.html 文档已更新 @李小勇
主数据API列表
A务PI列表 | 说明 |
---|---|
1. 项目管理 | |
2. 客户管理 | |
3. 租户管理 |
1 项目管理
API列表 | API接口URL | 说明 |
---|---|---|
1.1 项目地址新增、修改 | /v1/iot/main/spacelocation/add | |
1.2 项目地址修改(即将废除) | /v1/iot/main/spacelocation/edit | |
1.3 项目详情 | /v1/iot/main/space/detail/community/{id} | |
1.4 新增、修改员工 | /v1/iot/main/admin/update |
1.1 项目地址新增/修改
说明: 项目地址新增接口也可以达到项目地址修改的效果。建议使用此接口完成项目地址的新增和修改。
描述 新增项目地址, 一个小区空间(space_type=COMMUNITY)对应一个地址信息
请求信息
URL:/v1/iot/main/spacelocation/add
METHOD: POST
body: JSON格式约定
字段 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
province | String | 是 | 省 |
city | String | 是 | 市 |
district | String | 是 | 区 |
lon | Double | 是 | 高德地图经度 |
lat | Double | 是 | 高德地图纬 |
detail | String | 否 | 地址的详细门牌 |
space_id | Long | 是 | 这里是smart_cmty_space表的主键ID,空间ID,仅space_type=COMMUNITY对应的空间ID |
ico | String | 否 | 项目图片相对路径 |
contact_tels_json | JSONSObject | 否 | 联系电话集合JSONObject,如: [ {"area_no": "0757", "tel": "28102910" }, {"area_no": "0757", "tel": "28102910" }, ... ] |
shift_times_json | JSONObject | 否 | 上下班时间集合JSONObject [ {"start_time": "09:00", "end_time": "12:00" }, {"start_time": "14:00", "end_time": "17:00" }, ... ] ,集合对象需按照24小时内从早到晚排序, 24小时制。 |
请求示例:
{ "msgId":"ca181c23-03be-22a4-7c95-33502a3962f2","province":"广东省","city":"佛山市","district":"顺德区","lon":113.187862,"lat":22.892,"detail":"广东省佛山市顺德区北滘镇三江线test","area":110,"space_id":86597, "shift_times_json": [ {"begin_time": "09:00", "end_time": "12:00" }], "contact_tels_json": [ {"area_no": "0757", "tel": "28102910" }, {"area_no": "0757", "tel": "28102911" }] }
返回示例:
{
"code": "200",
"message": "成功",
"version": null,
"returnExceptionData": false,
"result": {
"id": 86598,
"province": "广东省",
"city": "佛山市",
"district": "顺德区",
"detail": "广东省佛山市顺德区北滘镇三江线test",
"lon": 113.187862,
"lat": 22.892,
"space_id": 86597,
"ico": null,
"contact_tels_json": [
{
"area_no": "0757",
"tel": "28102910"
},
{
"area_no": "0757",
"tel": "28102911"
}
],
"shift_times_json": [
{
"begin_time": "09:00",
"end_time": "12:00"
}
]
},
"data": null
}
1.2 项目地址修改
描述 修改项目地址, 一个小区空间(space_type=COMMUNITY)对应一个地址信息。 此接品即将作废。
请求信息
URL:/v1/iot/main/spacelocation/edit
METHOD: POST
body: JSON格式约定
字段 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
id | Int | 是 | 项目地址主键 ID |
province | String | 是 | 省 |
city | String | 是 | 市 |
district | String | 是 | 区 |
lon | Int | 是 | 高德地图经度 |
lat | Int | 是 | 高德地图纬 |
detail | Int | 否 | 地址的详细门牌 |
space_id | Array | 是 | 这里是smart_cmty_space表的主键ID,空间ID,仅space_type=COMMUNITY对应的空间ID |
ico | String | 否 | 项目图片相对路径 |
contact_tels_json | JSONString | 是 | 联系电话集合JSON字符串,如: [ {"area_no": "0757", "tel": "28102910" }, {"area_no": "0757", "tel": "28102910" }, ... ] |
shift_times_json | JSONString | 是 | 上下班时间集合JSON字符串 [ {"start_time": "09:00", "end_time": "12:00" }, {"start_time": "14:00", "end_time": "17:00" }, ... ] ,集合对象需按照24小时内从早到晚排序, 24小时制。 |
请求示例:
{"id": 123, space_id": 3429, "province": "AA", "city": "BB" , "district": "12333", "lon": 123.46, "lat": 123.56 , "detail": "AAC", "shift_times_json": [ {"start_time": "09:00", "end_time": "12:00" }, "contact_tels_json": [ {"area_no": "0757", "tel": "28102910" }, {"area_no": "0757", "tel": "28102910" }, ... ]
返回示例:
{
"code":"200",
"message": "成功",
"result": {
"id": 8825,
"province": "AA",
"city": "BB",
"district": "12333",
"detail": "AAC",
"lon": 123.46,
"lat": 123.56,
"space_id": 3429,
"ico":"dfdjkd",
"contact_tels_json": [ {"area_no": "0757", "tel": "28102910" }, {"area_no": "0757", "tel": "28102910" }, ... ],
"shift_times_json": [ {"start_time": "09:00", "end_time": "12:00" }, {"start_time": "14:00", "end_time": "17:00" }, ... ]
}
}
1.3 项目详情
描述 由项目ID加载出项目的详情,用于编辑加载或详情展示
请求信息
本接口更新后返回值多出 contact_tels_json, shift_times_json 两个字段。
URL:/v1/iot/main/space/detail/community/{id}
METHOD: POST
body: 空
路径参数:
id : 空间主键ID
返回:
1.3 新增、修改员工
请求信息
URL:/v1/iot/main/admin/update
Method: POST
body: JSON格式约定
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
id | Long | 否 | 主键id, 为空执行新增, 不为空执行修改 |
user_id | Long | 是(前端非必填,同步必填) | 原tb_uhome_admin_user表的主键字段 |
position_level | Int | 否 | 组织职级 1:部门负责人 2:部门中层 3:普通员工 |
org_id | Long | 是 | 行政组织ID,smart_cmty_org 外键 |
org_code | String | 是(前端必填,同步非必填) | 行政组织code |
mobile | String | 是 | 手机号 |
staff_no | String | 是(前端必填,同步非必填) | 工号 |
position | String | 职务 | |
job_number | String | 是 | 原tb_uhome_admin_user表的字段,账号,此属性针对物业员工 |
nickname | String | 昵称 | |
ico | String | 原tb_uhome_admin_user表字段,头像, 存储图片相对路径 | |
pwd | String | 原tb_uhome_admin_user表的主键字段,员工密码 | |
name | String | 是 | 原tb_uhome_admin_user表字段,姓名 |
sex | Integer | 原tb_uhome_admin_user表的字段,性别1为女,2为男 | |
String | 原tb_uhome_admin_user表的字段,邮件 | ||
identity | String | 原tb_uhome_admin_user表的字段,身份证 | |
type | Integer | 是 | 原tb_uhome_admin_user表的字段,用户类型: 1:物管用户,4:商户用户,8:平台管理用户 |
status | Integer | 原tb_uhome_admin_user表的字段,状态: 1为正常、2为注销 |
2 客户管理
PI列表 | API接口URL | 说明 |
---|---|---|
2.1 由业务组织org_code获取所有的项目列表 | /v1/iot/main/customer/house/relation/query/communitys | |
2.2 由小区ID查询一棵空间树 | /v1/iot/main/space/tree/{id} | 房产信息弹窗:https://lanhuapp.com/web/#/item/project/detailDetach?pid=e434338d-27e3-41bb-865f-5deb2d8cbc1e&project_id=e434338d-27e3-41bb-865f-5deb2d8cbc1e&image_id=c4fe644d-bf34-4205-8a0f-826651675164&fromEditor=true |
2.3分页查询客户 | 客信息列表 :https://lanhuapp.com/web/#/item/project/detailDetach?pid=e434338d-27e3-41bb-865f-5deb2d8cbc1e&project_id=e434338d-27e3-41bb-865f-5deb2d8cbc1e&image_id=8b600aeb-08ea-4545-9099-0f1164218537&fromEditor=true |
2.1 由业务组织org_code获取所有的项目列表
请求信息
URL:/v1/iot/main/customer/house/relation/query/communitys
Method: POST
body: JSON格式约定
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
org_id | String | 否 | 业务组织ID, org_id和org_code 两个必传其一; |
org_code | Long | 否 | 业务组织org_code, org_id和org_code 两个必传其一 |
space_name | String | 否 | 空间名称(用来过滤的) |
needReturnZoneCount | boolean | 否 | 是否需要返回小区片区数量,为true时后端返回片区数量,为false时后端不返回片区数量 默认不返回片区数量 |
请求示例:
{
"org_code":"901",
"space_name":"花园"
}
返回示例:
{
"code":"200",
"message": "成功",
"result": [
{
"id": 3280, //空间id 小区id
"parentid": 1572, //空间父节点id
"space_id": null, //4格系统空间id
"parent_space_id": null,
"community_id": null,//4格(小区)表主键
"space_name": "16栋_1单元_2602", //空间名
"full_space_name": "美的君兰江山(北滘)/16栋/1单元/26/16栋_1单元_2602", //空间全路径名称
"parent_code": "1000101410001024",//父节点空间编码
"space_code": "10001014100010241001",//空间编码
"space_type": "HOUSE", //'空间类型(细分类): COMMUNITY:小区、ZONE:片区、STRUCTURE:建筑物、BUILDING:楼栋、UNIT:单元、FLOOR:楼层、HOUSE:房屋、\r\nPARK:车场、PARK_NAME:车场名称、PARK_AREA:车场区域、PARK_SPACE:车位、PUBLIC_AREA:公共区域、PRIMARY_AREA:一级区域、SECONDARY_AREA:二级区域、THIRD_AREA:三级区域'
"src": 1, //数据来源:1:自研平台,2:四格
"org_id": null,//空间对应的 业务组织ID
"create_by": null,
"update_by": null,
"create_time": "2020-11-06T09:11:55.000+0000",
"update_time": null,
"directZoneNums": 0, //片区数量
},
...
],
"pageNo": 1,
"totalPage": 96,
"total": 1919,
"pageSize": 20,
"type": null
}
或
{
"code":"200",
"message": "成功",
"result": [
{
"create_by": null,
"update_by": null,
"create_time": "2020-11-07T10:21:57.000+0000",
"update_time": "2020-11-11T05:59:25.000+0000",
"id": 9885,
"parentid": null,
"space_id": null,
"parent_space_id": null,
"community_id": null,
"space_name": "简岸花园",
"full_space_name": "简岸花园",
"parent_code": null,
"space_code": "1000",
"space_type": "COMMUNITY",
"space_sort": "COMMUNITY",
"src": 1,
"org_id": 9103,
"province": null,
"city": null,
"district": null,
"detail": null,
"lon": 0.0,
"lat": 0.0,
"children": null,
"parent_name": null,
"org_ids": null,
"pageNo": 0,
"pageSize": 0,
"list": null
},
{
"create_by": null,
"update_by": null,
"create_time": "2020-11-07T10:21:57.000+0000",
"update_time": "2020-11-11T05:59:25.000+0000",
"id": 9887,
"parentid": null,
"space_id": null,
"parent_space_id": null,
"community_id": null,
"space_name": "海岸花园",
"full_space_name": "海岸花园",
"parent_code": null,
"space_code": "1002",
"space_type": "COMMUNITY",
"space_sort": "COMMUNITY",
"src": 1,
"org_id": 9104,
"province": null,
"city": null,
"district": null,
"detail": null,
"lon": 0.0,
"lat": 0.0,
"children": null,
"parent_name": null,
"org_ids": null,
"pageNo": 0,
"pageSize": 0,
"list": null
}
],
"pageNo": 0,
"pageSize": 0,
"total": 0,
"totalPage": 0
}
2.2 由小区ID查询一棵空间树
描述 : 根据空间节点的主键ID返回一个树型JSON
请求信息
URL:/v1/iot/main/space/tree/{id}
METHOD: POST
路径参数:
字段 | 类型 | 是否必传 | 说明 |
---|---|---|---|
id | Int | 是 | 空间主键ID,一般为顶级节点的ID |
请求示例:
/v1/iot/main/space/tree/17
返回示例:
{
"code":"200",
"message": "成功",
"result": [
{
"create_time": null,
"create_by": null,
"update_time": null,
"update_by": null,
"id": 17,
"parentid": null,
"space_id": null,
"space_name": "美的君兰江山",
"full_space_name": "美的君兰江山",
"parent_code": null,
"space_code": "1000",
"space_type": "COMMUNITY",
"src": 1,
"children": [
{
"create_time": null,
"create_by": null,
"update_time": null,
"update_by": null,
"id": 18,
"parentid": 17,
"space_id": null,
"space_name": "美的君兰江山一期A",
"full_space_name": "美的君兰江山/美的君兰江山一期A",
"parent_code": "1000",
"space_code": "10001001",
"space_type": "COMMUNITY",
"src": 1,
"children": null,
"parent_name": null
}
],
"parent_name": null
}
],
"pageNo": 0,
"totalPage": 0,
"total": 0,
"pageSize": 0
}
2.3 客户信息列表
描述 : 此接口已调整,请注意。
请求信息
URL:/v1/iot/main/customer/houseAndCustomers
Method: POST
body: JSON格式约定
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 是否唯一(默认否) | 说明 |
---|---|---|---|---|
org_code | String | 否 | 全局切换业务组织ID | |
org_id | Long | 否 | 全局切换业务组织code | |
space_code | String | 否 | 项目code, 由空间code来过滤数据 | |
identity | String | 否 | 由证件号码作为模糊查询 | |
customer_name | String | 否 | 由客户姓名作为模糊查询 | |
customer_phone | String | 否 | 电话号码作为模糊查询 | |
identity_type | Integer | 否 | 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:港澳台身份证 | |
customer_type | identity_type | 否 | 客户类型 ,客户类型( 2业主,3业主成员,14租户,15租户成员 ) | |
customer_properties | Integer | 否 | 客户性质 1:个人客户;2:政企客户 | |
is_history | Integer | 否 | 是否历史用户:1: 是 2: 否 | |
pageNo | Integer | 否 | 第几页 | |
pageSize | Integer | 否 | 每页大小 |
请求示例:
{"org_code": "100000001100000000", "pageSize": 25}
返回示例:
{
"code": "200",
"data": {
"result": [
{
"id": 87759,
"customer_name": "肖扬",
"customer_phone": "18819450802",
"identity": "410100198809040802",
"space_name": "201",
"sex": null,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "501",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "车位1",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 2,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "302",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "203",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "104",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "101",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "401",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "202",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "301",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "102",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "305",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "101",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "306",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "201",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21814,
"customer_name": "66666",
"customer_phone": "13455666666",
"identity": "666666199008086666",
"space_name": "103",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21427,
"customer_name": "王翦",
"customer_phone": "18900222333",
"identity": "889977333312234444",
"space_name": "2E",
"sex": 2,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21427,
"customer_name": "王翦",
"customer_phone": "18900222333",
"identity": "889977333312234444",
"space_name": "zt102",
"sex": 2,
"identity_type": 1,
"customer_properties": 1,
"type": 2,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21411,
"customer_name": "李静",
"customer_phone": "13344552211",
"identity": "445533444211223333",
"space_name": "203",
"sex": null,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21409,
"customer_name": "哈哈哈",
"customer_phone": "13222338884",
"identity": "445533222211223333",
"space_name": "测试产权车位",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 2,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 21405,
"customer_name": "王莽",
"customer_phone": "13455665544",
"identity": "112233111111112222",
"space_name": "203",
"sex": 2,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 20277,
"customer_name": "良良",
"customer_phone": "13100000008",
"identity": "450881200002206020",
"space_name": "103",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 20277,
"customer_name": "良良",
"customer_phone": "13100000008",
"identity": "450881200002206020",
"space_name": "203",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 20277,
"customer_name": "良良",
"customer_phone": "13100000008",
"identity": "450881200002206020",
"space_name": "1A",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
},
{
"id": 20277,
"customer_name": "良良",
"customer_phone": "13100000008",
"identity": "450881200002206020",
"space_name": "202",
"sex": 1,
"identity_type": 1,
"customer_properties": 1,
"type": 1,
"sex_trans": null,
"identity_type_trans": null,
"customer_properties_trans": null,
"type_trans": null
}
],
"total": 25,
"pageNo": 1,
"totalPage": 1,
"pageSize": 25
},
"message": "success"
}
2.3 客户信息新增、修改
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/updateCustomerAndHouses
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 是否唯一(默认否) | 说明 |
---|---|---|---|---|
id | 客户ID | 否 | 当id不为空,代表修改操作。当id为空代表新增操作。 | |
customer_properties | Integer | 是 | 客户性质 1:个人客户;2:政企客户 | |
customer_name | String | 是 | 姓名+手机号唯一 | 客户名称 |
customer_phone | String | 是 | 电话号码 | |
community_id | Long | 是 | 项目空间id | |
identity_type | Integer | 是 | 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:香港身份证,6:澳门身份证,7:台湾身份证,8:其他证件 | |
identity | String | 是 | 证件号码 | |
sex | Integer | 是 | 性别 1:女,2:男 | |
face_ico | String | 否 | 人脸, 存储图片相对路径 | |
status | Integer | 否 | 客户状态:1:有效 ;2:无效 默认是1 | |
cust_native | String | 否 | 户籍 | |
cust_live_city | Stirng | 否 | 常住城市 | |
cust_nation | Stirng | 否 | 客户民族 | |
cust_birthday | Stirng | 否 | 客户生日 | |
cust_urgent_contact | Stirng | 否 | 客户紧急联系人 | |
customerHouseRels | List |
否 | 客户所关联产权集合JSON格式。CustomerHouseRel:产权对象。 | |
customerOrgRels | List |
是 | 客户属业务组织集合JSON格式。CustomerOrgRel:业务组织对象。客户可以归属一个顶级业务组织下的多个业务组织 |
height | Int | 否 | 身高,50-250之间 | |
---|---|---|---|---|
blood_type | String | 否 | 血型:A/B/AB/O | |
weight | Int | 否 | 体重 | |
occupation | String | 否 | 职业:10字以内 | |
label_json | Array | 否 | 业主标签:1:公司员工、2:五星业主、3:残障人士、4:重点客户、5:政府机关人员、6:媒体名人、7:独居老人、8:业委会成员、9:中共党员。 多选,如:[1,3] | |
marry_status | Int | 否 | 婚姻状况:1:已婚,2:未婚 | |
education_status | Int | 否 | 教育程度,1:小学、2:初中, 3:高中, 4:大专,5:本科 6:硕士研究生,7:博士研究生 | |
live_status | Int | 否 | 居住情况, 1:独居 , 2:和家人同住 | |
policy_status | Int | 否 | 政治面貌, 1:共青团员, 2:共产党员,3:预备党员,4: 群众, 5: 无党派人士,6: 九三学社社员, 7: 民盟盟员, 8: 民进会员, 9:致公党党员,10:民革党员,11:台盟盟员, 12:民建会员,13:农工党党员 | |
graduated | String | 否 | 毕业院校(50) | |
contact | String | 否 | 联系方式(11) |
客户关联的产权对象CustomerHouseRel 属性如下:
字段 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
id | Long | 否 | 客户与房产关联关系主键ID. 为空代表新增的产权,不为空代表客户已有的产权,在修改客户时会加载出客户已有的产权,此时id不可为空。 |
community_name | String | 否 | 项目名称 |
community_id | Long | 否 | 项目id |
space_name | String | 否 | 房间号/车位号 |
space_id | Long | 是 | 空间ID |
space_type | String | 否 | 空间类型, |
resident | int | 是 | 是否常住,1:是,2:否 |
customer_type | int | 是 | 客户类型: 2业主,3业主成员,14租户,15租户成员 |
type | int | 否 | 产权类型: 1房屋;2车位 |
业务组织对象customerOrgRel 属性如下:
字段 | 字段类型 | 是否必填 | 说明 |
---|---|---|---|
id | Long | 否 | 客户与业务组织的关联关系ID ;不为空代表在修改客户信息时加载旧的客户与业务组织的关联关系。 |
business_org_id | Long | 是 | 业务组织ID |
business_org_code | String | 否 | 业务组织org_code |
business_org_name | String | 否 | 业务组织org_name |
2.4 客户信息加载
一次性加载出用户的基础信息和所关联的业务组织、所认证的产权。对于已信息认证的产权,前端不允许修改。
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/customerAndHouses/load/{id}?type=edit
method: GET
路径参数:
id: customer 客户表的主键ID
请求参数:type: 当type=edit表示编辑接口,type为空代表详情加载。 详情加载时返回客户所所有的房产信息,包括迁出状态的房产;ype=edit表示编辑接口时,返回的房产信息不会包括迁出状态的房产。
返回数据及字段:
字段 | 字段类型 | 是否必返(默认否) | 是否唯一(默认否) | 说明 |
---|---|---|---|---|
id | 客户ID | 否 | 当id不为空,代表修改操作。当id为空代表新增操作。 | |
customer_properties | Integer | 是 | 客户性质 1:个人客户;2:政企客户 | |
customer_name | String | 是 | 姓名+手机号唯一 | 客户名称 |
customer_phone | String | 是 | 电话号码 | |
community_id | Long | 是 | 项目空间id | |
identity_type | Integer | 是 | 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:香港身份证,6:澳门身份证,7:台湾身份证,8:其他证件 | |
identity | String | 是 | 证件号码 | |
sex | Integer | 是 | 性别 1:女,2:男 | |
face_ico | String | 否 | 人脸, 存储图片相对路径 | |
status | Integer | 否 | 客户状态:1:有效 ;2:无效 默认是1 | |
cust_native | String | 否 | 户籍 | |
cust_live_city | Stirng | 否 | 常住城市 | |
cust_nation | Stirng | 否 | 客户民族 | |
cust_birthday | Stirng | 否 | 客户生日 | |
cust_urgent_contact | Stirng | 否 | 客户紧急联系人 | |
customerHouseRels | List |
否 | 客户所关联产权集合JSON格式。CustomerHouseRel:产权对象。 | |
customerOrgRels | List |
是 | 客户属业务组织集合JSON格式。CustomerOrgRel:业务组织对象。客户可以归属一个顶级业务组织下的多个业务组织 | |
height | Int | 是 | 身高,50-250之间 | |
blood_type | String | 是 | 血型:A/B/AB/O | |
weight | Int | 是 | 体重 | |
occupation | String | 是 | 职业:10字以内 | |
label_json | Array | 是 | 业主标签:1:公司员工、2:五星业主、3:残障人士、4:重点客户、5:政府机关人员、6:媒体名人、7:独居老人、8:业委会成员、9:中共党员。 多选,如:[1,3] | |
marry_status | Int | 是 | 婚姻状况:1:已婚,2:未婚 | |
education_status | Int | 是 | 教育程度,1:小学、2:初中, 3:高中, 4:大专,5:本科 6:硕士研究生,7:博士研究生 | |
live_status | Int | 是 | 居住情况, 1:独居 , 2:和家人同住 | |
policy_status | Int | 是 | 政治面貌, 1:共青团员, 2:共产党员,3:预备党员,4: 群众, 5: 无党派人士,6: 九三学社社员, 7: 民盟盟员, 8: 民进会员, 9:致公党党员,10:民革党员,11:台盟盟员, 12:民建会员,13:农工党党员 | |
graduated | String | 是 | 毕业院校(50) | |
contact | String | 联系方式(11) |
产权对象CustomerHouseRel 属性如下:
注: 若在修改客户资料时,此值为空集合,代表解除客户与房产已有的关联关系。
字段 | 字段类型 | 必须返回 | 说明 |
---|---|---|---|
id | Long | 是 | 客户房产关联关系表主键ID, 若为修改客户信息从客户信息带出来的房产信息,此字段必填。 |
community_name | String | 否 | 项目名称; |
community_id | Long | 否 | 项目id |
space_name | String | 否 | 房间号/车位号 |
space_id | Long | 是 | 空间ID |
space_type | String | 否 | 空间类型, |
settle | int | 是 | 是否常住,1:是,2:否 |
customer_type | int | 是 | 客户类型: 2业主,3业主成员,14租户,15租户成员 |
type | int | 否 | 产权类型: 1房屋;2车位 |
approved | Boolean | 是 | 是否已信息认证:true: 是;false: 否。对于已信息认证的产权,前端不允许修改, 呈现的字段均只读。 |
业务组织对象customerOrgRel 属性如下:
字段 | 字段类型 | 是否必返 | 说明 |
---|---|---|---|
id | Long | 否 | 客户与业务组织的关联关系表主键ID;修改客户信息重新选取业务组织时必传。 |
business_org_id | Long | 是 | 业务组织ID |
business_org_code | String | 否 | 业务组织org_code |
business_org_name | String | 否 | 业务组织org_name |
2.5 由手机号查询社区APP用户和客户信息
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/getUserInfo
method: POST
请求body
字段 | 字段类型 | 是否必传 | 说明 |
---|---|---|---|
mobile | String | 是 | 社区APP注册用户的手机号 |
org_id | Long | 否 | 全局切换业务组织ID;org_id和org_code必传其一。 |
org_code | String | 否 | 全局切换业务组织code 。 |
返回:
{
"code": "200",
"essage":"success",
"data": {
"app_user": {"id":xxx, .... },
"customers": [{"id":XXX, "customer_phone" :XXX, "customer_properties":XX, ... }, ... {"id":XXX, "customer_phone" :XXX, "customer_properties":XX, ... } ]
}
}
返回字段:
app_user: 返回一条手机号对应的APP用户信息
字段 | 类型 | 说明 |
---|---|---|
id | Long | 客户表主键ID |
user_name | String | 社区用户名 |
nick_name | String | 社区用户昵称 |
real_name | String | 社区用户姓名 |
mobile | String | 社区用户手机号 |
customers: 返回同一手机号对应的多条客户集合, 以下是必须展示字段
字段 | 类型 | 说明 |
---|---|---|
id | Long | 客户表主键ID |
identity_type | Int | 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:港澳台身份证 |
identity | String | 证件号码 |
customer_properties | int | 客户性质 1:个人客户;2:政企客户 |
customer_name | String | 客户姓名 |
customer_phone | String | 客户手机号 |
2.6 信息认证
说明 : 信息认证即保存客户、产权(房屋或车位)、和社区APP三者的关联关系 。
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/custHouseApp/rel/update
method: POST
请求body
字段 | 字段类型 | 是否必传 | 说明 |
---|---|---|---|
customer_id | Long | 是 | 客户的主键ID |
user_id | Long | 是 | 社区APP注册用户的主键ID |
space_id | Long | 是 | 产权(房屋或车位)空间的主键ID |
auth_type | Integer | 是 | 认证客户类型(家庭成员角色类型:2业主,3业主成员,14租户,15租户成员) |
remark | String | 否 | 新增信息认证备注 |
返回 :
{
"code":"200",
"message":"success"
}
2.7 查询产权是否已被信息认证
说明 :
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/auth/status
method: POST
请求body
字段 | 字段类型 | 是否必传 | 说明 |
---|---|---|---|
customer_id | Long | 是 | 客户的主键ID |
space_id | Long | 是 | 产权(房屋或车位)空间的主键ID |
已认证:如果已认证,返回true
返回 :
{
"code":"200",
"message":"success",
"data": true
}
3 租户管理
A务PI列表 | API接口URL | 说明 | method |
---|---|---|---|
3.1 新增租户(含退租) | /v1/iot/main/house/lease/saveOrUpdate | POST | |
3.2 查询租户 | /v1/iot/main/house/lease/get/{id} | GET | |
3.3 租户列表 | /v1/iot/main/house/lease/list | POST | |
3.4 租户删除 | /v1/iot/main/house/lease/delete/{id} | DELETE | |
3.5 租户分页 | /v1/iot/main/house/lease/page/{pageNo}/{pageSize} | POST | |
3.6 批量新增 | /v1/iot/main/house/lease/batch/saveOrUpdate | POST |
3.1 新增租户
/v1/iot/main/house/lease/saveOrUpdate
method: POST
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
customer_id | long | 是 | 客户ID |
person_name | string | 否 | 客户名 |
contact_phone | string | 否 | 联系电话 |
start_time | date | 是 | 承租时间 |
end_time | date | 是 | 退租时间 |
operater | string | 否 | 操作人 |
lease_status | int | 否 | 承租状态 1承租 2退租 |
remark | string | 否 | 备注 |
说明:
请求示例:
{
"house_id":"房屋id",
"customer_id":"客户id",
"person_name":"承租人",
"contact_phone":"联系电话",
"start_time":"承租开始时间",
"end_time":"承租结束时间",
"operater":"操作人",
"lease_status":"承租状态 1承租2退租",
"remark":"备注"
}
退租示例:
{
"id": 89551,
"lease_status": 2
}
返回示例:
{
"code": 200,
"data": {
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636675200000,
"end_time": 1639267200000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
},
"message": "success"
}
3.2 查询租户
/v1/iot/main/house/lease/get/{id}
method: GET
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
id | long | 是 | 主键ID |
说明:
请求示例:
返回示例:
{
"code": 200,
"data": {
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636675200000,
"end_time": 1639267200000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
},
"message": "success"
}
3.3 租户列表
/v1/iot/main/house/lease/list
method: POST
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
id | long | 是 | 主键ID |
house_id | long | 是 | 房屋ID |
customer_id | long | 是 | 客户ID |
person_name | string | 是 | 客户名 |
contact_phone | string | 是 | 联系电话 |
start_time | date | 是 | 承租时间 |
end_time | date | 是 | 退租时间 |
operater | string | 否 | 操作人 |
lease_status | int | 否 | 承租状态 1承租 2退租 |
remark | string | 否 | 备注 |
说明:
请求示例:
{
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636646400000,
"end_time": 1639238400000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
}
返回示例:
{
"code": 200,
"data": {
"result": [
{
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636646400000,
"end_time": 1639238400000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
}
]
},
"message": "success"
}
3.4 租户删除
/v1/iot/main/house/lease/delete/{id}
method: DELETE
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
id | long | 是 | 主键ID |
说明:
请求示例:
返回示例:
{
"code": 200,
"data": {
},
"message": "success"
}
3.5 租户分页
/v1/iot/main/house/lease/page/{pageNo}/{pageSize}
method: POST
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
id | long | 是 | 主键ID |
house_id | long | 是 | 房屋ID |
customer_id | long | 是 | 客户ID |
person_name | string | 是 | 客户名 |
contact_phone | string | 是 | 联系电话 |
start_time | date | 是 | 承租时间 |
end_time | date | 是 | 退租时间 |
operater | string | 否 | 操作人 |
lease_status | int | 否 | 承租状态 1承租 2退租 |
remark | string | 否 | 备注 |
说明:
请求示例:
{
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636646400000,
"end_time": 1639238400000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
}
返回示例:
{
"code": 200,
"data": {
"total": "100",
"result": [
{
"id": 89551,
"house_id": 1000,
"customer_id": 10001,
"person_name": "承租人",
"contact_phone": "1800000001",
"start_time": 1636646400000,
"end_time": 1639238400000,
"operater": "操作人",
"lease_status": 1,
"remark": "备注备注备注备注备注备注备注备注备注",
"created_by": null,
"created_time": null,
"updated_by": null,
"updated_time": null
}
]
},
"message": "success"
}
3.6 批量新增租户
/v1/iot/main/house/lease/batch/saveOrUpdate
method: POST
请求body
入参dto:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
customer_id | long | 是 | 客户ID |
person_name | string | 是 | 客户名 |
contact_phone | string | 是 | 联系电话 |
start_time | date | 是 | 承租时间 |
end_time | date | 是 | 退租时间 |
operater | string | 否 | 操作人 |
lease_status | int | 否 | 承租状态 1承租 2退租 |
remark | string | 否 | 备注 |
attachment | string | 否 | 附件 |
说明:
请求示例:
[{
"house_id":"房屋id",
"customer_id":"客户id",
"person_name":"承租人",
"contact_phone":"联系电话",
"start_time":"承租开始时间",
"end_time":"承租结束时间",
"operater":"操作人",
"lease_status":"承租状态 1承租2退租",
"remark":"备注",
"attachment": "[{}]"
}]
退租示例:
[{
"id": 89551,
"lease_status": 2
}]
返回示例:
{
"code": 200,
"data": {
},
"message": "success"
}
3.7 由员工查所有的角色
URL: /platform/org/roles/{admin_id}
method: GET
路径变量:
admin_id: 长整型 ,员工表主键ID
返回值 :
{
"code":"200",
"message":"success",
"data": {
"result": [
{"role_id": 99, "role_name": "技术人员", "full_org_name":"美的置业/智慧生活研究院/软件开发部"}, ...
]
}
}
4 入伙管理
4.1 入伙新增/修改
/v1/iot/main/customer/join
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
list | JSONArray |
是 | 客户信息集合。 |
list集合中的JSONObject属性如下 :
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
customer_id | long | 是 | 客户id; 用户从当前房产中已认证的客户中选取客户信息。 |
notify_date | String | 是 | 通知过户时间;格式:yyyy-MM-dd HH:mm:ss |
join_date | String | 是 | 入伙时间;格式:yyyy-MM-dd HH:mm:ss |
返回示例 :
{
"code":"200",
"message":"success",
"data": {
"result": [{客户房产关系记录对象}, {}]
}
}
4.2 房产迁出
/v1/iot/main/customer/move
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
list | Array |
是 | 批量迁出多业主的customer_id集合, 如:[1109,1121]。需要从当前房产中已关联的业主作迁出动作. |
返回示例 :
{
"code":"200",
"message":"success",
"data": {
"result": [{客户房产关系记录对象}, {}]
}
}
4.3 房产过户
/v1/iot/main/customer/transfer
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
list | Array |
是 | 新业主对象集合 |
新业主对象customer
属性 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
customer_id | long | 是 | 客户ID |
transfer_date | String | 是 | 过户日期 yyyy-MM-dd |
请求示例 :
{"house_id":1109, "list":[ {"customer_id":1102, "transfer_date":"2021-12-09"}, {"customer_id":1109, "transfer_date":"2021-12-09"}, ..... ]}
4.2 房产详情
URL: /v1/iot/main/customer/join/history/{house_id}
描述 : 根据房产ID查询房产信息及历史客户信息
method: GET
路径参数
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
history | boolean | 是 | true: 查询出当前房产的历史业主; false: 当前房产的非历史业主集合 |
only_house | boolean | 是 | true: 仅返回当前房产信息 ; false: 返回当前房产信息的同时需要返回当前房产的历史业主或当前房产的非历史业主集合 ; |
返回示例 :
{
"code": "200",
"data": {
"list": [
{
"customer_type": 2,
"housing_status": 1000,
"full_space_name": "万科水晶城1/一级空间小区/建筑物/04金碧/第一单元/19/1901",
"customer_phone": "13570496384",
"transfer_date": null,
"move_date": null,
"space_name": "1901",
"customer_name": "老立",
"customer_id": 110414,
"update_by": null,
"space_id": 96627,
"notify_date": null
}
],
"house": {
"space_name": "1901",
"full_space_name": "万科水晶城1/一级空间小区/建筑物/04金碧/第一单元/19/1901",
"join_status": 1,
"space_id": 96627
}
},
"message": "成功"
}
房屋信息 house参见下表:
字段 | 字段类型 | 是否必返 | 说明 |
---|---|---|---|
id | Long | 是 | 空间ID |
customer_name | String | 是 | 空间名称 |
full_space_name | String | 是 | 完整空间名称 |
join_status | Integeger | 是 | 入伙状态 1: 已入伙 ; 2:未入伙 |
历史业主集合list 各字段参见:
当 history = true时 list集合代表历史的业主集合;
当 history = false 时 list集合代表非历史的业主集合;
字段 | 字段类型 | 是否必返 | 说明 |
---|---|---|---|
customer_id | Long | 是 | 客户ID |
customer_name | String | 是 | 客户称 |
customer_phone | String | 是 | 客户电话 |
transfer_date | String | 是 | 过户日期 yyyy-mm-dd HH:mm:ss |
move_date | String | 是 | 迁出日期 yyyy-mm-dd HH:mm:ss |
notify_date | String | 是 | 知过户日期 yyyy-mm-dd HH:mm:ss |
4.3 搜索客户信息
/v1/iot/main/house/join/customer/search
描述 : 数据实现多租户隔离,全局切换业务组织必填,平台将实现数据鉴权。如:只能搜索出用户所在的顶级业务组织下的客户。
method: PUT
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
org_id | Long | 是 | 全局切换业务组织ID |
customer_name | String | 否 | customer_name和customer_phone两都必选其一。 支持全模糊查询 |
customer_phone | String | 否 | customer_name和customer_phone两都必选其一。支持全模糊查询 |
list集合中的JSONObject属性如下 :
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
customer_id | long | 是 | 客户id; 用户从当前房产中已认证的客户中选取客户信息。 |
notify_date | String | 是 | 通知过户时间;格式:yyyy-MM-dd HH:mm:ss |
join_date | Stroing | 是 | 入伙时间;格式:yyyy-MM-dd HH:mm:ss |
join_status | Integer | 否 | 默认为入伙。入伙状态 1: 入伙 ; 2:迁出; |
4.4 出租管理附件上传
见: http://arch.smartmideazy.com/apidoc/common/file-service.html#16
5 生日提醒 - 由项目ID查询当天生日的社区用户
URL: /v1/iot/main/platform/app/birthday/users
描述:
Method: PUT
Body 属性:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
space_id | Long | 是 | 项目ID |
返回 :示例
{
"code": "200",
"data": {
"result": [
{ 用户信息 }, ...
]
}
}