curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/posts/123/mark-solution'
{
"success": true,
"old_solution_post": null,
"new_solution_post": {
"post_id": 123
}
}
Сообщения
Переключить отметку решения
Помечает сообщение решением вопроса или снимает существующую отметку.
POST
/
api
/
posts
/
{id}
/
mark-solution
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/posts/123/mark-solution'
{
"success": true,
"old_solution_post": null,
"new_solution_post": {
"post_id": 123
}
}
Помечает сообщение решением вопроса или снимает существующую отметку.
Обязательные scopes:
Дополнительные параметры не требуются.
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
thread:write.
Особенности
Если это сообщение уже является решением, отметка снимается. При выборе другого решения прежняя отметка снимается автоматически. Поляold_solution_post и new_solution_post показывают обе стороны изменения и могут быть null.
Параметры
integer
required
ID сообщения. Значение
123 в примере условное.Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
success | true | true, если действие выполнено успешно. |
new_solution_post | Post|null | Сообщение, получившее отметку решения, или null, если отметка только снята. |
old_solution_post | Post|null | Сообщение, потерявшее отметку решения, или null, если прежнего решения не было. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/posts/123/mark-solution'
{
"success": true,
"old_solution_post": null,
"new_solution_post": {
"post_id": 123
}
}