Pular para o conteúdo

Listar as resenhas de uma obra

GET/v1/works/{id}/reviews

Retorna as resenhas publicadas de uma obra, ordenadas por utilidade, data ou nota, com filtros.

Requisição

Shell
curl "https://api.nogitsu.com/v1/works/01a0cb02-0a14-7877-911d-5b4dde76df72/reviews"

Parâmetros

  • id

    caminhoobrigatório

    ID do item, um UUID.

    texto

  • sort

    consultaopcional

    Ordem dos resultados.

    texto

    Valores permitidoshelpfulnewesthighestlowest

    Padrão: helpful

  • score

    consultaopcional

    Apenas resenhas que dão esta nota.

    número inteiro

    De 1 a 10

  • language

    consultaopcional

    Apenas resenhas escritas neste idioma.

    texto

  • completedOnly

    consultaopcional

    true para apenas resenhas de membros que terminaram a obra.

    texto

  • detailed

    consultaopcional

    true para apenas resenhas longas, com 600 caracteres ou mais.

    texto

  • cursor

    consultaopcional

    O valor de nextCursor da página anterior. Omita-o na primeira página.

    texto

  • limit

    consultaopcional

    Quantos itens retornar em uma página.

    número inteiro

    De 1 a 20Padrão: 20

Resposta

Uma requisição bem-sucedida responde 200 com este JSON:

  • itemslista de objeto
    • idtexto (uuid)
    • authorobjeto
      • usernametexto
      • displayNametexto
      • avatarUrltexto (uri)pode ser null
    • titletextopode ser null
    • bodyobjetopode ser null
      • blockslista de um de vários formatos

        1. Opção 1

          • typetexto
            Valores permitidosparagraph
          • childrenlista de um de vários formatos

            1. Opção 1

            2. Opção 2

            3. Opção 3

            4. Opção 4

            5. Opção 5

        2. Opção 2

          • typetexto
            Valores permitidosheading
          • childrenlista de um de vários formatos

            1. Opção 1

            2. Opção 2

            3. Opção 3

            4. Opção 4

            5. Opção 5

        3. Opção 3

          • typetexto
            Valores permitidosquote
          • childrenlista de RichTextBlock

        4. Opção 4

          • typetexto
            Valores permitidoslist
          • isOrderedtrue ou false
          • itemslista de lista de RichTextBlock

        5. Opção 5

          • typetexto
            Valores permitidoscode
          • texttexto
    • bodyLengthnúmero inteiro

      De 0 a 9007199254740991

    • hasSpoilertrue ou false
    • spoilerUnitnúmeropode ser null

      No mínimo 0

    • sourceSpoilerobjetopode ser null
      • kindtexto
        Valores permitidosmangamanhwamanhuawebtoonnovelother
      • unitnúmeropode ser null

        No mínimo 0

    • proslista de textopode ser null
    • conslista de textopode ser null
    • imageslista de objeto
      • urltexto (uri)
      • widthnúmero inteiro

        De 0 a 9007199254740991

      • heightnúmero inteiro

        De 0 a 9007199254740991

      • alttextopode ser null
      • variantWidthslista de número inteiro

        De 0 a 9007199254740991

    • languagetexto
    • scoreHalfPointsnúmero inteiropode ser null

      De 1 a 20

    • categoryScoresobjeto
    • trackingStatustextopode ser null
      Valores permitidosplannedcurrentcompletedpauseddroppedrewatching
    • progressUnitsnúmeropode ser null

      No mínimo 0

    • progressTotalnúmero inteiropode ser null

      De 0 a 9007199254740991

    • repeatCountnúmero inteiro

      De 0 a 9007199254740991

    • authorStatsobjeto
      • reviewCountnúmero inteiro

        De 0 a 9007199254740991

      • helpfulCountnúmero inteiro

        De 0 a 9007199254740991

    • helpfulCountnúmero inteiro

      De 0 a 9007199254740991

    • unhelpfulCountnúmero inteiro

      De 0 a 9007199254740991

    • replyCountnúmero inteiro

      De 0 a 9007199254740991

    • createdAttexto (date-time)
    • editedAttexto (date-time)pode ser null
  • nextCursortextopode ser null

Erros

Como toda operação, esta pode responder 400 para parâmetros inválidos, 404 quando nada é encontrado e 429 quando você envia requisições demais. Todos os erros compartilham o mesmo formato.

Leia sobre erros