Deletes a specified individual from the face library. When an individual is deleted, the associated face image is also deleted.
Warning
When you delete an individual, the face image associated with the individual is also deleted. Proceed with caution.
QPS limits
20 calls per second per account. Exceeding this limit triggers throttling.
Request syntax
POST /green/sface/person/delete HTTPS|HTTPRequest headers
This operation uses only common request headers. For more information, see Common request headers.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| clientInfo | JSONObject | No | {"userId":"120234234","userNick":"Mike","userType":"others"} | The client information serialized from the ClientInfo structure in JSON format. Includes the Unique Machine Identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo. |
Request body
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| personId | String | Yes | person1 | The ID of the individual to delete. |
Response parameters
All responses are returned in JSON format. For more information about common response parameters, see Common response parameters.
The data field contains the following parameters.
The data field may be empty if an error occurs.| Parameter | Type | Example | Description |
|---|---|---|---|
| code | Integer | 200 | The HTTP status code. For more information, see Common error codes. |
| personId | String | person1 | The ID of the deleted individual. |
| deleteCount | Integer | 1 | The number of successfully deleted individuals. |
Examples
Sample request
POST /green/sface/person/delete HTTP/1.1
Common request headers
{
"personId": "person1"
}Sample success response
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"deleteCount": 1
}
}Error codes
For a list of error codes, see Service error codes.