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

Получение списка по адресу

GET/v1/collections/by-path/{username}/{slug}

Возвращает список по имени пользователя владельца и slug — двум частям адреса списка.

Запрос

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

Параметры

  • username

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

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

    текст

  • slug

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

    Slug из адреса страницы на nogitsu.com.

    текст

Ответ

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

  • 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)
  • themeобъектможет быть null
    • backgroundтекст
    • accentтекст
    • fontтекст
      Допустимые значенияdefaultserifmono
    • densityтекст
      Допустимые значенияcomfortablecompact
    • layoutтекст
      Допустимые значенияrowsposters
    • showsCurrentlyConsumingtrue или false
  • copiedFromобъектможет быть null
    • nameтекст
    • pathтекст
    • ownerDisplayNameтекст

Ошибки

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

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