Saltar al contenido

Listar publicaciones fijadas

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

Devuelve las publicaciones fijadas en la parte superior de una comunidad.

Solicitud

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

Parámetros

  • id

    rutaobligatorio

    Identificador del elemento, un UUID.

    texto

Respuesta

Una solicitud correcta responde 200 con este JSON:

  • itemslista de objeto
    • idtexto (uuid)
    • slugtexto
    • communityobjeto
      • idtexto (uuid)
      • slugtexto
      • languagetexto
      • kindtexto
        Valores permitidosworkboarduser
      • nametexto
      • iconUrltexto (uri)puede ser null
      • themetexto
        Valores permitidosvioletblueskycyanemeraldgreenyellowamberrosepink
      • isSampletrue o false
    • authorobjetopuede ser null
      • usernametexto
      • displayNametexto
      • avatarUrltexto (uri)puede ser null
    • authorFlairtextopuede ser null
    • kindtexto
      Valores permitidostextlinkimagepoll
    • titletextopuede ser null
    • excerpttextopuede ser null
    • flairobjetopuede ser null
      • idtexto (uuid)
      • labeltexto
      • tonetexto
        Valores permitidosneutralaccentsuccesswarningdangervioletblueskycyanemeraldgreenyellowamberrosepink
    • spoilerobjetopuede ser null
      • workTitletextopuede ser null
      • unitNumbernúmeropuede ser null

        Al menos 0

    • workobjetopuede ser null
      • idtexto (uuid)
      • titletexto
      • mediumtexto
        Valores permitidosanimedonghuaanimationmangamanhwamanhuawebtoon
      • slugtexto
      • unitNumbernúmeropuede ser null

        Al menos 0

    • isAdulttrue o false
    • isPinnedtrue o false
    • isLockedtrue o false
    • scorenúmero enteropuede ser null

      De -9007199254740991 a 9007199254740991

    • commentCountnúmero entero

      De 0 a 9007199254740991

    • reactionslista de objeto
      • kindtexto
        Valores permitidoslovelaughwowsadclapfirethinkangrypartycry
      • countnúmero entero

        De 0 a 9007199254740991

    • linkobjetopuede ser null
      • urltexto (uri)
      • hosttexto
      • titletextopuede ser null
      • descriptiontextopuede ser null
      • imageobjetopuede ser null
        • urltexto (uri)
        • widthnúmero entero

          De 0 a 9007199254740991

        • heightnúmero entero

          De 0 a 9007199254740991

        • alttextopuede ser null
        • variantWidthslista de número entero

          De 0 a 9007199254740991

      • isPendingtrue o false
    • imageslista de objeto
      • urltexto (uri)
      • widthnúmero entero

        De 0 a 9007199254740991

      • heightnúmero entero

        De 0 a 9007199254740991

      • alttextopuede ser null
      • variantWidthslista de número entero

        De 0 a 9007199254740991

    • pollobjetopuede ser null
      • optionslista de objeto
        • idtexto (uuid)
        • labeltexto
        • voteCountnúmero enteropuede ser null

          De 0 a 9007199254740991

      • totalVotesnúmero entero

        De 0 a 9007199254740991

      • closesAttexto (date-time)
      • isClosedtrue o false
      • allowsMultipletrue o false
    • createdAttexto (date-time)
    • editedAttexto (date-time)puede ser null

Errores

Como todas las operaciones, esta puede responder 400 si los parámetros no son válidos, 404 si no se encuentra nada y 429 si envías demasiadas solicitudes. Todos los errores comparten una misma forma.

Lee sobre los errores