房屋管理

房屋作为安装设备的最小单元结构，设备联动的最大范围。

API 列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/room	创建房屋
PUT	/v1.0/osaas/rooms/{room_id}/ownership	修改房屋所有权
GET	/v1.0/osaas/projects/{project_id}/rooms	分页查询房屋列表
GET	/v1.0/osaas/rooms/{room_id}	获取房屋详情
PUT	/v1.0/osaas/rooms/{room_id}	修改房屋
DELETE	/v1.0/osaas/rooms/{room_id}	删除房屋
GET	/v1.0/osaas/rooms/{room_id}/construction/status	查询房屋施工状态
GET	/v1.0/osaas/projects/{project_id}/spaces	分页查询房间列表（含公区）

创建房屋

接口描述

调用该接口创建房屋

接口地址

POST /v1.0/osaas/projects/{project_id}/room

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
space_id	String	BODY	空间唯一标识，房屋可以挂在任意空间下，可选	否
room_name	String	BODY	房屋名称(最大64个字符)	是
room_no	String	BODY	房屋编码(最大32个字符)	是
telephone	String	BODY	联系电话(最大20个字符)	否
description	String	BODY	房屋描述(最大255个字符)	否
uid	String	BODY	可指定C端用户唯一标识，为C端用户创建房屋使用	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	房屋唯一标识

请求示例

POST {url}/v1.0/osaas/projects/1160823965053******/room

{
  "room_no": "101",
  "room_name": "***房屋",
  "space_id": "116082396505312xxxxx"
}

响应成功示例

{
  "success": true,
  "result": "1112382396505******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改房屋所有权

接口描述

调用该接口修改房屋所有权

接口地址

PUT /v1.0/osaas/rooms/{room_id}/ownership

请求参数

参数名	类型	参数类型	说明	是否必需
room_id	String	URI	房屋唯一标识	是
uid	String	BODY	C端目标用户唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

PUT {url}/v1.0/osaas/rooms/128091******/ownership

{
  "uid": "C端目标用户唯一标识"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询房屋列表

接口描述

调用该接口分页查询房屋列表

接口地址

GET /v1.0/osaas/projects/{project_id}/rooms

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
page_no	Integer	URL	页码(page_no>0)(默认为1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认为20)	否
room_ids	String[]	URL	房屋唯一标识列表，最多支持100个	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
rooms	Array	房间集合

rooms参数说明

参数名	类型	说明
room_id	String	房屋唯一标识
room_name	String	房屋名称
room_no	String	房号
telephone	String	电话
construction_status	String	房屋施工状态 UNAUTHORIZED:未授权 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
gmt_create	Long	创建时间，13 位时间戳
gmt_modified	Long	修改时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/projects/1160823965053******/rooms

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 10,
    "rooms": [
      {
        "room_id": "116082396505314xxxxx",
        "room_name": "xx 房间",
        "room_no": "1001",
        "description": "房间描述",
        "construction_status": "UNAUTHORIZED",
        "gmt_create": 1559707046000,
        "gmt_modified": 1559707046000
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取房屋详情

接口描述

调用该获取房屋详情

接口地址

GET /v1.0/osaas/rooms/{room_id}

请求参数

参数名	类型	参数类型	说明	是否必需
room_id	String	URI	房屋唯一标识	true

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
room_id	String	房屋唯一标识
room_name	String	房屋名称
room_no	String	房号
telephone	String	电话
construction_status	String	房屋施工状态 UNAUTHORIZED:未授权 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
gmt_create	Long	创建时间，13 位时间戳
gmt_modified	Long	修改时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/rooms/1160823965053******

响应成功示例

{
  "result": {
    "room_id": "1160823965053******",
    "project_id": "11239994446505******",
    "room_name": "Test 房间",
    "room_no": "1001",
    "description": "房间描述",
    "construction_status": "UNAUTHORIZED",
    "gmt_create": 1559707046000,
    "gmt_modified": 1559707046000
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改房屋

接口描述

调用该接口修改房屋

接口地址

PUT /v1.0/osaas/rooms/{room_id}

请求参数

参数名	类型	参数类型	说明	是否必需
room_id	String	URI	房屋唯一标识	是
room_name	String	BODY	房屋名称(最大64个字符)	否
room_no	String	BODY	房屋编码(最大32个字符)	否
telephone	String	BODY	联系电话(最大20个字符)	否
description	String	BODY	房屋描述(最大255个字符)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

PUT {url}/v1.0/osaas/rooms/1160823965053****

{
    "room_no": "101",
    "room_name": "xx 房子"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除房屋

接口描述

调用该接口删除房屋

接口地址

DELETE /v1.0/osaas/rooms/{room_id}

请求参数

参数名	类型	参数类型	说明	是否必需
room_id	String	URI	房屋唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/rooms/1160823965053******

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

查询房屋施工状态

接口描述

调用该接口查询房屋施工状态

接口地址

GET /v1.0/osaas/rooms/{room_id}/construction/status

请求参数

参数名	类型	参数类型	说明	是否必需
room_id	String	URI	房屋唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	房屋施工状态 UNAUTHORIZED:未授权 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成

请求示例

GET {url}/v1.0/osaas/rooms/116082396505314xxxxx/construction/status

响应成功示例

{
  "success": true,
  "result": "UNAUTHORIZED",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询房屋列表（含公区）

接口描述

调用该接口分页查询房屋列表

接口地址

GET /v1.0/osaas/projects/{project_id}/spaces

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
page_no	Integer	URL	页码(page_no>0)(默认为1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认为20)	否
parent_space_id	String	URL	父级空间id(不传默认为查询该项目下第一级空间)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
spaces	Array	房间集合

spaces参数说明

参数名	类型	说明
space_id	String	房屋唯一标识
space_name	String	房屋名称
space_type	String	房间类型
sort	Integer	种类
gmt_create	Long	创建时间，13 位时间戳
gmt_modified	Long	修改时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/projects/1160823965053******/spaces

响应成功示例

{
    "result": {
        "page_no": 1,
        "page_size": 10,
        "spaces": [
            {
                "gmt_create": 1640524576555,
                "gmt_modified": 1677054428432,
                "sort": 1,
                "space_id": "147******928",
                "space_name": "Fit Test",
                "space_type": "PARK"
            }
        ],
        "total": 1
    },
    "success": true,
    "t": 1701079655521,
    "tid": "c977256*****e0b6121b90"
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误