提供Web API①:テンプレートフォーム一覧の取得

※LinkPrint CLOUD Web APIの概要や本記事内に記載されている用語についての説明はこちらをご確認ください。

テンプレートフォーム一覧の取得方法

LinkPrint CLOUD Web APIを利用して、対象テンプレートフォーム(※①)の一覧を取得できます。

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

※①:以下のテンプレートフォームが対象テンプレートフォームになります。

・標準テンプレートフォーム
開発会社様が作成し、対象の利用会社様に対して共通化したテンプレートフォーム。 
開発会社様が作成し共通化したフォームカテゴリを利用して、利用会社様が独自に作成したテンプレートフォーム。

 

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

取得方法サンプル
関数名 LPCA.getFormList
引数①
必須。

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

引数②
省略可。

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

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

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

戻り値

配列の形式でテンプレートフォーム一覧の情報を戻します。
配列の中身は、以下の情報になります。
1.form_id:テンプレートフォームのID
2.form_name:テンプレートフォーム名
3.form_category_name:テンプレートフォームカテゴリ名
4.form_make_user:
 “user”:連携利用会社が作成したテンプレートフォーム
 “developer”:開発会社が作成したテンプレートフォーム
 “lpc_common”:標準テンプレートフォーム
5.category_make_user:
 ”developer”:開発会社が作成したフォームカテゴリ
 ”lpc_common”:標準フォームカテゴリ

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

<script>
//formListの情報を扱う関数
function afterGetFormList(formListInfos){
  if(“error” in formListInfos){
    //エラー時の処理
  }else{
    //取得成功時の処理
    for(var i = 0; i < formListInfos["formList"].length; i++){
     //テンプレートフォームのID
     var template_id = formListInfos[“formList”][i][“form_id”];
     //テンプレートフォーム名
     var template_name = formListInfos[“formList”][i][“form_name”];
     //利用しているフォームカテゴリ名
     var template_form_category_name = formListInfos[“formList”][i][“form_category_name”];
     //テンプレートフォームの作成者
     var template_make_user = formListInfos[“formList”][i][“form_make_user”];
     //利用しているフォームカテゴリの作成者
     var template_category_make_user = formListInfos[“formList”][i][“category_make_user”];
    }
  }
}

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

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

//テンプレートフォーム一覧を取得する
LPCA.getFormList(afterGetFormList, waiting, waited);
</script>