本文へスキップ

メンバーのショーケースの取得

GET/v1/members/{username}/showcase

公開されたプロフィールのショーケースを返します。ブロック、その順序、ページのテーマが含まれます。

リクエスト

Shell
curl -g "https://api.nogitsu.com/v1/members/{username}/showcase"

パラメーター

  • username

    パス必須

    メンバーのユーザー名。

    テキスト

レスポンス

リクエストが成功すると、次のJSONとともに200が返ります。

  • showcaseオブジェクトnull になる場合あり
    • themeオブジェクトnull になる場合あり
      • backgroundテキスト
      • accentテキスト
      • fontテキスト
        使用できる値defaultserifmono
      • densityテキスト
        使用できる値comfortablecompact
    • blocks複数の形式のいずれかのリスト

      1. 選択肢1

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値currently_consuming
        • libraryテキスト
          使用できる値screenreading

      2. 選択肢2

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値favorites
        • subjectテキスト
          使用できる値workcharacter

      3. 選択肢3

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値pinned_collection
        • collectionIdテキスト (uuid)

      4. 選択肢4

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値collection_list

      5. 選択肢5

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値stats

      6. 選択肢6

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値genres

      7. 選択肢7

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値badges

      8. 選択肢8

        • isVisibletrue または false
        • widthテキスト
          使用できる値widenarrow
        • kindテキスト
          使用できる値communities
    • version整数

      0〜9007199254740991

    • updatedAtテキスト (date-time)

エラー

他の操作と同様に、この操作も無効なパラメーターでは400、何も見つからない場合は404、リクエストが多すぎる場合は429を返すことがあります。すべてのエラーは同じ形式です。

エラーについて読む