设备管理

本文主要介绍发卡器和卡片锁设备查询相关API

API列表

请求方式	API	描述
GET	/v1.0/osaas/projects/{project_id}/card-issue-devices	获取项目下的锁&发卡器设备分页列表(通过项目唯一标识获取该项目下锁和发卡器等特定设备类型的设备信息)
GET	/v1.0/osaas/rooms/{room_id}/card-issue-devices	获取房屋下的锁&发卡器设备分页列表(通过房屋唯一标识获取锁和发卡器等特定设备类型的设备列表)

获取项目下设备分页列表

本文介绍获取项目下设备分页列表的 API。

接口描述

根据项目唯一标识，获取该项目下锁和发卡器等特定设备类型的设备信息。

接口地址

GET: /v1.0/osaas/projects/{project_id}/card-issue-devices

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识。
request	LockCardDevicePageRequest		false	请求获取项目下设备分页列表。

request 说明

参数名	类型	参数位置	是否必填	说明
page_no	Integer		false	页码。页码须大于 0，默认为 1。
page_size	Integer		false	分页页面大小。0 < page_size < 1000，默认为 20。
device_type	String		true	产品类型。 FKQ：发卡器 CARD_LOCK：卡密锁

返回参数

参数名	类型	说明
result	DeviceAbilityPageResponse	设备分页列表返回结果。

result 说明

参数名	类型	说明
devices	List	设备列表。
total	Integer	总条数。
page_no	Integer	页码。
page_size	Integer	分页页面大小。

devices 说明

参数名	类型	说明
device_id	String	设备唯一标识。
product_id	String	产品唯一标识。
device_custom_name	String	设备自定义名称。
active_time	Long	激活时间，13 位时间戳。
gmt_create	Long	创建时间，13 位时间戳。
online	Boolean	在线状态。
room_id	String	房屋唯一标识。
project_id	String	项目唯一标识。

请求示例

GET: /v1.0/osaas/projects/150188910571223***/card-issue-devices

返回示例

{
    "tid": "bc9997990e3d11ed8a61ba62b***",
    "result": {
        "devices": [
            {
                "gmt_create": 1658454190642,
                "room_id": "15492738413169***",
                "device_id": "6c470253258246b9***",
                "project_id": "150188910571***",
                "product_id": "esddz***",
                "device_custom_name": "酒店门锁(zigbee)_1",
                "online": true,
                "position": "主卧"
            }
        ],
        "page_no": 1,
        "total": 2,
        "page_size": 20
    },
    "t": 1658989384437,
    "success": true
}

获取房屋下设备分页列表

本文介绍获取房屋下设备分页列表的 API。

接口描述

根据房屋唯一标识，获取锁和发卡器等特定设备类型的设备列表。

接口地址

GET: /v1.0/osaas/rooms/{room_id}/card-issue-devices

请求参数

参数名	类型	参数位置	是否必填	说明
room_id	String	uri	true	房屋唯一标识。
request	LockCardDevicePageRequest		false	请求获取房屋下设备分页列表。

request 说明

参数名	类型	参数位置	是否必填	说明
page_no	Integer		false	页码。页码须大于 0，默认为 1。
page_size	Integer		false	分页页面大小。0 < page_size < 1000，默认为 20。
device_type	String		true	产品类型。 FKQ：发卡器 CARD_LOCK：卡密锁

返回参数

参数名	类型	说明
result	DeviceAbilityPageResponse	设备分页列表返回结果。

result 说明

参数名	类型	说明
devices	List	设备列表。
total	Integer	总条数。
page_no	Integer	页码。
page_size	Integer	分页页面大小。

devices 说明

参数名	类型	说明
device_id	String	设备唯一标识。
product_id	String	产品唯一标识。
device_custom_name	String	设备自定义名称。
active_time	Long	激活时间，13 位时间戳。
gmt_create	Long	创建时间，13 位时间戳。
online	Boolean	在线状态。
room_id	String	房屋唯一标识。
project_id	String	项目唯一标识。

请求示例

GET: /v1.0/osaas/rooms/150188910571223***/card-issue-devices

返回示例

{
    "tid": "bc9997990e3d11ed8a61ba62b***",
    "result": {
        "devices": [
            {
                "gmt_create": 1658454190642,
                "room_id": "15492738413169***",
                "device_id": "6c470253258246b9***",
                "project_id": "150188910571***",
                "product_id": "esddz***",
                "device_custom_name": "酒店门锁(zigbee)_1",
                "online": true,
                "position": "主卧"
            }
        ],
        "page_no": 1,
        "total": 2,
        "page_size": 20
    },
    "t": 1658989384437,
    "success": true
}