本文へ移動
Bounty Developer

GET/api/boshu/calls/{id}/applications

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

要約

審査の材料(募集の要約と応募者・回答・作品・状態)

呼び方と印

ログイン

URL に付ける値(パラメータ)

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

  • idpath必須string(uuid)

返るもの(応答)200 · application/json

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

  • callobject
    • idstring
    • kind"staff" | "talk" | "pitch" | "other"
    • status"draft" | "published" | "closed"
    • titlestring
    • sessionIdstring | null
    • capacityinteger | null
    • talkMinutesinteger | null
    • opensAtstring
    • closesAtstring
    • phase"hidden" | "upcoming" | "open" | "closed"
    • paidboolean
    • compensationstring | null
    • announcedAtstring | null
    • externalobject | null
      • sourcestring
      • idstring
    • ownerOrgIdstring | null
    • ownerEventIdstring | null
    • ownerobject
      • kindenum(5)"platform" "event" "guild" "venture" "person"
      • idstring | null
      • namestring
      • hrefstring | null
    • approval"not_required" | "pending" | "approved" | "rejected"
    • countsobject
      • pendinginteger
      • holdinteger
      • acceptedinteger
      • waitlistedinteger
      • rejectedinteger
      • withdrawninteger
    • unnotifiedinteger
    • questionCountinteger
    • descriptionstring | null
    • requirementsstring | null
  • applicantsarray<object>
    • idstring
    • userIdstring | null
    • guest任意object | null
      • displayNamestring
      • emailstring
      • titlestring | null
      • orgNamestring | null
      • schoolNamestring | null
    • headlinestring | null
    • messagestring
    • person任意object | null
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • links任意record<string>
    • profileVisible任意boolean
    • facts任意array<string>
    • orgHref任意string | null
    • linksarray<object>
      • urlstring
      • labelstring | null
    • portfolioarray<object>
      • idstring
      • titlestring
      • urlstring
      • descriptionstring
      • entryType任意"work" | "lightning_talk"
      • format任意enum(14)"video" "animation" "photography" "image" "graphic" "audio" "music" "writing" "product" "software" "game" "hardware" …+2
      • tools任意array<string>
      • technicalDetails任意record<array<string>>
      • technicalNote任意string
      • attachment任意object
        • kind"pdf"
        • urlstring
      • media任意object
        • kind"image" | "video"
        • urlstring
        • posterUrl任意string
        • durationSec任意number
        • width任意integer
        • height任意integer
    • applicantOrg任意object | null
      • kind"guild" | "venture"
      • idstring
      • namestring
      • logoUrlstring | null
    • portfolioMissinginteger
    • answersarray<object>
      • questionIdstring
      • labelstring
      • textstring
      • imageUrlstring | null
      • documentUrl任意string | null
      • sensitiveboolean
      • hiddenboolean
    • submission任意object | null
      • organizationarray<object>
        • keystring
        • labelstring
        • valuestring
      • registrantarray<object>
        • keystring
        • labelstring
        • valuestring
      • linkedarray<object>
        • callIdstring
        • titlestring
        • role"partner" | "programme"
        • headlinestring | null
        • messagestring
        • answersarray<object>
          • questionIdstring
          • labelstring
          • textstring
          • imageUrlstring | null
          • documentUrl任意string | null
          • sensitiveboolean
          • hiddenboolean
    • questionVersioninteger
    • statusenum(6)"pending" "hold" "accepted" "waitlisted" "rejected" "withdrawn"
    • positioninteger | null
    • shownobject
      • kindenum(5)"pending" "accepted" "waitlisted" "rejected" "withdrawn"
      • labelstring
      • positioninteger | null
    • unnotifiedboolean
    • createdAtstring
    • updatedAtstring
  • canSeeSensitiveboolean

失敗したとき(エラー)

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

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

呼び出しの見本

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

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