简要描述
  • 新增、编辑、删除相机的车牌白名单信息，单次最多可以操作5个车牌信息。
请求URL
  • https://deviceiotcontrol.szymzh.com/v1/zlparkCamera/whitelistOperation
请求方式
  • POST
  • header 需加入appId参数
参数名 必选 类型 说明
appId 是 string appId
msgId
  • msgId规则为：设备序列号 + 15位毫秒时间戳 + 1位随机数
  • 回复的msgId与请求的msgId保持一致
请求参数
字段名称 类型 取值范围 是否必须 描述
appId string 是 appId
serialno string 是 设备唯一标识
msgId String 是 通讯唯一标识
sign string 是 签名
white_list_operate json字符串 是 白名单列表
operate_type int [0,1] 是 操作类型(0:增加，1：删除)
white_list_data 无 个数[1, 5] 是 白名单数组：单次操作，最大支持5条
plate string 长度[7, 15] 是 车牌（GB2312）
enable int [0, 1] 是 当前名单是否有效（0：无效， 1,：有效）
need_alarm int [0, 1] 是 当前名单是否为黑名单（0：否，1：黑名单）
enable_time string 固定格式、固定长度：19 是 当前名单生效时间，如：2018-01-01 11:11:11
overdue_time string 固定格式、固定长度：19 是 当前名单过期时间，如：2018-01-01 11:11:11 不传则永久有效
请求示例
{
    "appId": "ym50e8c7d7704c4fab",
    "sign": "614F613570864070B1328CC5676FB90B",
    "msgId": "e8ec45a4-ab80b4f616842078872279",
    "serialno": "e8ec45a4-ab80b4f6",
    "white_list_operate": "{\"operate_type\":0,\"white_list_data\":[{\"plate\":\"京A12345\",\"enable\":1,\"need_alarm\":1,\"enable_time\":\"2022-03-01 00:00:00\",\"overdue_time\":\"2022-04-01 23:59:59\"},{\"plate\":\"川A12345\",\"enable\":1,\"need_alarm\":1,\"enable_time\":\"2022-03-01 00:00:00\",\"overdue_time\":\"2022-04-01 23:59:59\"}]}"
}
返回参数说明
字段名称 类型 必填 描述
msg String 是 应答消息
code int 是 code等于0成功，其他失败
data json 是 设备返回内容

消息data字段说明：

字段名称 类型 是否必须 描述
error_msg string 是 处理结果消息
msgId string 是 通讯唯一标识
cmd string 是 操作白名单指令（white_list_operate)
state_code int 是 处理结果，返回200代表成功，其他值代表失败
serialno string 是 设备序列号
返回示例
{
    "msg": "操作成功",
    "code": 0,
    "data": {
        "error_msg": "success",
        "msgId": "e8ec45a4-ab80b4f616842078872279",
        "cmd": "white_list_operate",
        "state_code": 200,
        "serialno": "e8ec45a4-ab80b4f6"
    }
}
多条示例请求参数

删除多条白名单

{
    "appId": "ym50e8c7d7704c4fab",
    "sign": "42D3AF4CB1539CCDFE8B095BD033308E",
    "msgId": "e8ec45a4-ab80b4f616842087350168",
    "serialno": "e8ec45a4-ab80b4f6",
    "white_list_operate": "{\"operate_type\":1,\"white_list_data\":[{\"plate\":\"京A12345\"},{\"plate\":\"川A12345\"}]}"
}

删除全部白名单

{
    "appId": "ym50e8c7d7704c4fab",
    "sign": "5C75579496D8203B9198B0E614EC3680",
    "msgId": "e8ec45a4-ab80b4f616842078872279",
    "serialno": "e8ec45a4-ab80b4f6",
    "white_list_operate": "{\"operate_type\":1,\"white_list_data\":[{\"plate\":\"\"}]}"
}
作者：郭祥西  创建时间：2024-03-27 17:16
最后编辑：郭祥西  更新时间：2024-11-07 15:18