[TOC]
## 房源列表
* 請求地址： `/house_info`
* 請求方式： get
* 請求參數： 無
* 成功返回：
```json
{
"code": 0,
"data": {
"data": [
{
"id": 1,
"h_video": "",//視頻地址
"h_img": [],//圖片 json 格式
"r_mode": 0,//出租方式 0 短租合租 1 短租整租 2 長租整租 3 長租合租 4 長短合租 5 長短整租
"h_name": "龍湖時代天街",//房源名
"h_metro": 4,//地鐵線路
"h_site": "中壩",//地鐵站點
"h_area": 50,//房源面積
"h_type": "五室四廳四衛",//戶型
"h_floor": "18樓/18層",//樓層
"h_facilities": [//配套設施
{
}
],
"h_l_rent": 50000,//長租租金
"h_s_rent": null,//短租租金 (設計沒有，備用)
"h_l_p_n": "押三付一",//長租支付方式
"h_s_p_m": [//短租支付方式
{
"rent":10,//租金
"deposit":10,//押金
"day":3//天數
}
],
"create_time": "2017-11-15 09:31:07",//完善時間
"audit": 0,//審核狀態 0 待提交審核 1 提交審核中 2 審核通過 3 審核被拒
"status": 0,//狀態 0 未上架 1 已上架 2 已出租 3 已退房
"room": 0//可租房間數量
}
],
"currentPage": 1,//當前頁
"pageNumber": 10,//頁碼
"count": 1//總條數
}
}
```
* 失敗返回： 其他錯誤信息
## 房源分頁
* 請求地址: `/house_info/pag`
* 請求方式: get
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `currentPage` | int | 11 | `是` | 當前頁 |
| `pageNumber` | int | 11 | `是` | 頁碼 |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": [
{
"id": 1,
"h_video": "",//視頻地址
"h_img": [],//圖片 json 格式
"r_mode": 0,//出租方式 0 短租合租 1 短租整租 2 長租整租 3 長租合租 4 長短合租 5 長短整租
"h_name": "龍湖時代天街",//房源名
"h_metro": 4,//地鐵線路
"h_site": "中壩",//地鐵站點
"h_area": 50,//房源面積
"h_type": "五室四廳四衛",//戶型
"h_floor": "18樓/18層",//樓層
"h_facilities": [//配套設施
{
}
],
"h_l_rent": 50000,//長租租金
"h_s_rent": null,//短租租金 (設計沒有，備用)
"h_l_p_n": "押三付一",//長租支付方式
"h_s_p_m": [//短租支付方式
{
"rent":10,//租金
"deposit":10,//押金
"day":3//天數
}
],
"create_time": "2017-11-15 09:31:07",//完善時間
"audit": 0,//審核狀態 0 待提交審核 1 提交審核中 2 審核通過 3 審核被拒
"status": 0,//狀態 0 未上架 1 已上架 2 已出租 3 已退房
"room": 0//可租房間數量
}
]
}
}
```
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
## 房源搜索(暫時不使用)
* 請求地址: `/house_info/search`
* 請求方式: get
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `search` | string | 2-200 | `是` | 搜索內容 |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": [
{
"id": 1,
"h_video": "",//視頻地址
"h_img": [],//圖片 json 格式
"r_mode": 0,//出租方式 0 短租合租 1 短租整租 2 長租整租 3 長租合租 4 長短合租 5 長短整租
"h_name": "龍湖時代天街",//房源名
"h_metro": 4,//地鐵線路
"h_site": "中壩",//地鐵站點
"h_area": 50,//房源面積
"h_type": "五室四廳四衛",//戶型
"h_floor": "18樓/18層",//樓層
"h_facilities": [//配套設施
{
}
],
"h_l_rent": 50000,//長租租金
"h_s_rent": null,//短租租金 (設計沒有，備用)
"h_l_p_n": "押三付一",//長租支付方式
"h_s_p_m": [//短租支付方式
{
"rent":10,//租金
"deposit":10,//押金
"day":3//天數
}
],
"create_time": "2017-11-15 09:31:07",//完善時間
"audit": 0,//審核狀態 0 待提交審核 1 提交審核中 2 審核通過 3 審核被拒
"status": 0,//狀態 0 未上架 1 已上架 2 已出租 3 已退房
"room": 0//可租房間數量
}
]
}
}
```
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
## 房源修改查詢
* 請求地址: `/house_info/edit`
* 請求方式: get
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": {
"id": 1,
"h_video": "",
"h_img": [],
"r_mode": 4,
"h_name": "龍城高新天地",
"province_id": 1,
"h_province": "四川省",
"city_id": 1,
"h_city": "成都市",
"county_id": 1,
"h_county": "青羊區",
"landmark_id": 1,
"h_landmark": "內光華",
"community_id": 1,
"h_community": "光華中心",
"h_unit": "8棟8單元8號",
"metro_id": 1,
"h_metro": 4,
"site_id": 1,
"h_site": "中壩",
"h_type": "一室零廳零衛",
"h_floor": "8樓/8層",
"h_fitment": "豪華裝修",
"h_sex": 1,
"h_swap": 1,
"h_contract": 1,
"h_is_d_b": 0,
"h_area": 34,
"h_facilities": [
{
"id": 2,
"name": "洗衣機"
}
],
"h_l_rent": 120000,
"h_s_rent": null,
"h_l_p_m": 1,
"h_l_p_n": "押二付一",
"h_s_p_m": [
{
"day": 0,
"rent": 15000,
"deposit": 80000
}
],
"other": "Ft",
"source": 2,
"status": 1,
"h_toward": "",
"guard": [],
"h_is_look": 0
}
}
}
```
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
## 房源修改保存(初步完善房源信息)
* 請求地址: `/house_info/update`
* 請求方式: post
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
| `h_video` | string | 2-160 | 是(選填) | 視頻地址 |
| `h_img` | json | 0 | 是(選填) | 房源圖片 |
| `r_mode` | int | 1-6 | `是` | 出租方式 |
| `h_name` | string | 2-64 | `是` | 房源名 |
| `province_id` | int | 11 | `是` | `是` | `是` | 省id |
| `h_province` | string | 2-16 | `是` | `是` | 省名 |
| `city_id` | int | 11 | `是` | 市id |
| `h_city` | string | 2-16 | `是` | 市名 |
| `county_id` | int | 11 | `是` | 區id |
| `h_county` | string | 2-16 | `是` | 區名 |
| `landmark_id` | int | 11 | `是` | 地標id |
| `h_landmark` | string | 2-32 | `是` | 地標名 |
| `community_id` | int | 11 | `是` | 小區id |
| `h_community` | string | 2-32 | `是` | 小區名 |
| `h_unit` | string | 2-32 | 是(選填) | 所在單元 |
| `metro_id` | int | 11 | 是(選填) | 地鐵線路id |
| `h_metro` | int | 11 | 是(選填) | 地鐵線路名 |
| `site_id` | int | 11 | 是(選填) | 地鐵站點id |
| `h_site` | string | 2-16 | 是(選填) | 地鐵站點名 |
| `h_type` | string | 2-16 | `是` | 戶型 |
| `h_floor` | string | 2-16 | 是(選填) | 樓層 |
| `h_fitment` | string | 2-16 | `是` | 裝修 |
| `h_sex` | int | 1-3 | `是` | 性別限制 |
| `h_swap` | int | 0/1 | `是` | 是否可調換 |
| `h_is_d_b` | int | 0/1 | `是` | 是否需要門禁 |
| `h_area` | int | 11 | `是` | 房源面積 |
| `h_facilities` | json | 0 | `是` | 配套設施 |
| `h_l_rent` | bigint | 20 | 是(選填) | 長租租金 |
| `h_s_rent` | bingint | 20 | 是(選填) | 短租租金 |
| `h_l_p_m` | int | 11 | 是(選填) | 長租支付方式 |
| `h_l_p_n` | string | 2-16 | 是(選填) |長租支付方式名 |
| `h_s_p_m` | json | 0 | 是(選填) | 短租支付方式 |
| `other` | string | 0-255 | 是(選填) | 其他說明 |
| `h_toward` | string | 16 | 是(選填) | 朝向 |
| `guard` | json | 0 | 否 | 門禁人員資料 |
| `is_all_pay` | int | 11 | 否 | 是否全付 |
>[info] 請根據前端的實際情況選擇填寫字段
> 其中 是(選填) 字段可以為空 需要填才填寫
> 是否全付 在長租里面自行判斷填寫 0 全付 1 不全付
* 成功返回:
```json
{
"code": 0
}
```
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
## 第二步完善房源信息查詢
* 請求地址: `/house_info/read`
* 請求方式: get
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
* 成功返回:
```json
{
"code": 0,
"data": {
"id": 1,
"h_p_c_id": null,//物業公司id
"h_p_id": null,//物業人員id
"is_empower": 0,//是否授權開門 0 已授權 1 不授權
"commission": 0,//人員傭金
"property_company": null,//物業公司名
"property": null//物業人員名
}
}
```
## 完善物業提交審核
* 請求地址: `/house_info/property`
* 請求方式: post
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
| `h_p_c_id` | int | 11 | 是 | 物業公司id |
| `h_p_id` | int | 11 | 是 | 物業人員id |
| `is_empower` | int | 4 | 是 | 是否授權開門 |
| `commission` | int | 20 | `是` | 人員傭金 |
* 成功返回:
```json
{
"code": 0
}
```
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
## 獲取文件上傳地址
* 請求地址: `/house_info/getUpdatePath`
* 請求方式: get
* 請求參數:
| 字段名 | 字段類型 | 字段長度 | 必填 | 字段說明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
* 成功返回:
```json
{
"video": {//視頻上傳地址
"oss_id": "",//ossid
"host": "",//上傳地址
"policy": "",//上傳需要的 參數
"signature": "",//上傳需要的 參數
"expire": 0,//上傳時間限制
"dir": "",//上傳文件目錄名
"max_size": ,//上傳文件大小限制
"key": ""//上傳文件的文件名
},
"img": {
"oss_id": "",
"host": "",
"policy": "",
"signature": "",//上傳需要的 參數
"expire": 0,
"dir": "",
"max_size": 0
}
}
```
>[info] 上傳參數
```json
"OSSAccessKeyId": "oss_id",
"policy": "policy",
"Signature": "signature",
"key":"key",
"success_action_status":"201",
"file":"raw file data"
```
>[info] 提交地址為返回參數中的host
>[danger] 注：上傳方式 需要使用表單 `FormData` 格式上傳
>注：返回的上傳參數中若有key，必須使用返回的key，如果沒有，就需要使用返回的 `dir+/filename` 的格式拼接文件名
>注：`filename` 是自己定義的文件名
>注： file字段**必須在最后**，類型根據平臺不同而不同，兼容 `FormData`即可
>注：上傳成功之后會返回一個xml格式的文件，請解析xml文件 。
>注：取出xml文件的 location 當做圖片或者視頻地址 提交到服務器
>注：上傳圖片請自定義文件名
* 失敗返回:
```json
{
"code": -1,
"msg": "參數錯誤!"
}
```
