# House

**Repository Path**: ChenJef/House

## Basic Information

- **Project Name**: House
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-05-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 接口文档

#####备注：采用Vue前端框架
------

### ->  登陆
1、接口地址：^main/login.$
2、支持格式：json
3、请求方式：post
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|username|是|string|用户名|
|password|是|string|密码|
|captcha|是|string|验证码|

5、返回字段说明：
|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|登陆成功|
|userID|string|唯一用户id|

JSON返回示例：
```
{
  "error_code":"0",//0获取成功，1获取失败
  "result":"登录成功",
  "id":"123456"
}
```
--------

### ->  图形验证码
1、接口地址：^main/captcha.$
2、支持格式：json
3、请求方式：post
4、请求参数：
|名称|必填|类型|说明|
|------|------|------|------|
|captcha|是|string|图形验证码|

--------

### ->  发布房源
1、接口地址：^agent/issuehouse.$
2、支持格式：json
3、请求方式：post
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|title|是|string|标题|
|owner_name|是|string|房东姓名|
|owner_tel|是|int|房东电话|
|address_district|是|int|地址-区|
|address_street|否|int|地址-街道/路：0-梧村街道；1-鹭江街道；2-莲前街道；3-厦港街道；4-禾山街道；5-江头街道；6-金山街道；7-海沧社区；8-海发社区；9-侨英街道；10-集美街道；11-灌口镇；12-大同街道；13-祥平街道；14-大嶝街道；15-马巷镇|
|address_road|否|string|若未选择街道/路，则填写此地址|
|address_buildnumber|是|string|地址-楼栋号（XXX号）|
|address_housenumber|是|string|地址-门牌号（XXX室）|
|address_community|是|string|地址-小区|
|house_type_room|是|int|房间个数|
|house_type_lobby|是|int|大厅个数|
|house_type_toilet|是|int|卫生间个数|
|house_type_balcony|是|int|阳台个数|
|build_storey|是|int|总楼层|
|build_ages|是|int|房屋年代|
|property_area|是|float|产权面积|
|total_price|是|int|售价|
|unit_price|是|int|单价|
|decoration|是|int|装修:0-毛坯；1-简单装修；2-中等装修；3-精装修；4-豪华装修|
|orientation_east|否|bool|朝向-东：1-有此朝向，0-无此朝向|
|orientation_south|否|bool|朝向-南：1-有此朝向，0-无此朝向|
|orientation_west|否|bool|朝向-西：1-有此朝向，0-无此朝向|
|orientation_north|否|bool|朝向-北：1-有此朝向，0-无此朝向|
|elevator|是|bool|是否有电梯：1-有，0-没有|
|describe|是|string|房屋描述|

5.返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|发布成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"发布成功",
}
```

------
### ->  上传图片

1、接口地址：^function/upload_pictures.$
2、支持格式：file
3、请求方式：post
4、返回字段说明：
|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|图片上传成功|


------

### ->  我的发布
1、接口地址：^agent/myhouse.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|说明|
|------|------|
|userID|用户名|
|page|页码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|house.title|string|标题|
|house.owner_name|string|房东姓名|
|house.owner_tel|int|房东电话|
|house.address_district|int|地址-区|
|house.address_street|int|地址-街道/路：0-梧村街道；1-鹭江街道；2-莲前街道；3-厦港街道；4-禾山街道；5-江头街道；6-金山街道；7-海沧社区；8-海发社区；9-侨英街道；10-集美街道；11-灌口镇；12-大同街道；13-祥平街道；14-大嶝街道；15-马巷镇|
|house.address_road|string|若未选择街道/路，则填写此地址|
|house.address_buildnumber|string|地址-楼栋号（XXX号）|
|house.address_housenumber|string|地址-门牌号（XXX室）|
|house.address_communit|string|地址-小区|
|house.house_type_room|int|房间个数|
|house.house_type_lobby|int|大厅个数|
|house.house_type_toilet|int|卫生间个数|
|house.house_type_balcony|int|阳台个数|
|house.build_storey|int|总楼层|
|house.build_ages|int|房屋年代|
|house.property_area|float|产权面积|
|house.total_price|int|售价|
|house.unit_price|int|单价|
|house.decoration|int|装修:0-毛坯；1-简单装修；2-中等装修；3-精装修；4-豪华装修|
|house.orientation_east|bool|朝向-东：1-有此朝向，0-无此朝向|
|house.orientation_south|bool|朝向-南：1-有此朝向，0-无此朝向|
|house.orientation_west|bool|朝向-西：1-有此朝向，0-无此朝向|
|house.orientation_north|bool|朝向-北：1-有此朝向，0-无此朝向|
|house.elevator|bool|是否有电梯：1-有，0-没有|
|house.describe|string|房屋描述|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败，
    "house":[
        "title":"滨北国际 市政府旁 08年带 双露台 图片真实 豪宅",
        "owner_name":"张三",//姓名
        "owner_tel":"138 0000 0000",//电话
        "address_district":"0",//思明区
        "address_street":"0",//梧村街道
        "address_road":"厦禾路",
        "address_buildnumber":"2",//2号楼
        "address_housenumber":"302",//302室
        "address_community":"金榜大厦",//小区名
        "house_type_room":"3",//3房
        "house_type_lobby":"2",//2厅
        "house_type_toilet":"2",//2卫
        "house_type_balcony":"2",//2阳台
        "build_storey":"30",//总楼层 30层
        "build_ages":"2008",//2008年建成
        "property_area":"120.16",//产权面积120.16平
        "total_price":"650",//售价650万
        "unit_price":"54094",//单价（保留整数）
        "decoration":"3",//精装修
        "orientation_east":"0",//不朝东
        "orientation_south":"1",//朝南
        "orientation_west":"0",//不朝西
        "orientation_north":"1",//朝北
        "elevator":"1",//有电梯
        "describe":"1、户型佳，楼层好，采光没影响，性价比超高
                    2、采光佳，窗外无遮挡建筑物，充分享受阳光
                    3、房东诚心出售，欢迎随时来电话"
                    //房屋描述
    ]
}
```

