本文へ移動
Bounty Developer

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

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

要約

本人がこの募集に書きかけた応募の下書きを読む(無ければ null)

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • idpath必須string(uuid)

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

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

  • draftobject | null
    • callIdstring
    • eventIdstring
    • revisioninteger
    • questionSetIdstring
    • currentQuestionSetIdstring
    • headlinestring | null
    • messagestring
    • linksarray<object>
      • urlstring
      • labelstring | null
    • portfolioItemIdsarray<string>
    • answersrecord<string | array<string> | boolean>

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い
  • 428HTTP 428(x-bounty-error-codes を参照)
  • 429HTTP 429(x-bounty-error-codes を参照)
  • human_action_required
  • invalid_origin
  • unsupported_media_type
  • rate_limited
  • consent_required

呼び出しの見本

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

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