13-03-13.受講者情報編集API - E-learning ASP V6 利用マニュアル

API名	受講者情報編集API
ID	el_userInfo_upd_api

2.詳細解説

受講者の情報を登録したり、すでに登録されている受講者の設定項目を変更したりするAPI。受講者IDをINPUTに含めなければ新規登録、含めれば更新になる。
以下のような用途に利用される。

・受講者を新規登録する
・受講者を削除する（ステータスを９に更新する）
・受講者の設定項目を変更する（たとえばパスワード変更など）
・受講者の所属セクションを変更する（YYYYMMDDから別セクションに所属させる等）

$cstream->call_el_userInfo_upd_api($input_array);

3.I/O情報

INPUT

No	項目名	項目ID	項目説明	必須
1	会社ID	kaisha_id	会社を表すID	〇
2	アクセスキー	access_key	APIを認証するためのアクセスキー	〇
3	受講者ID	userid	値を入れなければ新規登録となる値を入れた場合、そのIDがすでに存在している場合更新処理になる。採番APIで取得した受講者IDを入れた場合、当該IDを利用して新規登録される。	△
4	受講者ﾊﾟｽﾜｰﾄﾞ	userpassword	半角英数記号　8桁以上16桁まで新規の場合必須、更新の場合、値が入っていないと更新処理が行われない。	△
5	受講者氏名	username	全角40文字まで
6	受講者氏名（カナ）	usernamekana	全角カナ40文字まで
7	性別	sex_kbn	0:男性　1:女性
8	年齢	age	半角数字
9	生年月日	birth	YYYYMMDD
10	既婚/未婚	marry_kbn	0:未婚　1:既婚
11	郵便番号	yubin	ハイフン抜き数字7桁
12	住所	address
13	電話番号	tdisp	ハイフン含む
14	ﾒｰﾙｱﾄﾞﾚｽ	mail	ASP基本設定でメールアドレスをログインの項目にしている場合必須	△
15	携帯ﾒｰﾙｱﾄﾞﾚｽ	mobileMail
16	職業	job_kbn	0：医師 1：弁護士 2：会計士・税理士 3：建築士・不動産鑑定士 4：その他士業 5：公務員 6：警察・消防士 7：教員 8：会社経営 9：自営業 10：モデル・タレント・スポーツ選手 11：営業 12：経理・法務・経営企画 13：研究 14：接客・販売 15：秘書・受付 16：事務職 17：コンピュータ関連技術者 18：エンジニア 19：コンサルタント 20：記者 21：客室乗務員 22：美容師 23：看護師 24：大学生・専門学生 25：その他
17	法人名	incName
18	業種	bizType_kbn	0050：水産・農林業 1050：鉱業 2050：建設業 3050：製造業(食料品) 3100：製造業(繊維製品) 3150：製造業(パルプ・紙) 3200：製造業(化学) 3250：製造業(医薬品) 3300：製造業(石油・石炭製品) 3350：製造業(ゴム製品) 3400：製造業(ガラス・土石製品) 3450：製造業(鉄鋼) 3500：製造業(非鉄金属) 3550：製造業(金属製品) 3600：製造業(機械) 3650：製造業(電気機器) 3700：製造業(輸送用機器) 3750：製造業(精密機器) 3800：製造業(その他) 4050：電気・ガス業 5050：陸運業 5100：海運業 5150：空運業 5200：倉庫・運輸関連業 5250：情報・通信業 6050：卸売業 6100：小売業 7050：銀行業 7100：証券、商品先物取引業 7150：保険業 7200：その他金融業 8050：不動産業 9050：サービス業
19	従業員数	enpNumber	0:10人未満 1:10人以上30人未満 2:30人以上100人未満 3:100人以上500人未満 4:500人以上1,000人未満 5:1,000人以上5,000人未満 6:5,000人以上
20	部署名	departName
21	役職	position
22	独自のログインID	original_login_id	ASP基本設定で独自のログインIDをログインの項目にしている場合必須	△
23	任意項目	other
24	ニックネーム	nickname
25	受講者画像URL	user_img_url	画像のパスを指定（http://xxxx/xxx.jpg）使用できる拡張子は jpg jpeg gif png
26	手動メール配信対象フラグ	manual_mail_target_flg	0:配信対象外　1:配信対象
27	講師権限付与フラグ	lecturer_auth_add_flg	0:付与しない　1:付与する
28	講師回答承認フラグ	lecturer_answer_approval_flg	0:承認不要　1:承認する
30	連携項目１	api_val_user1
31	連携項目２	api_val_user2
32	連携項目３	api_val_user3
33	連携項目４	api_val_user4
34	連携項目５	api_val_user5
35	受講者ステータス	user_status	0:仮登録 1:本登録 9:退会	〇
36	所属セクションID	section_id	新規の場合、設定しないとRootセクションになる
37	所属期間From	assign_date_from	新規の場合、設定しないとSYSDATEになる
38	所属期間To	assign_date_to	新規の場合、設定しないと99991231になる

