# **公共接口說明**
* * * * *
## **接口與接口說明**
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 操作數據庫出錯，包括查詢，插入，刪除，更新
+++
