Перейти к содержимому

Витрина участника

GET/v1/members/{username}/showcase

Возвращает опубликованную витрину профиля: её блоки, их порядок и тему страницы.

Запрос

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

Параметры

  • username

    путьобязательный

    Имя пользователя участника.

    текст

Ответ

Успешный запрос отвечает 200 с таким JSON:

  • 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, если вы отправляете слишком много запросов. У всех ошибок один формат.

Подробнее об ошибках