OUTPUT

No			項目名	項目ID	項目説明
1			実行フラグ	exec_flg	1:正常　9:エラー
2			エラータイプ	error_type	実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3			エラーメッセージ	error_msg	エラーごとに発生するメッセージ
4			エラー情報	error_info	各項目ごとのエラーメッセージを表示（登録に失敗したケース）
	4-1		受講者ID	userid
	4-2		受講者ﾊﾟｽﾜｰﾄﾞ	userpassword
	4-3		受講者氏名	username
	4-4		受講者氏名（カナ）	usernamekana
	4-5		性別	sex
	4-6		年齢	age
	4-7		生年月日	birth
	4-8		既婚/未婚	marry
	4-9		郵便番号	yubin
	4-10		住所	address
	4-11		電話番号	tdisp
	4-12		ﾒｰﾙｱﾄﾞﾚｽ	mail
	4-13		携帯ﾒｰﾙｱﾄﾞﾚｽ	mobileMail
	4-14		職業	job
	4-15		法人名	incName
	4-16		業種	bizType
	4-17		従業員数	enpNumber
	4-18		部署名	departName
	4-19		役職	position
	4-20		任意項目	other
	4-21		連携項目１	api_val_user1
	4-22		連携項目２	api_val_user2
	4-23		連携項目３	api_val_user3
	4-24		連携項目４	api_val_user4
	4-25		連携項目５	api_val_user5
	4-26		所属セクションリスト	section_list
		4-26-1	セクションID	section_id
		4-26-2	セクション名	section_name
		4-26-3	所属期間From	assign_date_from
		4-26-4	所属期間To	assign_date_to
5			受講者ID	userid	登録が正常に完了した場合、受講者IDを表示する

エラー

エラータイプ	エラー概要	発生させるメッセージ	発生させるException
0	アクセスキー不適合エラー	アクセスキーが適合しません。	AccessKeyException
1	ホスト許可エラー	対象のホストからのAPI実行を許可していません。	HostRestrictException
2	引数エラー	呼出パラメータが不足しているため実行できません。	CallParameterException
3	登録エラー	登録が失敗しました	AddDataException
9	システムメンテナンスエラー	現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。	SystemMaintenanceException

4.実装例

/*
  受講者を新規追加して、その受講者にC000001の講座権限を付与する実装例
*/

// APIに渡す配列
$apiParams = array();

$apiParams['userid'] = '';				//	新規登録 ※既存受講者の更新なら値をいれる
if($type == '0'){
	$apiParams['api_val_user4'] = '個人';	//	個人
}else{
	$apiParams['api_val_user4'] = '法人';	//	法人
}
$apiParams['username'] =  $user_name;

//全角カタカナ変換
$user_hurigana = mb_convert_kana($user_hurigana, "KVC");
$apiParams['usernamekana'] = $user_hurigana;
$apiParams['mail'] = $user_email;
$apiParams['userpassword'] = $userpassword;
$apiParams['incName'] = $company;			// 法人名

