调用deletePerson接口删除指定个体。

警告 删除个体时,与个体关联的人脸图片也将被删除。请谨慎操作。

请求语法

POST /green/sface/person/delete HTTPS|HTTP

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求头

请求参数

名称 类型 是否必选 示例值 描述
clientInfo JSONObject {"userId":"120234234","userNick":"Mike","userType":"others"} 客户端信息,由ClientInfo结构体通过JSON序列化获得,包含umid、imei等信息,具体结构描述,请参见ClientInfo

RequestBody

RequestBody中还需要填入以下参数,用来指定要删除的个体信息。

名称 类型 是否必选 示例值 描述
personId String person1 要删除的个体ID。

返回数据

所有请求均返回JSON格式的数据。关于返回数据中的公共字段,请参见公共返回参数。返回数据中的data字段表示与业务相关的数据,一般是一个JSON结构体或数组。
说明 响应出错的情况下,data字段可能为空。

该接口返回的data字段包含以下参数。

名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

personId String person1 已被删除的个体ID。
deleteCount Integer 1 成功删除的个体数量。

示例

请求示例
POST /green/sface/person/delete HTTP/1.1
公共请求头
{
    "personId": "person1"
}
正常返回示例
{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personId": "person1",
        "deleteCount": 1
    }
}

错误码

访问错误中心查看更多错误码。