Sohosai Online System (0.1.0)

Download OpenAPI specification:

License:

projects

企画関連の操作

企画募集期間を取得する

Authorizations:

None

Responses

Response samples

200
401
500

Content type

application/json

{"end_at": "2019-08-24T14:15:22Z",
"start_at": "2019-08-24T14:15:22Z"
}

企画一覧の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
403
500

Content type

application/json

[{"attributes": ["academic"
],
"category": "general",
"group_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"index": 0,
"kana_group_name": "string",
"kana_title": "string",
"location_id": "string",
"owner_email": "string",
"owner_id": "string",
"owner_name": "string",
"title": "string"
}
]

企画の作成

Authorizations:

jwt_token

Request Body schema: application/json
required

attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
category required	string (ProjectCategory) Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
group_name required	string
kana_group_name required	string
kana_title required	string
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attributes": ["academic"
],
"category": "general",
"group_name": "string",
"kana_group_name": "string",
"kana_title": "string",
"title": "string"
}

Response samples

201
400
401
422
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

企画一覧のエクスポート

Authorizations:

jwt_token

Responses

Response samples

401
403
500

Content type

application/json

{"code": "string",
"message": "string"
}

自分が企画責任者・副企画責任者になっている企画の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
404
500

Content type

application/json

{"attributes": ["academic"
],
"category": "general",
"created_at": "2019-08-24T14:15:22Z",
"group_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"index": 0,
"kana_group_name": "string",
"kana_title": "string",
"location_id": "string",
"owner_email": "string",
"owner_id": "string",
"owner_name": "string",
"remarks": "string",
"sub_owner_email": "string",
"sub_owner_id": "string",
"sub_owner_name": "string",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDの企画の取得

Authorizations:

jwt_token

path Parameters

project_id

required

string <uuid>

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"attributes": ["academic"
],
"category": "general",
"created_at": "2019-08-24T14:15:22Z",
"group_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"index": 0,
"kana_group_name": "string",
"kana_title": "string",
"location_id": "string",
"owner_email": "string",
"owner_id": "string",
"owner_name": "string",
"remarks": "string",
"sub_owner_email": "string",
"sub_owner_id": "string",
"sub_owner_name": "string",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDの企画を更新

Authorizations:

jwt_token

path Parameters

project_id

required

string <uuid>

Request Body schema: application/json
required

attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
category required	string (ProjectCategory) Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
group_name required	string
kana_group_name required	string
kana_title required	string
location_id	string or null
remarks	string or null
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attributes": ["academic"
],
"category": "general",
"group_name": "string",
"kana_group_name": "string",
"kana_title": "string",
"location_id": "string",
"remarks": "string",
"title": "string"
}

Response samples

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDの企画の削除

Authorizations:

jwt_token

path Parameters

project_id

required

string <uuid>

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

users

ユーザー関連の操作

ユーザー一覧の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
403
500

Content type

application/json

[{"email": "string",
"id": "string",
"name": "string",
"role": "administrator"
}
]

ユーザーの作成

Authorizations:

None

Request Body schema: application/json
required

email required	string
kana_name required	string
name required	string
password required	string <password>
phone_number required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"kana_name": "string",
"name": "string",
"password": "pa$$word",
"phone_number": "string"
}

Response samples

201
400
422
500

Content type

application/json

{"id": "string"
}

ユーザー一覧のエクスポート

Authorizations:

jwt_token

Responses

Response samples

401
403
500

Content type

application/json

{"code": "string",
"message": "string"
}

自分のユーザーの取得

Authorizations:

jwt_token

Responses

Response samples

200
401
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"id": "string",
"kana_name": "string",
"name": "string",
"owned_project_id": "ed354d7e-3891-4393-a3d7-946685192d4e",
"owned_project_title": "string",
"phone_number": "string",
"role": "administrator",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDのユーザーの取得

Authorizations:

jwt_token

path Parameters

user_id

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"id": "string",
"kana_name": "string",
"name": "string",
"owned_project_id": "ed354d7e-3891-4393-a3d7-946685192d4e",
"owned_project_title": "string",
"phone_number": "string",
"role": "administrator",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDのユーザーの更新

Authorizations:

jwt_token

path Parameters

user_id

required

string

Request Body schema: application/json
required

email required	string
kana_name required	string
name required	string
phone_number required	string
role required	string (UserRole) Enum: "administrator" "committee_operator" "committee_editor" "committee_drafter" "committee_viewer" "general"

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"kana_name": "string",
"name": "string",
"phone_number": "string",
"role": "administrator"
}

