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

Получение рецензии

GET/v1/reviews/{id}

Возвращает одну рецензию с идентификатором её произведения и признаком того, входит ли она в число самых полезных.

Запрос

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

Параметры

  • id

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

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

    текст

Ответ

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

  • workIdтекст (uuid)
  • isTopHelpfultrue или false
  • reviewобъект
    • idтекст (uuid)
    • authorобъект
      • usernameтекст
      • displayNameтекст
      • avatarUrlтекст (uri)может быть null
    • titleтекстможет быть null
    • bodyобъектможет быть null
      • blocksсписок из один из нескольких форматов

        1. Вариант 1

          • typeтекст
            Допустимые значенияparagraph
          • childrenсписок из один из нескольких форматов

            1. Вариант 1

              • typeлюбое значение
              • textлюбое значение
              • marksлюбое значение

            2. Вариант 2

              • typeлюбое значение
              • hrefлюбое значение
              • childrenлюбое значение

            3. Вариант 3

              • typeлюбое значение
              • usernameлюбое значение

            4. Вариант 4

              • typeлюбое значение
              • spoilerIdлюбое значение
              • childrenлюбое значение

            5. Вариант 5

              • typeлюбое значение

        2. Вариант 2

          • typeтекст
            Допустимые значенияheading
          • childrenсписок из один из нескольких форматов

            1. Вариант 1

              • typeлюбое значение
              • textлюбое значение
              • marksлюбое значение

            2. Вариант 2

              • typeлюбое значение
              • hrefлюбое значение
              • childrenлюбое значение

            3. Вариант 3

              • typeлюбое значение
              • usernameлюбое значение

            4. Вариант 4

              • typeлюбое значение
              • spoilerIdлюбое значение
              • childrenлюбое значение

            5. Вариант 5

              • typeлюбое значение

        3. Вариант 3

          • typeтекст
            Допустимые значенияquote
          • childrenсписок из RichTextBlock

        4. Вариант 4

          • typeтекст
            Допустимые значенияlist
          • isOrderedtrue или false
          • itemsсписок из список из RichTextBlock

        5. Вариант 5

          • typeтекст
            Допустимые значенияcode
          • textтекст
    • bodyLengthцелое число

      От 0 до 9007199254740991

    • hasSpoilertrue или false
    • spoilerUnitчисломожет быть null

      Не меньше 0

    • sourceSpoilerобъектможет быть null
      • kindтекст
        Допустимые значенияmangamanhwamanhuawebtoonnovelother
      • unitчисломожет быть null

        Не меньше 0

    • prosсписок из текстможет быть null
    • consсписок из текстможет быть null
    • imagesсписок из объект
      • urlтекст (uri)
      • widthцелое число

        От 0 до 9007199254740991

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

        От 0 до 9007199254740991

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

        От 0 до 9007199254740991

    • languageтекст
    • scoreHalfPointsцелое числоможет быть null

      От 1 до 20

    • categoryScoresобъект
    • trackingStatusтекстможет быть null
      Допустимые значенияplannedcurrentcompletedpauseddroppedrewatching
    • progressUnitsчисломожет быть null

      Не меньше 0

    • progressTotalцелое числоможет быть null

      От 0 до 9007199254740991

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

      От 0 до 9007199254740991

    • authorStatsобъект
      • reviewCountцелое число

        От 0 до 9007199254740991

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

        От 0 до 9007199254740991

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

      От 0 до 9007199254740991

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

      От 0 до 9007199254740991

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

      От 0 до 9007199254740991

    • createdAtтекст (date-time)
    • editedAtтекст (date-time)может быть null

Ошибки

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

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