ProvidersIndex - ぺったんR Wiki - ぺったんR

index @ ProvidersController

貸手一覧

url

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

解説

管理者が貸手を管理するために一覧形式で表示する。管理名順に表示される。 貸手は貸手文献からインポートされる。

• セッションまたは認証トークンから管理者アカウントを特定する。
• 貸手モデルにページ位置補正を依頼して開始ページを取得する。
  • urlパラメータpageを渡す。
• 貸手モデルにページ数補正を依頼して1ページの件数を取得する。
  • urlパラメータpage_sizeを渡す。
• パラメータから除外フラグを取得する。
• 貸手モデルに一覧取得を問い合わせ、貸手リストを取得する。
  • 除外フラグが空のとき
    • 一覧取得を問い合わせる。
  • 除外フラグが除外のとき
    • 待機中一覧取得を問い合わせる。
  • ページ位置と件数を渡す。
• 取得した貸手データを返す。

urlパラメータ

page

• 表示するデータが何ページ目からのものか。

page_size

• 1ページに収まる行の数。

hide

• 借受中の貸手は除外するフラグ

POSTデータ

auth_token

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

戻り値

正常系

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

参考:ProvidersIndexView

例外系

• 管理者アカウントでサインインしてなかった。(Devise)
  • htmlなら、ステータスコード302 Foundを返すとともに、サインインを促すページ(/admins/sign_in)へ遷移する。
  • jsonなら、ステータスコード401 Unauthorizedを返すとともに、応答メッセージにUnauthorizedを返す。