[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": "參數錯誤!"
}
```
