本文へ移動
Bounty Developer

PUT/api/me/academic

「学生団体・ベンチャー」の分類の、送った内容で対象を保存する（更新する）API。ログインした本人として呼ぶ。

要約

学籍を保存する（学校は同梱の大学の一覧のコード。無ければ名前だけ）

呼び方と印

ログイン

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • gradYear必須integer | null
    1950–2100
  • gradMonth任意integer | null
    1–12
  • enrollmentStatus必須enum(5)
    • "active"
    • "on_leave"
    • "graduated"
    • "withdrawn"
    • "unknown"
  • schoolCode任意string | null
    /^[A-Z0-9]{4,16}$/
  • schoolName任意string | null
    長さ ≤80

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • academicobject
    • gradYearinteger | null
    • gradMonth任意integer | null
    • enrollmentStatusstring
    • schoolCodestring | null
    • schoolNamestring | null
    • stage"student" | "alumni" | "unknown"

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • invalid_input
  • unknown_school

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X PUT "https://bounty.spikes.4s.link/api/me/academic" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "gradYear": 1950,
    "enrollmentStatus": "active"
  }'
PUT /api/me/academic | Bounty Developer