文档

测试

查找房源

websocket测试

GET

housing

接口描述

获取指定的房源信息。若不提交参数，则返回全部房源的信息。

接口概要

参数名

类型

描述

必填

需要登陆

是

必填

需要登陆为超级管理员

否

必填

请求参数

参数名

类型

描述

必填

filter

String

用于查找的过滤器，下方列出了可用值。

可选

可用值

必填

"address"

String

按地址查找。若选此过滤模式，需另提交请求参数address_building AND/OR address_room的值。参数address_building和address_room之中至少有一个值不得为空。

必填

"company"

String

按公司名称查找。若选此过滤模式，需另提交请求参数company。

必填

"legal_person"

String

按公司法人名字查找。若选此过滤模式，需另提交请求参数legal_person。

必填

若为空

则返回全部房源。

必填

address_building

Integer

目标房源的楼号。

可选

address_room

Integer

目标房源的房间号。

可选

company

String

目标房源的租户的公司名称。用于房源不为空的场景。

可选

legal_person

String

目标房源的租户的法人名字。用于房源不为空的场景。

可选

is_strict

表Bool的Integer

1或0。提交1遵循严格搜索，0进行模糊搜索。

可选

响应参数 (Json)

参数名

类型

描述

必填

status

表Bool的Integer

为1或0。1表获取成功，0表获取失败。

必填

error-diag

String

若status为0则不为空，显示错误类型。若status为1则为空。

必填

error-note

String

进一步解释错误原因。若status为1则为空。

必填

data

Array

若status为1则不为空，为返回的数据，包含所有符合搜索条件的房源条目。若status为0则为空。

必填

单个房源条目

Dict

包含以下。

必填

id

Integer

该房源的唯一编号。用于选择一个房源，进行后续操作。

必填

is_empty

表Bool的Integer

值为1表该房源目前有租户入住，0则表示房源目前为空。

必填

address_building

Integer

该房源所在楼的号码。

必填

address_room

Integer

该房源在楼内的房间号。

必填

company

String

租住该房源的公司名称。若is_empty为0则为空（null或""）。

必填

legal_person

String

租住该房源的公司法人名字。若is_empty为0则为空（null或""）。

必填

响应值示范

``` { "status": 1, "error-diag": "", "error-note": "", "data": [ { "id": 1, "is_empty": 0, "address_building": 12, "address_room": 601, "company": "山东蓝翔", "legal_person": "张三" }, { "id": 2, "is_empty": 0, "address_building": 3, "address_room": 103, "company": "北京新东方", "legal_person": "李四" }, { "id": 3, "is_empty": 1, "address_building": 5, "address_room": 502, "company": null, "legal_person": null } ] } ```

上一篇注册新管理员

nextDoc 选择房源