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

Список списков участника

GET/v1/members/{username}/collections

Возвращает публичные списки участника.

Запрос

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

Параметры

  • username

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

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

    текст

  • cursor

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

    Значение nextCursor с предыдущей страницы. Не указывайте для первой страницы.

    текст

  • workId

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

    Только списки, в которых есть это произведение.

    текст (uuid)

  • language

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

    Только списки, написанные на этом языке.

    текст

Ответ

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

  • itemsсписок из объект
    • idтекст (uuid)
    • nameтекст
    • slugтекст
    • pathтекст
    • descriptionтекстможет быть null
    • visibilityтекст
      Допустимые значенияpublicunlistedprivate
    • isOrderedtrue или false
    • languageтекст
      Допустимые значенияentrdefresptitruidjakozh
    • itemCountцелое число

      От 0 до 9007199254740991

    • subscriberCountцелое число

      От 0 до 9007199254740991

    • ownerобъект
      • usernameтекст
      • displayNameтекст
      • avatarUrlтекст (uri)может быть null
    • coversсписок из объект
      • urlтекст (uri)
      • variantWidthsсписок из целое число

        От -9007199254740991 до 9007199254740991

    • isRemovedtrue или false
    • isIndexabletrue или false
    • createdAtтекст (date-time)
    • updatedAtтекст (date-time)
  • nextCursorтекстможет быть null

Ошибки

Как и любая операция, эта может ответить 400 при неверных параметрах, 404, если ничего не найдено, и 429, если вы отправляете слишком много запросов. У всех ошибок один формат.

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