Список рецензий на произведение

GET/v1/works/{id}/reviews

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

Запрос

Shell

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

Параметры

id
путьобязательный
Идентификатор элемента, UUID.
текст
sort
запроснеобязательный
Порядок результатов.
текст
Допустимые значенияhelpfulnewesthighestlowest
По умолчанию: helpful
score
запроснеобязательный
Только рецензии с этой оценкой.
целое число
От 1 до 10
language
запроснеобязательный
Только рецензии, написанные на этом языке.
текст
completedOnly
запроснеобязательный
true — только рецензии участников, завершивших произведение.
текст
detailed
запроснеобязательный
true — только длинные рецензии, от 600 символов.
текст
cursor
запроснеобязательный
Значение nextCursor с предыдущей страницы. Не указывайте для первой страницы.
текст
limit
запроснеобязательный
Сколько элементов вернуть на одной странице.
целое число
От 1 до 20По умолчанию: 20

Ответ

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

itemsсписок из объект
- idтекст (uuid)
- authorобъект
  usernameтекст
  displayNameтекст
  avatarUrlтекст (uri)может быть null
- titleтекстможет быть null
- bodyобъектможет быть null
  blocksсписок из один из нескольких форматов
  Вариант 1
  typeтекст
  Допустимые значенияparagraph
  childrenсписок из один из нескольких форматов
  Вариант 1
  Вариант 2
  Вариант 3
  Вариант 4
  Вариант 5
  Вариант 2
  typeтекст
  Допустимые значенияheading
  childrenсписок из один из нескольких форматов
  Вариант 1
  Вариант 2
  Вариант 3
  Вариант 4
  Вариант 5
  Вариант 3
  typeтекст
  Допустимые значенияquote
  childrenсписок из RichTextBlock
  Вариант 4
  typeтекст
  Допустимые значенияlist
  isOrderedtrue или false
  itemsсписок из список из RichTextBlock
  Вариант 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
nextCursorтекстможет быть null

Ошибки

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

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