curl --request GET 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'page=1'
{
"alerts": [],
"pagination": {
"current_page": 0,
"last_page": 0,
"per_page": 20,
"shown": 0,
"total": 0
}
}
Уведомления
Получить уведомления
Возвращает уведомления пользователя с фильтрами и пагинацией.
GET
/
api
/
alerts
/
curl --request GET 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'page=1'
{
"alerts": [],
"pagination": {
"current_page": 0,
"last_page": 0,
"per_page": 20,
"shown": 0,
"total": 0
}
}
Возвращает уведомления пользователя с фильтрами и пагинацией.
Чтение списка не меняет отметки уведомлений. Для изменения состояния используйте отдельные POST-методы. Фильтры
У пустого набора
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
unread и unviewed при совместной передаче применяются одновременно.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: alert:read. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
Номер страницы. Размер страницы задаётся настройками форума; отдельного параметра
per_page у этого метода нет.integer
Нижняя граница даты уведомлений в Unix time. Непросмотренные и непрочитанные уведомления включаются даже до этой даты.
boolean
При
1 оставляет только уведомления, которые пользователь ещё не видел в интерфейсе.boolean
При
1 оставляет только непрочитанные элементы. Просмотр уведомления и прочтение связанного содержимого — разные состояния.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
UserAlert[]
Массив уведомлений текущего пользователя.
pagination
Сведения о странице:
current_page, last_page, per_page, shown, total.shown=0, total=0, а current_page и last_page могут быть 0. Не считайте 1 минимально возможным значением этих двух полей. Подробнее: пагинация и ошибки страниц.
Ошибки возвращаются в общей структуре errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'page=1'
{
"alerts": [],
"pagination": {
"current_page": 0,
"last_page": 0,
"per_page": 20,
"shown": 0,
"total": 0
}
}