本文へ移動
Bounty Developer

GET/api/universities

「参加登録」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

全国の大学を探す（文部科学省「全国大学一覧」の写し。略称・旧字体・法人格の表記ゆれを寄せる。pref で都道府県に絞る）

呼び方と印

ログイン

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • qquery任意string
    長さ ≤80
  • prefquery任意enum(47)
    • "北海道"
    • "青森県"
    • "岩手県"
    • "宮城県"
    • "秋田県"
    • "山形県"
    • "福島県"
    • "茨城県"
    • "栃木県"
    • "群馬県"
    • "埼玉県"
    • "千葉県"
    • …+35

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

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

  • resultsarray<object>
    • schoolCodestring
    • namestring
    • prefstring
    • ownership"national" | "public" | "private" | "other"
    • stoppedboolean
  • sourceobject
    • namestring
    • editionstring
    • asOfstring

失敗したとき（エラー）

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

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

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/universities" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/universities | Bounty Developer