提供Web API④：フォームの詳細情報を取得

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

フォームの詳細情報取得方法

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

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

関数名	SLA.getFormDetailInfo
引数①	必須。 SLA.getFormListにて取得した情報内にある対象のform_idをご指定ください。
引数②	必須。コールバック関数。フォームの詳細情報を取得した後にそれらの情報を扱う、「開発会社」様側の関数をご指定ください。
引数③	省略可。当処理は、非同期の処理です。フォームの詳細情報が返ってくるまでお時間がかかることがありますので、画面上に「処理中」等のメッセージを表示されたい場合は、メッセージを表示するための関数を「開発会社」様側でご用意いただき、その関数をこの二つ目の引数にご指定ください。
引数④	引数③を省略された場合は省略してください。引数③をご指定された場合に、そのメッセージ（「処理中」等）を非表示にするための処理をご指定ください。
戻り値	配列の形式でフォームの詳細情報を戻します。配列の中身は、以下の情報になります。 1.definition_id：フォームに利用している定義の定義ID 2.definition_name：フォームに利用している定義の定義名 3.form_name：フォーム名 4.last_update_date：最終更新日 5.panenum：面付タイプのフォームの場合に、その面付数 6.panesize：面付タイプのフォームの場合に、その面サイズ 7.papercate：専用紙/白紙 8.papersize：用紙サイズ 9.thumbnail：サムネイル画像 ※エラーが発生した場合は、「”error”」という情報が返ります。

●サンプル

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

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

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

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

フォームの詳細情報取得方法

関連記事