印刷する

ユーザー:ユーザーグループ

users > set_user_group_association

ユーザーをユーザーグループに関連付けたり、ユーザーグループから分離したりします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gousersAPIセクション
doset_user_group_associationAPIアクション
iqUser IDユーザーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=set_user_group_association&iq={user_id}&{required information}
POST変数

以下のPOST変数は必須です。

変数値説明
association (string) associate | dissociate ユーザーをユーザーグループに関連付けるか、もしくはユーザーグループから分離するか
user_group_ids (string) User Group IDs 1つ以上のユーザーグループのID（カンマ区切り）

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok：ユーザーがユーザーグループに関連付けられた、またはユーザーグループから分離された場合

{
    "ok": "The operation was performed"
}

association値が無効な場合など、リクエストが失敗した場合のレスポンス

{
    "error": "REQUEST_ERROR",
    "error_long": "Invalid association"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。

・NOT_FOUND | User not found
ユーザーが見つかりません。

・REQUEST_ERROR | User Group IDs is Empty
ユーザーグループIDの値が空欄です。

・REQUEST_ERROR | User Group IDs is not provided or invalid
ユーザーグループIDが指定されていないか無効です。

・REQUEST_ERROR | Invalid association [Must be 'associate' or 'dissociate']
associationの値が指定されていないか無効です。

・ERRORS_OCCURRED | Some operations succeeded and others failed
いくつかのグループIDが指定され、一部の操作しか成功しませんでした。おそらく無効なグループIDが原因です。

・ERROR | The operation(s) failed
処理に失敗しました。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "set_user_group_association",
					"iq"        => 700
					);

// POST変数
$POST_VARS = array(
                    "inclusion"		=> "associate",
                    "user_group_ids"	=> "1,2"
                    );