更新人员

更新时间:2023-06-20 14:54:11下载pdf

本文介绍更新人员的 API。

接口描述

下发更新人员指令给门禁,在门禁设备端更新人员信息。

接口地址

PUT: /v1.0/access-control/{device_id}/persons/{person_id}

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue涂鸦设备 ID。
person_idStringuritrue人员 ID。

body 说明

参数名类型参数位置是否必填说明
nameString false人员姓名。
id_cardString false证件 ID。
phoneString false手机号码。
person_floorInteger false人员所在楼层。
secret_keyString false人员密钥。
refresh_timeLong false二维码刷新时间,单位毫秒。
begin_timeLong false有效期开始时间,单位毫秒。
end_timeLong false有效期结束时间,单位毫秒。
door_time_rule_listList false日程时间规则。
extendString false扩展信息。

door_time_rule_list 说明

参数名类型参数位置是否必填说明
rule_nameString false日程时间规则名称。
periodString false可通⾏时间周期,json 字符串。例如: [{"weekDay":1,"weekTime":[{"start":"32400000","end":"64800000"}]},{"weekDay":2,"weekTime":[{"start":"68400000","end":"75600000"}]}]。
allowed_dateString false可通⾏时间段,json 字符串。例如:[{"start":"1571587200000","end":"1864569600000"},{"start":"1573022801885","end":"1864569600000"}]。
denied_dateString false不可通⾏时间段,json 字符串。例如:[{"start":"1571587200000","end":"1864569600000"},{"start":"1573022801885","end":"1864569600000"}]。

返回参数

参数名类型说明
resultCmdIssueResultResponse返回结果。

result 说明

参数名类型说明
snString指令记录 ID。

请求示例

PUT: /v1.0/access-control/6ce****/persons/123****
{
  "begin_time": 1582959882104,
  "end_time": 1661666512292,
  "id_card": "330****",
  "name": "张三",
  "phone": "135****",
  "person_floor": 5,
  "secret_key": "abc123***",
  "refresh_time": 300000
}

返回示例

{
    "result": {
        "sn": "133****"
    },
    "t": 1561456817168,
    "success": true
}

错误码

参考 错误码