Skip to content

API一覧

mizu-ryo edited this page Dec 22, 2020 · 4 revisions

API一覧

User周り

User

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
email string メールアドレス
password string パスワード
password_confirmation string パスワード確認
role_id integer Roleとn対1
id name email password password_confirmation role_id
1 技大太郎(dev) [email protected] gidaifes gidaifes 1
2 技大次郎(mng) [email protected] gidaifes gidaifes 2
3 技大三郎(usr) [email protected] gidaifes gidaifes 3

すべてのUser(GET)

/api/v1/users/index

該当するUser(GET)

/api/v1/users/1

Role(役割)

Userが持つ役割.開発者がdeveloper,委員がmanager,参加団体登録者がuserとなる.

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id name
1 developer
2 manager
3 user

UserDetail(User詳細)

カラム名 説明 POST必要パラメータ
id integer ID
tel string 電話番号
grade_id integer 学年
department_id integer 学科
user_id integer Userと1対1
student_id integer 学籍番号
id tel grade_id department_id user_id student_id
1 111-1111-1111 1 1 1 11111111
2 222-2222-2222 2 2 2 22222222
3 333-3333-3333 3 3 3 33333333

すべてのUserDetail(GET)

/user_details

該当するUserDetail(GET)

/user_details/1

UserDetail登録(POST)

/user_details

Grade(学年)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id name
1 B1[学部1年]
2 B2[学部2年]
3 B3[学部3年]
4 B4[学部4年]
5 M1[修士1年]
6 M2[修士2年]
7 D1[博士1年]
8 D2[博士2年]
9 D3[博士3年]
10 GD1[イノベ1年]
11 GD2[イノベ2年]
12 GD3[イノベ3年]
13 GD4[イノベ4年]
14 GD5[イノベ5年]
15 その他

Depertment(課程・専攻)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id name
1 機械創造工学課程
2 電気電子情報工学課程
3 物質材料工学課程
4 環境社会基盤工学課程
5 生物機能工学課程
6 情報・経営システム工学課程
7 機械創造工学専攻
8 電気電子情報工学専攻
9 物質材料工学専攻
10 環境社会基盤工学専攻
11 生物機能工学専攻
12 情報・経営システム工学専攻
13 原子力システム安全工学専攻
14 システム安全専攻
15 技術科学イノベーション専攻
16 情報・制御工学専攻
17 材料工学専攻
18 エネルギー・環境工学専攻
19 生物統合工学専攻
20 その他

Group周り

Group(参加団体)

Userが持つ参加団体.一つのUserは複数のGroupを持つことが出来る.

カラム名 説明 POST必要パラメータ
id integer ID
name string グループ名
project_name string 企画名
activity text 活動内容
user_id integer Userとn対1
group_category_id integer GroupCategoryとn対1
fes_year_id integer FesYearとn対1
id name project_name activity user_id group_category_id fes_year
1 nutfes nutfes nutfes 1 1 1

すべてのGroup(GET)

/groups

該当するGroup(GET)

/groups/1

Group登録(POST)

/groups

GroupCategory(参加団体種類)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id name
1 模擬店(食品販売)
2 模擬店(物品販売)
3 ステージ企画
4 展示・体験
5 研究室公開
6 その他

SubRep(副代表)

Groupが持つ副代表.Groupを所持するUserが登録する.UserDetailは持たない.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupと1対1
name string 名前
department_id integer Departmentとn対1
grade_id integer Gradeとn対1
tel string 電話番号
email string メールアドレス
student_id integer 学籍番号
id group_id name department_id grade_id tel email student_id
1 1 技大花子 1 1 111-2222-3333 [email protected] 11222333

すべてのSubRep(GET)

/sub_reps

該当するSubRep(GET)

/sub_reps/1

SubRep登録(POST)

/sub_reps

Employee(従業員)

Groupが持つ従業員.一つのGroupは複数のEmployeeを持つことが出来る.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupとn対1
name string 名前
student_id integer 学籍番号
employee_category integer EmployeeCategoryとn対1
id group_id name student_id employee_category_id
1 1 技大梅子 44555666 1

すべてのEmployee(GET)

/employees

該当するEmployee(GET)

/employees/1

Employee登録(POST)

/employees

StageCommonOption(ステージオプション)

参加団体が申請するステージの共通項目.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupと1対1
own_equipment boolean 所持機器の使用
bgm boolean 音楽
camera_permission boolean 撮影許可
loud_sound boolean 騒音
stage_content text ステージ内容
id group_id own_equipment bgm camera_permission loud_sound stage_content
1 1 true true true true nutfes

