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

Список закреплённых постов

GET/v1/communities/{id}/pinned-posts

Возвращает посты, закреплённые вверху сообщества.

Запрос

Shell
curl -g "https://api.nogitsu.com/v1/communities/{id}/pinned-posts"

Параметры

  • id

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

    Идентификатор элемента, UUID.

    текст

Ответ

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

  • itemsсписок из объект
    • idтекст (uuid)
    • slugтекст
    • communityобъект
      • idтекст (uuid)
      • slugтекст
      • languageтекст
      • kindтекст
        Допустимые значенияworkboarduser
      • nameтекст
      • iconUrlтекст (uri)может быть null
      • themeтекст
        Допустимые значенияvioletblueskycyanemeraldgreenyellowamberrosepink
      • isSampletrue или false
    • authorобъектможет быть null
      • usernameтекст
      • displayNameтекст
      • avatarUrlтекст (uri)может быть null
    • authorFlairтекстможет быть null
    • kindтекст
      Допустимые значенияtextlinkimagepoll
    • titleтекстможет быть null
    • excerptтекстможет быть null
    • flairобъектможет быть null
      • idтекст (uuid)
      • labelтекст
      • toneтекст
        Допустимые значенияneutralaccentsuccesswarningdangervioletblueskycyanemeraldgreenyellowamberrosepink
    • spoilerобъектможет быть null
      • workTitleтекстможет быть null
      • unitNumberчисломожет быть null

        Не меньше 0

    • workобъектможет быть null
      • idтекст (uuid)
      • titleтекст
      • mediumтекст
        Допустимые значенияanimedonghuaanimationmangamanhwamanhuawebtoon
      • slugтекст
      • unitNumberчисломожет быть null

        Не меньше 0

    • isAdulttrue или false
    • isPinnedtrue или false
    • isLockedtrue или false
    • scoreцелое числоможет быть null

      От -9007199254740991 до 9007199254740991

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

      От 0 до 9007199254740991

    • reactionsсписок из объект
      • kindтекст
        Допустимые значенияlovelaughwowsadclapfirethinkangrypartycry
      • countцелое число

        От 0 до 9007199254740991

    • linkобъектможет быть null
      • urlтекст (uri)
      • hostтекст
      • titleтекстможет быть null
      • descriptionтекстможет быть null
      • imageобъектможет быть null
        • urlтекст (uri)
        • widthцелое число

          От 0 до 9007199254740991

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

          От 0 до 9007199254740991

        • altтекстможет быть null
        • variantWidthsсписок из целое число

          От 0 до 9007199254740991

      • isPendingtrue или false
    • imagesсписок из объект
      • urlтекст (uri)
      • widthцелое число

        От 0 до 9007199254740991

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

        От 0 до 9007199254740991

      • altтекстможет быть null
      • variantWidthsсписок из целое число

        От 0 до 9007199254740991

    • pollобъектможет быть null
      • optionsсписок из объект
        • idтекст (uuid)
        • labelтекст
        • voteCountцелое числоможет быть null

          От 0 до 9007199254740991

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

        От 0 до 9007199254740991

      • closesAtтекст (date-time)
      • isClosedtrue или false
      • allowsMultipletrue или false
    • createdAtтекст (date-time)
    • editedAtтекст (date-time)может быть null

Ошибки

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

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