Site icon FantasticGame

Метод getReviews

Метод позволяет получить список отзывов (или комментариев), оставленных к определенному объекту карты либо оставленных конкретным пользователем. Метод является частью публичного API и его можно вызывать без указания токена доступа. Метод можно вызвать как GET-запросом, так и POST-запросом. За один запрос можно получить только 10 отзывов (комментариев).

GET https://waste.fantastic-game.ru/opm/api/getReviews.php?<PARAMS>

Отзывы и комментарии, по сути, являются синонимами. Единственное, что отличает отзыв от комментария – это наличие оценки: к основным объектам карты (node, way и relation) каждый пользователь может оставить только один отзыв с указанием оценки по пятибалльной шкале, а к дополнительным объектам карты (node и changeset) пользователь может оставлять неограниченное количество комментариев, не имеющих оценки.

Параметры

Параметр Описание
type
строка
Тип объекта карты:
node – одиночная точка на карте
way – линия (полигон)
relation – отношение (например, автобусный маршрут)
note – публичное сообщение на карте (заметка)
changeset – пакет правок
id
число
Числовой идентификатор объекта карты, отзывы (комментарии) о котором необходимо получить
author
число
Числовой идентификатор пользователя, отзывы которого необходимо получить. Указывается вместо параметров type и id.
offset
число
Обязательный
Номер страницы. 0 — первая страница, 1 — вторая…
.

Ответ

В случае успеха в ответе придет общее количество отзывов reviews_count, усредненная оценка (при наличии отзывов) mark и массив с 10-ю объектами отзывов.

Поля ответа

Поле Описание
reviews
массив
Массив с объектами отзывов (комментариев).
reviews_count
число
Общее количество отзывов.
Примечание: поле содержит общее число отзывов, а не количество возвращаемых в reviews отзывов
mark
float|null
Усредненная оценка.
Возвращает null если отсутствуют отзывы.
error
строка
Возвращается в случае ошибки. Содержит описание ошибки

Пример запроса

 

Объект отзыва (комментария)

Объект отзыва (комментария) содержит следующие поля:

Поле Описание
id
число
Числовой идентификатор отзыва (комментарий)
author_id
число
Числовой идентификатор пользователя, оставившего отзыв (комментарий)
author_name
строка
Псевдоним автора отзыва (комментария)
text
строка
Текст отзыва (комментария)
mark
число|null
Оценка, указанная пользователем, от 1 до 5.
Возвращается null в случае отсутствия оценки. Комментарии (например, к заметке [note]), в отличие от отзывов, не имеют оценки.
date
число
Unix-timestamp дата, когда был оставлен отзыв (комментарий)
object_id
число
Числовой идентификатор объекта карты, к которому оставлен отзыв (комментарий). Возвращается в случае, когда были запрошены все отзывы (комментарии) указанного пользователя.
object
строка
Тип объекта карты, к которому оставлен отзыв:
node – одиночная точка на карте
way – линия (полигон)
relation – отношение (например, автобусный маршрут)
либо комментарий:
note – публичное сообщение на карте (заметка)
changeset – пакет правок
Возвращается в случае, когда были запрошены все отзывы (комментарии) указанного пользователя.
badges
массив
Массив, содержащий метки (бейджи) пользователя.
Каждый такой бейдж содержит следующие поля:
text – текст бейджа (например, Staff или VK Donut)
type – строка, тип бейджа (может отсутствовать)
Возвращается только при запросе отзывов (комментариев), оставленных к указанному объекту карты.
Exit mobile version