すべてのStageCommonOption(GET)

/stage_common_options

該当するStageCommonOption(GET)

/stage_common_options/1

StageCommonOption登録(POST)

/stage_common_options

PowerOrder(電力申請)

Groupが持つ電力申請.一つのGroupは複数のPowerOrderを持つことが出来る.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupとn対1
item string 製品
power integer 電力
manufacturer string メーカー
model string 型番
item_url string 製品URL
id group_id item power manufacturer model
1 1 nutfes-sample 0 nutfes nutfes

すべてのPowerOrder(GET)

/power_orders

該当するPowerOrder(GET)

/power_orders/1

PowerOrder登録(POST)

/power_orders

Place周り

PlaceOrder(会場申請)

Groupが持つ会場申請.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupと1対1
first integer 第一希望場所
second integer 第二希望場所
third integer 第三希望場所
remark text 備考
id group_id first second third remark
1 1 1 2 3 sample

すべてのPlaceOrder(GET)

/place_orders

該当するPlaceOrder(GET)

/place_orders/1

PlaceOrder登録(POST)

/place_orders

AssignGroupPlace(会場割り当て)

技大祭実行委員が割り振る参加団体の会場割り当て.

カラム名 説明 POST必要パラメータ
id integer ID
place_order_id integer PlaceOrderと1対1
place_id integer Placeとn対1
id place_order_id place_id
1 1 1

すべてのAssignGroupPlace(GET)

/assign_group_places

該当するAssignGroupPlace(GET)

/assign_group_places/1

AssignGroupPlace登録(POST)

/assign_group_places

Place(会場)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id name
1 事務棟エリア
2 図書館エリア
3 電気棟エリア
4 メインステージエリア
5 セコムホール
6 電気棟204
7 電気棟206
8 電気棟208
9 電気棟212
10 電気棟310
11 講義棟部屋A (103講義室などの大きい講義室)
12 講義棟部屋B (104講義室などの小さい講義室)
13 マルチメディアセンター
14 グラウンド
15 規定外の場所
16 機械・建設エリア
17 講義棟103
18 講義棟104
19 講義棟105
20 講義棟106
21 電気棟102
22 機械棟101
23 機械棟103
24 機械棟105
25 希望なし

PlaceAllowList(使用可能会場)

参加団体の種類に応じた使用可能会場の一覧.

カラム名 説明 POST必要パラメータ
id integer ID
place_id integer Placeとn対1
group_category_id integer GroupCategoryとn対1
enable boolean 使用可否
id place_id group_category_id enable
1 1 1 true
2 1 2 true
3 1 3 true
4 1 4 true
5 1 5 true
6 1 6 true
7 2 1 true
8 2 2 true
9 2 3 true
10 2 4 true
11 2 5 true
12 2 6 true
13 3 1 true
14 3 2 true
15 3 3 true
16 3 4 true
17 3 5 true
18 3 6 true
19 4 1 true
20 4 2 true
21 4 3 true
22 4 4 true
23 4 5 true
24 4 6 true
25 5 1 true
26 5 2 true
27 5 3 true
28 5 4 true
29 5 5 true
30 5 6 true
31 6 1 true
32 6 2 true
33 6 3 true
34 6 4 true
35 6 5 true
36 6 6 true
37 7 1 true
38 7 2 true
39 7 3 true
40 7 4 true
41 7 5 true
42 7 6 true
43 8 1 true
44 8 2 true
45 8 3 true
46 8 4 true
47 8 5 true
48 8 6 true
49 9 1 true
50 9 2 true
51 9 3 true
52 9 4 true
53 9 5 true
54 9 6 true
55 10 1 true
56 10 2 true
57 10 3 true
58 10 4 true
59 10 5 true
60 10 6 true
61 11 1 true
62 11 2 true
63 11 3 true
64 11 4 true
65 11 5 true
66 11 6 true
67 12 1 true
68 12 2 true
69 12 3 true
70 12 4 true
71 12 5 true
72 12 6 true
73 13 1 true
74 13 2 true
75 13 3 true
76 13 4 true
77 13 5 true
78 13 6 true
79 14 1 true
80 14 2 true
81 14 3 true
82 14 4 true
83 14 5 true
84 14 6 true
85 15 1 true
86 15 2 true
87 15 3 true
88 15 4 true
89 15 5 true
90 15 6 true
91 16 1 true
92 16 2 true
93 16 3 true
94 16 4 true
95 16 5 true
96 16 6 true
97 17 1 true
98 17 2 true
99 17 3 true
100 17 4 true
101 17 5 true
102 17 6 true
103 18 1 true
104 18 2 true
105 18 3 true
106 18 4 true
107 18 5 true
108 18 6 true
109 19 1 true
110 19 2 true
111 19 3 true
112 19 4 true
113 19 5 true
114 19 6 true
115 20 1 true
116 20 2 true
117 20 3 true
118 20 4 true
119 20 5 true
120 20 6 true
121 21 1 true
122 21 2 true
123 21 3 true
124 21 4 true
125 21 5 true
126 21 6 true
127 22 1 true
128 22 2 true
129 22 3 true
130 22 4 true
131 22 5 true
132 22 6 true
133 23 1 true
134 23 2 true
135 23 3 true
136 23 4 true
137 23 5 true
138 23 6 true
139 24 1 true
140 24 2 true
141 24 3 true
142 24 4 true
143 24 5 true
144 24 6 true
145 25 1 true
146 25 2 true
147 25 3 true
148 25 4 false
149 25 5 false
150 25 6 false

