Alert — получение уведомлений о недоступности

Группа методов Alert внешнего программного интерфейса Менеджера сервиса предназначена для получения уведомлений о недоступности.

Сводка по методам

Метод

Примечание

root

list 

Возвращает список уведомлений

info

Возвращает информацию (включая текст) указанного уведомления

createЗарегистрировать новое уведомление о недоступности

alert/list

Метод возвращает список уведомлений о недоступности, адресованных абоненту. Эти уведомления располагаются в нижней части формы "Мои приложения" в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

Нет параметров

Ответ: alert (0..*)

id

 Число

Номер уведомления

startДата и времяНачало недоступности
completionДата и времяЗавершение недоступности
nameСтрокаЗаголовок уведомления
textСтрокаТекст уведомления
scheduledБулевоПлановая недоступность
levelЧислоУровень значимости уведомления (от 0 до 10)
Пример запроса  Развернуть
{
  "auth": {
    "type": "user",
    "account": 1010
  },
  "general": {
    "version": 22,
    "type": "usr",
    "method": "alert/list",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "alert": [
    {
      "id": 6,
      "start": "2022-05-08T23:30:00",
      "completion": "2022-05-08T23:50:00",
      "name": "Технические работы",
      "text": "Поддержка изменение законодательства, Исправление выявленных ошибок",
      "scheduled": true,
      "level": 7
    }
  ], 
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 22,
    "sm_version": "1.1.17.6",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

alert/info

Метод возвращает информацию об указанном уведомлении. Поиск уведомления выполняется по номеру.

Параметр

Тип

Примечание

Запрос

idЧислоНомер уведомления

Ответ: alert (1)

id

 Число

Номер уведомления

startДата и времяНачало недоступности
completionДата и времяЗавершение недоступности
nameСтрокаЗаголовок уведомления
textСтрокаТекст уведомления
scheduledБулевоПлановая недоступность
levelЧислоУровень значимости уведомления (от 0 до 10)
objects Массив

Массив объектов вида:

  • type — Строка, Тип объекта недоступности
  • id — Строка, Код объекта недоступности
Пример запроса  Развернуть
{
  "id": 1,
  "auth": {
    "type": "user",
    "account": 1010
  },
  "general": {
    "version": 22,
    "type": "usr",
    "method": "alert/info",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "alert": {
    "id": 6,
    "start": "2022-05-08T23:30:00",
    "completion": "2022-05-08T23:50:00",
    "name": "Технические работы",
    "text": "Поддержка изменение законодательства, Исправление выявленных ошибок",
    "scheduled": true,
    "level": 7,
    "objects": [
       {
         "type": "infobase",
         "id": "24",         
       }
    ]
  }, 
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 22,
    "sm_version": "1.1.17.6",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

alert/create

Метод позволяет зарегистрировать новое уведомление о недоступности. Метод доступен только полноправным пользователям.

Параметр

Тип

Примечание

Запрос

startДата и времяНачало недоступности
completionДата и времяЗавершение недоступности
nameСтрокаЗаголовок уведомления
textСтрокаТекст уведомления
scheduledБулевоПлановая недоступность
levelЧислоУровень значимости уведомления (от 0 до 10)
objects Массив

Массив объектов вида:

  • type — Строка, Тип объекта недоступности
  • id — Строка, Код объекта недоступности
start_notification_sendingБулевоЗапустить рассылку уведомлений
Ответ (1) 

id

 Число

Номер уведомления

Пример запроса  Развернуть
{
 "start": "2022-05-08T23:30:00",
 "completion": "2022-05-08T23:50:00",
 "name": "Технические работы",
 "text": "Поддержка изменение законодательства, Исправление выявленных ошибок",
 "scheduled": true,
 "level": 7,
 "objects": [
    {
      "type": "infobase",
      "id": "24",         
    }
  ],
  "start_notification_sending": false,
  "general": {
    "version": 22,
    "type": "usr",
    "method": "alert/create",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "id": 6,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 22,
    "sm_version": "1.1.17.6",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх