提供Web API①:フォーム一覧の取得

※この記事はSmartLabel Web API用アカウントをお持ちの「開発会社」様向けの内容となります。SmartLabel Web APIの概要についてはこちらからご確認ください。
また、本記事内に記載されている用語についての説明はこちらをご覧ください。

フォーム一覧の取得方法

SmartLabel Web APIを利用して、対象フォーム(※①)の一覧を取得できます。

取得した各フォームの詳細情報を取得することができます。「提供Web API④:フォームの詳細情報を取得」を参照ください。

※①:以下のフォームが対象フォームになります。

・「開発会社」様が作成し、対象の「利用会社」様に対して共通化したフォーム。
・「開発会社」様が作成し共通化した定義を利用して、「利用会社」様が独自に作成したフォーム

 

認証コードに弊社が用意したJavascriptがあり、その中にフォーム一覧の取得処理があります。以下の方法で取得することができます。

関数名 SLA.getFormList
引数①
必須。

コールバック関数。
フォーム一覧の情報を取得した後にそれらの情報を扱う、「開発会社」様側の関数をご指定ください。

引数②
省略可。

当処理は、非同期の処理です。フォーム一覧の情報が返ってくるまでお時間がかかることがありますので、画面上に「処理中」等のメッセージを表示されたい場合は、メッセージを表示するための関数を「開発会社」様側でご用意いただき、その関数をこの二つ目の引数にご指定ください。

引数③
引数②を省略された場合は省略してください。

引数②をご指定された場合に、そのメッセージ(「処理中」等)を非表示にするための処理をご指定ください。

戻り値 配列の形式でフォーム一覧の情報を戻します。
配列の中身は、以下の情報になります。
1.form_id:フォームのID
2.form_name:フォーム名
3.group_name:分類名
4.make_user:
“user”:連携利用会社が作成したフォーム
“developer”:開発会社が作成したフォーム

※エラーが発生した場合は、「”error”」という情報が返ります。

●サンプル

<script>
//formListの情報を扱う関数
function afterGetFormList(formList){
if(“error” in formList){
//エラー時の処理
}else{
//取得成功時の処理
}
}

//「処理中」等のメッセージを表示する関数
function waiting(){
//「処理中」等のメッセージを表示する処理
}

//「処理中」等のメッセージを非表示にする関数
function waited(){
//「処理中」等のメッセージを非表示にする処理
}

//フォーム一覧を取得する
SLA.getFormList(afterGetFormList, waiting, waited);
</script>

関連記事