GroundColorsShow - ぺったんR Wiki - ぺったんR

show @ GroundColorsController

色地詳細

url

• http://localhost:3000/ground_colors/1
• http://localhost:3000/ground_colors/1.json

リクエスト

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

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

解説

色地の情報を得るための機能。APIのために用意した機能なので画面表示はありません。

• セッションまたは認証トークンからユーザアカウントを特定する。
• 色地モデルに単体取得を問い合わせ、その結果を対象色地として取得する。
  • 要求されたidとロールリスト(ユーザアカウントと管理者アカウント)を渡す。
• 取得したデータを返す。

urlパラメータ

id

• 色地のid

POSTデータ

auth_token

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

戻り値

正常系

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

参考:GroundColorsShowView

例外系

• ユーザまたは管理者アカウントでサインインしてなかった。(Devise)
  • htmlなら、ステータスコード302 Foundを返すとともに、サインインを促すページ(/users/sign_in)へ遷移する。
  • jsonなら、ステータスコード401 Unauthorizedを返すとともに、応答メッセージにUnauthorizedを返す。
  • ただし、オープンモードで起動しているなら、サインインの必要はないので例外とはならない。
• 対象色地が存在しなかった。(GroundColorModel)
  • htmlなら、例外404 not_foundを返す
  • jsonなら、例外404 not_foundを返す
• 対象色地に対する閲覧権限がなかった。(GroundColorModel)
  • 例外403 forbiddenを返す
  • 例外403 forbiddenを返す