Response samples

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDのユーザーの削除

Authorizations:

jwt_token

path Parameters

user_id

required

string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

news

お知らせ関連の操作

お知らせ一覧の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
500

Content type

application/json

[{"attributes": ["academic"
],
"categories": ["general"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduled_at": "2019-08-24T14:15:22Z",
"state": "draft",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]

お知らせの作成

Authorizations:

jwt_token

Request Body schema: application/json
required

attachments required	Array of strings <uuid> [ items <uuid > ]
attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
body required	string
categories required	Array of strings (ProjectCategories) Items Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
scheduled_at	string or null <date-time>
state required	string (NewsState) Enum: "draft" "scheduled" "published"
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"body": "string",
"categories": ["general"
],
"scheduled_at": "2019-08-24T14:15:22Z",
"state": "draft",
"title": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

特定のIDのお知らせの取得

Authorizations:

jwt_token

path Parameters

news_id

required

string <uuid>

Responses

Response samples

200
401
404
500

Content type

application/json

{"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"body": "string",
"categories": ["general"
],
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduled_at": "2019-08-24T14:15:22Z",
"state": "draft",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDのお知らせを更新

Authorizations:

jwt_token

path Parameters

news_id

required

string <uuid>

Request Body schema: application/json
required

attachments required	Array of strings <uuid> [ items <uuid > ]
attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
body required	string
categories required	Array of strings (ProjectCategories) Items Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
scheduled_at	string or null <date-time>
state required	string (NewsState) Enum: "draft" "scheduled" "published"
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"body": "string",
"categories": ["general"
],
"scheduled_at": "2019-08-24T14:15:22Z",
"state": "draft",
"title": "string"
}

Response samples

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDのお知らせの削除

Authorizations:

jwt_token

path Parameters

news_id

required

string <uuid>

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

files

ファイル関連の操作

ファイル一覧の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
403
500

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"filename": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"updated_at": "2019-08-24T14:15:22Z"
}
]

ファイルの作成

Authorizations:

jwt_token

query Parameters

visibility

required

string

Enum: "private" "public"

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Response samples

Content type

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

ファイル一覧のエクスポート

Authorizations:

jwt_token

query Parameters

project_id	string or null <uuid>
form_id	string or null <uuid>

Responses

Response samples

401
403
500

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDのファイルの取得

Authorizations:

jwt_token

path Parameters

file_id

required

string <uuid>

Responses

Response samples

200
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"updated_at": "2019-08-24T14:15:22Z",
"url": "http://example.com"
}

特定のIDのファイルの削除

Authorizations:

jwt_token

path Parameters

file_id

required

string <uuid>

Responses

Response samples

401
403
500

Content type

application/json

{"code": "string",
"message": "string"
}

forms

申請関連の操作

申請一覧の取得

Authorizations:

jwt_token

query Parameters

project_id

string or null <uuid>

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8",
"answered_at": "2019-08-24T14:15:22Z",
"attributes": ["academic"
],
"categories": ["general"
],
"description": "string",
"ends_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"starts_at": "2019-08-24T14:15:22Z",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]

申請の作成

Authorizations:

jwt_token

Request Body schema: application/json
required

attachments required	Array of strings <uuid> [ items <uuid > ]
attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
categories required	Array of strings (ProjectCategories) Items Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
description required	string
ends_at required	string <date-time>
required	Array of NewFormItem (object) or NewFormItem (object) or NewFormItem (object) or NewFormItem (object) or NewFormItem (object) (NewFormItem)
starts_at required	string <date-time>
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"categories": ["general"
],
"description": "string",
"ends_at": "2019-08-24T14:15:22Z",
"items": [{"allow_newline": true,
"max_length": 0,
"min_length": 0,
"type": "string",
"description": "string",
"name": "string",
"required": true
}
],
"starts_at": "2019-08-24T14:15:22Z",
"title": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

特定のIDの申請を取得

Authorizations:

jwt_token

path Parameters

form_id

required

string <uuid>

Responses

Response samples

200
401
404
500

Content type

application/json

{"answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8",
"answered_at": "2019-08-24T14:15:22Z",
"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"categories": ["general"
],
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"ends_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"items": [{"allow_newline": true,
"max_length": 0,
"min_length": 0,
"type": "string",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"required": true
}
],
"starts_at": "2019-08-24T14:15:22Z",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDの申請を更新

Authorizations:

jwt_token

path Parameters

form_id

required

string <uuid>

Request Body schema: application/json
required

