API 関数の概要

API関数の詳細は，下表のとおりである．

表 5.3  API 関数の詳細一覧  セッション関数 Initialize 構文： Initialize(parameter)

解説： 通信セッションを開始（初期化）する．

パラメータ： (“”)−空文字列

返り値： 真理値（True／False）の文字列

true −LMS側での初期化が成功したことを示す．

false −LMS側での初期化が失敗したことを示す．

この場合，API インスタンスにエラーコードの値が設定されるの で，エラー情報を解析する場合にはサポート関数を利用するとよ い．

Terminate 構文： Terminate(parameter)

解説： 通信セッションを終了する．この終了処理は，APIインスタンスに 設定したデータをLMSに送信することも同時に行う．また，一度こ の終了処理を行うと，サポート関数しか呼び出すことができなくな る．

パラメータ： (“”)−空文字列

返り値： 真理値（True／False）の文字列

true −LMS側での終了処理が成功したことを示す．

false −LMS側での終了処理が失敗したことを示す．

この場合，API インスタンスにエラーコードの値が設定されるの で，エラー情報を解析する場合にはサポート関数を利用するとよ い．

データ転送関数 GetValue 構文： GetValue(parameter)

解説： LMSから情報を取得することができる．

SCOがLMSから取得できる情報は以下のとおりである．

・LMSでサポートされているデータモデル要素の値

・LMSでサポートされているデータモデルのバージョン

・サポートされている固有のデータモデル要素 パラメータ： データモデル要素名

返り値： 下記の２つのうち，どちらかの値，返り値はすべて文字列．

・パラメータに関係する値の文字列

・エラーが発生した場合には，空文字列(“”)が返却される．この場合 はAPIインスタンスにエラーコードの値が設定されるので，エラ ー情報を解析する場合にはサポート関数を利用するとよい．

SetValue 構文： SetValue(parameter_1,parameter_2) 解説： LMSへ情報を送信することができる．

データ要素（parameter_1）に対する値（parameter_2）を指定する．

API インスタンスは，設計によってデータを直ぐにサーバ側に送る か，一旦データをキャッシュして送るように実装されている．

パラメータ： parameter_1−設定されるデータ要素名 parameter_2−データ要素する値（文字列）

返り値： 真理値（True／False）の文字列

true −LMS側でのデータ設定が成功したことを示す．

false −LMS側でのデータ設定が失敗したことを示す．

この場合，API インスタンスにエラーコードの値が設定されるの で，エラー情報を解析する場合にはサポート関数を利用するとよ い．

Commit 構文： Commit(parameter)

解説： SCOからのデータをLMSに送信する．前回Initialize()かCommit() が実行された以降に API インスタンスによってキャッシュされたデ ータが送信される．LMS側への送信が成功すると，エラー未発生のエ ラーコードが API インスタンスに設定され， true が返却される．

また，APIインスタンスにデータがキャッシュされていない場合でも，

上記と同様に処理される．

パラメータ： (“”)−空文字列

返り値：真理値（True／False）の文字列

true −LMS側への送信が成功したことを示す．

false −LMS側への送信が失敗したことを示す．

この場合，API インスタンスにエラーコードの値が設定されるの で，エラー情報を解析する場合にはサポート関数を利用するとよ い．

サポート関数 GetLastError 構文： GetLastError ()

解説： APIインスタンスに設定された最新のエラー状態に対応するエラー コードを取得する．この関数を呼び出すと，APIインスタンスのエラ ー状態が変化しないが，単純に要求した情報が返却される．

パラメータ： 何も指定しない．

返り値： APIインスタンスの最新のエラー状態に対応するエラーコードが 文字列で返却される．

GetErrorString 構文： GetErrorString (prameter)

解説： 最新のエラー状態のテキストによる説明を取り出す．APIインスタ ンスは，APIに実装されているエラーコードを支援することを保証し なければならない．このエラーの呼び出しは，最新のエラー状態に影 響なく，要求した情報を返却してくれる．

パラメータ： エラーメッセージに対応するエラーコードの文字列．

返り値： パラメータで設定したエラーコードに対応するエラーメッセージ が文字列で返却される．

・返却される文字列は，最大255文字まで

・エラーコードは規定されているが，エラーに関する記述はLMS 固有のものである．

・LMS が要求したエラーコードを識別できなけば，空文字列(“”) が返却される．

GetDiagnostic 構文： GetDiagnostic (prameter)

解説： LMSが個別利用するための出力関数．APIインスタンスを通して，

診断情報を付加して定義することができる．

パラメータ： 診断の為に実装された個別の値．最大でも255文字の文字列 に指定すべきである．パラメータの値にエラーコードを指定する 場合もあるが，その制限はない．

返り値： パラメータで設定したエラーコードに対応するエラーメッセージ が文字列で返却される．このエラーの呼び出しは，最新のエラー 状態に影響なく，要求した情報を返却してくれる．

注：このcharacterstring (“”)関数のパラメータが空文字列(“”)ならば，この 関数は，直前に発生したエラーについての診断情報の文字列が返却され るように推奨されている．