POST/api/orgs/intake/{id}
「学生団体・ベンチャー」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
団体登録の申込者が本人であることを確かめる(同じ actionId の再送は同じ結果)
- 呼び方と印
ログイン
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)boshuCallIdquery任意string(uuid)
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
actionId必須string(uuid)expectedRevision必須integer≥0expectedSnapshotHash必須string/^[0-9a-f]{64}$/confirm必須true
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
sourceIdstringnamestringrevisionintegersnapshotHashstringverifiedbooleanregistrationStatestringorganizationHrefstring | nullmembershipStatusstring | nullofficersarray<object>indexintegernamestringtitlestring | nullrolestringterm"current" | "next"statusstring | nullinviteUrlstring | null
applicationHrefstring | null
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- 404HTTP 404(x-bounty-error-codes を参照)
- 409HTTP 409(x-bounty-error-codes を参照)
- 413HTTP 413(x-bounty-error-codes を参照)
- 503HTTP 503(x-bounty-error-codes を参照)
- intake_not_found
- invalid_navigation
- intake_control_not_ready
- snapshot_changed
- origin_denied
- action_conflict
- intake_changed
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/orgs/intake/{id}" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{
"actionId": "00000000-0000-4000-8000-000000000000",
"expectedRevision": 0,
"expectedSnapshotHash": "string",
"confirm": true
}'