提供Web API②:テンプレートフォームの詳細情報取得

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

テンプレートフォームの詳細情報取得方法

提供Web API①:テンプレートフォーム一覧の取得」で取得した各テンプレートフォームの詳細情報を取得することができます。

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

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

LPCA.getFormListにて取得した情報内にある対象のform_idをご指定ください。

引数②
必須。
コールバック関数。
テンプレートフォームの詳細情報を取得した後にそれらの情報を扱う、開発会社様側の関数をご指定ください。
引数③
省略可。

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

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

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

戻り値

配列の形式でテンプレートフォームの詳細情報を戻します。
配列の中身は、以下の情報になります。
1.definition_name:テンプレートフォームに利用しているフォームカテゴリの名前
2.form_name:テンプレートフォーム名
3.last_update_date:最終更新日
4.panenum:面付タイプのテンプレートフォームの場合に、その面付数
5.panesize:面付タイプのテンプレートフォームの場合に、その面サイズ
6.papercate:専用紙/白紙
7.papersize:用紙サイズ
8.thumbnail:サムネイル画像
9.form_divide_flg:
  true:フォーム振り分け設定あり
  false:フォーム振り分け設定なし

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

<script>
//上記表 引数②のコールバック関数
function afterGetFormDetail(returnData){
  if(“error” in returnData){
    //エラー時の処理
  }else{
    //取得成功時の処理
    //テンプレートフォームに利用しているフォームカテゴリの名前
    var form_category_name = returnData[“form_info”][“definition_name”];
    //テンプレートフォーム名
    var template_name = returnData[“form_info”][“form_name”];
    //最終更新日
    var last_update_date = returnData[“form_info”][“last_update_date”];
    //面付タイプのテンプレートフォームの場合に、その面付数
    var pane_num = returnData[“form_info”][“panenum”];
    //面付タイプのテンプレートフォームの場合に、その面サイズ
    var pane_size = returnData[“form_info”][“panesize”];
    //専用紙/白紙
    var paper_category = returnData[“form_info”][“papercate”];
    //用紙サイズ
    var paper_size= returnData[“form_info”][“papersize”];
    //サムネイル画像
    var thumbnail_url = returnData[“form_info”][“thumbnail”];
  }
}

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

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

//対象のform_id
var target_form_id = ‘●●’

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