Группа методов Alert внешнего программного интерфейса Менеджера сервиса предназначена для получения уведомлений о недоступности.
Сводка по методам
Метод | Примечание |
---|---|
root | |
Возвращает список уведомлений | |
Возвращает информацию (включая текст) указанного уведомления | |
create | Зарегистрировать новое уведомление о недоступности |
alert/list
Метод возвращает список уведомлений о недоступности, адресованных абоненту. Эти уведомления располагаются в нижней части формы "Мои приложения" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
Нет параметров | ||
Ответ: alert (0..*) | ||
id | Число | Номер уведомления |
start | Дата и время | Начало недоступности |
completion | Дата и время | Завершение недоступности |
name | Строка | Заголовок уведомления |
text | Строка | Текст уведомления |
scheduled | Булево | Плановая недоступность |
level | Число | Уровень значимости уведомления (от 0 до 10) |
alert/info
Метод возвращает информацию об указанном уведомлении. Поиск уведомления выполняется по номеру.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Номер уведомления |
Ответ: alert (1) | ||
id | Число | Номер уведомления |
start | Дата и время | Начало недоступности |
completion | Дата и время | Завершение недоступности |
name | Строка | Заголовок уведомления |
text | Строка | Текст уведомления |
scheduled | Булево | Плановая недоступность |
level | Число | Уровень значимости уведомления (от 0 до 10) |
objects | Массив | Массив объектов вида:
|
alert/create
Метод позволяет зарегистрировать новое уведомление о недоступности. Метод доступен только полноправным пользователям.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
start | Дата и время | Начало недоступности |
completion | Дата и время | Завершение недоступности |
name | Строка | Заголовок уведомления |
text | Строка | Текст уведомления |
scheduled | Булево | Плановая недоступность |
level | Число | Уровень значимости уведомления (от 0 до 10) |
objects | Массив | Массив объектов вида:
|
start_notification_sending | Булево | Запустить рассылку уведомлений |
Ответ (1) | ||
id | Число | Номер уведомления |