すべてのPlaceAllowList(GET)

/place_allow_lists

該当するPlaceAllowList(GET)

/place_allow_lists/1

PlaceAllowList登録(POST)

/place_allow_lists

Stage周り

Stage(ステージ)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
enable_sunny boolean 晴れの使用可否
enable_rainy boolean 雨の使用可否
id name enable_sunny enable_rainy
1 メインステージ true false
2 サブステージ true false
3 体育館 true true
4 マルチメディアセンター true true
5 武道館 true true
6 希望なし true true

StageOrder(ステージ申請)

参加団体が行うステージ申請. 時間の申請は時間幅で指定する方法と,時刻で指定する方法の2種類ある.

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupと1対1
is_sunny boolean 晴れがいいか
fes_date_id integer FesDateとn対1
stage_first integer 第1希望
stage_second integer 第2希望
use_time_interval string 使用時間幅
prepare_time_interval string 準備時間幅
cleanup_time_interval string 掃除時間幅
prepare_start_time string 準備開始時刻
performance_start_time string パフォーマンス開始時刻
performance_end_time string パフォーマンス終了時刻
cleanup_end_time string 掃除終了時刻
id group_id is_sunny fes_date_id stage_first stage_second use_time_interval prepare_time_interval cleanup_time_interval prepare_start_time performance_start_time performance_end_time cleanup_end_time
1 1 true 1 1 2 5分 5分 5分 12:30 13:00 13:30 14:00

すべてのStageOrder(GET)

/stage_orders

該当するStageOrder(GET)

/stage_orders/1

StageOrder登録(POST)

/stage_orders

AssignStage(ステージ割り当て)

カラム名 説明 POST必要パラメータ
id integer ID
stage_order_id integer StageOrderと1対1
stage_id integer Stageとn対1
time_point_start string 開始時間
time_point_end string 終了時間
id stage_order_id stage_id time_point_start time_point_end
1 1 1 00:00 00:00

すべてのAssignStage(GET)

/assign_stages

該当するAssignStage(GET)

/assign_stages/1

AssignStage登録(POST)

/assign_stages

FoodProduct周り

FoodProduct(食品製品)

カラム名 説明 POST必要パラメータ
id integer ID
group_id integer Groupとn対1
name string 名前
first_day_num integer 一日目の個数
second_day_num integer 二日目の個数
is_cooking boolean 調理するか
id group_id name is_cooking first_day_num second_day_num
1 1 baked tomato true 10 10

すべてのFoodProduct(GET)

/food_products

該当するFoodProduct(GET)

/food_products/1

FoodProduct登録(POST)

/food_products

PurchaseList(購入品)

カラム名 説明 POST必要パラメータ
id integer ID
food_product_id integer FoodProductとn対1
shop_id integer Shopとn対1
fes_date_id integer FesDateとn対1
is_fresh boolean 生ものかどうか
items string 購入物
id food_product_id shop_id fes_date_id items is_fresh
1 1 1 1 tomato true

すべてのPurchaseList(GET)

/purchase_lists

該当するPurchaseList(GET)

/purchase_lists/1

PurchaseList登録(POST)

/purchase_lists

