本文へ移動
Bounty Developer

GET/api/guilds/{slug}

「ギルド」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

ギルドのページ（紹介・出展・メンバー（3 人未満は人数だけ）・成績）

呼び方と印

ログイン

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

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

  • slugpath必須string
    /^[a-z0-9-]{1,64}$/

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

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

  • guildobject
    • basicProfile任意object
      • nameKana任意string | null長さ ≤240
      • organizationType任意string | null長さ ≤80
      • baseUniversities任意array<string>件数 ≤20
      • foundedYearMonth任意string | null/^(19[5-9]\d|20\d\d|2100)-(0[1-9]|1[0-2])$/
      • studentMemberCount任意integer | null0–100000
      • activitySummary任意string | null長さ ≤2000
      • catchphrase任意string | null長さ ≤40
    • memberCount任意integer | null
    • memberScale任意string | null
    • idstring
    • slugstring
    • namestring
    • colorstring
    • imageUrlstring | null
    • source"spikes" | "local"
    • universityNamestring | null
    • orgKind"university" | "highschool" | null
    • genresarray<string>
    • descriptionstring | null
    • linksarray<object>
      • kindstring
      • urlstring
      • title任意string
    • mediaarray<object>
      • kind"youtube" | "vimeo" | "image" | "link"
      • urlstring
      • titlestring | null
    • foundedYearinteger | null
    • lastConfirmedYearinteger | null
    • registeredMembersinteger | null
    • publicUrlstring | null
    • syncedAtstring | null
  • isMineboolean
  • boothsarray<object>
    • idstring
    • namestring
    • logoUrlstring | null
    • locationstring | null
    • schedule"allday" | "timed"
    • whenstring
    • liveboolean
    • checkedInboolean
    • pinobject | null
      • xnumber
      • ynumber
      • colorstring | null
  • mapobject | null
    • idstring
    • namestring
    • widthnumber
    • heightnumber
    • urlstring
  • membersobject
    • mode"list" | "count"
    • countinteger
    • peoplearray<object> | null
      • idstring
      • namestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
    • moreinteger
  • statsobject
    • pointsnumber
    • rankinteger | null
    • totalinteger
    • raceobject
      • rankinteger | null
      • pointsnumber
      • totalinteger
      • windowMininteger

失敗したとき（エラー）

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

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

呼び出しの見本

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

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