13-03-27.Infomation情報取得API

更新日：2020年6月2日

API名	Infomation情報取得API
ID	el_info_get_api.php

2.詳細解説

受講者サイトのお知らせや予定情報を取得するAPI。

$cstream->call_el_info_get_api($input_array);

3.I/O情報

INPUT

No	項目名	項目ID	項目説明	必須
1	会社ID	kaisha_id	会社を表すID	〇
2	アクセスキー	access_key	APIを認証するためのアクセスキー	〇
3	Information種類	information_type	0:お知らせ　1:予定 2:両方 (入力がない場合お知らせとなる）	△
4	受講者ID	user_id	配信対象となる受講者のID （入力がない場合、ROOTセクション所属の最も古い受講者のIDが自動的に選択される）	△

OUTPUT

No			項目名	項目ID	項目説明
1			実行フラグ	exec_flg	1:正常　9:エラー
2			エラータイプ	error_type	実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3			エラーメッセージ	error_msg	エラーごとに発生するメッセージ
4			エラー情報	error_info	エラーメッセージを表示（登録に失敗したケース）
5			お知らせ情報	notice_info
	5-1		お知らせ番号	info_no	お知らせをユニークに表す番号
	5-2		配信先区分	destination_kbn	0:セクション全体　1:カリキュラム　2:講座　3:受講者
	5-3		Informationタイトル	information_title	Informationのタイトル
	5-4		info表示フラグ	info_hyoji_flg	Informationを表示するか否かを判断するフラグ。
	5-5		配信管理者ID	inform_manager_id	お知らせを登録した管理者のID
	5-6		配信管理者名	inform_manager_name	お知らせを登録した管理者の名称
	5-7		配信期間日時From	notice_datetime_from	お知らせの配信期間FROM（YYYYMMDDHHII）
	5-8		配信期間日時To	notice_datetime_to	お知らせの配信期間TO（YYYYMMDDHHII）
	5-9		全セクション配信フラグ	all_section_inform_flg
	5-10		全カリキュラム配信フラグ	all_curriculum_inform_flg
	5-11		全講座配信フラグ	all_course_inform_flg
	5-12		メール通知フラグ	mail_inform_flg	メール通知されるお知らせは1
	5-13		LINE通知フラグ	line_inform_flg	LINE通知されるお知らせは1
	5-14		添付ファイルURL	information_filename_url	添付ファイルのURL
	5-15		重要性区分	importance_kbn	0:通常　1:重要　2:必読
	5-16		お知らせ内容	notice_contents
	5-17		お知らせ登録日時	touroku_date	お知らせを投稿した日時（YYYYMMDDHHIISS）
	5-18		お知らせ更新日時	koushin_date	お知らせを更新した日時（YYYYMMDDHHIISS）
	5-19		既読/未読	kidoku_midoku	0:未読　1:既読
	5-20		閲覧日	readed_date	当該Informationの内容を受講者が閲覧した日（YYYYMMDD）
	5-21		メール配信日時	mail_inform_datetime	当該Informationの内容をメール通知した日時（YYYYMMDDHHII）
	5-22		LINE配信日時	line_inform_datetime	当該Informationの内容をLINE通知した日時（YYYYMMDDHHII）
	5-23		通知先セクションリスト	inform_section_list
		5-23-1	セクションID	section_id
		5-23-2	セクション名	section_name
	5-24		通知先カリキュラムリスト	inform_curriculum_list
		5-24-1	カリキュラムID	curriculum_id
		5-24-2	カリキュラム名	curriculum_name
	5-25		通知先講座リスト	inform_course_list
		5-25-1	講座ID	course_id
		5-25-2	講座名	course_name
6			予定情報	schedule_info
	6-1		予定番号	info_no	予定をユニークに表す番号
	6-2		配信先区分	destination_kbn	0:セクション全体　1:カリキュラム　2:講座　3:受講者
	6-3		Informationタイトル	information_title	Informationのタイトル
	6-4		info表示フラグ	info_hyoji_flg	Informationを表示するか否かを判断するフラグ。
	6-5		配信管理者ID	inform_manager_id	予定を登録した管理者のID
	6-6		配信管理者名	inform_manager_name	予定を登録した管理者の名称
	6-7		配信日時From	schedule_datetime_from	予定期間FROM（YYYYMMDDHHII）
	6-8		配信日時To	schedule_datetime_to	予定期間TO（YYYYMMDDHHII）
	6-9		全セクション配信フラグ	all_section_inform_flg
	6-10		全カリキュラム配信フラグ	all_curriculum_inform_flg
	6-11		全講座配信フラグ	all_course_inform_flg
	6-12		メール通知フラグ	mail_inform_flg	メール通知される予定は1
	6-13		LINE通知フラグ	line_inform_flg	LINE通知される予定は1
	6-14		添付ファイルURL	information_filename_url	添付ファイルのURL
	6-15		予定内容	schedule_contents
	6-16		予定登録日時	touroku_date	予定を投稿した日時（YYYYMMDDHHIISS）
	6-17		予定更新日時	koushin_date	予定を更新した日時（YYYYMMDDHHIISS）
	6-18		既読/未読	kidoku_midoku	0:未読　1:既読
	6-19		閲覧日	readed_date	当該Informationの内容を受講者が閲覧した日（YYYYMMDD）
	6-20		メール配信日時	mail_inform_datetime	当該Informationの内容をメール通知した日時（YYYYMMDDHHII）
	6-21		LINE配信日時	line_inform_datetime	当該Informationの内容をLINE通知した日時（YYYYMMDDHHII）
	6-22		通知先セクションリスト	inform_section_list
		6-22-1	セクションID	section_id
		6-22-2	セクション名	section_name
	6-23		通知先カリキュラムリスト	inform_curriculum_list
		6-23-1	カリキュラムID	curriculum_id
		6-23-2	カリキュラム名	curriculum_name
	6-24		通知先講座リスト	inform_course_list
		6-24-1	講座ID	course_id
		6-24-2	講座名	course_name

エラー

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

13-03-27.Infomation情報取得API

2.詳細解説

3.I/O情報

INPUT

OUTPUT

エラー

4.実装例