指定した個人を削除ます。
個人を削除すると、その個人に関連付けられている顔画像も削除されます。 慎重に実行してください。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。 1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。 その結果、ビジネスに影響が及ぶ可能性があります。 この操作を呼び出すときは、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/person/delete HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
|
パラメーター |
タイプ |
必須 |
例 |
説明 |
|
clientInfo |
JSONObject |
いいえ |
{"userId":"120234234","userNick":"Mike","userType":"others"} |
ClientInfo 構造から JSON 形式でシリアル化されたクライアント情報。 情報には、クライアントの UMID（Unique Machine Identifier）と IMEI（International Mobile Equipment Identity）が含まれます。 詳細については、「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
}
}エラーコード
エラーコードのリストについては、サービスエラーコード を参照してください。