Device Management

Last Updated on : 2025-05-30 01:56:03download

This article mainly introduces the card issuer and door lock query related API.

API List

Request method	API	Description
GET	/v1.0/osaas/projects/{project_id}/card-issue-devices	Obtain the list of locks & card issuers devices under the project (obtain the device information of specific device types such as locks and card issuers under the project through the unique ID of the project)
GET	/v1.0/osaas/rooms/{room_id}/card-issue-devices	Obtain the list of locks & card issuers under the room (obtain the list of specific device types such as locks and card issuers through the unique ID of the room)

Querying the Device List of a Project

This article introduces the API to get the list of devices under the project.

API Description

According to the unique id of the project, obtain the device information of specific device types such as the lock and card issuer of the project.

API Address

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

Request Parameters

Parameter	Type	Position	Mandatory	Description
project_id	String	uri	true	Unique ID of the project
request	LockCardDevicePageRequest		false	Request to get the list of devices under the project

request description

Parameter	Type	Mandatory	Description
page_no	Integer	false	Page number. The default value is 1
page_size	Integer	false	Number of records on a page, which is greater than 0 and less than 100. If this parameter is not set, the number is 20 by default
device_type	String	true	Product type `FKQ`：Card issuer `CARD_LOCK`：Door lock

Response Parameters

Parameter	Type	Description
result	DeviceAbilityPageResponse	Return result of device list

result description

Parameter	Type	Description
devices	List	Device list
total	Integer	Total number of records
page_no	Integer	Page number
page_size	Integer	Number of records on a page

devices description

Parameter	Type	Description
device_id	String	Device unique ID
product_id	String	Product unique ID
device_custom_name	String	Device custom name
active_time	Long	Activation time, 13-digit timestamp
gmt_create	Long	Creation time, 13-digit timestamp
online	Boolean	Online status
room_id	String	Unique ID of the room
project_id	String	Unique ID of the project

Request Example

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

Response Example

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

Querying the Device List of a Room

This article introduces the API to get the list of devices under the room.