ユーザー
users > deactivate
ユーザーのステータスを「非アクティブ」にします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | deactivate | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=deactivate&iq={user_id}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:ユーザーが正常に非アクティブ化された場合
{
"ok": "User was deactivated successfully"
}
ユーザーが既に非アクティブだった場合など、リクエストが失敗した場合のレスポンス
{
"error": "DEACTIVATION_ERROR",
"error_long": "The User could not be deactivated: User already inactive or not found."
}
このリクエストは以下のエラーを返す可能性があります。
・DEACTIVATION_ERROR | The User could not be deactivated
ユーザーは既に無効になっているか、見つかりません。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "deactivate", "iq" => 7 ); // POST変数 $POST_VARS = array();