1.4.7.2.1. 远程开门
远程开门，只有启用并且在线的支持门禁功能的设备才能远程开门。调用该接口，将直接打开门，请调用方妥善校验好操作权限，防止误操作。
Request:
POST /v1.0/device/openDoor
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"sn": "33998400021314",
"doorNum": 1,
"delayTime": 5,
"employeeNo": "2596"
}
}
}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sn | String | Y | 设备序列号 |
| doorNum | Integer | N | 门编号，取值范围，1～4。当门编号为空或不传，则默认开启编号为1的门 |
| delayTime | Integer | N | 开门时长，单位秒。取值范围 1~254，默认值为 门参数说明的 "锁驱动时长"，若"锁驱动时长"为空，则默认值为 5 |
| employeeNo | String | N | 操作者编号。建议该字段传人员编号或者有辨识度的管理员代号，同时建议传送该字段；该操作者编号将在开门后的门禁记录中携带返回，以便做后续操作记录追踪。 |
Response：
{
"code": "00000000",
"mid": "xxx",
"message": "success"
}
1.4.7.2.2. 修改门信息
修改设备下的门信息
Request:
POST /v1.0/device/door/update
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"sn": "33998400021314",
"doorNum": 1,
"doorName": "门名称",
"enable": 1,
"address": 1
}
}
}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sn | String | Y | 设备序列号 |
| doorNum | Integer | Y | 门编号，取值范围，1～4 |
| doorName | String | Y | 门名称 |
| enable | Integer | N | 启用状态，0:停用，1:启用，为空时默认等于1 |
| address | String | N | 硬件设备的门锁继电器的编号，为空时默认与doorNum一致 |
Response：
{
"code": "00000000",
"mid": "xxx",
"message": "success"
}
1.4.7.2.3. 查询门信息
查询设备下的门信息。在接收到门初始化推送后调用该接口以获取设备关联的门信息。
Request:
POST /v1.0/device/door/query
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"sn": "33998400021314",
"doorNum": 1
}
}
}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sn | String | Y | 设备序列号 |
| doorNum | Integer | N | 门编号，当为空时，默认查询指定设备下的门列表信息 |
Response：
{
"code": "00000000",
"mid": "xxx",
"message": "success",
"payload": {
"results": [{
"sn": "33998400021314",
"doorNum": 1,
"doorName": "门名称",
"enable": 1,
"address": 1
}]
}
}
| 参数名 | 类型 | 描述 |
|---|---|---|
| sn | String | 设备序列号 |
| doorNum | Integer | 门编号，默认1-4 |
| doorName | String | 门名称 |
| enable | Integer | 启用状态，0：停用，1：启用 |
| address | Integer | 硬件设备的门锁继电器的编号, 范围:1-4 |
1.4.7.2.4. 修改门参数
修改设备下的门参数
Request:
POST /v1.0/device/doorParam/update
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"sn": "33998400021314",
"doorNum": 1,
"doorParams": [{
"name": "doorNormalOpenTZ",
"value": "1"
}, {
"name": "xxxxxx",
"value": "xxxx"
}]
}
}
}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sn | String | Y | 设备序列号 |
| doorNum | Integer | Y | 门编号，取值范围，1～4 |
| doorParams | Object[] | Y | 门参数列表 |
| name | String | Y | 参数名, 详见门参数说明 |
| value | String | Y | 参数值 |
Response：
{
"code": "00000000",
"mid": "xxx",
"message": "success"
}
1.4.7.2.5. 查询门参数
查询设备下的门参数
Request:
POST /v1.0/device/doorParam/query
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"sn": "33998400021314",
"doorNum": 1
}
}
}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sn | String | Y | 设备序列号 |
| doorNum | Integer | N | 编号，当为空时，默认查询指定设备下的门列表信息 |
Response：
{
"code": "00000000",
"mid": "xxx",
"message": "success",
"payload": {
"results": [{
"sn": "33998400021314",
"doorNum": 1,
"doorParams": [{
"name": "doorNormalOpenTZ",
"value": "1"
}, {
"name": "xxxxxx",
"value": "xxxx"
}]
}]
}
}
| 参数名 | 类型 | 描述 |
|---|---|---|
| sn | String | 设备序列号 |
| doorNum | Integer | 门编号，取值范围，1～4 |
| doorParams | Object[] | 门参数列表 |
| name | String | 参数名, 见附录门参数说明 |
| value | String | 参数值 |