Webサービスを利用する¶
Webサービス概要¶
Web サービスを利用すると、組織情報、利用者情報など、各種情報をプログラムから登録、変更、取得、削除する事が可能となります。
WSDL¶
Webサービスクライアントを作成するために必要なWSDLは、以下のURLから確認出来ます。
URL: https://ホスト名/テナント名/services/webapi?wsdl
Webサービスクライアントを作成する¶
WSDLからWebサービスクライアントを作成する方法の一例としてWSIMPORTを用いた方法を紹介します。 以下のバッチ処理を実行する事によりWSDLからjavaで記述されたWebサービスクライアントを作成することができます。:
@ECHO OFF
REM =============================================
REM ウェブサービスクライアントコード生成バッチ
REM =============================================
REM ※JDKのインストールフォルダ(/bin)を環境変数Pathに設定
REM
TITLE=ウェブサービスクライアントコード生成バッチ
ECHO =============================================
ECHO ウェブサービスクライアントコード生成バッチ
ECHO =============================================
ECHO 処理を開始します。
PAUSE
SET CLASS_FILE_DIR=C:\class
SET SOURCE_FILE_DIR=C:\src
SET WSDL_URL=https://ホスト名/テナント名/services/webapi?wsdl
WSIMPORT -s %SOURCE_FILE_DIR% -d %CLASS_FILE_DIR% -p jp.learningcast.webservice.client -verbose %WSDL_URL%
ECHO 処理完了です。
PAUSE
上記バッチ処理を実行することにより、SOURCE_FILE_DIRで指定したフォルダにWEBサービスクライアントのソースコードが、 CLASS_FILE_DIRで指定したフォルダにWEBサービスクライアントのバイナリファイルが作成されます。 その他お好みの方法でWEBサービスクライアントを作成しても構いません。
JDKがインストールされていれば上記バッチ処理は動作します。
CLASS_FILE_DIR、SOURCE_FILE_DIRの値はお好みの出力先を指定してください。
WSDL_URLのホスト名、テナント名にはお客様ご利用の値をご指定ください。
お使いのクライアント環境がプロキシ経由でネットワークへ接続している場合には、WSIMPORTに次のオプション（-httpproxy:プロキシのホスト名:プロキシのポート番号）を追加する必要があります。
サンプルコード:Webサービスを用いて認証キーを取得する¶
上記で作成したWEBサービスクライアントを用いてWebサービスの認証キーを取得するサンプルコードは以下の通りです。:
import jp.learningcast.webservice.client.WebAPI;
import jp.learningcast.webservice.client.WebAPI_Service;
import jp.learningcast.webservice.client.WebServiceException;
public class Main {
public static void main(String[] args) {
//プロキシをご利用の場合には以下のコメントを削除し、適切な値を入れる必要があります。
//System.getProperties().put( "proxySet", "true" );
//System.getProperties().put( "proxyHost", プロキシのホスト名);
//System.getProperties().put( "proxyPort", プロキシのポート番号);
WebAPI webApi = new WebAPI_Service().getWebAPIPort();
try {
String authKey = webApi.login("dummyid", "dummypassword");
} catch (WebServiceException e) {
//例外処理
System.out.println(e.getMessage());
return;
}
}
}
上記処理で取得したauthKey（認証キー）を用いて組織登録、利用者登録などのWebサービスを利用することが可能となります。
サンプルコード:Webサービスを用いて組織を登録する¶
上記で作成されたWEBサービスクライアントを用いて組織を登録するサンプルコードは以下の通りです。:
import jp.learningcast.webservice.client.Organization;
import jp.learningcast.webservice.client.WebAPI;
import jp.learningcast.webservice.client.WebAPI_Service;
import jp.learningcast.webservice.client.WebServiceException;
public class Main {
public static void main(String[] args) {
//プロキシをご利用の場合には以下のコメントを削除し、適切な値を入れる必要があります。
//System.getProperties().put( "proxySet", "true" );
//System.getProperties().put( "proxyHost", プロキシのホスト名);
//System.getProperties().put( "proxyPort", プロキシのポート番号);
WebAPI webApi = new WebAPI_Service().getWebAPIPort();
try {
//認証キー取得
String authKey = webApi.login("dummyid", "dummypassword");
//組織情報作成
Organization organization = new Organization();
organization.setCode("orgcode01");
organization.setName("組織１");
organization.setParentCode("parentOrgCode01");
//組織情報登録
webApi.registerOrganization(organization, authKey);
} catch (WebServiceException e) {
//例外処理
System.out.println(e.getMessage());
return;
}
}
}
WebAPI:認証キーを取得する¶
login¶
各Webサービスを利用するために必要な認証キーを取得します。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
loginId |
String |
必須 |
パスワード |
password |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
認証キー |
authKey |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 1 |
message |
String |
- 1
メッセージ一覧
「ログインID」が未指定の場合
認証に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
認証に失敗しました。ログインIDは128文字以内で入力してください。
「ログインID」に半角英数、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を利用した場合
認証に失敗しました。ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、 アットマーク（@）をご使用ください。
「パスワード」が未指定の場合
認証に失敗しました。パスワードは必須項目です。
「パスワード」が64文字より多い場合
認証に失敗しました。パスワードは64文字以内で入力してください。
「パスワード」がパスワード制約を満たしていない場合
認証に失敗しました。パスワードは～文字以上64文字以下で、英小文字,英大文字,数字,記号(すべて半角) のみ使用可能です。使用できる記号は～です。～のうち～種類以上を使用してください。
利用者が存在しない、或いはログイン無効化されている、或いはパスワードが間違っている為、ログインに失敗した場合
認証に失敗しました。
ログインに失敗し、さらにログイン失敗したことにより指定した利用者のアカウントロックアウトが成立した場合
認証に失敗しました。連続失敗のため指定したログインIDを利用できない状態にしました。 この状態は”アカウントロックアウトが解除される日時”に解除されます。
指定した利用者が、アカウントロックアウトされた状態だった場合
認証に失敗しました。指定したログインIDは現在利用できません。 この状態は”アカウントロックアウトが解除される日時”に解除されます。
loginByApiLoginKey¶
各Webサービスを利用するために必要な認証キーを取得します。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
APIログインID |
apiLoginId |
String |
必須 |
APIログインキー |
apiLoginKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
認証キー |
authKey |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 2 |
message |
String |
- 2
メッセージ一覧
「APIログインID」が未指定の場合
認証に失敗しました。APIログインIDは必須項目です。
「APIログインID」が20文字より多い場合
認証に失敗しました。APIログインIDは20文字以内で入力してください。
「APIログインID」に半角英数字以外を利用した場合
認証に失敗しました。APIログインIDは半角英数字をご使用ください。
「APIログインキー」が未指定の場合
認証に失敗しました。APIログインキーは必須項目です。
「APIログインキー」が50文字より多い場合
認証に失敗しました。APIログインキーは50文字以内で入力してください。
「APIログインID」に半角英数字記号(/+)以外を利用した場合
認証に失敗しました。APIログインキーは50文字以下で、英小文字,英大文字,数字,記号(/+)のみ使用可能です。
利用者が存在しない、或いはログイン無効化されている、或いはパスワードが間違っている為、ログインに失敗した場合
認証に失敗しました。
WebAPI:ログアウトする¶
logout¶
取得した認証キーを無効にします。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 3 |
message |
String |
- 3
メッセージ一覧
「認証キー」が未指定の場合
ログアウトに失敗しました。認証キーは必須項目です。
「認証キー」が32文字より多い場合
ログアウトに失敗しました。認証キーは32文字以内で入力してください。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
ログアウトに失敗しました。実行権限がありません。
WebAPI:組織を登録する¶
registerOrganization¶
組織を登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
組織 |
Organization |
complexType |
必須 |
組織.組織ID |
id |
Integer |
指定しない |
組織.組織コード |
code |
String |
必須 |
組織.組織名 |
name |
String |
必須 |
組織.組織名フリガナ |
furigana |
String |
任意 |
組織.所在地 |
place |
String |
任意 |
組織.業種 |
typeOfIndustory |
String |
任意 |
組織.契約種別 |
contractType |
String |
任意 |
組織.上位組織コード |
parentCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 4 |
message |
String |
- 4
メッセージ一覧
「認証キー」が未指定の場合
組織登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
組織登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
組織登録に失敗しました。認証キーは32文字以内で入力してください。
「組織.組織ID」が指定されている場合
組織登録に失敗しました。登録処理の場合、組織IDは自動採番しますので省略してください。
「組織.組織コード」が未指定の場合
組織登録に失敗しました。組織コードは必須項目です。
「組織.組織コード」が256文字より多い場合
組織登録に失敗しました。組織コードは256文字以内で入力してください。
「組織.組織名」が未入力の場合
組織登録に失敗しました。組織名は必須項目です。
「組織.組織名」が256文字より多い場合
組織登録に失敗しました。組織名は256文字以内で入力してください。
「組織.組織名フリガナ」が256文字より多い場合
組織登録に失敗しました。組織名フリガナは256文字以内で入力してください。
「組織.組織名フリガナ」に全角カタカナ以外を入力した場合
組織登録に失敗しました。組織名フリガナは全角カタカナで入力してください。
「組織.所在地」が256文字より多い場合
組織登録に失敗しました。所在地は256文字以内で入力してください。
「組織.業種」が256文字より多い場合
組織登録に失敗しました。業種は256文字以内で入力してください。
「組織.契約種別」が256文字より多い場合
組織登録に失敗しました。契約種別は256文字以内で入力してください。
「組織.上位組織コード」が256文字より多い場合
組織登録に失敗しました。上位組織コードは256文字以内で入力してください。
「組織.組織コード」がすでに存在している組織コードの場合
組織登録に失敗しました。指定した組織コードはすでに存在しています。異なる値を指定してください。
「組織.上位組織コード」が「組織.組織コード」と同じ場合
組織登録に失敗しました。組織コードと同じコードを上位組織コードにはできません。
「組織.上位組織コード」が存在しない場合
組織登録に失敗しました。指定した上位組織は存在しません。
WebAPI:組織を取得する¶
getOrganization¶
組織を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
組織コード |
organizationCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
組織 |
Organization |
conplexType |
組織.組織ID |
id |
Integer |
組織.組織コード |
code |
String |
組織.組織名 |
name |
String |
組織.組織名フリガナ |
furigana |
String |
組織.所在地 |
place |
String |
組織.業種 |
typeOfIndustory |
String |
組織.契約種別 |
contractType |
String |
組織.上位組織ID |
parentId |
Integer |
組織.上位組織コード |
parentCode |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 5 |
message |
String |
- 5
メッセージ一覧
「認証キー」が未指定の場合
組織取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
組織取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
組織取得に失敗しました。認証キーは32文字以内で入力してください。
「組織コード」が未入力の場合
組織取得に失敗しました。組織コードは必須項目です。
「組織コード」が256文字より多い場合
組織取得に失敗しました。組織コードは256文字以内で入力してください。
「組織コード」が存在しない場合
組織取得に失敗しました。指定した組織コードは存在しません。
WebAPI:組織を変更する¶
updateOrganization¶
組織を変更するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
組織 |
Organization |
complexType |
必須 |
組織.組織ID |
id |
Integer |
必須 |
組織.組織コード |
code |
String |
必須 |
組織.組織名 |
name |
String |
必須 |
組織.組織名フリガナ |
furigana |
String |
任意 |
組織.所在地 |
place |
String |
任意 |
組織.業種 |
typeOfIndustory |
String |
任意 |
組織.契約種別 |
contractType |
String |
任意 |
組織.上位組織コード |
parentCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 6 |
message |
String |
- 6
メッセージ一覧
「認証キー」が未指定の場合
組織更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
組織更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
組織更新に失敗しました。認証キーは32文字以内で入力してください。
「組織.組織ID」が未入力の場合
組織更新に失敗しました。組織IDは必須項目です。
「組織.組織ID」が5文字より多い場合
組織更新に失敗しました。組織IDは5文字以内で入力してください。
「組織.組織コード」が未入力の場合
組織更新に失敗しました。組織コードは必須項目です。
「組織.組織コード」が256文字より多い場合
組織更新に失敗しました。組織コードは256文字以内で入力してください。
「組織.組織名」が未入力の場合
組織更新に失敗しました。組織名は必須項目です。
「組織.組織名」が256文字より多い場合
組織更新に失敗しました。組織名は256文字以内で入力してください。
「組織.組織名フリガナ」が256文字より多い場合
組織更新に失敗しました。組織名フリガナは256文字以内で入力してください。
「組織.組織名フリガナ」に全角カタカナ以外を入力した場合
組織更新に失敗しました。組織名フリガナは全角カタカナで入力してください。
「組織.所在地」が256文字より多い場合
組織更新に失敗しました。所在地は256文字以内で入力してください。
「組織.業種」が256文字より多い場合
組織更新に失敗しました。業種は256文字以内で入力してください。
「組織.契約種別」が256文字より多い場合
組織更新に失敗しました。契約種別は256文字以内で入力してください。
「組織.上位組織コード」が256文字より多い場合
組織更新に失敗しました。上位組織コードは256文字以内で入力してください。
「組織.組織ID」が存在しない場合
組織更新に失敗しました。指定した組織IDは存在しません。
「組織.組織コード」がすでに存在している組織コードの場合
組織更新に失敗しました。指定した組織コードはすでに存在しています。異なる値を指定してください。
「組織.組織コード」が「組織.上位組織コード」と同じ場合
組織更新に失敗しました。組織コードと同じコードを上位組織コードにはできません。
「組織.上位組織コード」が存在しない場合
組織更新に失敗しました。指定した上位組織は存在しません。
「組織.上位組織コード」が更新対象組織の下位組織である場合
組織更新に失敗しました。指定した組織は下位組織であるため、上位組織に指定できません。
WebAPI:組織を削除する¶
deleteOrganization¶
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
組織コード |
organizationCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 7 |
message |
String |
- 7
メッセージ一覧
「認証キー」が未指定の場合
組織削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
組織削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
組織削除に失敗しました。認証キーは32文字以内で入力してください。
「組織コード」が未入力の場合
組織削除に失敗しました。組織コードは必須項目です。
「組織コード」が256文字より多い場合
組織削除に失敗しました。組織コードは256文字以内で入力してください。
「組織コード」が存在しない場合
組織削除に失敗しました。指定した組織コードは存在しません。
WebAPI:利用者を登録する¶
registerAccount¶
利用者を登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者 |
Account |
complexType |
必須 |
利用者.利用者ID |
id |
Integer |
*指定しない |
利用者.ログインID |
code |
String |
必須 |
利用者.姓 |
lastName |
String |
必須 |
利用者.名 |
firstName |
String |
必須 |
利用者.eメールアドレス |
email1 |
String |
必須 |
利用者.パスワード |
password |
String |
必須 |
利用者.利用者種別 1:システム管理者 2:運用管理者 3:一般利用者 |
role |
Integer |
必須 |
利用者.ログイン無効 true:ログイン無効にする false:ログイン有効にする |
loginInvalidation |
Boolean |
必須 |
利用者.表示言語 1:日本語 2:英語 3:中国語（簡体字） 4:中国語（繁体字） 5:インドネシア語 |
lang |
Integer |
必須 |
利用者.姓フリガナ |
kanaLastName |
String |
任意 |
利用者.名フリガナ |
kanaFirstName |
String |
任意 |
利用者.照査者ログインID |
superiorAccountCode |
String |
任意 |
利用者.代理処理者ログインID |
proxyAccountCode |
String |
任意 |
利用者.eメールアドレス（携帯電話） |
email2 |
String |
任意 |
利用者.担当業務 |
jobType |
String |
任意 |
利用者.役職 |
post |
String |
任意 |
利用者.資料送付先郵便番号 |
zipCode |
String |
任意 |
利用者.資料送付先住所 |
address1 |
String |
任意 |
利用者.資料送付先住所（番地・ビル名） |
address2 |
String |
任意 |
利用者.電話番号 |
telephone |
String |
任意 |
利用者.所属組織コード |
organizationCode |
String |
任意 |
利用者.組織長識別子 0：組織長でない 1：組織長 |
position |
Integer |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 8 |
message |
String |
- 8
メッセージ一覧
「認証キー」が未指定の場合
利用者登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者登録に失敗しました。認証キーは32文字以内で入力してください。
「利用者.利用者ID」が指定されている場合
利用者登録に失敗しました。登録処理の場合、利用者IDは自動採番しますので省略してください。
「利用者.ログインID」が未指定の場合
利用者登録に失敗しました。ログインIDは必須項目です。
「利用者.ログインID」が128文字より多い場合
利用者登録に失敗しました。ログインIDは128文字以内で入力してください。
「利用者.ログインID」に半角英数字、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を指定した場合
利用者登録に失敗しました。ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.姓」が未指定の場合
利用者登録に失敗しました。姓は必須項目です。
「利用者.姓」が64文字より多い場合
利用者登録に失敗しました。姓は64文字以内で入力してください。
「利用者.名」が未指定の場合
利用者登録に失敗しました。名は必須項目です。
「利用者.名」が64文字より多い場合
利用者登録に失敗しました。名は64文字以内で入力してください。
「利用者.姓フリガナ」が64文字より多い場合
利用者登録に失敗しました。姓（カナ）は64文字以内で入力してください。
「利用者.姓フリガナ」に全角カタカナ以外を入力した場合
利用者登録に失敗しました。姓（カナ）は全角カタカナで入力してください。
「利用者.名フリガナ」が64文字より多い場合
利用者登録に失敗しました。名（カナ）は64文字以内で入力してください。
「利用者.名フリガナ」に全角カタカナ以外を入力した場合
利用者登録に失敗しました。名（カナ）は全角カタカナで入力してください。
「利用者.照査者ログインID」が128文字より多い場合
利用者登録に失敗しました。照査者ログインIDは128文字以内で入力してください。
「利用者.照査者ログインID」に半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を入力した場合
利用者登録に失敗しました。照査者ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.代理処理者ログインID」が128文字より多い場合
利用者登録に失敗しました。代理処理者ログインIDは128文字以内で入力してください。
「利用者.代理処理者ログインID」に半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を入力した場合
利用者登録に失敗しました。代理処理者ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.eメールアドレス」が未入力の場合
利用者登録に失敗しました。eメールアドレスは必須項目です。
「利用者.eメールアドレス」が256文字より多い場合
利用者登録に失敗しました。eメールアドレスは256文字以内で入力してください。
「利用者.eメールアドレス」がメールアドレスとして正しい形式でない場合
利用者登録に失敗しました。eメールアドレスを正しく入力してください。
「利用者.eメールアドレス（携帯電話）」が256文字より多い場合
利用者登録に失敗しました。eメールアドレス2は256文字以内で入力してください。
「利用者.eメールアドレス（携帯電話）」がメールアドレスとして正しい形式でない場合
利用者登録に失敗しました。eメールアドレス2を正しく入力してください。
「利用者.担当業務」が256文字より多い場合
利用者登録に失敗しました。担当業務は256文字以内で入力してください。
「利用者.役職」が256文字より多い場合
利用者登録に失敗しました。役職は256文字以内で入力してください。
「利用者.資料送付先郵便番号」が128文字より多い場合
利用者登録に失敗しました。郵便番号は128文字以内で入力してください。
「利用者.資料送付先郵便番号」に数字とハイフン以外を入力した場合
利用者登録に失敗しました。郵便番号は数字とハイフン（-）を使用してください。
「利用者.資料送付先住所」が128文字より多い場合
利用者登録に失敗しました。住所1は128文字以内で入力してください。
「利用者.資料送付先住所（番地・ビル名）」が128文字より多い場合
利用者登録に失敗しました。住所2は128文字以内で入力してください。
「利用者.パスワード」が64文字より多い場合
利用者登録に失敗しました。パスワードは64文字以内で入力してください。
「利用者.パスワード」がパスワード制約を満たしていない場合
利用者登録に失敗しました。パスワードは～文字以上64文字以下で、英小文字,英大文字,数字,記号(すべて半角)のみ使用可能です。使用できる記号は～です。～のうち～種類以上を使用してください。
「利用者.電話番号」が128文字より多い場合
利用者登録に失敗しました。電話番号は128文字以内で入力してください。
「利用者.電話番号」に数字とハイフン（-）以外を入力した場合
利用者登録に失敗しました。電話番号は数字とハイフン（-）を使用してください。
「利用者.所属組織コード」が256文字より多い場合
利用者登録に失敗しました。所属組織コードは256文字以内で入力してください。
「利用者.利用者種別」が未指定の場合
利用者登録に失敗しました。利用者種別は必須項目です。
「利用者.利用者種別」が1文字より多い場合
利用者登録に失敗しました。利用者種別は1文字以内で入力してください。
「利用者.利用者種別」が1文字だが、1、2、3以外の場合
利用者登録に失敗しました。利用者種別が不正です。
「利用者.ログイン無効」が未指定の場合
利用者登録に失敗しました。ログイン識別子は必須項目です。
「利用者.組織長識別子」が1文字より多い場合
利用者登録に失敗しました。組織長識別子は1文字以内で入力してください。
「利用者.組織長識別子」が0,1以外の場合
利用者登録に失敗しました。組織長識別子が不正です。
「利用者.表示言語」が未指定の場合
利用者登録に失敗しました。表示言語識別子は必須項目です
「利用者.表示言語」が1,2,3,4以外の場合
利用者登録に失敗しました。表示言語識別子が不正です。
「利用者.表示言語」が1,2,3,4以外の場合
利用者登録に失敗しました。表示言語識別子が不正です。
「利用者.ログインID」がすでに存在しているログインIDの場合
利用者登録に失敗しました。指定したログインIDはすでに存在しています。異なる値を指定してください。
「利用者.照査者ログインID」が存在しない場合
利用者登録に失敗しました。指定した照査者は存在しません。
「利用者.照査者ログインID」がログイン無効化された利用者のログインIDだった場合
利用者登録に失敗しました。指定した利用者は照査者に指定できません。
「利用者.代理処理者ログインID」が存在しない場合
利用者登録に失敗しました。指定した代理処理者は存在しません。
「利用者.代理処理者ログインID」がログイン無効化された利用者のログインIDだった場合
利用者登録に失敗しました。指定した利用者は代理処理者に指定できません。
「利用者.所属組織コード」が存在しない場合
利用者登録に失敗しました。指定した所属組織コードは存在しません。
WebAPI:利用者を取得する¶
getAccount¶
利用者を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
利用者 |
Account |
complexType |
利用者.利用者ID |
id |
Integer |
利用者.ログインID |
code |
String |
利用者.姓 |
lastName |
String |
利用者.名 |
firstName |
String |
利用者.姓フリガナ |
kanaLastName |
String |
利用者.名フリガナ |
kanaFirstName |
String |
利用者.照査者ログインID |
superiorAccountCode |
String |
利用者.代理処理者ログインID |
proxyAccountCode |
String |
利用者.eメールアドレス |
email1 |
String |
利用者.eメールアドレス（携帯電話） |
email2 |
String |
利用者.担当業務 |
jobType |
String |
利用者.役職 |
post |
String |
利用者.資料送付先郵便番号 |
zipCode |
String |
利用者.資料送付先住所 |
address1 |
String |
利用者.資料送付先住所（番地・ビル名） |
address2 |
String |
利用者.電話番号 |
telephone |
String |
利用者.所属組織コード |
organizationCode |
String |
利用者.組織長識別子 0：組織長でない 1：組織長 |
position |
Integer |
利用者.利用者種別 1:システム管理者 2:運用管理者 3:一般利用者 |
role |
Integer |
利用者.ログイン無効 |
loginInvalidation |
Boolean |
利用者.表示言語 1:日本語 2:英語 3:中国語（簡体字） 4:中国語（繁体字） 5:インドネシア語 |
lang |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 9 |
message |
String |
- 9
メッセージ一覧
「認証キー」が未指定の場合
利用者取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
利用者取得に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
利用者取得に失敗しました。ログインIDは128文字以内で入力してください。
「ログインID」が存在しない場合
利用者取得に失敗しました。指定した利用者コードは存在しません。
WebAPI:利用者を変更する¶
updateAccount¶
利用者を変更するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者 |
Account |
complexType |
必須 |
利用者.利用者ID |
id |
Integer |
必須 |
利用者.ログインID |
code |
String |
必須 |
利用者.姓 |
lastName |
String |
必須 |
利用者.名 |
firstName |
String |
必須 |
利用者.eメールアドレス |
email1 |
String |
必須 |
利用者.利用者種別 1:システム管理者 2:運用管理者 3:一般利用者 |
role |
Integer |
必須 |
利用者.ログイン無効 true:ログイン無効にする false:ログイン有効にする |
loginInvalidation |
Boolean |
必須 |
利用者.表示言語 1:日本語 2:英語 3:中国語（簡体字） 4:中国語（繁体字） 5:インドネシア語 |
lang |
Integer |
必須 |
利用者.姓フリガナ |
kanaLastName |
String |
任意 |
利用者.名フリガナ |
kanaFirstName |
String |
任意 |
利用者.照査者ログインID |
superiorAccountCode |
String |
任意 |
利用者.代理処理者ログインID |
proxyAccountCode |
String |
任意 |
利用者.eメールアドレス（携帯電話） |
email2 |
String |
任意 |
利用者.担当業務 |
jobType |
String |
任意 |
利用者.役職 |
post |
String |
任意 |
利用者.資料送付先郵便番号 |
zipCode |
String |
任意 |
利用者.資料送付先住所 |
address1 |
String |
任意 |
利用者.資料送付先住所（番地・ビル名） |
address2 |
String |
任意 |
利用者.パスワード |
password |
String |
任意（未指定の場合は更新されない、指定された場合は更新される） |
利用者.電話番号 |
telephone |
String |
任意 |
利用者.所属組織コード |
organizationCode |
String |
任意 |
利用者.組織長識別子 0：組織長でない 1：組織長 |
position |
Integer |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 10 |
message |
String |
- 10
メッセージ一覧
「認証キー」が未指定の場合
利用者更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者更新に失敗しました。認証キーは32文字以内で入力してください。
「利用者.利用者ID」が未指定の場合
利用者更新に失敗しました。利用者IDは必須項目です。
「利用者.利用者ID」の文字数が8文字より多い場合
利用者更新に失敗しました。利用者IDは8文字以内で入力してください。
「利用者.利用者ID」が存在しない場合
利用者更新に失敗しました。指定した利用者IDは存在しません。
「利用者.ログインID」が未指定の場合
利用者更新に失敗しました。ログインIDは必須項目です。
「利用者.ログインID」が128文字より多い場合
利用者更新に失敗しました。ログインIDは128文字以内で入力してください。
「利用者.ログインID」に半角英数字、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を指定した場合
利用者更新に失敗しました。ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.ログインID」がすでに存在しているログインIDの場合
利用者更新に失敗しました。指定したログインIDはすでに存在しています。異なる値を指定してください。
「利用者.姓」が未指定の場合
利用者更新に失敗しました。姓は必須項目です。
「利用者.姓」が64文字より多い場合
利用者更新に失敗しました。姓は64文字以内で入力してください。
「利用者.名」が未指定の場合
利用者更新に失敗しました。名は必須項目です。
「利用者.名」が64文字より多い場合
利用者更新に失敗しました。名は64文字以内で入力してください。
「利用者.姓フリガナ」が64文字より多い場合
利用者更新に失敗しました。姓（カナ）は64文字以内で入力してください。
「利用者.姓フリガナ」に全角カタカナ以外を入力した場合
利用者更新に失敗しました。姓（カナ）は全角カタカナで入力してください。
「利用者.名フリガナ」が64文字より多い場合
利用者更新に失敗しました。名（カナ）は64文字以内で入力してください。
「利用者.名フリガナ」に全角カタカナ以外を入力した場合
利用者更新に失敗しました。名（カナ）は全角カタカナで入力してください。
「利用者.照査者ログインID」が128文字より多い場合
利用者更新に失敗しました。照査者ログインIDは128文字以内で入力してください。
「利用者.照査者ログインID」に半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を入力した場合
利用者更新に失敗しました。照査者ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.代理処理者ログインID」が128文字より多い場合
利用者更新に失敗しました。代理処理者ログインIDは128文字以内で入力してください。
「利用者.代理処理者ログインID」に半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）以外を入力した場合
利用者更新に失敗しました。代理処理者ログインIDは半角英数字か、アンダーバー（_）、ハイフン（-）、ドット（.）、アットマーク（@）をご使用ください。
「利用者.eメールアドレス」が未指定の場合
利用者更新に失敗しました。eメールアドレスは必須項目です。
「利用者.eメールアドレス」が256文字より多い場合
利用者更新に失敗しました。eメールアドレスは256文字以内で入力してください。
「利用者.eメールアドレス」の入力形式がメールアドレスとして正しくない場合
利用者更新に失敗しました。eメールアドレスを正しく入力してください。
「利用者.eメールアドレス（携帯電話）」が256文字より多い場合
利用者更新に失敗しました。eメールアドレス2は256文字以内で入力してください。
「利用者.eメールアドレス（携帯電話）」の入力形式がメールアドレスとして正しくない場合
利用者更新に失敗しました。eメールアドレス2を正しく入力してください。
「利用者.担当業務」が256文字より多い場合
利用者更新に失敗しました。担当業務は256文字以内で入力してください。
「利用者.役職」が256文字より多い場合
利用者更新に失敗しました。役職は256文字以内で入力してください。
「利用者.郵便番号」が128文字より多い場合
利用者更新に失敗しました。郵便番号は128文字以内で入力してください。
「利用者.郵便番号」に数字とハイフン（-）以外を入力した場合
利用者更新に失敗しました。郵便番号は数字とハイフン（-）を使用してください。
「利用者.資料送付先住所」が128文字より多い場合
利用者更新に失敗しました。住所1は128文字以内で入力してください。
「利用者.資料送付先住所（番地・ビル名）」が128文字より多い場合
利用者更新に失敗しました。住所2は128文字以内で入力してください。
「利用者.パスワード」が64文字より多い場合
利用者更新に失敗しました。パスワードは64文字以内で入力してください。
「利用者.パスワード」がパスワード制約を満たしていない場合
利用者更新に失敗しました。パスワードは～文字以上64文字以下で、英小文字,英大文字,数字,記号(すべて半角)のみ使用可能です。使用できる記号は～です。～のうち～種類以上を使用してください。
「利用者.電話番号」が128文字より多い場合
利用者更新に失敗しました。電話番号は128文字以内で入力してください。
「利用者.電話番号」に数字とハイフン（-）以外を入力した場合
利用者更新に失敗しました。電話番号は数字とハイフン（-）を使用してください。
「利用者.所属組織コード」が256文字より多い場合
利用者更新に失敗しました。所属組織コードは256文字以内で入力してください。
「利用者.利用者種別」が未指定の場合
利用者更新に失敗しました。利用者種別は必須項目です。
「利用者.利用者種別」が1文字より多い場合
利用者更新に失敗しました。利用者種別は1文字以内で入力してください。
「利用者.利用者種別」が1,2,3以外の場合
利用者更新に失敗しました。利用者種別が不正です。
「利用者.ログイン無効」が未指定の場合
利用者更新に失敗しました。ログイン識別子は必須項目です。
「利用者.組織長識別子」が1文字より多い場合
利用者更新に失敗しました。組織長識別子は1文字以内で入力してください。
「利用者.組織長識別子」が0,1以外の場合
利用者更新に失敗しました。組織長識別子が不正です。
「利用者.表示言語識別子」が未入力の場合
利用者更新に失敗しました。表示言語識別子は必須項目です。
「利用者.表示言語識別子」が1,2,3,4以外の場合
利用者更新に失敗しました。表示言語識別子が不正です。
「利用者.利用者ID」に10000001を指定し、かつ「利用者.ログイン無効」にtrueを指定した場合
利用者更新に失敗しました。利用者IDが「10000001」の利用者はログイン無効化出来ません。
「利用者.利用者ID」が存在しない場合
利用者更新に失敗しました。指定した利用者IDは存在しません。
「利用者.ログインID」がすでに存在しているログインIDの場合
利用者更新に失敗しました。指定したログインIDはすでに存在しています。異なる値を指定してください。
「利用者.照査者ログインID」が存在しない場合
利用者更新に失敗しました。指定した照査者は存在しません。
「利用者.照査者ログインID」がログイン無効化された利用者のログインIDだった場合(変更前と同じ照査者だった場合を除く):
利用者更新に失敗しました。指定した利用者は照査者に指定できません。
「利用者.代理処理者ログインID」が存在しない場合
利用者更新に失敗しました。指定した代理処理者は存在しません。
「利用者.代理処理者ログインID」がログイン無効化された利用者のログインIDだった場合(変更前と同じ代理処理者だった場合を除く):
利用者更新に失敗しました。指定した利用者は代理処理者に指定できません。
「利用者.所属組織コード」が存在しない場合
利用者更新に失敗しました。指定した所属組織コードは存在しません。
WebAPI:利用者を削除する¶
deleteAccount¶
利用者を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 11 |
message |
String |
- 11
メッセージ一覧
「認証キー」が未指定の場合
利用者削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者削除に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未入力の場合
利用者削除に失敗しました。ログインIDは必須項目です。
「ログインID」が256文字より多い場合
利用者削除に失敗しました。ログインIDは256文字以内で入力してください。
「ログインID」に初期登録されているシステム管理者のログインIDを指定した場合
利用者削除に失敗しました。ログインIDが「system」（初期登録されているシステム管理者のログインID）の利用者は削除出来ません。
「ログインID」が存在しない場合
利用者削除に失敗しました。指定したログインIDは存在しません。
WebAPI:兼務組織を取得する¶
getAnotherOrganization¶
利用者の兼務組織を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
兼務組織 |
AnotherOrganization |
conplexType |
兼務組織.ログインID |
accountCode |
String |
兼務組織.組織コード |
organizationCode |
String |
兼務組織.識別子 0:兼務組織員、1:兼務組織長 |
anotherPosition |
int |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 12 |
message |
String |
- 12
メッセージ一覧
「認証キー」が未指定の場合
兼務組織の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
兼務組織の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
兼務組織の取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未入力の場合
兼務組織の取得に失敗しました。ログインIDは必須項目です。
「ログインID」が存在しない場合
兼務組織の取得に失敗しました。指定した利用者コードは存在しません。
WebAPI:兼務組織を割当する¶
assignAnotherOrganization¶
利用者に兼務組織を割当てるサービスです。識別子(兼務組織員、兼務組織長)を更新する場合にも利用できます。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
兼務組織 |
AnotherOrganization |
complexType |
必須 |
兼務組織.ログインID |
accountCode |
String |
必須 |
兼務組織.組織コード |
organizationCode |
String |
必須 |
兼務組織.識別子 0:兼務組織員、1:兼務組織長 |
anotherPosition |
int |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 13 |
message |
String |
- 13
メッセージ一覧
「認証キー」が未指定の場合
兼務組織の割当てに失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
兼務組織の割当てに失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
兼務組織の割当てに失敗しました。認証キーは32文字以内で入力してください。
「兼務組織.ログインID」が未指定の場合
兼務組織の割当てに失敗しました。ログインIDは必須項目です。
「兼務組織.組織コード」が未指定の場合
兼務組織の割当てに失敗しました。組織コードは必須項目です。
「兼務組織.識別子」が0,1以外の場合
兼務組織の割当てに失敗しました。兼務組織の識別子が不正です。
指定した「兼務組織.ログインID」に紐づく利用者が存在しない場合
兼務組織の割当てに失敗しました。指定したログインIDは存在しません。
指定した「兼務組織.組織コード」に紐づく組織が存在しない場合
兼務組織の割当てに失敗しました。指定した組織コードは存在しません。
指定した「兼務組織.ログインID」と「兼務組織.組織コード」が既に組織員、または組織長として登録されている場合
兼務組織の割当てに失敗しました。指定した組織コードは既に組織員、または組織長として割当てられています。
WebAPI:兼務組織を削除する¶
deleteAnotherOrganization¶
利用者の兼務組織を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
組織コード |
organizationCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
- なし※兼務組織が割り当たっていない兼務組織の削除処理を行った場合、何も処理を行わず終了します。
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 14 |
message |
String |
- 14
メッセージ一覧
「認証キー」が未指定の場合
兼務組織の削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
兼務組織の削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
兼務組織の削除に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
兼務組織の削除に失敗しました。ログインIDは必須項目です。
「ログインID」が存在しない場合
兼務組織の削除に失敗しました。指定したログインIDは存在しません。
「組織コード」が未指定の場合
兼務組織の削除に失敗しました。組織コードは必須項目です。
「組織コード」が存在しない場合
兼務組織の削除に失敗しました。組織コードは存在しません。
WebAPI:受講申込しているクラスを取得する¶
getSubscriptionLearner¶
受講申込しているクラスを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講申込 ＊繰り返しあり |
Learner |
complexType |
受講申込.研修受講者ID |
learnerId |
Integer |
受講申込.開催番号 |
classCode |
String |
受講申込.クラス名 |
className |
String |
受講申込.申込状況 |
subscriptionStatus |
Integer |
受講申込.申込年月日 |
subscriptionDate |
Date |
受講申込.申込者ログインID |
subscriptionAccountCode |
String |
受講申込.受講者ログインID |
learnerAccountCode |
String |
受講申込.照査者ログインID |
approvalAccountCode |
String |
受講申込.申込タイプ 1:受講者本人 2:代理処理者 3:クラス管理者 |
subscriptionType |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 15 |
message |
String |
- 15
メッセージ一覧
「認証キー」が未指定の場合
受講申込しているクラスの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講申込しているクラスの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講申込しているクラスの取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
受講申込しているクラスの取得に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
受講申込しているクラスの取得に失敗しました。ログインIDは128文字以内で入力してください。
「ログインID」が存在しない場合
受講申込しているクラスの取得に失敗しました。指定した利用者コードは存在しません。
WebAPI:キャンセルされた受講申込を取得する¶
getCanceledSubscription¶
検索範囲の期間にキャンセルされた受講申込を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
検索範囲（開始日） |
start |
Date |
必須 |
検索範囲（終了日） |
end |
Date |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
キャンセルされた受講申込 ＊繰り返しあり |
CancelLearner |
complexType |
キャンセルされた受講申込.キャンセルID |
id |
Integer |
キャンセルされた受講申込.開催番号 |
classCode |
String |
キャンセルされた受講申込.クラス名 |
className |
String |
キャンセルされた受講申込.クラス開始日 |
startDate |
Date |
キャンセルされた受講申込.クラス終了日 |
endDate |
Date |
キャンセルされた受講申込.申込受付開始日時 |
subscriptionStartDate |
Date |
キャンセルされた受講申込.申込受付終了日時 |
subscriptionEndDate |
Date |
キャンセルされた受講申込.キャンセル日時 |
cancelDate |
Date |
キャンセルされた受講申込.キャンセル処理者ログインID |
cancelerAccountCode |
String |
キャンセルされた受講申込.キャンセル対象者ログインID |
canceledAccountCode |
String |
キャンセルされた受講申込.申込状況 1:照査待ち 2:受講確定待ち 3:受講確定 |
subscriptionStatus |
Integer |
キャンセルされた受講申込.受講申込日時 |
subscriptionDate |
Date |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 16 |
message |
String |
- 16
メッセージ一覧
「認証キー」が未指定の場合
キャンセルされた受講申込の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
キャンセルされた受講申込の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
キャンセルされた受講申込の取得に失敗しました。認証キーは32文字以内で入力してください。
「検索範囲（開始日）」が未指定の場合
キャンセルされた受講申込の取得に失敗しました。検索範囲（開始）は必須項目です。
「検索範囲（開始日）」が年月日形式の書式でない場合
キャンセルされた受講申込の取得に失敗しました。検索範囲（開始）の年月日を正しく入力してください。
「検索範囲（終了日）」が未指定の場合
キャンセルされた受講申込の取得に失敗しました。検索範囲（終了）は必須項目です。
「検索範囲（終了日）」が年月日形式の書式でない場合
キャンセルされた受講申込の取得に失敗しました。検索範囲（終了）の年月日を正しく入力してください。
「検索範囲（終了日）」が「検索範囲（開始日）」より前の日付の場合
キャンセルされた受講申込の取得に失敗しました。検索終了日は検索開始日より後の日付を指定してください。
WebAPI:講師/アシスタントを取得する（利用者指定）¶
getLecturer¶
ログインIDを指定して講師/アシスタントを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
任意（ログインID未指定の場合はシステムに登録されている講師/アシスタントを全件取得します。） |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
講師 ＊繰り返しあり |
Lecturer |
complexType |
講師.開催番号 |
classCode |
String |
講師.ログインID |
accountCode |
String |
講師.役割 1:講師 2:アシスタント |
classRole |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 17 |
message |
String |
- 17
メッセージ一覧
「認証キー」が未指定の場合
講師/アシスタントの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
講師/アシスタントの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
講師/アシスタントの取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が128文字より多い場合
講師/アシスタントの取得に失敗しました。ログインIDは128文字以内で入力してください。
「ログインID」が存在しない場合
講師/アシスタントの取得に失敗しました。指定した利用者コードは存在しません。
WebAPI:講師/アシスタントを取得する（クラス指定）¶
getLecturerByClassCode¶
開催番号を指定して講師/アシスタントを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
講師 ＊繰り返しあり |
Lecturer |
complexType |
講師.開催番号 |
classCode |
String |
講師.ログインID |
accountCode |
String |
講師.役割 1:講師 2:アシスタント |
classRole |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 18 |
message |
String |
- 18
メッセージ一覧
「認証キー」が未指定の場合
講師/アシスタントの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
講師/アシスタントの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
講師/アシスタントの取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未入力の場合
講師/アシスタントの取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
講師/アシスタントの取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
講師/アシスタントの取得に失敗しました。指定した開催番号は存在しません。
WebAPI:講師/アシスタントを登録する¶
addLecturer¶
講師/アシスタントを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
ログインID |
lecturerAccountCode |
String |
必須 |
役割 1:講師 2:アシスタント |
role |
Integer |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 19 |
message |
String |
- 19
メッセージ一覧
「認証キー」が未指定の場合
講師/アシスタントの追加に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
講師/アシスタントの追加に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
講師/アシスタントの追加に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未入力の場合
講師/アシスタントの追加に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
講師/アシスタントの追加に失敗しました。開催番号は256文字以内で入力してください。
「ログインID」が未入力の場合
講師/アシスタントの追加に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
講師/アシスタントの追加に失敗しました。ログインIDは128文字以内で入力してください。
「役割」が未入力の場合
講師/アシスタントの追加に失敗しました。役割は必須項目です。
「役割」が1、2以外の場合
講師/アシスタントの追加に失敗しました。役割の識別子が不正です。
「開催番号」が存在しない場合
講師/アシスタントの追加に失敗しました。指定した開催番号は存在しません。
「ログインID」が存在しない場合
講師/アシスタントの追加に失敗しました。指定した利用者コードは存在しません。
「ログインID」がログイン無効化された利用者のログインIDだった場合
講師/アシスタントの追加に失敗しました。指定した利用者は講師/アシスタントに指定できません。
「ログインID」が対象クラスの講師あるいはアシスタントのログインIDだった場合
講師/アシスタントの追加に失敗しました。指定したログインIDは、この研修の講師またはアシスタントです。
「ログインID」が対象クラスの受講者のログインIDだった場合
講師/アシスタントの追加に失敗しました。指定したログインIDは、このクラスの受講者です。
WebAPI:講師/アシスタントを削除する¶
deleteLecturer¶
講師/アシスタントを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
ログインID |
lecturerAccountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 20 |
message |
String |
- 20
メッセージ一覧
「認証キー」が未指定の場合
講師/アシスタントの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
講師/アシスタントの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
講師/アシスタントの削除に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未入力の場合
講師/アシスタントの削除に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
講師/アシスタントの削除に失敗しました。開催番号は256文字以内で入力してください。
「ログインID」が未入力の場合
講師/アシスタントの削除に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
講師/アシスタントの削除に失敗しました。ログインIDは128文字以内で入力してください。
「開催番号」が存在しない場合
講師/アシスタントの削除に失敗しました。指定した開催番号は存在しません。
「ログインID」が存在しない場合
講師/アシスタントの削除に失敗しました。指定した利用者コードは存在しません。
「ログインID」が対象クラスの講師、アシスタントいずれでもない場合
講師/アシスタントの削除に失敗しました。削除しようとしたログインIDは講師、アシスタントいずれにも登録されていませんでした。
WebAPI:クラスを取得する¶
getClass¶
クラスを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
クラス |
Class |
complexType |
クラス.クラスID |
id |
Integer |
クラス.開催番号 |
code |
String |
クラス.クラス名 |
name |
String |
クラス.開始日 |
startDate |
Date |
クラス.終了日 |
endDate |
Date |
クラス.受付開始日時 |
subscriptionStartDate |
Date |
クラス.受付終了日時 |
subscriptionEndDate |
Date |
クラス.定員 |
capacity |
Integer |
クラス.開催場所 |
classroom |
String |
クラス.研修時間 |
hour |
String |
クラス.所属コースコード |
courseCode |
String |
クラス.クラス管理者ログインIDリスト |
classAdminCodeList |
List<String> |
クラス.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
クラス.受講確定要否 true:受講確定必要 false:受講確定不要 |
confirmation |
Boolean |
クラス.照査者による申込キャンセル可否 true:可能 false:不可能 |
cancelable |
Boolean |
クラス.実施先タイプ 1:利用者 2:組織 3:利用者属性（AND条件） 4:利用者属性（OR条件） |
assignType |
Integer |
クラス.学習形態 |
learningStyle |
String |
クラス.オンライン会議URL |
trainingLink |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 21 |
message |
String |
- 21
メッセージ一覧
「認証キー」が未指定の場合
クラスの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラスの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラスの取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラスの取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラスの取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラスの取得に失敗しました。指定した開催番号は存在しません。
WebAPI:クラスを全件取得する¶
getAllClass¶
クラスを全件取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
クラス ＊繰り返しあり |
Class |
complexType |
クラス.クラスID |
id |
Integer |
クラス.開催番号 |
code |
String |
クラス.クラス名 |
name |
String |
クラス.開始日 |
startDate |
Date |
クラス.終了日 |
endDate |
Date |
クラス.受付開始日時 |
subscriptionStartDate |
Date |
クラス.受付終了日時 |
subscriptionEndDate |
Date |
クラス.定員 |
capacity |
Integer |
クラス.開催場所 |
classroom |
String |
クラス.研修時間 |
hour |
String |
クラス.所属コースコード |
courseCode |
String |
クラス.クラス管理者ログインIDリスト |
classAdminCodeList |
List<String> |
クラス.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
クラス.受講確定要否 true:受講確定必要 false:受講確定不要 |
confirmation |
Boolean |
クラス.照査者による申込キャンセル可否 true:可能 false:不可能 |
cancelable |
Boolean |
クラス.実施先タイプ 1:利用者 2:組織 3:利用者属性（AND条件） 4:利用者属性（OR条件） |
assignType |
Integer |
クラス.学習形態 |
learningStyle |
String |
クラス.オンライン会議URL |
trainingLink |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 22 |
message |
String |
- 22
メッセージ一覧
「認証キー」がの場合
クラス全件取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス全件取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス全件取得に失敗しました。認証キーは32文字以内で入力してください。
WebAPI:クラスを登録する¶
registerClass¶
クラスを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
クラス |
Class |
complexType |
必須 |
クラス.クラスID |
id |
Integer |
*指定しない |
クラス.開催番号 |
code |
String |
必須 |
クラス.クラス名 |
name |
String |
必須 |
クラス.開始日 |
startDate |
Date |
必須 |
クラス.終了日 |
endDate |
Date |
必須 |
クラス.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
必須 |
クラス.受付開始日時 |
subscriptionStartDate |
Date |
任意 |
クラス.受付終了日時 |
subscriptionEndDate |
Date |
任意 |
クラス.定員 |
capacity |
Integer |
任意 |
クラス.開催場所 |
classroom |
String |
任意 |
クラス.研修時間 |
hour |
String |
任意 |
クラス.所属コースコード |
courseCode |
String |
任意 |
クラス.受講確定要否 true:受講確定必要 false:受講確定不要 |
confirmation |
Boolean |
必須 |
クラス.照査者による申込キャンセル可否 true:可能 false:不可能 |
cancelable |
Boolean |
必須 |
クラス.実施先タイプ 1:利用者 2:組織 3:利用者属性（AND条件） 4:利用者属性（OR条件） |
assignType |
Integer |
必須 |
クラス.学習形態 |
learningStyle |
String |
任意 |
クラス.クラス管理者ログインIDリスト |
classAdminCodeList |
List<String> |
任意 |
クラス.オンライン会議URL |
trainingLink |
String |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 23 |
message |
String |
- 23
メッセージ一覧
「認証キー」が未指定の場合
クラスの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラスの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラスの登録に失敗しました。認証キーは32文字以内で入力してください。
「クラス.開催番号」が未指定の場合
クラスの登録に失敗しました。開催番号は必須項目です。
「クラス.開催番号」が256文字より多い場合
クラスの登録に失敗しました。開催番号は256文字以内で入力してください。
「クラス.クラス名」が未指定の場合
クラスの登録に失敗しました。クラス名は必須項目です。
「クラス.クラス名」が256文字より多い場合
クラスの登録に失敗しました。クラス名は256文字以内で入力してください。
「クラス.クラスタイプ」が未指定の場合
クラスの登録に失敗しました。クラスタイプは必須項目です。
「クラス.クラスタイプ」が1、2以外の場合
クラスの登録に失敗しました。クラスタイプの識別子が不正です。
「クラス.受講確定要否」が未指定の場合
クラスの登録に失敗しました。受講確定要否は必須項目です。
「クラス.実施先タイプ」が未指定の場合
クラスの登録に失敗しました。実施先タイプは必須項目です。
「クラス.実施先タイプ」が1、2、3以外の場合
クラスの登録に失敗しました。実施先タイプの識別子が不正です。
「クラス.照査者による申込キャンセル可否」が未指定の場合
クラスの登録に失敗しました。照査者による受講申込キャンセル可否は必須項目です。
「クラス.開始日」が未指定の場合
クラスの登録に失敗しました。開始日は必須項目です。
「クラス.開始日」が年月日形式の書式でない場合
クラスの登録に失敗しました。クラスの年月日を正しく入力してください。
「クラス.終了日」が未指定の場合
クラスの登録に失敗しました。終了日は必須項目です。
「クラス.終了日」が年月日形式の書式でない場合
クラスの登録に失敗しました。終了日の年月日を正しく入力してください。
「クラス.終了日」が「クラス.開始日」よりも前の日付の場合
クラスの登録に失敗しました。終了日は開始日より後の日付を指定してください。
「クラス.受付終了日時」が「クラス.受付開始日時」よりも前の日付の場合
クラスの登録に失敗しました。終了日は開始日より後の日付を指定してください。
「クラス.受付終了日時」が「クラス.終了日」よりも後の日付の場合
クラスの登録に失敗しました。受講申込終了日は研修終了日よりも前の日付を指定してください。
「クラス.開催場所」が256文字より多い場合
クラスの登録に失敗しました。開催場所は256文字以内で入力してください。
「クラス.研修時間」が256文字より多い場合
クラスの登録に失敗しました。研修時間は256文字以内で入力してください。
「クラス.学習形態」が256文字より多い場合
クラスの登録に失敗しました。学習形態は256文字以内で入力してください。
「クラス.所属コースコード」が256文字より多い場合
クラスの登録に失敗しました。所属コースコードは256文字以内で入力してください。
「クラス.クラス管理者ログインIDリスト」のログインIDが128文字より多い場合
クラスの登録に失敗しました。クラス管理者コードは128文字以内で入力してください。
「クラス.クラス管理者ログインIDリスト」のログインIDが存在しない場合
クラスの登録に失敗しました。指定したクラス管理者コードは存在しません。
「クラス.開催番号」がすでに存在している開催番号の場合
クラスの登録に失敗しました。指定した開催番号はすでに存在しています。異なる値を指定してください。
「クラス.所属コースコード」のコースが存在しない場合
クラスの登録に失敗しました。指定したコースコードは存在しません。
「クラス.所属コースコード」で指定したコースがオープン申込可で、クラスの受講対象に組織が指定されている場合
クラスの登録に失敗しました。組織を受講対象とする場合は、所属コースとしてオープン申込可のコースは指定できません。
「クラス.所属コースコード」で指定したコースが代理申込可で、クラスの受講対象に組織が指定されている場合
クラスの登録に失敗しました。組織を受講対象とする場合は、所属コースとして代理申込可のコースは指定できません。
「クラス.受講確定要否」が受講確定必要で、クラスの受講対象に組織が指定されている場合
クラスの登録に失敗しました。組織を受講対象とする場合は、受講確定必要にすることはできません。
「クラス.照査者による申込キャンセル可否」が可能で、クラスの受講対象に組織が指定されている場合
クラスの登録に失敗しました。組織を受講対象とする場合は、照査者によるキャンセルを可にすることはできません。
「クラス.所属コースコード」で指定したコースがオープン申込可で、クラスの受講対象に利用者属性が指定されている場合
クラスの登録に失敗しました。利用者属性を受講対象とする場合は、所属コースとしてオープン申込可のコースは指定できません。
「クラス.所属コースコード」で指定したコースが代理申込可で、クラスの受講対象に利用者属性が指定されている場合
クラスの登録に失敗しました。利用者属性を受講対象とする場合は、所属コースとして代理申込可のコースは指定できません。
「クラス.受講確定要否」が受講確定必要で、クラスの受講対象に利用者属性が指定されている場合
クラスの登録に失敗しました。利用者属性を受講対象とする場合は、受講確定必要にすることはできません。
「クラス.照査者による申込キャンセル可否」が可能で、クラスの受講対象に利用者属性が指定されている場合
クラスの登録に失敗しました。利用者属性を受講対象とする場合は、照査者によるキャンセルを可にすることはできません。
「クラス.オンライン会議URL」の値がhttp://またはhttps://で始まらない場合
クラスの登録に失敗しました。オンライン会議URLは、「http://」もしくは「https://」から始まるようにしてください。
WebAPI:クラスを更新する¶
updateClass¶
クラスを更新するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
クラス |
Class |
complexType |
必須 |
クラス.クラスID |
id |
Integer |
必須 |
クラス.開催番号 |
code |
String |
必須 |
クラス.クラス名 |
name |
String |
必須 |
クラス.開始日 |
startDate |
Date |
必須 |
クラス.終了日 |
endDate |
Date |
必須 |
クラス.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
必須 |
クラス.受付開始日時 |
subscriptionStartDate |
Date |
任意 |
クラス.受付終了日時 |
subscriptionEndDate |
Date |
任意 |
クラス.定員 |
capacity |
Integer |
任意 |
クラス.開催場所 |
classroom |
String |
任意 |
クラス.研修時間 |
hour |
String |
任意 |
クラス.学習形態 |
learningStyle |
String |
任意 |
クラス.所属コースコード |
courseCode |
String |
任意 |
クラス.受講確定要否 true:受講確定必要 false:受講確定不要 |
confirmation |
Boolean |
必須 |
クラス.照査者による申込キャンセル可否 true:可能 false:不可能 |
cancelable |
Boolean |
必須 |
クラス.実施先タイプ 1:利用者 2:組織 3:利用者属性（AND条件） 4:利用者属性（OR条件） |
assignType |
Integer |
必須 |
クラス.クラス管理者ログインIDリスト |
classAdminCodeList |
List<String> |
任意 |
クラス.オンライン会議URL |
trainingLink |
String |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 24 |
message |
String |
- 24
メッセージ一覧
「認証キー」が未指定の場合
クラスの更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラスの更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラスの更新に失敗しました。認証キーは32文字以内で入力してください。
「クラス.クラスID」が未指定の場合
クラスの更新に失敗しました。クラスIDは必須項目です。
「クラス.開催番号」が未指定の場合
クラスの更新に失敗しました。開催番号は必須項目です。
「クラス.開催番号」が256文字より多い場合
クラスの更新に失敗しました。開催番号は256文字以内で入力してください。
「クラス.クラス名」が未指定の場合
クラスの更新に失敗しました。クラス名は必須項目です。
「クラス.クラス名」が256文字より多い場合
クラスの更新に失敗しました。クラス名は256文字以内で入力してください。
「クラス.クラスタイプ」が未指定の場合
クラスの更新に失敗しました。クラスタイプは必須項目です。
「クラス.クラスタイプ」が1、2以外の場合
クラスの更新に失敗しました。クラスタイプの識別子が不正です。
「クラス.受講確定要否」が未指定の場合
クラスの更新に失敗しました。受講確定要否は必須項目です。
「クラス.実施先タイプ」が未指定の場合
クラスの更新に失敗しました。実施先タイプは必須項目です。
「クラス.実施先タイプ」が1、2、3以外の場合
クラスの更新に失敗しました。実施先タイプの識別子が不正です。
「クラス.照査者による申込キャンセル可否」が未指定の場合
クラスの更新に失敗しました。照査者による受講申込キャンセル可否は必須項目です。
「クラス.開始日」が未指定の場合
クラスの更新に失敗しました。開始日は必須項目です。
「クラス.開始日」が年月日形式の書式でない場合
クラスの更新に失敗しました。クラスの年月日を正しく入力してください。
「クラス.終了日」が未指定の場合
クラスの更新に失敗しました。終了日は必須項目です。
「クラス.終了日」が年月日形式の書式でない場合
クラスの更新に失敗しました。終了日の年月日を正しく入力してください。
「クラス.終了日」が「クラス.開始日」よりも前の日付の場合
クラスの更新に失敗しました。終了日は開始日より後の日付を指定してください。
「クラス.受付終了日時」が「クラス.受付開始日時」よりも後の日付の場合
クラスの更新に失敗しました。終了日は開始日より後の日付を指定してください。
「クラス.受付終了日時」が「クラス.終了日」よりも後の日付の場合
クラスの登録に失敗しました。受講申込終了日は研修終了日よりも前の日付を指定してください。
「クラス.開催場所」が256文字より多い場合
クラスの更新に失敗しました。開催場所は256文字以内で入力してください。
「クラス.研修時間」が256文字より多い場合
クラスの更新に失敗しました。研修時間は256文字以内で入力してください。
「クラス.学習形態」が256文字より多い場合
クラスの更新に失敗しました。学習形態は256文字以内で入力してください。
「クラス.所属コースコード」が256文字より多い場合
クラスの更新に失敗しました。所属コースコードは256文字以内で入力してください。
「クラス.クラス管理者ログインIDリスト」のログインIDが128文字より多い場合
クラスの更新に失敗しました。所属コースコードは128文字以内で入力してください。
「クラス.クラスID」が存在しない場合
クラスの更新に失敗しました。指定したクラスIDは存在しません。
「クラス.所属コースコード」が存在しない場合
クラスの更新に失敗しました。指定した所属コースコードは存在しません。
「クラス.受講確定要否」が受講確定必要で、クラスの受講対象に組織が指定されている場合
クラスの更新に失敗しました。組織を受講対象とする場合は、受講確定必要にすることはできません。
「クラス.照査者による申込キャンセル可否」が可能で、クラスの受講対象に組織が指定されている場合
クラスの更新に失敗しました。組織を受講対象とする場合は、照査者によるキャンセルを可にすることはできません。
「クラス.所属コースコード」で指定したコースがオープン申込可で、クラスの受講対象に組織が指定されている場合
クラスの更新に失敗しました。組織を受講対象とする場合は、所属コースとしてオープン申込可のコースは指定できません。
「クラス.所属コースコード」で指定したコースが代理申込可で、クラスの受講対象に組織が指定されている場合
クラスの更新に失敗しました。組織を受講対象とする場合は、所属コースとして代理申込可のコースは指定できません。
クラスの実施先を組織に変更する際に、既に受講者が登録されている場合
クラスの更新に失敗しました。クラスに受講者が存在するため、組織を受講対象に指定できません。
クラスの実施先を組織に変更する際に、既に実施先の利用属性情報が指定されている場合
クラスの更新に失敗しました。クラスに受講対象の利用者属性情報が存在するため、クラスの受講対象を利用者属性から変更することはできません。
「クラス.受講確定要否」が受講確定必要で、クラスの受講対象に利用者属性が指定されている場合
クラスの更新に失敗しました。利用者属性を受講対象とする場合は、受講確定必要にすることはできません。
「クラス.照査者による申込キャンセル可否」が可能で、クラスの受講対象に利用者属性が指定されている場合
クラスの更新に失敗しました。利用者属性を受講対象とする場合は、照査者によるキャンセルを可にすることはできません。
「クラス.所属コースコード」で指定したコースがオープン申込可で、クラスの受講対象に利用者属性が指定されている場合
クラスの更新に失敗しました。利用者属性を受講対象とする場合は、所属コースとしてオープン申込可のコースは指定できません。
「クラス.所属コースコード」で指定したコースが代理申込可で、クラスの受講対象に利用者属性が指定されている場合
クラスの更新に失敗しました。利用者属性を受講対象とする場合は、所属コースとして代理申込可のコースは指定できません。
クラスの実施先を利用者属性に変更する際に、既に受講者が登録されている場合
クラスの更新に失敗しました。クラスに受講者が存在するため、利用者属性を受講対象に指定できません。
クラスの実施先を利用者属性に変更する際に、既に実施先の利用者属性情報が指定されている場合
クラスの更新に失敗しました。クラスに受講対象の組織情報が存在するため、クラスの受講対象を組織から変更することはできません。
クラスの実施先を利用者に変更する際に、既に実施先の組織情報が指定されている場合
クラスの更新に失敗しました。クラスに受講対象の組織情報が存在するため、クラスの受講対象を組織から変更することはできません。
クラスの実施先を利用者に変更する際に、既に実施先の利用者属性情報が指定されている場合
クラスの更新に失敗しました。クラスに受講対象の利用者属性情報が存在するため、クラスの受講対象を利用者属性から変更することはできません。
「クラス.クラス管理者ログインIDリスト」のログインIDが存在しない場合
クラスの更新に失敗しました。指定したクラス管理者コードは存在しません。
「クラス.オンライン会議URL」の値がhttp://またはhttps://で始まらない場合
クラスの更新に失敗しました。オンライン会議URLは、「http://」もしくは「https://」から始まるようにしてください。
WebAPI:クラスを削除する¶
deleteClass¶
クラスを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 25 |
message |
String |
- 25
メッセージ一覧
「認証キー」が未指定の場合
クラスの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラスの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラスの削除に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラスの削除に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラスの削除に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラスの削除に失敗しました。指定した開催番号は存在しません。
WebAPI:クラス実施先組織マップを取得する¶
getClassOrganizationMap¶
クラス実施先組織マップを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
クラス実施先組織マップ |
ClassOrganizationMap |
complexType |
クラス実施先組織マップ.開催番号 |
classCode |
String |
クラス実施先組織マップ.組織コード |
organizationCode |
String |
クラス実施先組織マップ.下位組織含む |
includeSuborganization |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 26 |
message |
String |
- 26
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先組織マップの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先組織マップの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先組織マップの取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラス実施先組織マップの取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラス実施先組織マップの取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラス実施先組織マップの取得に失敗しました。指定した開催番号は存在しません。
WebAPI:クラス実施先組織マップを登録する¶
registerClassOrganizationMap¶
クラス実施先組織マップを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
クラス実施先組織マップ |
ClassOrganizationMap |
complexType |
必須 |
クラス実施先組織マップ.開催番号 |
classCode |
String |
必須 |
クラス実施先組織マップ.組織コード |
organizationCode |
String |
必須 |
クラス実施先組織マップ.下位組織含む |
includeSuborganization |
Boolean |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 27 |
message |
String |
- 27
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先組織マップの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先組織マップの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先組織マップの登録に失敗しました。認証キーは32文字以内で入力してください。
「クラス実施先組織マップ.開催番号」が未指定の場合
クラス実施先組織マップの登録に失敗しました。開催番号は必須項目です。
「クラス実施先組織マップ.開催番号」が256文字より多い場合
クラス実施先組織マップの登録に失敗しました。開催番号は256文字以内で入力してください。
「クラス実施先組織マップ.開催番号」が存在しない場合
クラス実施先組織マップの登録に失敗しました。指定した開催番号は存在しません。
「クラス実施先組織マップ.開催番号」で指定したクラスの実施先が組織でない場合
クラス実施先組織マップの登録に失敗しました。指定した開催番号のクラスの実施先は組織ではありません。
「クラス実施先組織マップ.組織コード」が未指定の場合
クラス実施先組織マップの登録に失敗しました。組織コードは必須項目です。
「クラス実施先組織マップ.組織コード」が256文字より多い場合
クラス実施先組織マップの登録に失敗しました。組織コードは256文字以内で入力してください。
「クラス実施先組織マップ.組織コード」が存在しない場合
クラス実施先組織マップの登録に失敗しました。指定した組織コードは存在しません。
「クラス実施先組織マップ.下位組織含む」が未指定の場合
クラス実施先組織マップの登録に失敗しました。下位組織含むは必須項目です。
指定した組織が、既に指定したクラスの実施先に登録されている場合
クラス実施先組織マップの登録に失敗しました。指定した組織コードは既に指定した開催番号のクラスの実施先に登録されています。
WebAPI:クラス実施先組織マップを削除する¶
deleteClassOrganizationMap¶
クラス実施先組織マップを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
組織コード |
organizationCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 28 |
message |
String |
- 28
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先組織マップの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先組織マップの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先組織マップの削除に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラス実施先組織マップの削除に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラス実施先組織マップの削除に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラス実施先組織マップの削除に失敗しました。指定した開催番号は存在しません。
「組織コード」が未指定の場合
クラス実施先組織マップの削除に失敗しました。組織コードは必須項目です。
「組織コード」が256文字より多い場合
クラス実施先組織マップの削除に失敗しました。組織コードは256文字以内で入力してください。
「組織コード」が存在しない場合
クラス実施先組織マップの削除に失敗しました。指定した組織コードは存在しません。
指定した組織が、指定したクラスの実施先ではない場合
クラス実施先組織マップの削除に失敗しました。指定した組織コードは指定した開催番号のクラスの実施先に指定されていません。
WebAPI:クラス実施先利用者属性マップを取得する¶
getClassAttributeMap¶
クラス実施先利用者属性マップを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
クラス実施先利用者属性マップ |
ClassAttributeMap |
complexType |
クラス実施先利用者属性マップ.開催番号 |
classCode |
String |
クラス実施先利用者属性マップ.利用者属性コード |
attributeCode |
String |
クラス実施先利用者属性マップ.属性項目コード |
typeCode |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 29 |
message |
String |
- 29
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先利用者属性マップの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先利用者属性マップの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先利用者属性マップの取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラス実施先利用者属性マップの取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラス実施先利用者属性マップの取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラス実施先利用者属性マップの取得に失敗しました。指定した開催番号は存在しません。
WebAPI:クラス実施先利用者属性マップを登録する¶
registerClassAttributeMap¶
クラス実施先利用者属性マップを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
クラス実施先利用者属性マップ |
ClassAttributeMap |
complexType |
必須 |
クラス実施先利用者属性マップ.開催番号 |
classCode |
String |
必須 |
クラス実施先利用者属性マップ.利用者属性コード |
attributeCode |
String |
必須 |
クラス実施先利用者属性マップ.属性項目コード |
typeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 30 |
message |
String |
- 30
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先利用者属性マップの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先利用者属性マップの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先利用者属性マップの登録に失敗しました。認証キーは32文字以内で入力してください。
「クラス実施先利用者属性マップ.開催番号」が未指定の場合
クラス実施先利用者属性マップの登録に失敗しました。開催番号は必須項目です。
「クラス実施先利用者属性マップ.開催番号」が256文字より多い場合
クラス実施先利用者属性マップの登録に失敗しました。開催番号は256文字以内で入力してください。
「クラス実施先利用者属性マップ.開催番号」が存在しない場合
クラス実施先利用者属性マップの登録に失敗しました。指定した開催番号は存在しません。
「クラス実施先利用者属性マップ.開催番号」で指定したクラスの実施先が利用者属性でない場合
クラス実施先利用者属性マップの登録に失敗しました。指定した開催番号のクラスの実施先は利用者属性ではありません。
「クラス実施先利用者属性マップ.利用者属性コード」が未指定の場合
クラス実施先利用者属性マップの登録に失敗しました。利用者属性コードは必須項目です。
「クラス実施先利用者属性マップ.利用者属性コード」が存在しない場合
クラス実施先利用者属性マップの登録に失敗しました。指定した利用者属性コードは存在しません。
「クラス実施先利用者属性マップ.属性項目コード」が未指定の場合
クラス実施先利用者属性マップの登録に失敗しました。指定した属性項目コードは必須項目です。
「クラス実施先利用者属性マップ.属性項目コード」が存在しない場合
クラス実施先利用者属性マップの登録に失敗しました。指定した属性項目コードは存在しません。
「クラス実施先利用者属性マップ.属性項目コード」が既に指定されている場合
クラス実施先利用者属性マップの登録に失敗しました。指定した属性項目コードは既に指定した開催番号のクラスの実施先に登録されています。
WebAPI:クラス実施先利用者属性マップを削除する¶
deleteClassAttributeMap¶
クラス実施先利用者属性マップを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
利用者属性コード |
attributeCode |
String |
必須 |
属性項目コード |
typeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 31 |
message |
String |
- 31
メッセージ一覧
「認証キー」が未指定の場合
クラス実施先利用者属性マップの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
クラス実施先利用者属性マップの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
クラス実施先利用者属性マップの削除に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
クラス実施先利用者属性マップの削除に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
クラス実施先利用者属性マップの削除に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
クラス実施先利用者属性マップの削除に失敗しました。指定した開催番号は存在しません。
「クラス実施先利用者属性マップ.利用者属性コード」が未指定の場合
クラス実施先利用者属性マップの削除に失敗しました。利用者属性コードは必須項目です。
「クラス実施先利用者属性マップ.利用者属性コード」が存在しない場合
クラス実施先利用者属性マップの削除に失敗しました。指定した利用者属性コードは存在しません。
「クラス実施先利用者属性マップ.属性項目コード」が未指定の場合
クラス実施先利用者属性マップの削除に失敗しました。指定した属性項目コードは必須項目です。
「クラス実施先利用者属性マップ.属性項目コード」が存在しない場合
クラス実施先利用者属性マップの削除に失敗しました。指定した属性項目コードは存在しません。
「クラス実施先利用者属性マップ.属性項目コード」がクラスに指定されていない場合
クラス実施先利用者属性マップの削除に失敗しました。指定した属性項目コードは指定した開催番号のクラスの実施先に登録されていません。
WebAPI:コースを取得する¶
getCourse¶
コースを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
コースコード |
courseCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
コース |
Course |
complexType |
コース.コースID |
id |
Integer |
コース.コースコード |
code |
String |
コース.コース名 |
name |
String |
コース.コースカテゴリ |
category |
String |
コース.オープン申込 |
openSubscription |
Boolean |
コース.代理申込 |
proxySubscription |
Boolean |
コース.照査 |
needAdmission |
Boolean |
コース.コース概要 |
explanation |
String |
コース.到達目標 |
goal |
String |
コース.受講対象者 |
target |
String |
コース.受講の前提知識 |
prerequisite |
String |
コース.受講料 |
price |
Integer |
コース.研修期間 |
timeLength |
String |
コース.レベル |
level |
String |
コース.内容 |
detail |
String |
コース.注意事項 |
notes |
String |
コース.クラスコードリスト |
classCodeList |
List<String> |
コース.コース管理者コードリスト |
courseAdminCodeList |
List<String> |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 32 |
message |
String |
- 32
メッセージ一覧
「認証キー」が未指定の場合
コースの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
コースの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
コースの取得に失敗しました。認証キーは32文字以内で入力してください。
「コースコード」が未指定の場合
コースの取得に失敗しました。コースコードは必須項目です。
「コースコード」が256文字より多い場合
コースの取得に失敗しました。コースコードは256文字以内で入力してください。
「コースコード」が存在しない場合
コースの取得に失敗しました。指定したコースコードは存在しません。
WebAPI:コースを登録する¶
registerCourse¶
コースを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
コース |
Course |
complexType |
必須 |
コース.コースID |
id |
Integer |
*指定しない |
コース.コースコード |
code |
String |
必須 |
コース.コース名 |
name |
String |
必須 |
コース.コースカテゴリ |
category |
String |
任意 |
コース.オープン申込 |
openSubscription |
Boolean |
必須 |
コース.代理申込 |
proxySubscription |
Boolean |
必須 |
コース.照査 |
needAdmission |
Boolean |
必須 |
コース.コース概要 |
explanation |
String |
任意 |
コース.到達目標 |
goal |
String |
任意 |
コース.受講対象者 |
target |
String |
任意 |
コース.受講の前提知識 |
prerequisite |
String |
任意 |
コース.受講料 |
price |
Integer |
任意 |
コース.研修期間 |
timeLength |
String |
任意 |
コース.レベル |
level |
String |
任意 |
コース.内容 |
detail |
String |
任意 |
コース.注意事項 |
notes |
String |
任意 |
コース.クラスコードリスト |
classCodeList |
List<String> |
任意 |
コース.コース管理者コードリスト |
courseAdminCodeList |
List<String> |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 33 |
message |
String |
- 33
メッセージ一覧
「認証キー」が未指定の場合
コースの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
コースの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
コースの登録に失敗しました。認証キーは32文字以内で入力してください。
「コース.コースコード」が未指定の場合
コースの登録に失敗しました。コースコードは必須項目です。
「コース.コースコード」が256文字より多い場合
コースの登録に失敗しました。コースコードは256文字以内で入力してください。
「コース.コース名」が未指定の場合
コースの登録に失敗しました。コース名は必須項目です。
「コース.コース名」が256文字より多い場合
コースの登録に失敗しました。コース名は256文字以内で入力してください。
「コース.オープン申込」が未指定の場合
コースの登録に失敗しました。オープン申込は必須項目です。
「コース.代理申込」が未指定の場合
コースの登録に失敗しました。代理申込は必須項目です。
「コース.照査」が未指定の場合
コースの登録に失敗しました。照査は必須項目です。
「コース.オープン申込」と「コース.代理申込」の両方が不可で「コース.照査」が必要と指定した場合
コースの登録に失敗しました。オープン申込が”0”（不可）かつ代理申込が”0” （不可）の場合は、照査は”0”（照査なし）とする必要があります。
「コース.オープン申込」が可で、クラスコードリストで指定されたクラスの受講対象が組織に指定されている場合
コースの登録に失敗しました。クラスの受講対象に組織が指定されているため、オープン申込可にすることはできません。
「コース.代理申込」が可で、クラスコードリストで指定されたクラスの受講対象が組織に指定されている場合
コースの登録に失敗しました。クラスの受講対象に組織が指定されているため、代理申込可にすることはできません。
「コース.オープン申込」が可で、クラスコードリストで指定されたクラスの受講対象が利用者属性に指定されている場合
コースの登録に失敗しました。オープン申込を可にする場合は、利用者属性を受講対象とするクラスを指定できません。
「コース.代理申込」が可で、クラスコードリストで指定されたクラスの受講対象が利用者属性に指定されている場合
コースの登録に失敗しました。代理申込を可にする場合は、利用者属性を受講対象とするクラスを指定できません。
「コース.クラスコードリスト」のクラスコードが256文字より多い場合
コースの登録に失敗しました。クラスコードは256文字以内で入力してください。
「コース.コース管理者コードリスト」のコース管理者コードが256文字より多い場合
コースの登録に失敗しました。コース管理者コードは256文字以内で入力してください。
「コース.クラスコードリスト」のクラスコードが存在しない場合
コースの登録に失敗しました。指定したクラスコードは存在しません。
「コース.コース管理者コードリスト」のコース管理者コードが存在しない場合
コースの登録に失敗しました。指定したコース管理者コードは存在しません。
「コース.コースコード」がすでに存在しているコースコードの場合
コースの登録に失敗しました。指定したコースコードはすでに存在しています。異なる値を指定してください。
WebAPI:コースを更新する¶
updateCourse¶
コースを更新するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
コース |
Course |
complexType |
必須 |
コース.コースID |
id |
Integer |
必須 |
コース.コースコード |
code |
String |
必須 |
コース.コース名 |
name |
String |
必須 |
コース.コースカテゴリ |
category |
String |
任意 |
コース.オープン申込 |
openSubscription |
Boolean |
必須 |
コース.代理申込 |
proxySubscription |
Boolean |
必須 |
コース.照査 |
needAdmission |
Boolean |
必須 |
コース.コース概要 |
explanation |
String |
任意 |
コース.到達目標 |
goal |
String |
任意 |
コース.受講対象者 |
target |
String |
任意 |
コース.受講の前提知識 |
prerequisite |
String |
任意 |
コース.受講料 |
price |
Integer |
任意 |
コース.研修期間 |
timeLength |
String |
任意 |
コース.レベル |
level |
String |
任意 |
コース.内容 |
detail |
String |
任意 |
コース.注意事項 |
notes |
String |
任意 |
コース.クラスコードリスト |
classCodeList |
List<String> |
任意 |
コース.コース管理者コードリスト |
courseAdminCodeList |
List<String> |
任意 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 34 |
message |
String |
- 34
メッセージ一覧
「認証キー」が未指定の場合
コースの更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
コースの更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
コースの更新に失敗しました。認証キーは32文字以内で入力してください。
「コース.コースID」が未指定の場合
コースの更新に失敗しました。コースIDは必須項目です。
「コース.コースコード」が未指定の場合
コースの更新に失敗しました。コースコードは必須項目です。
「コース.コースコード」が256文字より多い場合
コースの更新に失敗しました。コースコードは256文字以内で入力してください。
「コース.コース名」が未指定の場合
コースの更新に失敗しました。コース名は必須項目です。
「コース.コース名」が256文字より多い場合
コースの更新に失敗しました。コース名は256文字以内で入力してください。
「コース.オープン申込」が未指定の場合
コースの更新に失敗しました。オープン申込は必須項目です。
「コース.代理申込」が未指定の場合
コースの更新に失敗しました。代理申込は必須項目です。
「コース.照査」が未指定の場合
コースの更新に失敗しました。照査は必須項目です。
「コース.オープン申込」と「コース.代理申込」の両方が不可で「コース.照査」が必要と指定した場合
コースの更新に失敗しました。オープン申込が”0”（不可）かつ代理申込が”0” （不可）の場合は、照査は”0”（照査なし）とする必要があります。
「コース.オープン申込」が可で、クラスコードリストで指定されたクラスの受講対象が組織に指定されている場合
コースの更新に失敗しました。クラスの受講対象に組織が指定されているため、オープン申込可にすることはできません。
「コース.代理申込」が可で、クラスコードリストで指定されたクラスの受講対象が組織に指定されている場合
コースの更新に失敗しました。クラスの受講対象に組織が指定されているため、代理申込可にすることはできません。
「コース.オープン申込」が可で、クラスコードリストで指定されたクラスの受講対象が利用者属性に指定されている場合
コースの更新に失敗しました。オープン申込を可にする場合は、利用者属性を受講対象とするクラスを指定できません。
「コース.代理申込」が可で、クラスコードリストで指定されたクラスの受講対象が利用者属性に指定されている場合
コースの更新に失敗しました。代理申込を可にする場合は、利用者属性を受講対象とするクラスを指定できません。
「コース.クラスコードリスト」のクラスコードが256文字より多い場合
コースの更新に失敗しました。クラスコードは256文字以内で入力してください。
「コース.コース管理者コードリスト」のコース管理者コードが256文字より多い場合
コースの更新に失敗しました。コース管理者コードは256文字以内で入力してください。
「コース.クラスコードリスト」のクラスコードが存在しない場合
コースの更新に失敗しました。指定したクラスコードは存在しません。
「コース.コース管理者コードリスト」のコース管理者コードが存在しない場合
コースの更新に失敗しました。指定したコース管理者コードは存在しません。
「コース.コースID」が存在しない場合
コースの更新に失敗しました。指定したコースIDは存在しません。
「コース.コースコード」がすでに存在しているコースコードの場合
コースの更新に失敗しました。指定したコースコードはすでに存在しています。異なる値を指定してください。
WebAPI:コースを削除する¶
deleteCourse¶
コースを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
コースコード |
courseCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 35 |
message |
String |
- 35
メッセージ一覧
「認証キー」が未指定の場合
コースの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
コースの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
コースの削除に失敗しました。認証キーは32文字以内で入力してください。
「コースコード」が未指定の場合
コースの削除に失敗しました。コースコードは必須項目です。
「コースコード」が256文字より多い場合
コースの削除に失敗しました。コースコードは256文字以内で入力してください。
「コースコード」が存在しない場合
コースの削除に失敗しました。指定したコースコードは存在しません。
「コースコード」に付随するクラスが存在する場合
コースの削除に失敗しました。コースに関連するクラスが存在するため、削除できません。
WebAPI:受講者を取得する¶
getLearners¶
受講者を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
申込状況 1:照査待ち 2:受講確定待ち 3:受講確定 |
subscriptionStatus |
Integer |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講者 ＊繰り返しあり |
Learner |
complexType |
受講者.研修受講者ID |
learnerId |
Integer |
受講者.開催番号 |
classCode |
String |
受講者.クラス名 |
className |
String |
受講者.申込状況 1:照査待ち 2:受講確定待ち 3:受講確定 |
subscriptionStatus |
Integer |
受講者.申込年月日時 |
subscriptionDate |
Date |
受講者.申込者ログインID |
subscriptionAccountCode |
String |
受講者.受講者ログインID |
learnerAcconutCode |
String |
受講者.照査者ログインID |
approvalAccountCode |
String |
受講者.申込タイプ 1:受講者本人による申込 2:代理処理者による申込 3:クラス管理者による申込 |
subscriptionType |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 36 |
message |
String |
- 36
メッセージ一覧
「認証キー」が未指定の場合
受講者の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講者の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講者の取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
受講者の取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
受講者の取得に失敗しました。開催番号は256文字以内で入力してください。
「受講申込状況」が規定の値でない場合
受講者の取得に失敗しました。申し込み状況の識別子が不正です。
「開催番号」が存在しない場合
受講者の取得に失敗しました。指定した開催番号は存在しません。
WebAPI:受講者を登録する¶
addLearner¶
受講者を登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
受講者 |
Learner |
complexType |
必須 |
受講者.開催番号 |
classCode |
String |
必須 |
受講者.申込者ログインID |
subscriptionAccountCode |
String |
必須 |
受講者.受講者ログインID |
learnerAcconutCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 37 |
message |
String |
- 37
メッセージ一覧
「認証キー」が未指定の場合
受講者の追加に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講者の追加に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講者の追加に失敗しました。認証キーは32文字以内で入力してください。
「受講者.受講者ログインID」が未指定の場合
受講者の追加に失敗しました。受講者のログインIDは必須項目です。
「受講者.受講者ログインID」が256文字より多い場合
受講者の追加に失敗しました。受講者のログインIDは256文字以内で入力してください。
「受講者.申込者ログインID」が未指定の場合
受講者の追加に失敗しました。申込者ログインIDは必須項目です。
「受講者.申込者ログインID」が256文字より多い場合
受講者の追加に失敗しました。申込者ログインIDは256文字以内で入力してください。
「受講者.開催番号」が未指定の場合
受講者の追加に失敗しました。開催番号は必須項目です。
「受講者.開催番号」が256文字より多い場合
受講者の追加に失敗しました。開催番号は256文字以内で入力してください。
「受講者.申込者ログインID」が存在しない場合
受講者の追加に失敗しました。指定した申込者ログインIDは存在しません。
「受講者.受講者ログインID」が存在しない場合
受講者の追加に失敗しました。指定した受講者のログインIDは存在しません。
「受講者.開催番号」が存在しない場合
受講者の追加に失敗しました。指定した開催番号は存在しません。
「受講者.開催番号」のクラスの受講対象に組織が指定されている場合
受講者の追加に失敗しました。クラスの受講対象に組織が指定されているため、受講者を追加することはできません。
「受講者.開催番号」のクラスの受講対象に利用者属性が指定されている場合
受講者の追加に失敗しました。クラスの受講対象に利用者属性が指定されているため、受講者を追加することはできません。
「受講者.受講者ログインID」が対象の研修の講師またはアシスタントのログインIDだった場合
受講者の追加に失敗しました。指定した受講者のログインIDは、この研修の講師またはアシスタントです。
「受講者.受講者ログインID」の利用者がすでに対象の研修に受講申込み済みだった場合
受講者の追加に失敗しました。登録しようとした受講者のログインIDはすでに講師、アシスタント、一般利用者のいずれかで登録済みです。
WebAPI:受講者を削除する¶
deleteLearner¶
受講者を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
受講者ログインID |
learnerAccountCode |
String |
必須 |
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 38 |
message |
String |
- 38
メッセージ一覧
「認証キー」が未指定の場合
受講者の削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講者の削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講者の削除に失敗しました。認証キーは32文字以内で入力してください。
「受講者ログインID」が未指定の場合
受講者の削除に失敗しました。受講者のログインIDは必須項目です。
「受講者ログインID」が256文字より多い場合
受講者の削除に失敗しました。受講者のログインIDは256文字以内で入力してください。
「開催番号」が未指定の場合
受講者の削除に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
受講者の削除に失敗しました。開催番号は256文字以内で入力してください。
「受講者ログインID」が存在しない場合
受講者の削除に失敗しました。指定した受講者のログインIDは存在しません。
「開催番号」が存在しない場合
受講者の削除に失敗しました。指定した開催番号は存在しません。
「受講者.開催番号」のクラスの受講対象に組織が指定されている場合
受講者の削除に失敗しました。クラスの受講対象に組織が指定されているため、受講者を削除することはできません。
「受講者.開催番号」のクラスの受講対象に利用者属性が指定されている場合
受講者の削除に失敗しました。クラスの受講対象に利用者属性が指定されているため、受講者を削除することはできません。
WebAPI:受講履歴を登録または更新する¶
registerLearningHistory¶
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講履歴処理件数（登録件数+更新件数） |
registerLearningHistoryCount |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 39 |
message |
String |
- 39
メッセージ一覧
「認証キー」が未指定の場合
受講履歴登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講履歴登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講履歴登録に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
受講履歴登録に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
受講履歴登録に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
受講履歴登録に失敗しました。指定した開催番号は存在しません。
WebAPI:受講履歴を取得する（利用者指定）¶
getLearningHistory¶
ログインIDを指定して受講履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講履歴 |
LearningHistory |
complexType |
受講履歴.受講履歴ID |
id |
Integer |
受講履歴.ログインID |
accountCode |
String |
受講履歴.コース名 |
courseName |
String |
受講履歴.コースカテゴリ |
category |
String |
受講履歴.オープン申込可否 |
openSubscription |
Boolean |
受講履歴.代理申込可否 |
proxySubscription |
Boolean |
受講履歴.照査必要 |
needAdmission |
Boolean |
受講履歴.コース概要 |
explanation |
String |
受講履歴.到達目標 |
goal |
String |
受講履歴.受講対象者 |
target |
String |
受講履歴.前提知識 |
prerequisite |
String |
受講履歴.受講料 |
price |
Integer |
受講履歴.研修期間 |
timeLength |
String |
受講履歴.難易度 |
level |
String |
受講履歴.内容 |
detail |
String |
受講履歴.注意事項 |
notes |
String |
受講履歴.開催番号 |
classCode |
String |
受講履歴.クラス名 |
className |
String |
受講履歴.開始日 |
startDate |
Date |
受講履歴.終了日 |
endDate |
Date |
受講履歴.申込開始日時 |
subscriptionStartDate |
Date |
受講履歴.申込終了日時 |
subscriptionEndDate |
Date |
受講履歴.定員 |
capacity |
Integer |
受講履歴.開催場所 |
classroom |
String |
受講履歴.研修時間 |
hour |
String |
受講履歴.入室可否状態 |
admission |
Integer |
受講履歴.所属コースコード（研修番号） |
courseCode |
String |
受講履歴.研修総評 |
comment |
String |
受講履歴.研修総評最終更新日時 |
commentUpdate |
Date |
受講履歴.研修総評最終更新者ログインID |
commentedAccountCode |
String |
受講履歴.最終評価 |
finalScore |
String |
受講履歴.出席数 |
classAttendance |
Integer |
受講履歴.欠席数 |
classAbsence |
Integer |
受講履歴.遅刻数 |
classLateness |
Integer |
受講履歴.早退数 |
classLeavingearly |
Integer |
受講履歴.公欠数 |
classOfficialleave |
Integer |
受講履歴.照査者ログインID |
approvalAccountCode |
String |
受講履歴.申込タイプ 1:受講者本人 2:代理処理者 3:クラス管理者 |
subscriptionType |
Integer |
受講履歴.登録日時 |
registerTime |
Date |
受講履歴.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
受講履歴.学習形態 |
learningStyle |
String |
受講履歴.教材完了状況 0:不明 1:完了 2:手動で完了 3:未完了 4:教材なし |
learningResourceCompletionStatus |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 40 |
message |
String |
- 40
メッセージ一覧
「認証キー」が未指定の場合
受講履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
受講履歴の取得に失敗しました。ログインIDは必須項目です。
「ログインID」が128文字より多い場合
受講履歴の取得に失敗しました。ログインIDは128文字以内で入力してください。
「ログインID」が存在しない場合
受講履歴の取得に失敗しました。指定した利用者コードは存在しません。
WebAPI:受講履歴を取得する（クラス指定）¶
getLearningHistoryByClassCode¶
開催番号を指定して受講履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講履歴 |
LearningHistory |
complexType |
受講履歴.受講履歴ID |
id |
Integer |
受講履歴.ログインID |
accountCode |
String |
受講履歴.コース名 |
courseName |
String |
受講履歴.コースカテゴリ |
category |
String |
受講履歴.オープン申込可否 |
openSubscription |
Boolean |
受講履歴.代理申込可否 |
proxySubscription |
Boolean |
受講履歴.照査必要 |
needAdmission |
Boolean |
受講履歴.コース概要 |
explanation |
String |
受講履歴.到達目標 |
goal |
String |
受講履歴.受講対象者 |
target |
String |
受講履歴.前提知識 |
prerequisite |
String |
受講履歴.受講料 |
price |
Integer |
受講履歴.研修期間 |
timeLength |
String |
受講履歴.難易度 |
level |
String |
受講履歴.内容 |
detail |
String |
受講履歴.注意事項 |
notes |
String |
受講履歴.開催番号 |
classCode |
String |
受講履歴.クラス名 |
className |
String |
受講履歴.開始日 |
startDate |
Date |
受講履歴.終了日 |
endDate |
Date |
受講履歴.申込開始日時 |
subscriptionStartDate |
Date |
受講履歴.申込終了日時 |
subscriptionEndDate |
Date |
受講履歴.定員 |
capacity |
Integer |
受講履歴.開催場所 |
classroom |
String |
受講履歴.研修時間 |
hour |
String |
受講履歴.入室可否状態 |
admission |
Integer |
受講履歴.所属コースコード（研修番号） |
courseCode |
String |
受講履歴.研修総評 |
comment |
String |
受講履歴.研修総評最終更新日時 |
commentUpdate |
Date |
受講履歴.研修総評最終更新者ログインID |
commentedAccountCode |
String |
受講履歴.最終評価 |
finalScore |
String |
受講履歴.出席数 |
classAttendance |
Integer |
受講履歴.欠席数 |
classAbsence |
Integer |
受講履歴.遅刻数 |
classLateness |
Integer |
受講履歴.早退数 |
classLeavingearly |
Integer |
受講履歴.公欠数 |
classOfficialleave |
Integer |
受講履歴.照査者ログインID |
approvalAccountCode |
String |
受講履歴.申込タイプ 1:受講者本人 2:代理処理者 3:クラス管理者 |
subscriptionType |
Integer |
受講履歴.登録日時 |
registerTime |
Date |
受講履歴.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
受講履歴.学習形態 |
learningStyle |
String |
受講履歴.教材完了状況 0:不明 1:完了 2:手動で完了 3:未完了 4:教材なし |
learningResourceCompletionStatus |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 41 |
message |
String |
- 41
メッセージ一覧
「認証キー」が未指定の場合
受講履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未指定の場合
受講履歴の取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
受講履歴の取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
受講履歴の取得に失敗しました。指定した開催番号は存在しません。
WebAPI:受講履歴を取得する（登録日指定）¶
getLearningHistoryByRegisterDate¶
登録日を指定して受講履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
登録日 |
registerDate |
Date |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
受講履歴 |
LearningHistory |
complexType |
受講履歴.受講履歴ID |
id |
Integer |
受講履歴.ログインID |
accountCode |
String |
受講履歴.コース名 |
courseName |
String |
受講履歴.コースカテゴリ |
category |
String |
受講履歴.オープン申込可否 |
openSubscription |
Boolean |
受講履歴.代理申込可否 |
proxySubscription |
Boolean |
受講履歴.照査必要 |
needAdmission |
Boolean |
受講履歴.コース概要 |
explanation |
String |
受講履歴.到達目標 |
goal |
String |
受講履歴.受講対象者 |
target |
String |
受講履歴.前提知識 |
prerequisite |
String |
受講履歴.受講料 |
price |
Integer |
受講履歴.研修期間 |
timeLength |
String |
受講履歴.難易度 |
level |
String |
受講履歴.内容 |
detail |
String |
受講履歴.注意事項 |
notes |
String |
受講履歴.開催番号 |
classCode |
String |
受講履歴.クラス名 |
className |
String |
受講履歴.開始日 |
startDate |
Date |
受講履歴.終了日 |
endDate |
Date |
受講履歴.申込開始日時 |
subscriptionStartDate |
Date |
受講履歴.申込終了日時 |
subscriptionEndDate |
Date |
受講履歴.定員 |
capacity |
Integer |
受講履歴.開催場所 |
classroom |
String |
受講履歴.研修時間 |
hour |
String |
受講履歴.入室可否状態 |
admission |
Integer |
受講履歴.所属コースコード（研修番号） |
courseCode |
String |
受講履歴.研修総評 |
comment |
String |
受講履歴.研修総評最終更新日時 |
commentUpdate |
Date |
受講履歴.研修総評最終更新者ログインID |
commentedAccountCode |
String |
受講履歴.最終評価 |
finalScore |
String |
受講履歴.出席数 |
classAttendance |
Integer |
受講履歴.欠席数 |
classAbsence |
Integer |
受講履歴.遅刻数 |
classLateness |
Integer |
受講履歴.早退数 |
classLeavingearly |
Integer |
受講履歴.公欠数 |
classOfficialleave |
Integer |
受講履歴.照査者ログインID |
approvalAccountCode |
String |
受講履歴.申込タイプ 1:受講者本人 2:代理処理者 3:クラス管理者 |
subscriptionType |
Integer |
受講履歴.登録日時 |
registerTime |
Date |
受講履歴.クラスタイプ 1:通常クラス 2:eラーニングクラス |
classType |
Integer |
受講履歴.学習形態 |
learningStyle |
String |
受講履歴.教材完了状況 0:不明 1:完了 2:手動で完了 3:未完了 4:教材なし |
learningResourceCompletionStatus |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 42 |
message |
String |
- 42
メッセージ一覧
「認証キー」が未指定の場合
受講履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
受講履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
受講履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「登録日」が未指定の場合
受講履歴の取得に失敗しました。登録年月日は必須項目です。
「登録日」が年月日形式の書式でない場合
受講履歴の取得に失敗しました。登録年月日の年月日を正しく入力してください。
WebAPI:アンケートテンプレートを取得する¶
getQuestionnaireTemplate¶
アンケートテンプレートを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （アンケートテンプレート名、説明に部分一致） |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
アンケートテンプレート *繰り返しあり |
QuestionnaireTemplate |
complexType |
アンケートテンプレート .アンケートテンプレート ID |
id |
Integer |
アンケートテンプレート .タイトル |
title |
String |
アンケートテンプレート .説明 |
description |
String |
アンケートテンプレート .匿名アンケート true:匿名アンケート false:記名式アンケート |
anonymousSurvey |
Boolean |
アンケートテンプレート .個人情報取り扱いへの同意が必要か（記名式アンケートの場合） true:必要 false:不要 |
requireAgreement |
Boolean |
アンケートテンプレート .個人情報取り扱い文（個人情報取り扱いへの同意が必要な場合） |
privacyStatement |
String |
アンケートテンプレート .導入文 |
introduction |
String |
アンケートテンプレート .アンケート作成数 |
countQuestionnaire |
Integer |
アンケートテンプレート .作成日 |
createDate |
Date |
アンケートテンプレート .更新日 |
lastModifiedDate |
Date |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 43 |
message |
String |
- 43
メッセージ一覧
「認証キー」が未指定の場合
アンケートテンプレートの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケートテンプレートの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケートテンプレートの取得に失敗しました。認証キーは32文字以内で入力してください。
WebAPI:アンケートを取得する¶
getQuestionnaire¶
アンケートを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （アンケート名、実施先名、実施先コードに部分一致） |
状態 0:開始前 1：実施中 2：終了 |
state |
Integer |
任意 |
検索範囲（開始日） |
startDate |
Date |
任意 ※クラスの開催期間に合わせて実施するアンケートは検索対象から除外されます。 |
検索範囲（終了日） |
endDate |
Date |
任意 ※クラスの開催期間に合わせて実施するアンケートは検索対象から除外されます。 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
アンケート *繰り返しあり |
Questionnaire |
complexType |
アンケート.アンケートID |
id |
Integer |
アンケート.アンケートテンプレートID |
questionnaireTemplateId |
Integer |
アンケート.タイトル |
title |
String |
アンケート.説明 |
description |
String |
アンケート.状態 0:開始前 1：実施中 2：終了 |
state |
Integer |
アンケート.開始と終了を自動で行う |
automaticExec |
Boolean |
アンケート.開始日時 |
startDate |
Date |
アンケート.終了日時 |
endDate |
Date |
アンケート.実施先の管理者・講師に編集・集計権限を与える |
addEditCounterRole |
Boolean |
アンケート.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
アンケート.アンケート実施先種類 1:プログラム 2：コース 3：クラス |
excutedPlaceType |
Integer |
アンケート.アンケート実施先コード |
excutedPlaceCode |
String |
アンケート.アンケート実施先名 |
excutedPlaceName |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 44 |
message |
String |
- 44
メッセージ一覧
「認証キー」が未指定の場合
アンケート情報の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケート情報の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケート情報の取得に失敗しました。認証キーは32文字以内で入力してください。
「状態」が規定の値でない場合
アンケート情報の取得に失敗しました。アンケート状態の識別子が不正です。
「検索範囲（開始日）」が年月日形式の書式でない場合
アンケート情報の取得に失敗しました。検索範囲（開始）の年月日を正しく入力してください。
「検索範囲（終了日）」が年月日形式の書式でない場合
アンケート情報の取得に失敗しました。検索範囲（終了）の年月日を正しく入力してください。
「検索範囲（終了日）」が「検索範囲（開始日）」より前の日付の場合
アンケート情報の取得に失敗しました。検索終了日は検索開始日より後の日付を指定してください。
WebAPI:アンケート回答を取得する¶
getQuestionnaireAnswer¶
アンケート回答を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
アンケートID |
questionnaireId |
Integer |
必須 |
回答者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
アンケート回答 *繰り返しあり |
QuestionnaireAnswer |
complexType |
アンケート回答.アンケートID |
questionnaireId |
Integer |
アンケート回答.アンケート名 |
questionnaireTitle |
String |
アンケート回答.アンケートテンプレート名 |
questionnaireTemplateTitle |
String |
アンケート回答.回答者ログインID |
accountCode |
String |
アンケート回答.回答者氏名 |
accountName |
String |
アンケート回答.回答者組織コード |
organizationCode |
String |
アンケート回答.回答者組織名 |
organizationName |
String |
アンケート回答.アンケート提出日時 |
submitDate |
Date |
アンケート回答.アンケート質問ID |
questionId |
Integer |
アンケート回答.アンケート質問種別 1:記述問題 2：択一選択問題 3：複数選択問題 |
questionType |
Integer |
アンケート回答.アンケート質問タイトル |
questionTitle |
String |
アンケート回答.アンケート質問複数行テキスト |
questionBody |
String |
アンケート回答.アンケート質問への回答（記述内容 or 選択肢の記述） |
answerString |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 45 |
message |
String |
- 45
メッセージ一覧
「認証キー」が未指定の場合
アンケート回答の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケート回答の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケート回答の取得に失敗しました。認証キーは32文字以内で入力してください。
「アンケートID」が未指定の場合
アンケート回答の取得に失敗しました。アンケートIDは必須項目です。
「アンケートID」が存在しない場合
アンケート回答の取得に失敗しました。指定したアンケートIDは存在しません。
「回答者ログインID」が存在しない場合
アンケート回答の取得に失敗しました。指定した利用者コードは存在しません。
「回答者ログインID」がアンケート対象者でない場合
アンケート回答の取得に失敗しました。指定したログインIDは、指定したアンケートの回答対象者ではありません。
WebAPI:アンケート提出状況を取得する¶
getQuestionnaireResult¶
アンケート提出状況を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
アンケートID |
questionnaireId |
Integer |
必須 |
回答者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
アンケート提出状況 *繰り返しあり |
QuestionnaireResult |
complexType |
アンケート提出状況.アンケートID |
questionnaireId |
Integer |
アンケート提出状況.アンケート名 |
questionnaireTitle |
String |
アンケート提出状況.アンケートテンプレート名 |
questionnaireTemplateTitle |
String |
アンケート提出状況.回答者ログインID |
accountCode |
String |
アンケート提出状況.回答者氏名 |
accountName |
String |
アンケート提出状況.回答者組織コード |
organizationCode |
String |
アンケート提出状況.回答者組織名 |
organizationName |
String |
アンケート提出状況.アンケート提出日時 |
submitDate |
Date |
アンケート提出状況.アンケート提出有無 true:提出済み false:未提出 |
result |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 46 |
message |
String |
- 46
メッセージ一覧
「認証キー」が未指定の場合
アンケート提出状況の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケート提出状況の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケート提出状況の取得に失敗しました。認証キーは32文字以内で入力してください。
「アンケートID」が未指定の場合
アンケート提出状況の取得に失敗しました。アンケートIDは必須項目です。
「アンケートID」が存在しない場合
アンケート提出状況の取得に失敗しました。指定したアンケートIDは存在しません。
「回答者ログインID」が存在しない場合
アンケート提出状況の取得に失敗しました。指定した利用者コードは存在しません。
「回答者ログインID」がアンケート対象者でない場合
アンケート提出状況の取得に失敗しました。指定したログインIDは、指定したアンケートの回答対象者ではありません。
WebAPI:アンケートを登録する¶
registerQuestionnaire¶
アンケートを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
アンケートテンプレートID |
questionnaireTemplateId |
Integer |
必須 |
アンケート名 |
title |
String |
必須 |
説明 |
description |
String |
任意 |
実施方法 1:手動 2:開始日時・終了日時を指定 3:クラスの開催期間 4:クラス終了日の１２時から指定期間 |
execMethod |
Integer |
必須 |
開始日時 |
startDate |
Date |
必須 ※実施方法が「開始日時・終了日時を指定」の場合 |
終了日時 |
endDate |
Date |
任意 ※実施方法が「開始日時・終了日時を指定」の場合 |
実施期間 |
term |
Integer |
必須 ※実施方法が「クラス終了日の１２時から指定期間」の場合 |
実施先の種類 1:プログラム 2:コース 3:クラス |
excutedPlaceType |
Integer |
必須 |
実施先コード |
excutedPlaceCode |
String |
必須 ※実施先がプログラム、コース、クラスの場合、それぞれパックコード、コースコード、開催番号を指定する |
実施先の管理者・講師に編集・集計権限を与える |
addEditcounterRole |
Boolean |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 47 |
message |
String |
- 47
メッセージ一覧
「認証キー」が未指定の場合
アンケートの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケートの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケートの登録に失敗しました。認証キーは32文字以内で入力してください。
「アンケートテンプレートID」が未指定の場合
アンケートの登録に失敗しました。アンケートテンプレートIDは必須項目です。
「アンケート名」が未指定の場合
アンケートの登録に失敗しました。アンケート名は必須項目です。
「アンケート名」が128文字より多い場合
アンケートの登録に失敗しました。アンケート名は128文字以内で入力してください。
「実施方法」が未指定の場合
アンケートの登録に失敗しました。実施方法は必須項目です。
「開始日時」が未指定の場合(実施方法が「開始日時・終了日時を指定」の場合):
アンケートの登録に失敗しました。開始日時は必須項目です。
「期間」が未指定の場合(実施方法が「クラス終了日の１２時から指定期間」の場合):
アンケートの登録に失敗しました。期間は必須項目です。
「実施方法」が規定の値でない場合
アンケートの登録に失敗しました。実施方法の識別子が不正です。
「実施先の種類」が未指定の場合
アンケートの登録に失敗しました。実施先の種類は必須項目です。
「実施先の種類」が規定の値でない場合
アンケートの登録に失敗しました。実施先の種類の識別子が不正です。
「実施先コード」が未指定の場合
アンケートの登録に失敗しました。実施先コードは必須項目です。
「実施先の管理者・講師に編集・集計権限を与える」が未指定の場合
アンケートの登録に失敗しました。実施先の管理者に編集・集計権限を与えるかは必須項目です。
「アンケートテンプレートID」が存在しない場合
アンケートの登録に失敗しました。指定したアンケートテンプレートIDは存在しません。
「開始日時」が「終了日時」よりも後の日時の場合
アンケートの登録に失敗しました。開始日時は終了日時の前でなければなりません。
「実施方法」が「クラス終了日の１２時から指定期間」で、「実施先の種類」がプログラムやコースの場合
アンケートの登録に失敗しました。クラス終了日の１２時から指定期間を実施方法とする場合、実施先の種類にはクラスを指定してください。
「実施先コード」が存在しない場合（「実施先の種類」がプログラムのとき）:
アンケートの登録に失敗しました。指定したパックコードは存在しません。
「実施先コード」が存在しない場合（「実施先の種類」がコースのとき）:
アンケートの登録に失敗しました。指定したコースコードは存在しません。
「実施先コード」が存在しない場合（「実施先の種類」がクラスのとき）:
アンケートの登録に失敗しました。指定したクラスコードは存在しません。
「期間」が0より大きい整数でない場合
アンケートの登録に失敗しました。期間には0より大きい整数を指定してください。
WebAPI:アンケートを削除する¶
deleteQuestionnaire¶
アンケートを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
アンケートID |
questionnaireId |
Integer |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 48 |
message |
String |
- 48
メッセージ一覧
「認証キー」が未指定の場合
アンケートの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
アンケートの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
アンケートの削除に失敗しました。認証キーは32文字以内で入力してください。
「アンケートID」が未指定の場合
アンケートの削除に失敗しました。アンケートIDは必須項目です。
「アンケートID」が存在しない場合
アンケートの削除に失敗しました。指定したアンケートIDは存在しません。
WebAPI:テストを取得する¶
getExamination¶
テストを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （テスト名、実施先名、実施先コードに部分一致） |
状態 0:開始前 1：実施中 2：終了 |
state |
Integer |
任意 |
検索範囲（開始日） |
startDate |
Date |
任意 ※クラスの開催期間に合わせて実施するテストは検索対象から除外されます。 |
検索範囲（終了日） |
endDate |
Date |
任意 ※クラスの開催期間に合わせて実施するテストは検索対象から除外されます。 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
テスト *繰り返しあり |
Examination |
complexType |
テスト.テストID |
id |
Integer |
テスト.テストテンプレートID |
examinationTemplateId |
Integer |
テスト.テスト名 |
name |
String |
テスト.状態 0:開始前 1：実施中 2：終了 |
state |
Integer |
テスト.開始と終了を自動で行う |
automaticExec |
Boolean |
テスト.開始日時 |
startDate |
Date |
テスト.終了日時 |
endDate |
Date |
テスト.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
テスト.実施先の管理者・講師に編集・集計権限を与える |
addEditCounterRole |
Boolean |
テスト.テスト実施先種類 1:プログラム 2：コース 3：クラス |
excutedPlaceType |
Integer |
テスト.テスト実施先コード |
excutedPlaceCode |
String |
テスト.テスト実施先名 |
excutedPlaceName |
String |
テスト.合格条件(%) |
criteriaForPassing |
Integer |
テスト.問題順をランダムにする |
randomQuestions |
Boolean |
テスト.問題順ランダム時の出題問題数 |
numberOfRandomQuestions |
Integer |
テスト.ページあたりの問題数を指定する |
questionsPerPage |
Boolean |
テスト.ページあたりの問題数 |
numberOfQuestionsPerPage |
Integer |
テスト.試験時間を設定する |
timeLimit |
Boolean |
テスト.試験時間（分） |
minutesOfTimeLimit |
Integer |
テスト.解答者による提出を一回のみに制限する |
submitOnlyOnce |
Boolean |
テスト.選択肢の正解が１つの場合はラジオボタンで表示する |
displayRadioButton |
Boolean |
テスト.不合格の場合にテスト結果確認画面に選択肢の結果を表示する |
displayResultAtFailedCase |
Boolean |
テスト.不合格の場合にテスト結果確認画面に問題への解説を表示する |
displayReferenceAtFailedCase |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 49 |
message |
String |
- 49
メッセージ一覧
「認証キー」が未指定の場合
テストの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
テストの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
テストの取得に失敗しました。認証キーは32文字以内で入力してください。
「状態」が規定の値でない場合
テストの取得に失敗しました。テスト状態の識別子が不正です。
「検索範囲（開始日）」が年月日形式の書式でない場合
テストの取得に失敗しました。検索範囲（開始）の年月日を正しく入力してください。
「検索範囲（終了日）」が年月日形式の書式でない場合
テストの取得に失敗しました。検索範囲（終了）の年月日を正しく入力してください。
「検索範囲（終了日）」が「検索範囲（開始日）」より前の日付の場合
テストの取得に失敗しました。検索終了日は検索開始日より後の日付を指定してください。
WebAPI:テスト解答履歴を取得する¶
getExaminationAnswer¶
テスト解答履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
テストID |
examinationId |
Integer |
必須 |
解答者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
テスト解答履歴 *繰り返しあり |
ExaminationAnswer |
complexType |
テスト解答履歴.テストID |
examinationId |
Integer |
テスト解答履歴.テスト名 |
examinationName |
String |
テスト解答履歴.テストテンプレート名 |
examinationTemplateName |
String |
テスト解答履歴.解答者ログインID |
accountCode |
String |
テスト解答履歴.解答者氏名 |
accountName |
String |
テスト解答履歴.解答者組織コード |
organizationCode |
String |
テスト解答履歴.解答者組織名 |
organizationName |
String |
テスト解答履歴.テスト結果 1:未提出 2：不合格 3：合格 |
result |
Integer |
テスト解答履歴.合格回数 |
numberOfPassed |
Integer |
テスト解答履歴.最初に合格した日時 |
passedDate |
Date |
テスト解答履歴.問題ID |
questionId |
Integer |
テスト解答履歴.問題順番号 |
questionOrder |
Integer |
テスト解答履歴.問題文 |
questionSentence |
String |
テスト解答履歴.解答者が問題に正解したか |
correct |
Boolean |
テスト解答履歴.選択肢の記述内容 |
choiceSentence |
String |
テスト解答履歴.選択肢が正解か |
correctChoice |
Boolean |
テスト解答履歴.解答者が選択肢を選択したか |
chosen |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 50 |
message |
String |
- 50
メッセージ一覧
「認証キー」が未指定の場合
テスト解答履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
テスト解答履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
テスト解答履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「テストID」が未指定の場合
テスト解答履歴の取得に失敗しました。テストIDは必須項目です。
「テストID」が存在しない場合
テスト解答履歴の取得に失敗しました。指定したテストIDは存在しません。
「解答者ログインID」が存在しない場合
テスト解答履歴の取得に失敗しました。指定した利用者コードは存在しません。
「解答者ログインID」がテスト対象者でない場合
テスト解答履歴の取得に失敗しました。指定したログインIDは、指定したテストの解答対象者ではありません。
WebAPI:テスト完了状況を取得する¶
getExaminationResult¶
テスト完了状況を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
テストID |
examinationId |
Integer |
必須 |
解答者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
テスト完了状況 *繰り返しあり |
ExaminationResult |
complexType |
テスト完了状況.テストID |
examinationId |
Integer |
テスト完了状況.テスト名 |
examinationName |
String |
テスト完了状況.テストテンプレート名 |
examinationTemplateName |
String |
テスト完了状況.解答者ログインID |
accountCode |
String |
テスト完了状況.解答者氏名 |
accountName |
String |
テスト完了状況.解答者組織コード |
organizationCode |
String |
テスト完了状況.解答者組織名 |
organizationName |
String |
テスト完了状況.テスト結果 1:未提出 2：不合格 3：合格 |
result |
Integer |
テスト完了状況.合格回数 |
numberOfPassed |
Integer |
テスト完了状況.最初に合格した日時 |
passedDate |
Date |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 51 |
message |
String |
- 51
メッセージ一覧
「認証キー」が未指定の場合
テスト完了状況の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
テスト完了状況の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
テスト完了状況の取得に失敗しました。認証キーは32文字以内で入力してください。
「テストID」が未指定の場合
テスト完了状況の取得に失敗しました。テストIDは必須項目です。
「テストID」が存在しない場合
テスト完了状況の取得に失敗しました。指定したテストIDは存在しません。
「解答者ログインID」が存在しない場合
テスト完了状況の取得に失敗しました。指定した利用者コードは存在しません。
「解答者ログインID」がテスト対象者でない場合
テスト完了状況の取得に失敗しました。指定したログインIDは、指定したテストの解答対象者ではありません。
WebAPI:テストを削除する¶
deleteExamination¶
テストを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
テストID |
examinationId |
Integer |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 52 |
message |
String |
- 52
メッセージ一覧
「認証キー」が未指定の場合
テストの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
テストの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
テストの削除に失敗しました。認証キーは32文字以内で入力してください。
「テストID」が未指定の場合
テストの削除に失敗しました。テストIDは必須項目です。
「テストID」が存在しない場合
テストの削除に失敗しました。指定したテストIDは存在しません。
WebAPI:eラーニングを取得する¶
getElearning¶
eラーニングを取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （eラーニング名、実施先名、実施先コードに部分一致） |
状態 0:開始前 1：実施中 2：終了 3:実施しない（非公開） |
state |
Integer |
任意 |
検索範囲（開始日） |
startDate |
Date |
任意 ※クラスの開催期間に合わせて実施するeラーニングは検索対象から除外されます。 |
検索範囲（終了日） |
endDate |
Date |
任意 ※クラスの開催期間に合わせて実施するeラーニングは検索対象から除外されます。 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
eラーニング *繰り返しあり |
Elearning |
complexType |
eラーニング.eラーニングID |
id |
Integer |
eラーニング.eラーニング名 |
name |
String |
eラーニング.状態 0:開始前 1：実施中 2：終了 3:実施しない（非公開） |
state |
Integer |
eラーニング.eラーニングを実施する |
published |
boolean |
eラーニング.開始日時 |
startDate |
Date |
eラーニング.終了日時 |
endDate |
Date |
eラーニング.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
eラーニング.eラーニング実施先種類 1:プログラム 2：コース 3：クラス |
excutedPlaceType |
Integer |
eラーニング.eラーニング実施先コード |
excutedPlaceCode |
String |
eラーニング.eラーニング実施先名 |
excutedPlaceName |
String |
eラーニング.説明 |
explain |
String |
eラーニング.実施先管理者に編集集計権限を付与する |
grantPermission |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 53 |
message |
String |
- 53
メッセージ一覧
「認証キー」が未指定の場合
eラーニングの取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングの取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングの取得に失敗しました。認証キーは32文字以内で入力してください。
「状態」が規定の値でない場合
eラーニングの取得に失敗しました。eラーニング状態の識別子が不正です。
「検索範囲（開始日）」が年月日形式の書式でない場合
eラーニングの取得に失敗しました。検索範囲（開始）の年月日を正しく入力してください。
「検索範囲（終了日）」が年月日形式の書式でない場合
eラーニングの取得に失敗しました。検索範囲（終了）の年月日を正しく入力してください。
「検索範囲（終了日）」が「検索範囲（開始日）」より前の日付の場合
eラーニングの取得に失敗しました。検索終了日は検索開始日より後の日付を指定してください。
WebAPI:eラーニングを登録する¶
registerElearning¶
eラーニングを登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
eラーニング |
Elearning |
complexType |
必須 |
eラーニング.eラーニングID |
id |
Integer |
任意(※入力値は無視されます) |
eラーニング.eラーニング名 |
name |
String |
必須 |
eラーニング.状態 |
state |
Integer |
任意(※入力値は無視されます) |
eラーニング.eラーニングを実施する |
published |
boolean |
任意(指定しない場合はfalse) |
eラーニング.開始日時 |
startDate |
Date |
必須 |
eラーニング.終了日時 |
endDate |
Date |
必須 |
eラーニング.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
必須 |
eラーニング.eラーニング実施先種類 |
excutedPlaceType |
Integer |
必須( 1:プログラム 2：コース 3：クラス) |
eラーニング.eラーニング実施先コード |
excutedPlaceCode |
String |
必須 |
eラーニング.eラーニング実施先名 |
excutedPlaceName |
String |
任意(※入力値は無視されます) |
eラーニング.説明 |
explain |
String |
任意 |
eラーニング.実施先管理者に編集集計権限を付与する |
grantPermission |
Boolean |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 54 |
message |
String |
- 54
メッセージ一覧
「認証キー」が未指定の場合
eラーニングの登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングの登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングの登録に失敗しました。認証キーは32文字以内で入力してください。
「eラーニング」が未指定の場合
eラーニングの登録に失敗しました。eラーニングは必須項目です。
「eラーニング名」が未指定の場合
eラーニングの登録に失敗しました。eラーニング名は必須項目です。
「eラーニング名」が128文字より多い場合
eラーニングの登録に失敗しました。eラーニング名は128文字以内で入力してください。
「実施期間をクラスの開催期間に合わせる」が未指定の場合
eラーニングの登録に失敗しました。実施期間をクラスの開催期間に合わせるは必須項目です。
「実施先種類」が未指定の場合
eラーニングの登録に失敗しました。実施先種類は必須項目です。
「実施先種類」が規定の値でない場合
eラーニングの登録に失敗しました。実施先種類の識別子が不正です。
「実施先コード」が未指定の場合
eラーニングの登録に失敗しました。実施先コードは必須項目です。
「実施先管理者に編集集計権限を付与する」が未指定の場合
eラーニングの登録に失敗しました。実施先管理者に編集集計権限を付与するは必須項目です。
eラーニングを実施しないときに実施期間をクラスの開催期間に合わせている場合
eラーニングの登録に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせることはできません。
クラスの開催期間に実施期間を合わせるときに開始日時を指定している場合
eラーニングの登録に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせる場合、開始日時を指定することができません。
クラスの開催期間に実施期間を合わせるときに終了日時を指定している場合
eラーニングの登録に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせる場合、終了日時を指定することができません。
「終了日時」が「開始日時」より前の日付を指定している場合
eラーニングの登録に失敗しました。eラーニングの登録に失敗しました。終了日は開始日より後の日付を指定してください。
「実施先コード」が存在しない場合:
eラーニングの登録に失敗しました。eラーニング実施先コードで指定した実施先は存在しません。
WebAPI:eラーニングを更新する¶
updateElearning¶
eラーニングを更新するサービスです。※Webサービスから実施先の変更はできません。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
eラーニング |
Elearning |
complexType |
必須 |
eラーニング.eラーニングID |
id |
Integer |
必須 |
eラーニング.eラーニング名 |
name |
String |
必須 |
eラーニング.状態 |
state |
Integer |
任意(※入力値は無視されます) |
eラーニング.eラーニングを実施する |
published |
boolean |
任意(指定しない場合はfalse) |
eラーニング.開始日時 |
startDate |
Date |
必須 |
eラーニング.終了日時 |
endDate |
Date |
必須 |
eラーニング.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
必須 |
eラーニング.eラーニング実施先種類 |
excutedPlaceType |
Integer |
必須( 1:プログラム 2：コース 3：クラス) |
eラーニング.eラーニング実施先コード |
excutedPlaceCode |
String |
必須 |
eラーニング.eラーニング実施先名 |
excutedPlaceName |
String |
任意(※入力値は無視されます) |
eラーニング.説明 |
explain |
String |
任意 |
eラーニング.実施先管理者に編集集計権限を付与する |
grantPermission |
Boolean |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 55 |
message |
String |
- 55
メッセージ一覧
「認証キー」が未指定の場合
eラーニングの更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングの更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングの更新に失敗しました。認証キーは32文字以内で入力してください。
「eラーニング」が未指定の場合
eラーニングの更新に失敗しました。eラーニングは必須項目です。
「eラーニングID」が未指定の場合
eラーニングの更新に失敗しました。eラーニングIDは必須項目です。
「eラーニング名」が未指定の場合
eラーニングの更新に失敗しました。eラーニング名は必須項目です。
「eラーニング名」が128文字より多い場合
eラーニングの更新に失敗しました。eラーニング名は128文字以内で入力してください。
「実施期間をクラスの開催期間に合わせる」が未指定の場合
eラーニングの更新に失敗しました。実施期間をクラスの開催期間に合わせるは必須項目です。
「実施先種類」が未指定の場合
eラーニングの更新に失敗しました。実施先種類は必須項目です。
「実施先種類」が規定の値でない場合
eラーニングの更新に失敗しました。実施先種類の識別子が不正です。
「実施先コード」が未指定の場合
eラーニングの更新に失敗しました。実施先コードは必須項目です。
「実施先管理者に編集集計権限を付与する」が未指定の場合
eラーニングの更新に失敗しました。実施先管理者に編集集計権限を付与するは必須項目です。
eラーニングを実施しないときに実施期間をクラスの開催期間に合わせている場合
eラーニングの更新に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせることはできません。
クラスの開催期間に実施期間を合わせるときに開始日時を指定している場合
eラーニングの更新に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせる場合、開始日時を指定することができません。
クラスの開催期間に実施期間を合わせるときに終了日時を指定している場合
eラーニングの更新に失敗しました。eラーニングを実施しない場合、実施期間をクラスの開催期間に合わせる場合、終了日時を指定することができません。
「終了日時」が「開始日時」より前の日付を指定している場合
eラーニングの更新に失敗しました。eラーニングの登録に失敗しました。終了日は開始日より後の日付を指定してください。
「eラーニングID」が存在しない場合:
eラーニングの更新に失敗しました。指定したeラーニングIDは存在しません。
「実施先コード」が存在しない場合:
eラーニングの更新に失敗しました。eラーニング実施先コードで指定した実施先は存在しません。
指定したeラーニングIDと実施先が異なる場合:
eラーニングの更新に失敗しました。eラーニングの実施先を変更することはできません。
WebAPI:eラーニングを削除する¶
deleteElearning¶
eラーニングを削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
eラーニングIDリスト＊繰り返しあり |
idList |
List<Integer> |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 56 |
message |
String |
- 56
メッセージ一覧
「認証キー」が未指定の場合
クラスの削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングの削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングの削除に失敗しました。認証キーは32文字以内で入力してください。
「eラーニングIDリスト」が未指定の場合
eラーニングの削除に失敗しました。eラーニングIDリストは必須項目です。
「eラーニングIDリスト」のIDが重複している場合
eラーニングの削除に失敗しました。同じeラーニングIDが指定されています。
「eラーニングIDリスト」のIDが存在しない場合
eラーニングの削除に失敗しました。指定したeラーニングは存在しません。
WebAPI:eラーニング実施履歴を取得する¶
getElearningProgress¶
eラーニング実施履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
eラーニングID |
elearningId |
Integer |
必須 |
受講者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
eラーニング実施履歴 *繰り返しあり |
ElearningProgress |
complexType |
eラーニング実施履歴.eラーニングID |
elearningId |
Integer |
eラーニング実施履歴.eラーニング名 |
elearningName |
String |
eラーニング実施履歴.受講者ログインID |
accountCode |
String |
eラーニング実施履歴.受講者氏名 |
accountName |
String |
eラーニング実施履歴.受講者組織コード |
organizationCode |
String |
eラーニング実施履歴.受講者組織名 |
organizationName |
String |
eラーニング実施履歴.コンテンツID |
contentId |
Integer |
eラーニング実施履歴.コンテンツの種類 1:通常教材 2：HTML教材 3：SCO教材 |
contentType |
Integer |
eラーニング実施履歴.コンテンツ名 |
contentName |
String |
eラーニング実施履歴.コンテンツを完了したかの判別 |
finished |
Boolean |
eラーニング実施履歴.コンテンツ完了日時 |
completedDate |
Date |
eラーニング実施履歴.コンテンツ最終実施日時 |
lastLearningDate |
Date |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 57 |
message |
String |
- 57
メッセージ一覧
「認証キー」が未指定の場合
eラーニング実施履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニング実施履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニング実施履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「eラーニングID」が未指定の場合
eラーニング実施履歴の取得に失敗しました。eラーニングIDは必須項目です。
「eラーニングID」が存在しない場合
eラーニング実施履歴の取得に失敗しました。指定したeラーニングIDは存在しません。
「受講者ログインID」が存在しない場合
eラーニング実施履歴の取得に失敗しました。指定した利用者コードは存在しません。
「受講者ログインID」がeラーニング対象者でない場合
eラーニング実施履歴の取得に失敗しました。指定したログインIDは、指定したeラーニングの対象者ではありません。
WebAPI:eラーニングのSCORM実施履歴を取得する¶
getElearningScormProgress¶
eラーニングのSCORM実施履歴を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
SCORMコンテンツID |
contentId |
Integer |
必須 |
受講者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
eラーニングSCORM教材実施履歴 *繰り返しあり |
ElearningScormProgress |
complexType |
eラーニングSCORM教材実施履歴.コンテンツID |
contentId |
Integer |
eラーニングSCORM教材実施履歴.コンテンツ名 |
contentName |
String |
eラーニングSCORM教材実施履歴.受講者ログインID |
accountCode |
String |
eラーニングSCORM教材実施履歴.受講者氏名 |
accountName |
String |
eラーニングSCORM教材実施履歴.受講者組織コード |
organizationCode |
String |
eラーニングSCORM教材実施履歴.受講者組織名 |
organizationName |
String |
eラーニングSCORM教材実施履歴.コンテンツ開始日時 |
startDate |
Date |
eラーニングSCORM教材実施履歴.コンテンツ終了日時 |
completeDate |
Date |
eラーニングSCORM教材実施履歴.目次ID |
scoId |
String |
eラーニングSCORM教材実施履歴.目次タイトル |
scoName |
String |
eラーニングSCORM教材実施履歴.目次を参照した回数 |
attemptCount |
Integer |
eラーニングSCORM教材実施履歴.目次の学習時間 *フォーマットは「(2桁以上の数字)時間:(2桁の数字)分:(2桁の数字)秒」となっています。未実施の場合は「-」が出力されます。 |
learningTime |
String |
eラーニングSCORM教材実施履歴.目次の状態 (SCORM1.2) passed:合格, completed：完了, failed:不合格, incomplete：学習中, browsed:閲覧済み, not attempted:未学習 |
lessonStatus |
String |
eラーニングSCORM教材実施履歴.目次の完了状態 (SCORM2004) completed:完了, incomplete：学習中, unknown:不明, skipped:スキップ, not attempted:未学習 |
completionStatus |
String |
eラーニングSCORM教材実施履歴.目次の合格状態 (SCORM2004) passed:合格, failed:不合格, unknown:不明 |
successStatus |
String |
eラーニングSCORM教材実施履歴.目次の開始日時 |
scoDate |
Date |
eラーニングSCORM教材実施履歴.目次の点数 |
score |
String |
eラーニングSCORM教材実施履歴.問題ID |
responseId |
String |
eラーニングSCORM教材実施履歴.問題への受講者の回答 |
response |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 58 |
message |
String |
- 58
メッセージ一覧
「認証キー」が未指定の場合
eラーニングSCORM教材実施履歴の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングSCORM教材実施履歴の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングSCORM教材実施履歴の取得に失敗しました。認証キーは32文字以内で入力してください。
「SCORMコンテンツID」が未指定の場合
eラーニングSCORM教材実施履歴の取得に失敗しました。SCORMコンテンツIDは必須項目です。
「SCORMコンテンツID」が存在しない場合
eラーニングSCORM教材実施履歴の取得に失敗しました。指定したSCORMコンテンツIDは存在しません。
「SCORMコンテンツID」がSCORM教材ではない場合
eラーニングSCORM教材実施履歴の取得に失敗しました。指定したコンテンツIDは、SCORM教材ではありません。
「受講者ログインID」が存在しない場合
eラーニングSCORM教材実施履歴の取得に失敗しました。指定した利用者コードは存在しません。
「受講者ログインID」がeラーニング対象者でない場合
eラーニングSCORM教材実施履歴の取得に失敗しました。指定したログインIDは、指定したeラーニングの対象者ではありません。
WebAPI:eラーニングのSCORM進捗率を取得する¶
getScormProgressRate¶
eラーニングのSCORM進捗率を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
SCORMコンテンツID |
contentId |
Integer |
必須 |
受講者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
eラーニングSCORM進捗率 *繰り返しあり |
ScormProgressRate |
complexType |
eラーニングSCORM進捗率.eラーニングID |
elearningId |
Integer |
eラーニングSCORM進捗率.eラーニング名 |
elearningName |
String |
eラーニングSCORM進捗率.コンテンツID |
contentId |
Integer |
eラーニングSCORM進捗率.コンテンツ名 |
contentName |
String |
eラーニングSCORM進捗率.受講者ログインID |
accountCode |
String |
eラーニングSCORM進捗率.受講者氏名 |
accountName |
String |
eラーニングSCORM進捗率.受講者組織コード |
organizationCode |
String |
eラーニングSCORM進捗率.受講者組織名 |
organizationName |
String |
eラーニングSCORM進捗率.コンテンツ開始日時 |
startDate |
Date |
eラーニングSCORM進捗率.コンテンツ終了日時 |
completeDate |
Date |
eラーニングSCORM進捗率.受講者eメールアドレス |
String |
|
eラーニングSCORM進捗率.進捗率(%) |
progressRate |
Integer |
eラーニングSCORM進捗率.受講者ログイン無効 true:ログイン無効 false:ログイン有効 |
loginInvalidation |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 59 |
message |
String |
- 59
メッセージ一覧
「認証キー」が未指定の場合
eラーニングSCORM進捗率の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングSCORM進捗率の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングSCORM進捗率の取得に失敗しました。認証キーは32文字以内で入力してください。
「SCORMコンテンツID」が未指定の場合
eラーニングSCORM進捗率の取得に失敗しました。SCORMコンテンツIDは必須項目です。
「SCORMコンテンツID」が存在しない場合
eラーニングSCORM進捗率の取得に失敗しました。指定したSCORMコンテンツIDは存在しません。
「SCORMコンテンツID」がSCORM教材ではない場合
eラーニングSCORM進捗率の取得に失敗しました。指定したコンテンツIDは、SCORM教材ではありません。
「受講者ログインID」が存在しない場合
eラーニングSCORM進捗率の取得に失敗しました。指定した利用者コードは存在しません。
「受講者ログインID」がeラーニング対象者でない場合
eラーニングSCORM進捗率の取得に失敗しました。指定したログインIDは、指定したeラーニングの対象者ではありません。
WebAPI:eラーニングのSCORM進捗率を取得する(クラス指定)¶
getScormProgressRateOfClass¶
クラスの開催番号を指定してeラーニングのSCORM進捗率を取得するサービスです。 指定したクラスの受講者アカウントに割り当てられている全eラーニング（実施中）のSCORM進捗率を取得します。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
開催番号 |
classCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
eラーニングSCORM進捗率 *繰り返しあり |
ScormProgressRate |
complexType |
eラーニングSCORM進捗率.eラーニングID |
elearningId |
Integer |
eラーニングSCORM進捗率.eラーニング名 |
elearningName |
String |
eラーニングSCORM進捗率.コンテンツID |
contentId |
Integer |
eラーニングSCORM進捗率.コンテンツ名 |
contentName |
String |
eラーニングSCORM進捗率.受講者ログインID |
accountCode |
String |
eラーニングSCORM進捗率.受講者氏名 |
accountName |
String |
eラーニングSCORM進捗率.受講者組織コード |
organizationCode |
String |
eラーニングSCORM進捗率.受講者組織名 |
organizationName |
String |
eラーニングSCORM進捗率.コンテンツ開始日時 |
startDate |
Date |
eラーニングSCORM進捗率.コンテンツ終了日時 |
completeDate |
Date |
eラーニングSCORM進捗率.受講者eメールアドレス |
String |
|
eラーニングSCORM進捗率.進捗率(%) |
progressRate |
Integer |
eラーニングSCORM進捗率.受講者ログイン無効 true:ログイン無効 false:ログイン有効 |
loginInvalidation |
Boolean |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 60 |
message |
String |
- 60
メッセージ一覧
「認証キー」が未指定の場合
eラーニングSCORM進捗率の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
eラーニングSCORM進捗率の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
eラーニングSCORM進捗率の取得に失敗しました。認証キーは32文字以内で入力してください。
「開催番号」が未入力の場合
eラーニングSCORM進捗率の取得に失敗しました。開催番号は必須項目です。
「開催番号」が256文字より多い場合
eラーニングSCORM進捗率の取得に失敗しました。開催番号は256文字以内で入力してください。
「開催番号」が存在しない場合
eラーニングSCORM進捗率の取得に失敗しました。指定した開催番号は存在しません。
WebAPI:共有コンテンツ情報を取得する¶
WebAPI:動画情報を取得する¶
getVideoFileInfo¶
動画情報を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （タイトルに部分一致） |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
動画ファイル情報 *繰り返しあり |
VideoFileInfo |
complexType |
動画ファイル情報.動画ファイルID |
id |
Integer |
動画ファイル情報.タイトル |
title |
String |
動画ファイル情報.ステータス(1:視聴可能 2:準備中 3:登録失敗) |
status |
Integer |
動画ファイル情報.拡張子 |
extention |
String |
動画ファイル情報.動画の長さ(秒) |
seconds |
Integer |
動画ファイル情報.登録者ログインID |
accountCode |
String |
動画ファイル情報.VR(true:VR設定有り、false：VR設定なし) |
vr |
Boolean |
動画ファイル情報.URL(有効期限は1時間です) |
url |
String |
動画ファイル情報.使用中のeラーニングID |
materialIdList |
List<Integer> |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 62 |
message |
String |
- 62
メッセージ一覧
「認証キー」が未指定の場合
動画ファイル情報の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
動画ファイル情報の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
動画ファイル情報の取得に失敗しました。認証キーは32文字以内で入力してください。
WebAPI:課題を取得する¶
getAssignment¶
課題を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
キーワード |
keyword |
String |
任意 （課題タイトル、実施先名、実施先コードに部分一致） |
状態 0:受付開始前 1：受付中 2：受付終了 |
state |
Integer |
任意 |
検索範囲（開始日） |
startDate |
Date |
任意 ※クラスの開催期間に合わせて実施する課題は検索対象から除外されます。 |
検索範囲（終了日） |
endDate |
Date |
任意 ※クラスの開催期間に合わせて実施する課題は検索対象から除外されます。 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
課題 *繰り返しあり |
Assignment |
complexType |
課題.課題ID |
id |
Integer |
課題.課題タイトル |
title |
String |
課題.課題の説明 |
explain |
String |
課題.受講者への評点結果を公開するかの判別 |
openScore |
Boolean |
課題.開始と終了を期間に合わせて自動で行うかの判別 |
automaticExec |
Boolean |
課題.レポート提出受付の状態 0:受付開始前 1：受付中 2：受付終了 |
state |
Integer |
課題.レポート提出受付開始日時 |
startDate |
Date |
課題.レポート提出受付終了日時 |
endDate |
Date |
課題.実施先の管理者・講師に編集・集計権限を与える |
addEditCounterRole |
Boolean |
課題.実施期間をクラスの開催期間に合わせる |
dependOnClass |
Boolean |
課題.課題実施先種類 1:プログラム 2：コース 3：クラス |
excutedPlaceType |
Integer |
課題.課題実施先コード |
excutedPlaceCode |
String |
課題.課題実施先名 |
excutedPlaceName |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 63 |
message |
String |
- 63
メッセージ一覧
「認証キー」が未指定の場合
課題の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
課題の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
課題の取得に失敗しました。認証キーは32文字以内で入力してください。
「状態」が規定の値でない場合
課題の取得に失敗しました。課題状態の識別子が不正です。
「検索範囲（開始日）」が年月日形式の書式でない場合
課題の取得に失敗しました。検索範囲（開始）の年月日を正しく入力してください。
「検索範囲（終了日）」が年月日形式の書式でない場合
課題の取得に失敗しました。検索範囲（終了）の年月日を正しく入力してください。
「検索範囲（終了日）」が「検索範囲（開始日）」より前の日付の場合
課題の取得に失敗しました。検索終了日は検索開始日より後の日付を指定してください。
WebAPI:課題レポート提出状況を取得する¶
getAssignmentLearnerStatus¶
課題レポート提出状況を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
課題ID |
assignmentId |
Integer |
必須 |
受講者ログインID |
accountCode |
String |
任意 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
課題レポート提出状況 *繰り返しあり |
AssignmentLearnerStatus |
complexType |
課題レポート提出状況.課題ID |
assignmentId |
Integer |
課題レポート提出状況.課題タイトル |
assignmentTitle |
String |
課題レポート提出状況.受講者ログインID |
accountCode |
String |
課題レポート提出状況.受講者氏名 |
accountName |
String |
課題レポート提出状況.受講者組織コード |
organizationCode |
String |
課題レポート提出状況.受講者組織名 |
organizationName |
String |
課題レポート提出状況.レポートを提出したかの判別 |
submitted |
Boolean |
課題レポート提出状況.レポートを最後に提出した日時 |
submittedLastDate |
Date |
課題レポート提出状況.評点 |
score |
String |
課題レポート提出状況.評点最終更新日時 |
scoredLastDate |
Date |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 64 |
message |
String |
- 64
メッセージ一覧
「認証キー」が未指定の場合
課題レポート提出状況の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
課題レポート提出状況の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
課題レポート提出状況の取得に失敗しました。認証キーは32文字以内で入力してください。
「課題ID」が未指定の場合
課題レポート提出状況の取得に失敗しました。課題IDは必須項目です。
「課題ID」が存在しない場合
課題レポート提出状況の取得に失敗しました。指定した課題IDは存在しません。
「受講者ログインID」が存在しない場合
課題レポート提出状況の取得に失敗しました。指定した利用者コードは存在しません。
「受講者ログインID」が課題対象者でない場合
課題レポート提出状況の取得に失敗しました。指定したログインIDは、指定した課題の対象者ではありません。
WebAPI:利用者属性を登録する¶
registerUserAttribute¶
利用者属性を登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者属性 |
UserAttribute |
complexType |
必須 |
利用者属性.利用者属性ID |
id |
Integer |
*指定しない |
利用者属性.利用者属性コード |
code |
String |
必須 |
利用者属性.利用者属性名 |
name |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 65 |
message |
String |
- 65
メッセージ一覧
「認証キー」が未指定の場合
利用者属性の登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者属性の登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者属性の登録に失敗しました。認証キーは32文字以内で入力してください。
「利用者属性.利用者属性ID」が指定されている場合
利用者属性の登録に失敗しました。登録処理の場合、利用者属性IDは自動採番しますので省略してください。
「利用者属性.利用者属性コード」が未指定の場合
利用者属性の登録に失敗しました。利用者属性コードは必須項目です。
「利用者属性.利用者属性名」が未指定の場合
利用者属性の登録に失敗しました。利用者属性名は必須項目です。
「利用者属性.利用者属性コード」がすでに存在している利用者属性コードの場合
利用者属性の登録に失敗しました。指定した利用者属性コードはすでに存在しています。異なる値を指定してください。
WebAPI:利用者属性を取得する¶
getUserAttribute¶
利用者属性を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
利用者属性 |
UserAttribute |
complexType |
利用者属性.利用者属性ID |
id |
Integer |
利用者属性.利用者属性コード |
code |
String |
利用者属性.利用者属性名 |
name |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 66 |
message |
String |
- 66
メッセージ一覧
「認証キー」が未指定の場合
利用者属性の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者属性の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者属性の取得に失敗しました。認証キーは32文字以内で入力してください。
「利用者属性コード」が未指定の場合
利用者属性の取得に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
利用者属性の取得に失敗しました。指定した利用者属性コードは存在しません。
WebAPI:利用者属性を更新する¶
updateUserAttribute¶
利用者属性を更新するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者属性 |
UserAttribute |
complexType |
必須 |
利用者属性.利用者属性ID |
id |
Integer |
必須 |
利用者属性.利用者属性コード |
code |
String |
必須 |
利用者属性.利用者属性名 |
name |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 67 |
message |
String |
- 67
メッセージ一覧
「認証キー」が未指定の場合
利用者属性の更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者属性の更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者属性の更新に失敗しました。認証キーは32文字以内で入力してください。
「利用者属性.利用者属性ID」が未指定の場合
利用者属性の更新に失敗しました。利用者属性IDは必須項目です。
「利用者属性.利用者属性ID」が存在しない場合
利用者属性の更新に失敗しました。指定した利用者属性IDは存在しません。
「利用者属性.利用者属性コード」が未指定の場合
利用者属性の更新に失敗しました。利用者属性コードは必須項目です。
「利用者属性.利用者属性名」が未指定の場合
利用者属性の更新に失敗しました。利用者属性名は必須項目です。
「利用者属性.利用者属性コード」がすでに存在している利用者属性コードの場合
利用者属性の更新に失敗しました。指定した利用者属性コードはすでに存在しています。異なる値を指定してください。
WebAPI:利用者属性を削除する¶
deleteUserAttribute¶
利用者属性を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 68 |
message |
String |
- 68
メッセージ一覧
「認証キー」が未指定の場合
利用者属性の削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者属性の削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者属性の削除に失敗しました。認証キーは32文字以内で入力してください。
「利用者属性コード」が未指定の場合
利用者属性の削除に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
利用者属性の削除に失敗しました。指定した利用者属性コードは存在しません。
削除したい利用者属性が、クラスの受講対象に指定されている場合
利用者属性の削除に失敗しました。利用者属性がクラスの受講対象に指定されているため、削除できません。
WebAPI:属性項目を登録する¶
registerUserAttributeType¶
属性項目を登録するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
属性項目 |
UserAttributeType |
complexType |
必須 |
属性項目.属性項目ID |
id |
Integer |
*指定しない |
属性項目.属性項目コード |
code |
String |
必須 |
属性項目.属性項目名 |
name |
String |
必須 |
属性項目.利用者属性ID |
attributeId |
Integer |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 69 |
message |
String |
- 69
メッセージ一覧
「認証キー」が未指定の場合
属性項目の登録に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
属性項目の登録に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
属性項目の登録に失敗しました。認証キーは32文字以内で入力してください。
「属性項目.属性項目ID」が指定されている場合
属性項目の登録に失敗しました。登録処理の場合、属性項目IDは自動採番しますので省略してください。
「属性項目.属性項目コード」が未指定の場合
属性項目の登録に失敗しました。属性項目コードは必須項目です。
「属性項目.属性項目名」が未指定の場合
属性項目の登録に失敗しました。属性項目名は必須項目です。
「属性項目.利用者属性ID」が未指定の場合
属性項目の登録に失敗しました。利用者属性IDは必須項目です。
「属性項目.属性項目コード」がすでに他の利用者属性と紐づいている場合
属性項目の登録に失敗しました。指定した属性項目コードはすでに存在しています。異なる値を指定してください。
「属性項目.利用者属性ID」に紐づく利用者属性が存在しない場合
属性項目の登録に失敗しました。利用者属性IDが不正です。
WebAPI:属性項目を取得する¶
getUserAttributeType¶
属性項目を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
属性項目コード |
userAttributeTypeCode |
String |
必須 |
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
属性項目 |
UserAttributeType |
complexType |
属性項目.属性項目ID |
id |
Integer |
属性項目.属性項目コード |
code |
String |
属性項目.属性項目名 |
name |
String |
属性項目.利用者属性ID |
attributeId |
Integer |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 70 |
message |
String |
- 70
メッセージ一覧
「認証キー」が未指定の場合
属性項目の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
属性項目の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
属性項目の取得に失敗しました。認証キーは32文字以内で入力してください。
「属性項目コード」が未指定の場合
属性項目の取得に失敗しました。属性項目コードは必須項目です。
「属性項目コード」が存在しない場合
属性項目の取得に失敗しました。指定した属性項目コードは存在しません。
「利用者属性コード」が未指定の場合
属性項目の取得に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
属性項目の取得に失敗しました。指定した利用者属性コードは存在しません。
WebAPI:属性項目を更新する¶
updateUserAttributeType¶
属性項目を更新するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
属性項目 |
UserAttributeType |
complexType |
必須 |
属性項目.属性項目ID |
id |
Integer |
必須 |
属性項目.属性項目コード |
code |
String |
必須 |
属性項目.属性項目名 |
name |
String |
必須 |
属性項目.利用者属性ID |
attributeId |
Integer |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 71 |
message |
String |
- 71
メッセージ一覧
「認証キー」が未指定の場合
属性項目の更新に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
属性項目の更新に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
属性項目の更新に失敗しました。認証キーは32文字以内で入力してください。
「属性項目.属性項目ID」が未指定の場合
属性項目の更新に失敗しました。属性項目IDは必須項目です。
「属性項目.属性項目ID」が存在しない場合
属性項目の更新に失敗しました。指定した属性項目IDは存在しません。
「属性項目.属性項目コード」が未指定の場合
属性項目の更新に失敗しました。属性項目コードは必須項目です。
「属性項目.属性項目名」が未指定の場合
属性項目の更新に失敗しました。属性項目名は必須項目です。
「属性項目.利用者属性ID」が未指定の場合
属性項目の更新に失敗しました。利用者属性IDは必須項目です。
「属性項目.属性項目コード」がすでに他の利用者属性と紐づいている場合
属性項目の更新に失敗しました。指定した属性項目コードはすでに存在しています。異なる値を指定してください。
WebAPI:属性項目を削除する¶
deleteUserAttributeType¶
属性項目を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
属性項目コード |
userAttributeTypeCode |
String |
必須 |
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 72 |
message |
String |
- 72
メッセージ一覧
「認証キー」が未指定の場合
属性項目の削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
属性項目の削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
属性項目の削除に失敗しました。認証キーは32文字以内で入力してください。
「属性項目コード」が未指定の場合
属性項目の削除に失敗しました。属性項目コードは必須項目です。
「属性項目コード」が存在しない場合
属性項目の削除に失敗しました。指定した属性項目コードは存在しません。
「利用者属性コード」が未指定の場合
属性項目の削除に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
属性項目の削除に失敗しました。指定した利用者属性コードは存在しません。
削除したい属性項目が、クラスの受講対象に指定されている場合
属性項目の削除に失敗しました。属性項目がクラスの受講対象に指定されているため、削除できません。
WebAPI:利用者に利用者属性を割り当てる¶
assignUserAttributeMapping¶
利用者に利用者属性を割り当てるサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
利用者と利用者属性マッピング |
UserAttributeMapping |
complexType |
必須 |
利用者と利用者属性マッピング.ログインID |
accountCode |
String |
必須 |
利用者と利用者属性マッピング.利用者属性コード |
attributeCode |
String |
必須 |
利用者と利用者属性マッピング.属性項目コード |
typeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
なし
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 73 |
message |
String |
- 73
メッセージ一覧
「認証キー」が未指定の場合
利用者の利用者属性の割当てに失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者の利用者属性の割当てに失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者の利用者属性の割当てに失敗しました。認証キーは32文字以内で入力してください。
「利用者と利用者属性マッピング.ログインID」が未指定の場合
利用者の利用者属性の割当てに失敗しました。ログインIDは必須項目です。
「利用者と利用者属性マッピング.利用者属性コード」が未指定の場合
利用者の利用者属性の割当てに失敗しました。利用者属性コードは必須項目です。
「利用者と利用者属性マッピング.属性項目コード」が未指定の場合
利用者の利用者属性の割当てに失敗しました。属性項目コードは必須項目です。
指定した「利用者と利用者属性マッピング.ログインID」に紐づく利用者が存在しない場合
利用者の利用者属性の割当てに失敗しました。ログインIDが不正です。
指定した「利用者と利用者属性マッピング.利用者属性コード」に紐づく利用者属性が存在しない場合
利用者の利用者属性の割当てに失敗しました。利用者属性コードが不正です。
指定した「利用者と利用者属性マッピング.属性項目コード」と利用者属性の組み合わせが存在しない場合
利用者の利用者属性の割当てに失敗しました。指定した属性項目コードは存在しません。
WebAPI:利用者の利用者属性を取得する¶
getUserAttributeMapping¶
利用者の利用者属性を取得するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
項目名 |
フィールド名 |
型 |
|---|---|---|
利用者と利用者属性マッピング |
UserAttributeMapping |
complexType |
利用者と利用者属性マッピング.ログインID |
accountCode |
String |
利用者と利用者属性マッピング.利用者属性コード |
attributeCode |
String |
利用者と利用者属性マッピング.属性項目コード（未指定の場合「空（""）」） |
typeCode |
String |
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 74 |
message |
String |
- 74
メッセージ一覧
「認証キー」が未指定の場合
利用者の利用者属性の取得に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者の利用者属性の取得に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者の利用者属性の取得に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
利用者の利用者属性の取得に失敗しました。ログインIDは必須項目です。
「ログインID」が存在しない場合
利用者の利用者属性の取得に失敗しました。指定したログインIDは存在しません。
「利用者属性コード」が未指定の場合
利用者の利用者属性の取得に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
利用者の利用者属性の取得に失敗しました。指定した利用者属性コードは存在しません。
WebAPI:利用者の利用者属性を削除する¶
deleteUserAttributeMapping¶
利用者の利用者属性を削除するサービスです。
項目名 |
フィールド名 |
型 |
説明 |
|---|---|---|---|
ログインID |
accountCode |
String |
必須 |
利用者属性コード |
userAttributeCode |
String |
必須 |
認証キー |
authKey |
String |
必須 |
- レスポンスパラメータ：正常終了時
- なし※利用者属性が割り当てられていない利用者に対して削除処理を行った場合、何も処理を行わず終了します。
項目名 |
フィールド名 |
型 |
|---|---|---|
メッセージ 75 |
message |
String |
- 75
メッセージ一覧
「認証キー」が未指定の場合
利用者の利用者属性の削除に失敗しました。認証キーは必須項目です。
「認証キー」がシステム管理者権限をもつ利用者のログイン情報で取得した有効な認証キーではない場合
利用者の利用者属性の削除に失敗しました。実行権限がありません。
「認証キー」が32文字より多い場合
利用者の利用者属性の削除に失敗しました。認証キーは32文字以内で入力してください。
「ログインID」が未指定の場合
利用者の利用者属性の削除に失敗しました。ログインIDは必須項目です。
「ログインID」が存在しない場合
利用者の利用者属性の削除に失敗しました。指定したログインIDは存在しません。
「利用者属性コード」が未指定の場合
利用者の利用者属性の削除に失敗しました。利用者属性コードは必須項目です。
「利用者属性コード」が存在しない場合
利用者の利用者属性の削除に失敗しました。指定した利用者属性コードは存在しません。