curl --request POST 'https://forum.arzguard.com/api/alerts/123/mark' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'read=1'
{
"success": true
}
Уведомления
Изменить отметку уведомления
Меняет состояние просмотра или прочтения одного уведомления.
POST
/
api
/
alerts
/
{id}
/
mark
curl --request POST 'https://forum.arzguard.com/api/alerts/123/mark' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'read=1'
{
"success": true
}
Меняет состояние просмотра или прочтения одного уведомления.
Выберите один режим:
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
viewed=1, read=1 или unread=1. При нескольких истинных флагах приоритет такой: viewed, затем read, затем unread. Вернуть состояние «не просмотрено» этим методом нельзя. Меняется только выбранное уведомление.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: alert:read. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
required
Идентификатор уведомления.
application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
boolean
При
1 помечает выбранное уведомление прочитанным.boolean
При
1 помечает выбранное уведомление непрочитанным.boolean
При
1 помечает выбранное уведомление просмотренным.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
true
Результат выполнения операции.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/alerts/123/mark' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'read=1'
{
"success": true
}