Отзывы о модели
Описание
GET /{version}/models/{id}/opinions
Возвращает отзывы пользователей о модели. Оценки без отзывов не входят в ответ.
Ресурс является списочным.
URL ресурса:
https://api.content.market.yandex.ru/{version}/models/{id}/opinions
Входные данные
Параметр | Положение | Тип | Обязательность | Описание |
---|---|---|---|---|
version | PATH | Enum | Да | |
id | PATH | Int64 | Да | Идентификатор модели. |
format | QUERY | Enum | Нет | Формат выходных данных. Возможные значения: Значение по умолчанию: JSON .
|
grade | QUERY | Int32 | Нет | Оценка, выставленная автором отзыва Ограничения:
|
max_comments | QUERY | Int32 | Нет | Максимальное количество комментариев, возвращаемых для каждого отзыва Ограничения: Значение по умолчанию: 0.
|
Параметры страницы | ||||
count | QUERY | Int32 | Нет | Размер страницы (количество элементов на странице). Ограничения: Значение по умолчанию: 10.
|
page | QUERY | Int32 | Нет | Номер страницы. Ограничения: Значение по умолчанию: 1.
|
Параметры сортировки отзывов | ||||
how | QUERY | Enum | Нет | Направление сортировки. Возможные значения: Значение по умолчанию: Зависит от поля, по которому сортируем (так по цене сортировка по возрастанию, а по популярности по убыванию).
|
sort | QUERY | Enum | Нет | тип сортировки отзывов Возможные значения: Значение по умолчанию: DATE.
|
Параметр | Положение | Тип | Обязательность | Описание |
---|---|---|---|---|
version | PATH | Enum | Да | |
id | PATH | Int64 | Да | Идентификатор модели. |
format | QUERY | Enum | Нет | Формат выходных данных. Возможные значения: Значение по умолчанию: JSON .
|
grade | QUERY | Int32 | Нет | Оценка, выставленная автором отзыва Ограничения:
|
max_comments | QUERY | Int32 | Нет | Максимальное количество комментариев, возвращаемых для каждого отзыва Ограничения: Значение по умолчанию: 0.
|
Параметры страницы | ||||
count | QUERY | Int32 | Нет | Размер страницы (количество элементов на странице). Ограничения: Значение по умолчанию: 10.
|
page | QUERY | Int32 | Нет | Номер страницы. Ограничения: Значение по умолчанию: 1.
|
Параметры сортировки отзывов | ||||
how | QUERY | Enum | Нет | Направление сортировки. Возможные значения: Значение по умолчанию: Зависит от поля, по которому сортируем (так по цене сортировка по возрастанию, а по популярности по убыванию).
|
sort | QUERY | Enum | Нет | тип сортировки отзывов Возможные значения: Значение по умолчанию: DATE.
|
Выходные данные
Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.
{
"status" : "{enum}",
"context" : {
"region" : {
"id" : {int32},
"name" : "{string}",
"type" : "{enum}",
"childCount" : {int32},
"country" : {
Содержимое объекта
}
},
"currency" : {
"id" : "{string}",
"name" : "{string}"
},
"alternateCurrency" : {
"id" : "{string}",
"name" : "{string}"
},
"page" : {
"number" : {int32},
"count" : {int32},
"total" : {int32},
"last" : {boolean}
},
"warnings" : [
{
"type" : "{string}",
"code" : "{string}",
"message" : "{string}"
},
...
],
"id" : "{string}",
"time" : "{date}",
"link" : "{string}",
"marketUrl" : "{string}"
},
"opinions" : [
{
Содержимое объекта
},
...
]
}
<result status="{enum}">
<context id="{string}" time="{date}" link="{string}" marketUrl="{string}">
<region id="{int32}" name="{string}" type="{enum}" childCount="{int32}">
<country>Содержимое объекта</country>
</region>
<currency id="{string}" name="{string}"/>
<alternateCurrency id="{string}" name="{string}"/>
<page number="{int32}" count="{int32}" total="{int32}" last="{boolean}"/>
<warnings>
<warning type="{string}" code="{string}" message="{string}"/>
...
</warnings>
</context>
<opinions>
<opinion>Содержимое объекта</opinion>
...
</opinions>
</result>
Описание параметров:
Параметр для формата JSON | Параметр для формата XML | Тип | Описание |
---|---|---|---|
status | status | Enum | Статус обработки запроса. Возможные значения:
|
context | context | Object | Контекст обработки запроса. |
opinions | opinions | Object list | Отзывы |
| |||
id | id | String | Уникальный идентификатор запроса. |
time | time | Date | Дата и время выполнения запроса в формате ISO 8601. |
link | link | String | Ссылка на текущий запрос. |
marketUrl | marketUrl | String | Ссылка на Яндекс.Маркет. |
region | region | Object | Информация о регионе запроса. |
currency | currency | Object | Валюта запроса. |
alternateCurrency | alternateCurrency | Object | Альтернативная валюта запроса. |
page | page | Object | Информация о параметрах страницы запроса. |
warnings | warnings | Object list | Список предупреждений, возникших при обработке запроса. Предупреждение может быть связано с некритичной ошибкой, позволяющей продолжить обработку запроса. При этом результат может частично не соответствовать параметрам запроса. |
| |||
id | id | Int32 | Идентификатор региона. |
name | name | String | Наименование региона. |
type | type | Enum | Тип региона. Возможные значения:
|
childCount | childCount | Int32 | Количество дочерних регионов. |
country | country | Object | Страна, к которой относится регион. |
| |||
id | id | String | Код валюты. |
name | name | String | Название валюты. |
| |||
number | number | Int32 | Номер страницы. |
count | count | Int32 | Размер страницы. |
total | total | Int32 | Количество страниц в результате. |
last | last | Boolean | Признак последней страницы. |
| |||
type | type | String | Тип предупрежедния. |
code | code | String | Код предупреждения. |
message | message | String | Сообщение с описанием предупреждения. |
Параметр для формата JSON | Параметр для формата XML | Тип | Описание |
---|---|---|---|
status | status | Enum | Статус обработки запроса. Возможные значения:
|
context | context | Object | Контекст обработки запроса. |
opinions | opinions | Object list | Отзывы |
| |||
id | id | String | Уникальный идентификатор запроса. |
time | time | Date | Дата и время выполнения запроса в формате ISO 8601. |
link | link | String | Ссылка на текущий запрос. |
marketUrl | marketUrl | String | Ссылка на Яндекс.Маркет. |
region | region | Object | Информация о регионе запроса. |
currency | currency | Object | Валюта запроса. |
alternateCurrency | alternateCurrency | Object | Альтернативная валюта запроса. |
page | page | Object | Информация о параметрах страницы запроса. |
warnings | warnings | Object list | Список предупреждений, возникших при обработке запроса. Предупреждение может быть связано с некритичной ошибкой, позволяющей продолжить обработку запроса. При этом результат может частично не соответствовать параметрам запроса. |
| |||
id | id | Int32 | Идентификатор региона. |
name | name | String | Наименование региона. |
type | type | Enum | Тип региона. Возможные значения:
|
childCount | childCount | Int32 | Количество дочерних регионов. |
country | country | Object | Страна, к которой относится регион. |
| |||
id | id | String | Код валюты. |
name | name | String | Название валюты. |
| |||
number | number | Int32 | Номер страницы. |
count | count | Int32 | Размер страницы. |
total | total | Int32 | Количество страниц в результате. |
last | last | Boolean | Признак последней страницы. |
| |||
type | type | String | Тип предупрежедния. |
code | code | String | Код предупреждения. |
message | message | String | Сообщение с описанием предупреждения. |
Возможные ошибки
В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.