PicturesCredit - ぺったんR Wiki - ぺったんR

credit　@ PicturesController

クレジット表示

url

• http://localhost:3000/pictures/1/credit
• http://localhost:3000/pictures/1/credit.json

リクエスト

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

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

解説

実素材のクレジット表示、あるいは実素材のクレジット情報を得るために使う機能。

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

urlパラメータ

id

• 対象となる実素材のid

POSTデータ

auth_token

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

戻り値

正常系

• htmlのとき、ステータスコード200 OKとともに、テンプレートから起こしたページを返す。
• jsonのとき、ステータスコード200 OKとともに、json構造のデータを返す。

参考:PicturesCreditView

例外系

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