[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": "参数错误!"
}
```
