【intra-mart】暗黙レスポンスパラメータのJSON文字列を作りました

はじめに

アクション処理内でのエラーチェック時やファイルダウンロード時に利用する、「暗黙レスポンスパラメータ」について、JSON文字列を見つけられなかったので作成しました。

暗黙レスポンスパラメータをJSON入力機能で利用された方はご利用いただければと思います。

JSON文字列

imfrSoaResultのオブジェクト配下のJSON文字列です。各項目の仕様詳細はintra-mart公式ドキュメントをご確認いただければと思います。

なおすべて定義する必要はありません。必要なオブジェクト部分のみ定義すればOKです。

（例）ファイルダウンロードだけ使いたい→「imfrDownloadFile」オブジェクトを含むオブジェクト配下を出力定義すればOK

加えてロケール文字の定義（imfrMulti、imfrErrorMulti）は必要なロケール文字のみの定義でOKです。

{
  "imfrSoaResult": {
    "imfrErrorFlag": false,
    "imfrMessage": [
      ""
    ],
    "imfrMultiMessages": [
      {
        "imfrMulti_ja": "",
        "imfrMulti_en": ""
      }
    ],
    "imfrErrorItems": [
      {
        "imfrInputId": [
          ""
        ],
        "imfrErrorMessage": "",
        "imfrErrorMultiMessages": {
          "imfrErrorMulti_ja": "",
          "imfrErrorMulti_en": "",
          "imfrIndex": 0
        }
      }
    ],
    "imfrDownloadFile": {
      "imfrFile": null,
      "imfrFileName": "",
      "string1": ""
    }
  }
}

JSON文字列取り込み時のワンポイントアドバイス

JSON文字列化すると定義の中に「null」がありますが、null値の型で特定の型に指定すると意図通りに設定されます。毎回毎回なぜかobjectになるなと思われる場合は、こちらをお試しいただければと思います。

まとめ

以上で、『【intra-mart】暗黙レスポンスパラメータのJSON文字列を作りました』でした。私の検索の仕方が悪いのか、暗黙レスポンスパラメータのJSON文字列を見つけられなかったので、作成してみました。公式のがあればそちらを使われるのが良いので、公式の定義をお使いいただければと思います。