lms-他システム連携/API

13-03-11.受講者情報取得API

更新日:

4-31

API名 受講者情報取得API
ID el_userInfo_get_api

2.詳細解説

受講者IDを指定し、受講者の詳細情報を取得するAPI。今まで所属していたセクションのリストも同時に取得することができる。

$cstream->call_el_userInfo_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1     会社ID kaisha_id 会社を表すID
2     アクセスキー access_key APIを認証するためのアクセスキー
3     受講者ID userid 受講者ID (一致検索)
4     メールアドレス mail メールアドレス (一致検索)
5     受講者ステータス user_status 0:仮登録 1:本登録 9:退会  
6 登録日From touroku_date_from 抽出に利用する登録日From(YYYYMMDD)
登録日がFrom~Toの間の場合のみ抽出
7 登録日To touroku_date_to 抽出に利用する登録日To(YYYYMMDD)
8 更新日From koushin_date_from 抽出に利用する更新日From(YYYYMMDD)
登録日がFrom~Toの間の場合のみ抽出
9 更新日To koushin_date_to 抽出に利用する更新日To(YYYYMMDD)
連携項目1 api_val_user1 APIの連携項目(一致検索)
連携項目2 api_val_user2 APIの連携項目(一致検索)
連携項目3 api_val_user3 APIの連携項目(一致検索)
連携項目4 api_val_user4 APIの連携項目(一致検索)
連携項目5 api_val_user5 APIの連携項目(一致検索)

OUTPUT

No 項目名 項目ID 項目説明
1     実行フラグ exec_flg 1:正常 9:エラー
2     エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3     エラーメッセージ error_msg エラーごとに発生するメッセージ
4     受講者情報 user_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   独自のログインID original_login_id  
4-22 ニックネーム nickname
4-23 受講者画像URL user_img_url
4-24 手動メール配信対象 manual_mail_target_flg 0:配信対象外 1:配信対象
4-25 講師権限付与 lecturer_auth_add_flg 0:付与しない 1:付与する
4-26 講師回答承認 lecturer_answer_approval_flg 0:承認不要 1:承認する
4-27  講師権限付与フラグ  lecturer_auth_add_flg  0:付与しない 1:付与する
  4-28   連携項目1 api_val_user1  
  4-29   連携項目2 api_val_user2  
  4-30   連携項目3 api_val_user3  
  4-31   連携項目4 api_val_user4  
  4-32   連携項目5 api_val_user5  
4-33 マスタ登録日時 touroku_date
4-34 マスタ更新日時 koushin_date
4-35 セッション期限日時 session_expired_date
4-36 セッション登録日時 session_touroku_date
4-37 最終ログイン日時 login_date
  4-38   受講者ステータス user_status 0:仮登録 1:本登録 9:退会
  4-39   所属セクションリスト section_list  
    4-34-1 セクションID section_id  
    4-34-2 セクション名 section_name  
    4-34-3 セクション分類 section_type  
    4-34-4 所属期間From assign_date_from  
    4-34-5 所属期間To assign_date_to  
    4-34-6 セクションステータス section_status 0:停止 1:有効 6:設定未了 7:期間前 8:期限切れ 9:削除

エラー

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

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.