锁操作能力

本文介绍锁操作能力相关API

API列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards	门锁卡片信息操作：下发卡片(使用发卡器制卡生成的卡片唯一标识，对门锁进行门卡通行方式指令下发操作，从而达到使用指定门卡通行门锁的操作。)
DELETE	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}	门锁卡片信息操作：删除卡片(使用门锁卡片唯一标识对锁下发删除卡片指令，使该该门卡对门锁通行方式失效)
PUT	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}/freeze-status	门锁卡片信息操作：卡片状态修改(使用门锁卡片唯一标识对指定门锁对应卡片状态进行修改，支持冻结和解冻两种操作。)
PUT	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}	门锁卡片信息操作：卡片修改(通过生效时间和失效时间对指定门锁下发通行卡片的授权时间修改指令，在无需使用发卡器重新制卡的情况下，对门卡通行时间修改。)
GET	/v1.0/cloud/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}	门锁卡片信息操作：卡片查询(使用门锁卡片唯一标识查询指定门锁对应的卡片信息)

门锁卡片信息操作：下发卡片

本文介绍下发卡片的 API。

接口描述

使用发卡器制卡生成的卡片唯一标识，对门锁进行门卡通行方式指令下发操作，从而可使用指定门卡来通行门锁。

接口地址

POST: /v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
request	LockCardIssueRequest		false	请求

request 说明

参数名	类型	参数位置	是否必填	说明
card_id	String		true	卡片唯一标识

返回参数

参数名	类型	说明
result	LockCardOperateResponse	门锁卡片返回消息体

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果
lock_card_id	String	门锁卡片唯一标识

请求示例

POST: /v1.0/osaas/projects/150188910571223***/card-issue-devices/lock-devices/6c470253258246b99*****/cards

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e****",
    "result": {
        "lock_card_id": "3245***",
        "operate_id": "1552534592777359***",
        "operate_result": true
    },
    "t": 1658988066464,
    "success": true
}

门锁卡片信息操作：卡片修改

本文介绍修改卡片的 API。

接口描述

通过生效时间和失效时间，对指定门锁下发通行卡片的授权时间修改指令。无需使用发卡器重新制卡，修改门卡通行时间。

接口地址

PUT: /v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
lock_card_id	String	uri	true	门锁卡片唯一标识
request	LockCardUpdateRequest		false	请求

request 说明

参数名	类型	参数位置	是否必填	说明
begin_time	Long		false	卡片生效时间
end_time	Long		false	卡片失效时间

返回参数

参数名	类型	说明
result	LockCardOperateResponse	门锁卡片唯一标识

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果
lock_card_id	String	门锁卡片唯一标识

请求示例

PUT: /v1.0/osaas/projects/15018891057122****/card-issue-devices/lock-devices/6c470253258246b99****/cards/3245***

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e****",
    "result": {
        "lock_card_id": "3245***",
        "operate_id": "3245***",
        "operate_result": true
    },
    "t": 1658988066464,
    "success": true
}

门锁卡片信息操作：删除卡片

本文介绍删除卡片的 API。

接口描述

根据门锁卡片唯一标识，对锁下发删除卡片指令，使该卡片对门锁通行方式失效。

接口地址

DELETE: /v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
lock_card_id	String	uri	true	门锁卡片唯一标识

返回参数

参数名	类型	说明
result	LockCardOperateResponse	门锁卡片返回消息体

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果
lock_card_id	String	门锁卡片唯一标识

请求示例

DELETE: /v1.0/osaas/projects/150188910571223***/card-issue-devices/lock-devices/6c470253258246b99*****/cards/3245***

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e****",
    "result": {
        "lock_card_id": "3245***",
        "operate_id": "1552534592777359***",
        "operate_result": true
    },
    "t": 1658988066464,
    "success": true
}

门锁卡片信息操作：卡片状态修改

本文介绍修改卡片状态的 API。

接口描述

根据门锁卡片唯一标识，对指定门锁对应卡片状态进行修改，支持冻结和解冻两种操作。

接口地址

PUT: /v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}/freeze-status

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
lock_card_id	String	uri	true	门锁卡片唯一标识
request	LockCardFreezeRequest		false	请求修改卡片状态

request 说明

参数名	类型	参数位置	是否必填	说明
freeze_status	LockFreezeStatusEnum		true	卡片操作状态。 0：冻结 1：解冻

返回参数

参数名	类型	说明
result	LockCardOperateResponse	门锁卡片操作结果

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果
lock_card_id	String	门锁卡片唯一标识

请求示例

PUT: /v1.0/osaas/projects/150188910571223***/card-issue-devices/lock-devices/6c470253258246b99***/cards/3245***/freeze-status

{
  "freeze_status": 1
}

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e***",
    "result": {
        "lock_card_id": "3245***",
        "operate_id": "1552534592777359***",
        "operate_result": true
    },
    "t": 1658988066464,
    "success": true
}

门锁卡片信息操作：卡片查询

本文介绍查询卡片信息的 API。

接口描述

根据门锁卡片唯一标识，对指定门锁对应卡片信息进行查询，返回卡片有效期等信息。

接口地址

GET:/v1.0/cloud/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
lock_card_id	String	uri	true	门锁卡片唯一标识

返回参数

参数名	类型	说明
result	LockCardInfoResponse	门锁卡片查询结果

result 说明

参数名	类型	说明
lock_card_id	String	门锁卡片唯一标识
begin_time	Long	卡片生效时间
end_time	Long	卡片失效时间

请求示例

GET:/v1.0/cloud/osaas/projects/150188910571223***/card-issue-devices/lock-devices/6c470253258246b99***/cards/3245***

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e***",
    "result": {
        "lock_card_id": "3245***",
        "begin_time": 1750226997548,
        "end_time": 1750227997548
    },
    "t": 1658988066464,
    "success": true
}