-------

### ->  添加经纪人
1、接口地址：^manager/add_agent.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|username|是|string|用户名|
|sex|是|bool|性别|
|phone|是|int|电话号码|
|id|是|string|身份证号|
|email|否|string|电子邮箱|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|注册成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"注册成功",
}
```
--------

### ->  查看经纪人
1、接口地址：^manager/check_agent.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|说明|
|------|------|
|page|页码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|user_list.username|string|用户名|
|user_list.sex|bool|性别|
|user_list.phone|int|电话号码|
|user_list.id|string|身份证号|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "user_list":[
        {
            "uesrname":"用户名1",
            "sex":"性别",
            "phone":"电话号码",
            "id":"身份证号码"
        },
        {
            "uesrname":"用户名2",
            "sex":"性别",
            "phone":"电话号码",
            "id":"身份证号码"
        },{
            "uesrname":"用户名3",
            "sex":"性别",
            "phone":"电话号码",
            "id":"身份证号码"
        }
    ]
}
```
--------

### ->  修改经纪人信息
1、接口地址：^manager/change_agent.$
2、支持格式：json
3、请求方式：post
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|facepicture|否|jpg|头像|
|username|是|string|姓名|
|sex|是|bool|性别|
|phone|是|int|联系电话|
|email|是|string|电子邮箱|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|修改成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"修改成功",
}
```
--------

### ->  录入客户
1、接口地址：^agent/input_client.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|agentname|是|string|用户名|
|agentphone|是|int|电话号码|
|agentsex|是|bool|性别|
|notes|是|text|备注信息|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|录入成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"录入成功",
}
```
--------