Shop(商店)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
tel string 電話番号
opening_hours string 営業時間
address string 住所
id name tel opening_hours address
1 アピタ長岡店 0258-29-6111 09:00 - 21:00 新潟県長岡市千秋 2丁目 278 リバーサイド千秋 1F
2 イオン長岡店 0258-28-0880 07:00 - 22:00 新潟県長岡市古正寺 1-249-1
3 ウオロク 北山店 0258-25-8333 09:00 - 22:00 新潟県長岡市北山 3 丁目 5-1
4 ウオロク 長岡店 0258-38-8800 09:00 - 24:00 新潟県長岡市日赤町 2丁目 6-1
5 カトウ食材 0258-46-1170 05:00 - 18:00 新潟県長岡市新産 1丁目 1-16
6 業務スーパー 中沢店 0258-38-8200 09:00 - 20:00 新潟県長岡市美沢 3丁目 86−9
7 サンマート 0258-28-1488 10:00 - 20:00 新潟県長岡市北山 4丁目 37-3
8 スーパーセンタームサシ 0258-27-6345 07:00 - 19:30 新潟県長岡市古正寺町字中割 64
9 チャレンジャー 北長岡店 0258-88-0050 09:00 - 21:00 新潟県長岡市城岡 1-1-10
10 ドン・キホーテ 長岡インター店 0258-46-0311 00:00 - 03:00 10:00 - 24:00 新潟県長岡市福山町 1078
11 ナルス 大島店 0258-20-5800 09:00 - 22:00
12 なんじゃ村 0258-22-5511 10:00 - 20:00 新潟県長岡市喜多町 398−1
13 原信 今朝白店 0258-39-1311 00:00 - 24:00 新潟県長岡市今朝白 2丁目 5
14 原信 古正寺店 0258-28-5590 00:00 - 24:00 新潟県長岡市古正寺町 20-1
15 原信 関原店 0258-46-6585 09:00 - 22:00 新潟県長岡市関原町 1丁目 957-1
16 原信 寺島店 0258-28-5868 07:00 - 24:00 新潟県長岡市寺島町 7-1
17 原信 来迎寺店 0258-92-2090 09:00 - 23:00 新潟県長岡市浦 610
18 PLANT-5 見附店 0258-61-4400 09:00 - 22:00 新潟県見附市上新田町 725-1
19 三和園茶舗 0258-32-1105 08:00 - 18:00 新潟県長岡市千手 3丁目 7-8
20 大和屋 本店 0258-35-3533 09:00 - 17:30 新潟県長岡市柳原町 3-3
21 やまや 0258-22-5066 09:00 - 21:00 新潟県長岡市大島新町 4-892
22 リカードコミュニケーション おぐまや 0258-27-0709 08:00 - 20:00 新潟県長岡市蓮潟 4-6-14
23 良食生活館 きたまち店 0258-28-2855 10:00 - 22:00 新潟県長岡市喜多町字下川原 1000-1
24 山ス流通サービス株式会社 0258-27-4638 08:00 - 16:30 新潟県長岡市喜多町 1015
25 菜加 0258-89-2669 08:00 - 18:00 新潟県東川口 1939
26 ひらせい 長岡ニュータウン店 0258-47-8889 09:30 - 20:00 新潟県長岡市青葉台 1丁目甲 120-17
27 紅屋重正 0258-32-1456 09:00 - 17:30 新潟県長岡市表町 1丁目 10 番地 35
28 ダイレックス喜多町店 0258-94-5896 09:00 - 22:00 新潟県長岡市喜多町土地区画整理事業内 4 街区 3

物品周り

RentalItem(物品)

物品の種類.

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
is_rentable boolean 貸せるかどうか
id name is_rentable
1 true
2 長机 false
3 木の椅子 true
4 パイプ椅子 true
5 パーテーション true
6 掲示板 true
7 暗幕 true
8 マイク false
9 椅子 true
10 テント true
11 パーテーション足 true

RentalItemAllowLIst(使用可能物品)

参加団体の種類に応じた使用可能物品の一覧.

カラム名 説明 POST必要パラメータ
id integer ID
rental_item_id integer RentalItemとn対1
group_category_id integer GroupCategoryとn対1
id rental_item_id group_category_id
1 1 1
2 1 2
3 1 4
4 1 5
5 1 6
6 2 1
7 2 2
8 2 4
9 2 5
10 2 6
11 3 1
12 3 2
13 3 3
14 3 4
15 3 5
16 3 6
17 4 1
18 4 2
19 4 3
20 4 4
21 4 5
22 4 6
23 5 1
24 5 2
25 5 3
26 5 4
27 5 5
28 5 6
29 6 1
30 6 2
31 6 4
32 6 5
33 6 6
34 7 1
35 7 2
36 7 4
37 7 5
38 7 6
39 8 3
40 10 1
41 10 2
42 10 4
43 10 5
44 10 6
45 11 1
46 11 2
47 11 3
48 11 4
49 11 5
50 11 6