attachments required	Array of strings <uuid> [ items <uuid > ]
attributes required	Array of strings (ProjectAttributes) Items Enum: "academic" "art" "official" "inside" "outside"
categories required	Array of strings (ProjectCategories) Items Enum: "general" "foods_with_kitchen" "foods_without_kitchen" "foods_without_cooking" "stage_1a" "stage_university_hall" "stage_united"
description required	string
ends_at required	string <date-time>
required	Array of NewFormItem (object) or NewFormItem (object) or NewFormItem (object) or NewFormItem (object) or NewFormItem (object) (NewFormItem)
starts_at required	string <date-time>
title required	string

Responses

Request samples

Payload

Content type

application/json

{"attachments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"attributes": ["academic"
],
"categories": ["general"
],
"description": "string",
"ends_at": "2019-08-24T14:15:22Z",
"items": [{"allow_newline": true,
"max_length": 0,
"min_length": 0,
"type": "string",
"description": "string",
"name": "string",
"required": true
}
],
"starts_at": "2019-08-24T14:15:22Z",
"title": "string"
}

Response samples

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDの申請を削除

Authorizations:

jwt_token

path Parameters

form_id

required

string <uuid>

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

form-answers

申請回答関連の操作

申請回答一覧を取得

Authorizations:

jwt_token

query Parameters

project_id	string or null <uuid>
form_id	string or null <uuid>

Responses

Response samples

200
401
403
500

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_title": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"project_title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]

申請回答を作成

Authorizations:

jwt_token

Request Body schema: application/json
required

form_id required	string <uuid>
required	Array of objects or objects or objects or objects or objects (FormAnswerItem)

Responses

Request samples

Payload

Content type

application/json

{"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"items": [{"item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
"type": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

申請回答一覧のエクスポート

Authorizations:

jwt_token

query Parameters

form_id

string or null <uuid>

Responses

Response samples

401
403
500

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDの申請回答を取得

Authorizations:

jwt_token

path Parameters

form_answer_id

required

string <uuid>

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_title": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"items": [{"item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
"type": "string",
"value": "string"
}
],
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"project_title": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

特定のIDの申請回答を更新

Authorizations:

jwt_token

path Parameters

form_answer_id

required

string <uuid>

Request Body schema: application/json
required

required

Array of objects or objects or objects or objects or objects (FormAnswerItem)

Responses

Request samples

Payload

Content type

application/json

{"items": [{"item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
"type": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"code": "string",
"message": "string"
}

invitations

招待関連の操作

招待一覧の取得

Authorizations:

jwt_token

Responses

Response samples

200
401
403
500

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inviter": "string",
"inviter_name": "string",
"position": "owner",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"project_title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"used_by": "string"
}
]

招待の作成

Authorizations:

jwt_token

Request Body schema: application/json
required

position required	string (InvitationPosition) Enum: "owner" "sub_owner"
project_id required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"position": "owner",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

特定のIDの招待の取得

Authorizations:

jwt_token

path Parameters

invitation_id

required

string <uuid>

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inviter": "string",
"inviter_name": "string",
"position": "owner",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"project_title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"used_by": "string"
}

特定のIDの招待の受諾

Authorizations:

jwt_token

path Parameters

invitation_id

required

string <uuid>

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

特定のIDの招待の削除

Authorizations:

jwt_token

path Parameters

invitation_id

required

string <uuid>

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": "string",
"message": "string"
}

サーバーの状態を確認する

Authorizations:

None

Sohosai Online System (0.1.0)

projects

企画募集期間を取得する

Authorizations:

Responses

Response samples

企画一覧の取得

Authorizations:

Responses

Response samples

企画の作成

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

企画一覧のエクスポート

Authorizations:

Responses

Response samples

自分が企画責任者・副企画責任者になっている企画の取得

Authorizations:

Responses

Response samples

特定のIDの企画の取得

Authorizations:

path Parameters

Responses

Response samples

特定のIDの企画を更新

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

特定のIDの企画の削除

Authorizations:

path Parameters

Responses

Response samples

users

ユーザー一覧の取得

Authorizations:

Responses

Response samples

ユーザーの作成

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ユーザー一覧のエクスポート

Authorizations:

Responses

Response samples

自分のユーザーの取得

Authorizations:

Responses

Response samples

特定のIDのユーザーの取得

Authorizations:

path Parameters

Responses

Response samples

特定のIDのユーザーの更新

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

特定のIDのユーザーの削除

Authorizations:

path Parameters

Responses

Response samples

news

お知らせ一覧の取得

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required