SUIRANFES API

SUIRANFES APIとは

文化祭向けの独自仕様のデータベース的なものです。

pugなどのjavascriptで扱いやすいように作りました。

以下に層ごとに簡単に説明します。

1層目

{
  "option" : "",
  "fes" : { ~ },
  "site" : { ~ }
}

"option"は必ず空の文字列を返します。

"fes"

"fes" : {
  "common" : { ~ },
  "Day1" : { ~ },
  "Day2" : { ~ },
  "pantene" : { ~ },
  "pantenebadges" : { ~ },
  "foods" : { ~ },
  "foodsshops" : { ~ },
  "events" : { ~ },
  "eventsplaces" : { ~ }
}

• commonはテーマや学校の住所を返します。
• Daynはn日目の情報を返します。
  • 返す情報は日付など固有の情報です。
  • 含む情報は自由ですが、日付に強く囚われた情報のみ格納してください。

pantene,pantenebadges

• panteneは「部活動展示」「クラス展示」といった主に校内で常時展示されるものに利用します。
• pantenebadgesは、分かりやすくバッジやタグを表示するときの、日本語名とスタイルを指定するセットです。
  • bootstrap等にあるバッジを利用するときに活用されます。

"pantene" : [
  {
    "id" : 文字列ないし数字,  // 学校内での場所を示します。 例:"A01"
    "type" : 文字列ないし数字, // 展示の種類
    "name" : 文字列,  // 英数字を推奨します。たとえばhtmlの要素のidに指定されます。
    "title" : 文字列,  // ディスプレイに表示されます。
    "description" : 文字列, // 説明を書き入れます。
    "attractions" : [Strings], // その展示でできることを羅列し、検索の補助になるようにします。
    "place" : 任意, // 展示が行われている場所を任意の型で記入します。
    "place" : { "floor" : 2, "room" : 5 } // 例:「2年5組」
    "hosts" : [  // 翠巒祭のような特殊な例で配列にしていますが、任意。
      { "name" : "3-5", "title" : "3年5組" },
      { "name" : "3-6", "title" : "3年6組" },
    ]
  },
  .
  .
  .
],

"pantenebadges" : {
  文字列 : {
    "title" : 文字列,
    "style" : 文字列
  },
  .
  .
  .
}