RentalOrder(物品申請)

カラム名 説明 POST必要パラメータ
id integer ID
group_id string Groupとn対1
rental_item_id integer RentalItamとn対1
num integer 申請する数
id group_id rental_item_id num
1 1 1 10

すべてのRentalOrder(GET)

/rental_orders

該当するRentalOrder(GET)

/rental_orders/1

RentalOrder登録(POST)

/rental_orders

StockerPlace(在庫場所)

カラム名 説明 POST必要パラメータ
id integer ID
name string 名前
id year_num
1 講義棟101
2 講義棟102
3 講義棟103
4 講義棟104
5 講義棟105
6 講義棟106
7 講義棟201
8 講義棟202
9 講義棟203
10 講義棟204
11 講義棟205
12 講義棟206
13 講義棟207
14 講義棟208
15 講義棟209
16 講義棟210
17 講義棟301
18 講義棟302
19 講義棟303
20 講義棟304
21 講義棟305
22 講義棟306
23 総合研究棟101
24 総合研究棟102
25 総合研究棟103
26 総合研究棟104
27 総合研究棟105
28 総合研究棟106
29 物材経棟210
30 物材経棟601-602
31 物材経棟603-604
32 物材経棟604-604
33 物材経棟605-606
34 電気棟101
35 電気棟102
36 電気棟103
37 電気棟104
38 電気棟204
39 電気棟206
40 電気棟208
41 電気棟212
42 電気棟310
43 機械棟101
44 機械棟103
45 機械棟105
46 機械棟201
47 機械棟204
48 生物棟260
49 生物棟459
50 生物棟465
51 生物棟466
52 体育館
53 廃液処理施設
54 課外活動共有施設
55 セコムホール(北側倉庫)
56 セコムホール(入口側倉庫)
57 本部(福利棟)
58 セコム会議室
59 24下倉庫
60 グラウンド倉庫
61 セコムホール

StockerItem(在庫品)

カラム名 説明 POST必要パラメータ
id integer ID
rental_item_id integer RentalItemとn対1
stocker_place_id integer StockerPlaceとn対1
fes_year_id integer FesYearとn対1
num integer 在庫数
id rental_item_id stocker_place_id fes_year_id num
1 1 1 1 1

すべてのStockerItem(GET)

/stocker_items

該当するStockerItem(GET)

/stocker_items/1

StockerItem登録(POST)

/stocker_items

RentableItem(レンタル可能物品)

カラム名 説明 POST必要パラメータ
id integer ID
stocker_item_id integer 名前
stocker_place_id integer StockerPlaceとn対1
max_num integer 最大使用可能数
id stocker_item_id stoker_place_id max_num
1 1 1 1

すべてのRentableItem(GET)

/rentable_items

該当するRentableItem(GET)

/rentable_items/1

RentableItem登録(POST)

/rentable_items

AssignRentalItem(物品割り当て)

カラム名 説明 POST必要パラメータ
id integer ID
rental_order_id integer RentalOrderとn対1
rentable_item_id integer RentableItemとn対1
num integer 割り当て数
id rental_order_id rentable_item_id num
1 1 1 1

すべてのAssignRentalItem(GET)

/assign_rental_items

該当するAssignRentalItem(GET)

/assign_rental_items/1

AssignRentalItem登録(POST)

/assign_rental_items

その他

FesYear(開催年)

カラム名 説明 POST必要パラメータ
id integer ID
year_num string 名前
id year_num
1 2020
2 2021
3 2022

FesDate(開催日)

カラム名 説明 POST必要パラメータ
id integer ID
days_num string 名前
date string 日付
day string 曜日
fes_year_id integer FesYearとn対1
id days_num date day fes_year_id
1 0 9/18 fri 1
2 1 9/19 sat 1
3 2 9/20 sun 1
4 0 9/17 fri 2
5 1 9/18 sat 2
6 2 9/19 sun 2

News(お知らせ)

カラム名 説明 POST必要パラメータ
id integer ID
title string タイトル
body text 内容
id title body
1 nutfes-news 参加団体管理アプリです.

すべてのNews(GET)

/news

該当するNews(GET)

/news/1

News登録(POST)

/news