### ->  我的客户
1、接口地址：^agent/mycustomer.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|page|是|int|页码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|customer_list.agentname|是|string|用户名|
|customer_list.agentphone|是|int|电话号码|
|customer_list.agentsex|是|bool|性别|
|customer_list.notes|是|string|备注信息|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "customer_list":[
        {
            "customername":"客户姓名",
            "customerphone":"电话",
            "customersex":"性别",
            "notes":"备注信息"
        },
        {
            "customername":"客户姓名",
            "customerphone":"电话",
            "customersex":"性别",
            "notes":"备注信息"
        },{
            "customername":"客户姓名",
            "customerphone":"电话",
            "customersex":"性别",
            "notes":"备注信息"
        }
    ]
}
```
--------

### ->  查看房源
1、接口地址：^manager/check_house.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|说明|
|------|------|
|userID|用户名|
|page|页码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|house.title|string|标题|
|house.owner_name|string|房东姓名|
|house.owner_tel|int|房东电话|
|house.address_district|int|地址-区|
|house.address_street|int|地址-街道/路：0-梧村街道；1-鹭江街道；2-莲前街道；3-厦港街道；4-禾山街道；5-江头街道；6-金山街道；7-海沧社区；8-海发社区；9-侨英街道；10-集美街道；11-灌口镇；12-大同街道；13-祥平街道；14-大嶝街道；15-马巷镇|
|house.address_road|string|若未选择街道/路，则填写此地址|
|house.address_buildnumber|string|地址-楼栋号（XXX号）|
|house.address_housenumber|string|地址-门牌号（XXX室）|
|house.address_communit|string|地址-小区|
|house.house_type_room|int|房间个数|
|house.house_type_lobby|int|大厅个数|
|house.house_type_toilet|int|卫生间个数|
|house.house_type_balcony|int|阳台个数|
|house.build_storey|int|总楼层|
|house.build_ages|int|房屋年代|
|house.property_area|float|产权面积|
|house.total_price|int|售价|
|house.unit_price|int|单价|
|house.decoration|int|装修:0-毛坯；1-简单装修；2-中等装修；3-精装修；4-豪华装修|
|house.orientation_east|bool|朝向-东：1-有此朝向，0-无此朝向|
|house.orientation_south|bool|朝向-南：1-有此朝向，0-无此朝向|
|house.orientation_west|bool|朝向-西：1-有此朝向，0-无此朝向|
|house.orientation_north|bool|朝向-北：1-有此朝向，0-无此朝向|
|house.elevator|bool|是否有电梯：1-有，0-没有|
|house.describe|string|房屋描述|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败，
    "house":[
        "title":"滨北国际 市政府旁 08年带 双露台 图片真实 豪宅",
        "owner_name":"张三",//姓名
        "owner_tel":"138 0000 0000",//电话
        "address_district":"0",//思明区
        "address_street":"0",//梧村街道
        "address_road":"厦禾路",
        "address_buildnumber":"2",//2号楼
        "address_housenumber":"302",//302室
        "address_community":"金榜大厦",//小区名
        "house_type_room":"3",//3房
        "house_type_lobby":"2",//2厅
        "house_type_toilet":"2",//2卫
        "house_type_balcony":"2",//2阳台
        "build_storey":"30",//总楼层 30层
        "build_ages":"2008",//2008年建成
        "property_area":"120.16",//产权面积120.16平
        "total_price":"650",//售价650万
        "unit_price":"54094",//单价（保留整数）
        "decoration":"3",//精装修
        "orientation_east":"0",//不朝东
        "orientation_south":"1",//朝南
        "orientation_west":"0",//不朝西
        "orientation_north":"1",//朝北
        "elevator":"1",//有电梯
        "describe":"1、户型佳，楼层好，采光没影响，性价比超高
                    2、采光佳，窗外无遮挡建筑物，充分享受阳光
                    3、房东诚心出售，欢迎随时来电话"
                    //房屋描述
    ]
}
```

-------

### ->  添加订单
1、接口地址：^manager/add_indent.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|username|string|用户名|
|address_communit|string|地址-小区|
|address_buildnumber|string|地址-楼栋号（XXX号）|
|address_housenumber|string|地址-门牌号（XXX室）|
|house_type_room|int|房间个数|
|house_type_lobby|int|大厅个数|
|house_type_toilet|int|卫生间个数|
|house_type_balcony|int|阳台个数|
|value|int|成交金额|
|area|int|产权面积|
|date|string|成交日期|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|订单提交成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "indent":"订单提交成功",
}
```
--------

### ->  查看订单情况
1、接口地址：^manager/check_indent.$
2、支持格式：json
3、请求方式：get
4、请求参数：

|名称|说明|
|------|------|
|page|页码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|indent.username|string|经纪人|
|indent.address_communit|string|地址-小区|
|indent.address_buildnumber|string|地址-楼栋号（XXX号）|
|indent.address_housenumber|string|地址-门牌号（XXX室）|
|indent.house_type_room|int|房间个数|
|indent.house_type_lobby|int|大厅个数|
|indent.house_type_toilet|int|卫生间个数|
|indent.house_type_balcony|int|阳台个数|
|indent.value|int|成交金额|
|indent.area|int|产权面积|
|indent.date|string|成交日期|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":[
        "username":"经纪人",
        "address_communit":"地址-小区",
        "address_buildnumber":"地址-楼栋号（XXX号）",
        "address_housenumber":"地址-门牌号（XXX室）",
        "house_type_room":"房间个数",
        "house_type_lobby":"大厅个数",
        "house_type_toilet":"卫生间个数",
        "house_type_balcony":"阳台个数",
        "value":"成交金额",
        "area":"产权面积",
        "date":"成交日期"
    ]
}
```
-------

### ->  修改管理员密码
1、接口地址：^manager/change_password.$
2、支持格式：json
3、请求方式：post
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|oldpassword|是|string|旧密码|
|newpassword_1|是|string|新密码|
|newpassword_2|是|string|确认密码|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|密码修改成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"密码修改成功",
}
```
-------

### ->  忘记密码（经纪人）
1、接口地址：^main/forget_password.$
2、支持格式：json
3、请求方式：post
4、请求参数：

|名称|必填|类型|说明|
|------|------|------|------|
|phone|是|int|电话号码|
|email|是|string|电子邮箱|

5、返回字段说明：

|名称|类型|说明|
|------|------|------|
|error_code|int|返回码|
|result|string|提交成功|

JSON返回示例：
```
{
    "error_code":"0",//0获取成功，1获取失败
    "result":"提交成功",
}
```
-------