SpeechBalloonTemplatesIndex - ぺったんR Wiki - ぺったんR

index @ SpeechBalloonTemplatesController

一覧形式

url

• http://localhost:3000/speech_balloon_templates
• http://localhost:3000/speech_balloon_templates.json

リクエスト

認証	読者*
権限
method	get
urlパラメータ
POSTデータ	json形式*
html	○
json	○
jsonp	×

*オープンモードのとき、誰でも可 →RunMode

解説

フキダシを選ぶためのフキダシエクスプローラーを表示するために、一覧形式で表示する。コマエディタが管理するデータなので、ページ管理はしない。

• セッションまたは認証トークンからユーザアカウントを特定する。
• フキダシテンプレートモデルに一覧取得を問い合わせ、その結果をテンプレートリストとして取得する。
• 取得したデータを返す。

urlパラメータ

POSTデータ

auth_token

• 外部からjsonで要求する場合、認証処置として認証トークンが必要。

戻り値

正常系

• htmlのとき、ステータスコード200 OKとともに、テンプレートから起こしたページを返す。
• jsonのとき、ステータスコード200 OKとともに、json構造のデータを返す。
  • 出力フォーマットはフキダシテンプレートモデルのjson一覧出力オプションに従う

例外系

• ユーザまたは管理者アカウントでサインインしてなかった。(Devise)
  • htmlなら、ステータスコード302 Foundを返すとともに、サインインを促すページ(/users/sign_in)へ遷移する。
  • jsonなら、ステータスコード401 Unauthorizedを返すとともに、応答メッセージにUnauthorizedを返す。
  • ただし、オープンモードで起動しているなら、サインインの必要はない。