本文へ移動
Bounty Developer

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

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

要約

募集の設問（1 つの仕組みのページ）と共通モジュールの棚（行き先に募集を含むもの）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

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

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

  • callIdstring(uuid)
  • versioninteger | null
  • pageobject
    • idstring
    • destinationstring
    • placementstring
    • titlestring
    • modulesarray<object | object>
      • |1object
        • kind"shared"
        • idstring
        • moduleIdstring
        • pinned任意object
          • revisioninteger
          • bodyobject
            • titlestring
            • helpstring | null
            • questionsarray<object>
      • |2object
        • kind"inline" | "legacy"
        • idstring
        • bodyobject
          • titlestring
          • helpstring | null
          • questionsarray<object>
            • idstring
            • typestring
            • labelstring
  • placedarray<object>
    • refIdstring
    • moduleIdstring
    • revisioninteger | null
    • shelfRevisioninteger | null
    • outdatedboolean
    • archivedboolean
  • shelfarray<object>
    • idstring
    • keystring
    • eventIdstring | null
    • destinationsarray<string>
    • revisioninteger
    • bodyobject
      • titlestring
      • helpstring | null
      • questionsarray<object>
        • idstring
        • typestring
        • labelstring
    • archivedAt任意string | null
    • placedboolean
    • canEditboolean

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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}/questionnaire" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/boshu/calls/{id}/questionnaire | Bounty Developer