curl --request GET 'https://forum.arzguard.com/api/alerts/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"alert": {
"alert_id": 123,
"read_date": 0,
"view_date": 0
}
}
Уведомления
Получить уведомление
Возвращает одно доступное уведомление по его идентификатору.
GET
/
api
/
alerts
/
{id}
/
curl --request GET 'https://forum.arzguard.com/api/alerts/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"alert": {
"alert_id": 123,
"read_date": 0,
"view_date": 0
}
}
Возвращает одно доступное уведомление по его идентификатору.
Других входных параметров у метода нет. Общие параметры контекста описаны в разделе авторизации.
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: alert:read. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
required
Идентификатор уведомления.
Ответ
HTTP200, JSON. Схемы объектов и условные поля.
UserAlert
Описание уведомления и его состояния.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/alerts/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"alert": {
"alert_id": 123,
"read_date": 0,
"view_date": 0
}
}