更新时间:2024-05-21 GMT+08:00
分享

删除目标信息

功能介绍

批量删除目标信息,仅支持好望协议设备,使用该接口需要设备安装了目标算法,NVR800需要切换到人卡模式,SDC直连需要开启目标库对比

URI

POST /v1/{user_id}/target/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

用户认证AccessToken:从获取用户北向接口认证AccessToken中获取

表3 请求Body参数

参数

是否必选

参数类型

描述

device_id

String

设备ID:

好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取

group_id

Integer

目标库分组ID:非负值,从获取目标库分组接口获取

target_ids

Array of strings

目标ID列表:数组长度范围[1,100]

目标ID:支持数字和-,长度范围[1,20],需要已添加目标才可以删除,可以从按索引范围获取目标ID列表获取目标信息按索引范围获取目标ID信息中获取

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

group_id

Integer

目标库分组ID:目标库标识符

target_ids

Array of TargetResultVo objects

目标ID列表

表5 TargetResultVo

参数

参数类型

描述

target_id

String

目标ID:目标标识符

result

Result object

结果码

表6 Result

参数

参数类型

描述

code

String

错误编码

msg

String

错误信息

请求示例

批量删除目标信息

POST /v1/2562572829***/target/batch-delete

{
  "device_id" : "952352LWXT***",
  "group_id" : 2,
  "target_ids" : [ "1" ]
}

响应示例

状态码: 200

OK
{
  "group_id" : 2,
  "target_ids" : [ {
    "result" : {
      "code" : "IVM.0",
      "msg" : "Success"
    },
    "target_id" : "1"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档