[TOC]
## 获取市下面地标和小区
* 请求地址: `/getAllRegions`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `city` | string | 2-16 | `是` | 市名 |
| `mode` | int | 11 | `是` | 租房方式 |
>[info] 租房方式 0 短租合租 1 短租整租 2 长租整租 3 长租合租
* 成功返回:
```json
{
"code": 0,
"msg": [
{
"id": 1,
"name": "青羊区",//区名
"city_id": 1,//市id
"landmark": [//地标信息
{
"id": 2,
"name": "外光华",//地标名
"longitude": "103.984479",//地标经度
"latitude": "30.651085",//地标纬度
"community": []//小区信息
},
{
"id": 1,
"name": "内光华",
"longitude": "103.977147",
"latitude": "30.674078",
"community": [
{
"id": 1,
"name": "光华中心",//小区名
"longitude": "103.970194",//小区经度
"latitude": "30.675829",//小区纬度
"house_num": 4//可租房源数量
}
]
}
]
},
{
"id": 2,
"name": "锦江区",
"city_id": 1,
"landmark": []
}
]
}
```
* 失败返回:其他错误信息
## 获取省
* 请求地址: `/getProvince`
* 请求方式: get
* 请求参数:无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "四川省"//省名
}
]
}
```
* 失败返回:其他错误信息
## 获取所有城市
* 请求地址: `/getCityAll`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "成都市"
}
]
}
```
>[success] 返回的数据都按照省名字母排好序的
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取市
* 请求地址: `/getCity`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 省id |
* 成功返回:
```json
{
"code": 0,
"data":
[
{
"id": 1,
"name": "成都市",//市名
"province_id": 1//省id
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取区
* 请求地址: `/getCounty`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 市id |
* 成功返回:
```json
{
"code": 0,
"data":
[
{
"id": 1,
"name": "青羊区",//区名
"city_id": 1//市id
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取地标
* 请求地址: `/getLandmark`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 区/县id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 2,
"name": "外光华",//地标名
"county_id": 1//区id
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取小区
* 请求地址: `/getCommunity`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 区/县id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "",//小区名
"county_id": 1//区id
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取门店
* 请求地址: `/getStore`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"title": "内光华门店"//门店名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取销售
* 请求地址: `/getSale`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 门店id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 3,
"name": " "//销售名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取配套设施
* 请求地址: `/getFacility`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "电视机"//设施名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取当前城市的地铁线路和站点
* 请求地址: `/getMetroAll`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 市id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": 4,//线路名
"site": [
{
"id": 1,
"name": "中坝"//站点名
}
]
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取地铁线路
* 请求地址: `/getMetro`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 市id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": 4//地铁线路名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取地铁站点
* 请求地址: `/getMetroSite`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 线路id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "中坝"//站点名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取支付方式
* 请求地址: `/getPaymentMethod`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "押一付三"//支付方式名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取物业公司
* 请求地址: `/getPropertyCompany`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 2,
"name": ""//物业公司名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取物业人员
* 请求地址: `/getProperty`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 物业公司id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 3,
"name": ""//物业人员名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取地标详情
* 请求地址: `/getLandmarkDetail`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 区/县id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "内光华",//地标名
"county_id": 1,//区id
"longitude": "103.977147",//经度
"latitude": "30.674078"//纬度
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取小区详情
* 请求地址: `/getCommunityDetail`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 区/县id |
| `mode` | int | 0,1,2,3 | `是` | 租房方式 |
>[info] 租房方式 0 短租合租 1 短租整租 2 长租整租 3 长租合租
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "光华中心",//小区名
"county_id": 1,//区id
"longitude": "103.970194",//经度
"latitude": "30.675829",//纬度
"house_num": 0//房源数量
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取地铁站点详情
* 请求地址: `/getMetroSite`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | 线路id |
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": "中坝",//站点名
"house_num": 0//房源数量
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取租金区间
* 请求地址: `/getRent`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": ""//区间名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取面积区间
* 请求地址: `/getArea`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": ""//面积区间名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取房源户型
* 请求地址: `/getType`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"name": ""//户型名
}
]
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取生活缴费项
* 请求地址: `/getLifePay`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": [
{
"id": 1,
"c_name": "水费",//缴费中文名
"e_name": "water_fee_icon",//缴费英文名
"min_sum": 1000//最低缴费金额
}
]
}
```
>[info] 缴费中文名和英文名都不会变
>中文名用于前端显示
>英文名用来搜索对应的图标
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 获取长租周期和支付方式
* 请求地址: `/getMonth`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": {
"month": [
{
"month": 3//月数
}
],
"pay": [
{
"id": 1,
"name": "押一付三"//支付方式名
}
]
}
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
