# **公共接口说明**
* * * * *
## **接口与接口说明**
1. 添加私客
2. 搜索私客
3. 获取私客列表
4. 获取私客详情
5. 添加普通带看
## 添加私客
+++
post:Api/PrivateGuest/addUserGuest/token/用户token
*customer_name=私客姓名 #
*customer_phone=私客电话 #
certificates=身份证 #
*region=委托区域 #
*company_name=公司名称 #
*industry_id=公司行业ID 【调用公告类接口中的常用单位】#
*describe=描述 #
*demand_area_less=最小需求面积不可为空 #
*demand_area_large=最大需求面积不可为空 #
<<<
success
{
"data": "2", //私客ID
"info": "添加成功",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "请输入2到4位字的姓名。",
"code": 1006,
"state": 2
}
可能返回的错误：
代号 错误
999 用户未登录
1006 输入的信息不符合
+++
## 修改私客
+++
post:Api/PrivateGuest/addUserGuest/token/用户token
*GuestId=私客ID #
customer_name=私客姓名 #
customer_phone=私客电话 #
certificates=身份证 #
region=委托区域 #
company_name=委托公司名称 #
industry_id=公司行业ID 【调用公告类接口中的常用单位】#
describe=描述 #
demand_area_less=最小需求面积不可为空 #
demand_area_large=最大需求面积不可为空 #
<<<
success
{
"data": "",
"info": "修改成功",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "修改失败。",
"code": 998,
"state": 2
}
可能返回的错误：
代号 错误
999 用户未登录
998 修改失败
+++
## 搜索私客【暂时用不上】
+++
get:Api/PrivateGuest/searchUserGuest?token=用户token
*page=当前页数 #
*searchKey=搜索关键字 #
<<<
success
{
"data": [
{
"id": "1",
"customer_name": "方法", //私客姓名
"customer_phone": "15507898841", //私客电话
"lead_num": "0" //带看次数
}
],
"info": "查询成功。",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "您未登录。",
"code": 999,
"state": 2
}
可能返回的错误：
代号 错误
998 操作数据库出错，包括查询，插入，删除，更新。
999 用户未登录
1006 输入的信息不符合
+++
## 获取私客列表
+++
get:Api/PrivateGuest/getStateUserGuest?token=用户token
*page=需要获取的页数，默认为第一页 #
*state=状态 # //0为全部私客，1为已带看私客。2为未带看私客
<<<
success
{
"data": {
"total": "2", //私客总数
"list": [
{
"id": "2",
"customer_name": "222",
"customer_phone": "15507898841",
"lead_num": "0"
},
{
"id": "1",
"customer_name": "方法",
"customer_phone": "15507898841",
"lead_num": "0"
}
]
},
"info": "查询成功",
"code": 1000,
"state": 1
}
<<<
error
{
"data": “”,
"info": "暂无私客信息",
"code": 1017,
"state": 2
}
可能返回的错误：
代号 错误
999 用户未登录
1006 输入的信息不符合
+++
## 获取私客详情
+++
get:Api/PrivateGuest/getUserGuestDetails?token=用户token
*GuestId=私客ID #
<<<
success
{
"data": {
"id": "1",
"customer_name": "方法",
"customer_phone": "15507898841",
"certificates": "450521199508125555",
"address": "0",
"house_type_id": "2",
"entrust_type": "1",
"demand_area": "a:2:{s:16:\"demand_ar",
"price_units_id": "1",
"price": "11",
"region": "22",
"company_name": "11",
"industry_id": "1",
"describe": "2222",
"settled": "0",
"user_id": "0",
"lead_num": "0"
},
"info": "查询成功",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "私客ID不可为空",
"code": 1018,
"state": 2
}
可能返回的错误：
代号 错误
999 用户未登录
1006 输入的信息不符合
+++
## 添加普通带看
>可能返回的错误码：999，998，1020，1006
+++
post:Api/PrivateGuest/lead_see?token=用户token
type=带看类型 1为普通带看，2为付佣带看，3为竞拍客户的带看 默认为1#
*user_guest_id=私客或竞拍客户ID #
*house_type_id=户型ID #
*content=内容 #
*image_data_id=图片ID。数组形式【调用上传图片接口】#
<<<
success
{
"data": "",
"info": "添加成功。",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "上传的图片格式不正确",
"code": 1020,
"state": 2
}
可能返回的错误：
代号 错误
998 操作数据库出错，包括查询，插入，删除，更新
999 用户未登录
1006 输入的信息不符合
1020 上传的图片格式不正确。需要将上传图片后返回的图片ID转为json格式。
+++
## 获取带看列表
+++
post:Api/PrivateGuest/lead_see?token=用户token
*type=带看类型 1为普通带看，2为付佣带看，3为竞拍客户的带看 默认为1#
*user_guest_id=私客或竞拍客户ID #
<<<
success
{
"data": [
{
"id": "8",
"content": "123", //带看内容
"image_data_id": [ //带看图片
{
"img": "image/201610082037085985.png"
},
{
"img": "image/201610082039581692.png"
}
]
}
],
"info": "获取成功",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "查询没有数据",
"code": 996,
"state": 2
}
可能返回的错误：
代号 错误
996 查询没有数据
998 操作数据库出错，包括查询，插入，删除，更新
999 用户未登录
+++
## 删除私客
+++
post:Api/PrivateGuest/deleteUserGuest?token=用户token
*GuestId=私客ID #
<<<
success
{
"data": "",
"info": "删除成功。",
"code": 1000,
"state": 1
}
<<<
error
{
"data": "",
"info": "缺少必须参数",
"code": 997,
"state": 2
}
可能返回的错误：
代号 错误
997 缺少必须参数
998 操作数据库出错，包括查询，插入，删除，更新
+++
