顔画像を削除ます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が生じる可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/face/delete HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
|
パラメーター |
タイプ |
必須 |
例 |
説明 |
|
clientInfo |
JSONObject |
いいえ |
{"userId":"120234234","userNick":"Mike","userType":"others"} |
ClientInfo 構造から JSON 形式でシリアル化されたクライアント情報。この情報には、クライアントの一意識別子（UMID）と国際移動体装置識別子（IMEI）が含まれます。詳細については、「ClientInfo」をご参照ください。 |
リクエスト本文
削除する顔画像情報を指定するには、リクエスト本文で次のパラメーターも指定する必要があります。
|
パラメーター |
タイプ |
必須 |
例 |
説明 |
|
personId |
String |
はい |
person1 |
顔画像に関連付けられている個人の ID。 |
|
faceIds |
StringArray |
はい |
["1244453323565","1345345466455"] |
削除する顔画像の ID リスト。 説明
getPersonInfo 操作を呼び出して、個人に関連付けられている顔画像の ID をクエリできます。 |
レスポンスパラメーター
JSON 形式のデータがすべてのリクエストに対して返されます。共通レスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。レスポンスの data パラメーターは、ビジネス関連データを返すために使用されます。一般に、このパラメーターの値は JSON 構造または配列です。
エラーが発生した場合、data パラメーターは空になる場合があります。
次の表は、data フィールドで返されるパラメーターを示しています。
|
パラメーター |
タイプ |
例 |
説明 |
|
code |
Integer |
200 |
返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
|
personId |
String |
person1 |
個人の ID。 |
|
faceIds |
StringArray |
["1244453323565","1345345466455"] |
正常に削除された顔画像の ID リスト。 |
|
deleteCount |
Integer |
2 |
正常に削除された顔画像の数。 |
例
リクエストの例
POST /green/sface/face/delete HTTP/1.1
共通リクエストヘッダー
{
"personId": "person1",
"faceIds": [
"1244453323565",
"1345345466455"
]
}成功レスポンスの例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"faceIds": [
"1244453323565",
"1345345466455"
],
"deleteCount": 2
}
}エラーコード
エラーコードのリストについては、サービスエラーコード を参照してください。