try{
	// APIを呼び出す
	$output = $cstream->call_el_userInfo_upd_api($apiParams);

	if($output['exec_flg'] == 1 && isset($output['userid'])){
		//正常完了処理

		$apiParamsAuth = array();

		$apiParamsAuth['userid'] = $output['userid'];
		$apiParamsAuth['upd_type'] = "0";		//権限の追加更新

		$auth_list = array();
		$auth_list[0]['course_ap_date'] = date('Ymd');//受講申込日
		$auth_list[0]['course_end_date'] = "";//受講期限日(未入力だとデフォルト値になる)
		if($payment_type == '振込'){
			$auth_list[0]['attend_status'] = "0";	//仮登録(銀行振込の場合いったん仮登録にする)
		}else{
			$auth_list[0]['attend_status'] = "1";	//本登録
		}
		$auth_list[0]['course_id'] = 'C000001';//講座ID

		$apiParamsAuth['auth_list'] = $auth_list;		//権限リスト

		// API呼び出し
		$output = $cstream->call_el_userAuth_upd_api($apiParamsAuth);
		if($output['exec_flg'] == 1){
			//権限付与成功！
		}else{

			//異常時処理
			$err = 1;

			switch($output['error_type']){
				case '0':
					echo $output['error_msg'];
					break;
				case '1':
					echo $output['error_msg'];
					break;
				case '2':
					echo $output['error_msg'];
					break;
				case '3':
					print_r($output['error_info']);
					break;
			}
		}
	}else{
		//異常時処理
		$err = 1;

		switch($output['error_type']){
			case '0':
				echo $output['error_msg'];
				break;
			case '1':
				echo $output['error_msg'];
				break;
			case '2':
				echo $output['error_msg'];
				break;
			case '3':
				foreach ($output['error_info'] as $key => $value) {
					if($value != "")
						echo "エラー項目:".$key." -> ".$value;
				}
				break;
		}
	}

}catch (Exception $e) {
	$arrError[0] = $e->getMessage();
}

受講者を新規追加して、その受講者にC000001の講座権限を付与する実装例

// APIに渡す配列

$apiParams = array();

$apiParams['userid'] = ''; // 新規登録 ※既存受講者の更新なら値をいれる

if($type == '0'){

$apiParams['api_val_user4'] = '個人'; // 個人

}else{

$apiParams['api_val_user4'] = '法人'; // 法人

}

$apiParams['username'] = $user_name;

//全角カタカナ変換

$user_hurigana = mb_convert_kana($user_hurigana, "KVC");

$apiParams['usernamekana'] = $user_hurigana;

$apiParams['mail'] = $user_email;

$apiParams['userpassword'] = $userpassword;

$apiParams['incName'] = $company; // 法人名

try{

// APIを呼び出す

$output = $cstream->call_el_userInfo_upd_api($apiParams);

if($output['exec_flg'] == 1 && isset($output['userid'])){

//正常完了処理

$apiParamsAuth = array();

$apiParamsAuth['userid'] = $output['userid'];

$apiParamsAuth['upd_type'] = "0"; //権限の追加更新

$auth_list = array();

$auth_list[0]['course_ap_date'] = date('Ymd');//受講申込日

$auth_list[0]['course_end_date'] = "";//受講期限日(未入力だとデフォルト値になる)

if($payment_type == '振込'){

$auth_list[0]['attend_status'] = "0"; //仮登録(銀行振込の場合いったん仮登録にする)

}else{

$auth_list[0]['attend_status'] = "1"; //本登録

}

$auth_list[0]['course_id'] = 'C000001';//講座ID

$apiParamsAuth['auth_list'] = $auth_list; //権限リスト

// API呼び出し

$output = $cstream->call_el_userAuth_upd_api($apiParamsAuth);

if($output['exec_flg'] == 1){

//権限付与成功！

}else{

//異常時処理

$err = 1;

switch($output['error_type']){

case '0':

echo $output['error_msg'];

break;

case '1':

echo $output['error_msg'];

break;

case '2':

echo $output['error_msg'];

break;

case '3':

print_r($output['error_info']);

break;

}

}else{

//異常時処理

$err = 1;

switch($output['error_type']){

case '0':

echo $output['error_msg'];

break;

case '1':

echo $output['error_msg'];

break;

case '2':

echo $output['error_msg'];

break;

case '3':

foreach ($output['error_info'] as $key => $value) {

if($value != "")

echo "エラー項目:".$key." -> ".$value;

}

break;

}

}catch (Exception $e) {

$arrError[0] = $e->getMessage();

}