1 客户云
1.1 数据字典
业务 | 值 | 说明 |
---|---|---|
客户类型 | 2 | 业主 |
客户类型 | 3 | 业主成员 |
客户类型 | 14 | 租户 |
客户类型 | 15 | 租户成员 |
1.1 入伙管理
1.1.1 批量入伙新增/修改操作
更新说明:(1) join_date, notify_date 更新为跟房子走, 不再是随入伙或迁出的记录来变更;(2)新增常住不常住字段; (3) 旧的接口只新增/修改业主的入伙,新的接口支持入伙时新增业主和业主成员。故,list字段的对象中新增一个字段:customer_type以告诉云端,入伙的客户的性质是业主还是业主成员。
原接口见:http://arch.smartmideazy.com/main-entry/platform-main-entry.html
https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/join
URL: /v1/iot/main/customer/join
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
space_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": [{客户房产关系记录对象}, {}]
}
}
新接口:客户信息集合字段中的join_date、notify_date字段将忽略。 join_date、notify_date 在BODY JSON参数中的第一层级;list集合中的JSONObject属性中新增是否常住字段:settle。客户信息集合list对象中新增一个字段:customer_type。
URL: /v1/iot/main/customer/join
method: POST
请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
space_id | long | 是 | 房屋ID |
list | JSONArray | 是 | 客户信息集合。 |
notify_date | String | 否 | 通知入伙日期,yyyy-MM-dd |
join_date | String | 是 | 入伙日期,必填, yyyy-MM-dd |
list集合中的JSONObject属性如下 :
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
customer_id | long | 是 | 客户id; 用户从当前房产中已认证的客户中选取客户信息。 |
settle | Int | 否 | 是否常住。1: 常住, 2:不常住。默认为1:常住。 |
customer_type | Int | 是 | 客户类型; 见《1.1 数据字典》 2:业主,3:业主成员 |
返回示例 :
{
"code":"200",
"message":"success",
"data": {
"result": [{客户房产关系记录对象}, {}]
}
}
1.2 房产迁出
/v1/iot/main/customer/move
method: POST
原请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
house_id | long | 是 | 房屋ID |
list | Array | 是 | 批量迁出多业主的customer_id集合, 如:[1109,1121]。需要从当前房产中已关联的业主作迁出动作. |
新请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
space_id | long | 是 | 房屋ID |
list | Array | 是 | 批量迁出多业主的customer_id集合, 如:[1109,1121]。需要从当前房产中已关联的业主作迁出动作. |
返回示例 :
{
"code":"200",
"message":"success",
"data": {
"result": [{客户房产关系记录对象}, {}]
}
}
1.3 房产过户
说明: 新接口house_id改为space_id
/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 |
新请求body
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
space_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"}, ..... ]}
1.4 房产详情
原接口见:http://47.111.56.94/apidoc/main-entry/platform-main-entry.html 《4.2 房产详情》
说明: 新接口house_id改为space_id ; 此处更新不涉及到H5端。入参和出参均不变。仅后端逻辑调整。入伙时间和通告入伙时间从空间拓展表中取值。
URL: /v1/iot/main/customer/join/history/{house_id}
描述 : 根据房产ID查询房产信息及历史客户信息
method: GET
原路径参数
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
long | 是 | 房屋ID | |
history | boolean | 是 | true: 查询出当前房产的历史业主; false: 当前房产的非历史业主集合 |
only_house | boolean | 是 | true: 仅返回当前房产信息 ; false: 返回当前房产信息的同时需要返回当前房产的历史业主或当前房产的非历史业主集合 ; |
新路径参数:
字段 | 字段类型 | 是否必填(默认否) | 说明 |
---|---|---|---|
space_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 |
1.5 客户信息/关联信息/产权信息和成员信息
由分页调整为不分页:
URL: https://biz-admin-sit.smartmideazy.com/v1/iot/main/customer/house/relation/query/byCustomerId
POST:
BODY:
{"pageSize":10,"pageNo":1,"type":1,"customer_id":127141}
字段 | 字段类型 | 是否必返 | 说明 |
---|---|---|---|
customer_id | Long | 是 | 客户ID |
type | Int | 是 | 1: 查询客户的产权记录; 2: 查询客户的成员记录 |
1.6 租户管理-新增/修改
功能说明:新增和修改接口公用一个接口,入参一致,租户名下的租户成员需要全量传给我,如果没有传给我的租户成员,会当做被“减去”操作
URL: /v1/iot/main/space/lease/batch/saveOrUpdate
POST:
BODY:
{
"list": [
{
"id":270354, //承租记录id 新增租户时这个字段必须为空,修改租户时这个字段必填
"space_id": 91087, //房屋的空间id 必填项
"customer_id": 270263, //租户的客户id 必填项
"start_time": "2022-07-13", //承租时间 必填项
"end_time": "2022-07-31", //退租时间 有值时必填,无值时不传
"lease_status": 1, //承租状态 必填项 枚举值:1承租; 2退租 新增/修改这种场景下,状态一定是1承租
"remark": "", //备注,非必填项
"attachmentM": [], //附件 非必填项
"attachment": "",//附件 非必填项
"leaseMemberCustomerIds":[270241,270184] //该租户下现有的所有租户成员的id集合,如果没有传给我的租户成员,会当做被“减去”操作
}
]
}
参数说明:新增租户成员id集合字段—leaseMemberCustomerIds,其他字段和以前保持一致
字段 | 字段类型 | 是否必返 | 说明 |
---|---|---|---|
leaseMemberCustomerIds | Array | 否 | 该租户下现有的所有租户成员的id集合 |
lease_status | Int | 是 | 枚举值:1承租; 2退租 |
id | Int | 否 | 用来区分是新增还是修改的标识 |
正常返回:
{
"code": 200,
"data": null,
"message": "success"
}
异常返回:
{
"code": 500,
"message": "找不到该承租记录;"
}
1.7 租户管理-租户退租
URL: /v1/iot/main/space/lease/batch/saveOrUpdate
POST:
BODY:
{
"list": [
{
"id": 270354,//承租记录id 必填项
"lease_status": 2 //承租状态 必填项 枚举值:1承租; 2退租 退租这种场景下,状态一定是2退租
}
]
}
正常返回:
{
"code": 200,
"data": null,
"message": "success"
}
异常返回:
{
"code": 500,
"message": "找不到该承租记录;"
}
1.8 租户管理-指定房间下租户和租户成员查询
URL:/v1/iot/main/space/lease/page/{pageNo}/{pageSize}
POST:
BODY:
{
"space_id": 91087, //房间id 必填项
"lease_status": 1 //承租状态 枚举值:1承租; 2退租 必填项 查询租户场景下,状态一定是1承租
}
返回结果中增加租户下的租户成员对象集合:leaseMemberRels
正常返回:
{
"code": 200,
"data": {
"result": [
{
"create_by": null,
"update_by": null,
"create_by_id": null,
"update_by_id": null,
"create_time": 1657721547000,
"update_time": 1657855534000,
"id": 270354,
"space_id": 91087,
"customer_id": 270263,
"person_name": "车行03",
"contact_phone": "13832399393",
"start_time": "2022-07-13",
"end_time": "2022-07-31",
"operater": null,
"lease_status": 1,
"space_type": 1,
"remark": "",
"attachment": "",
"leaseMemberCustomerIds": null,
"leaseMemberRels": [ //租户成员记录
{
"create_by": null,
"update_by": null,
"create_by_id": null,
"update_by_id": null,
"create_time": 1657718605000,
"update_time": 1657855534000,
"id": 270358,
"lease_id": 270354,
"space_id": 91087,
"customer_id": 270241,
"person_name": "车行02",
"contact_phone": "13878786767",
"lease_status": 1,
"space_type": null
},
{
"create_by": null,
"update_by": null,
"create_by_id": null,
"update_by_id": null,
"create_time": 1657718625000,
"update_time": 1657855534000,
"id": 270359,
"lease_id": 270354,
"space_id": 91087,
"customer_id": 270184,
"person_name": "关二波",
"contact_phone": "13929922484",
"lease_status": 1,
"space_type": null
}
]
}
],
"total": 1
},
"message": "success"
}