Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/02/20 09:52

From version < 89.4 >

edited by Илья Крайнов
on 2023/05/22 15:01

To version < 79.1 >

edited by Илья Крайнов
on 2023/03/29 12:22

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -62,7 +62,7 @@
  (% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
++(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -82,7 +82,7 @@
  **GET api/v3/agents/{id}**
  )))
--Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
@@ -124,7 +124,7 @@
  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
  )))
--(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
@@ -161,7 +161,7 @@
  **POST /api/v3/agents **
  )))
--Метод позволяет добавить клиента, указанного в запросе.
++Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **POST**
@@ -224,7 +224,7 @@
  **PUT /api/v3/agents**
  )))
--Метод позволяет отредактировать клиента, указанного в запросе.
++Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **PUT**
@@ -288,7 +288,7 @@
  **DELETE /api/v3/agents/{clientId}**
  )))
--Метод позволяет удалить клиента, указанного в строке запроса.
++Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **DELETE**
@@ -309,7 +309,7 @@
  (% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -436,7 +436,7 @@
      "email": "" ,  ~/~/ E-mail
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
--    "lastLogged": "", ~/~/ дата/время последней авторизации
++    "astLogged": "", ~/~/ дата/время последней авторизации
  (% style="color:#000000" %)}
@@ -499,7 +499,7 @@
  (% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -580,7 +580,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -610,7 +610,7 @@
  **POST /api/v3/users/disable**
  )))
--Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
++Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -632,7 +632,7 @@
  **POST /api/v3/users/enable**
  )))
--Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
++Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -669,7 +669,7 @@
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -693,7 +693,7 @@
  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
@@ -701,9 +701,9 @@
  (% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
--(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
++(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -717,124 +717,20 @@
      "deviceTypeId": , ~/~/ ID типа устройства
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
--    "sim2": "", ~/~/ Номер SIM2
--
--    "parentId": "", ~/~/ ID клиента-родителя
--    "parentName": "", ~/~/ Наименование клиента-родителя
--    "modelId": "", ~/~/ ID модели объекта
--    "modelName": "", ~/~/ Имя модели объекта
--
--    "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
--    "unitName": "string", ~/~/ Наименование подразделения
--    "status": 0, ~/~/ Статус объекта
--
--    "createdAt": "", ~/~/ Дата создания объекта
++    "parentId": "", Номер SIM2
++    "parentName": "", Наименование клиента-родителя
++    "modelId": "", ID модели объекта
++    "modelName": "", Имя модели объекта
++    "createdAt": "", Дата создания объекта
++    "mileageCalcMethod": "", Выбранный метод расчета пробега
++    "counters": { ~/~/ Нормы
++        "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
++        "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
++        "mileage": "", ~/~/ Пробег по нормам в метрах
++        "motohours": "" ~/~/ Моточасы по нормам, в секундах
++        "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
++        "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
      },
--
--"customFields": [ ~/~/ Произвольные поля
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
--      "name": "string", ~/~/ Имя поля
--      "value": "string", ~/~/ Значение поля
--      "forClient": true, ~/~/ Не используемая функция
--      "forTooltip": true, ~/~/ Отображать в подсказке
--      "forReport": true ~/~/ Отображать в отчете
--    }
--
--], ~/~/ Данные с вкладки нормы
--    "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
--    "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
--    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
--    "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
--    "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
--     "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
--     "consumptionPer100KmSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
--     "consumptionPer100KmSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
--     "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
--     "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
--     "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
--  "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
--  "mileageCoeff": 0, ~/~/ коэффициент пробега
--  "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
--  "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
--  "counters": { ~/~/ Счетчики
--    "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
--    "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
--    "mileage": 0, ~/~/ Текущий пробег
--    "motohours": 0, ~/~/ Текущие моточасы
--    "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
--    "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
--  },
--
--"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
--    "id": "string", ~/~/ ID объекта
--    "enabled": true, ~/~/ Включить, true - активна, false - не активна
--    "host": "string", ~/~/ CMSV6 Web Host
--    "login": "string", ~/~/ CMSV6 Account
--    "password": "string" ~/~/ CMSV6 Password
--  },
--
--"commandTemplates": [ ~/~/ Шаблоны команд
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
--      "name": "string", ~/~/ Наименование команды
--      "command": "string", ~/~/ Текст команды
--      "retries": 0 ~/~/ Количество попыток
--    }
--  ],
--
--   "sensors": [ ~/~/ Датчики
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки
--      "gradesTables": [ ~/~/ Тип тарировки Таблица
--        {
--          "grades": [ ~/~/ Тарировка
--            {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
--            }
--          ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z"
--        }
--      ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0,
--      "expr": "string",
--      "children": [
--        "string"
--      ],
--      "customParams": {
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      },
--      "summaryMaxValue": 0
--    }
--
--    "drivers": [ ~/~/ Водители
--          {
--         "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--         "name": "string",
--         "description": "string",
--         "isDefault": true
--          }
--    ],
--
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -850,17 +850,7 @@
              "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
--    ],
--
-- "statusHistory": [ ~/~/ История статусов
--    {
--      "status": 0,
--      "date": "2023-05-22T09:57:39.562Z",
--      "description": "string",
--      "additionalInfo": "string"
--    }
--  ]
--
++    ]
  }
  )))
@@ -877,7 +877,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -999,7 +999,7 @@
  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -1079,7 +1079,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -1125,7 +1125,7 @@
  (% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1242,7 +1242,7 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--**Валидация:**
++**валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
@@ -1254,7 +1254,7 @@
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1276,7 +1276,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1303,7 +1303,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1332,7 +1332,7 @@
  )))
  (% style="text-align: left;" %)
--Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="text-align: left;" %)
  Метод запроса **POST**
@@ -1363,14 +1363,16 @@
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
++(% style="text-align: left;" %)
++(% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**
++
  (% class="box infomessage" %)
  (((
  **POST /api/v3/terminalMessages**
  )))
--Метод возвращает список сообщений терминала объекта за выбранный период.
++Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="text-align: left;" %)
  Метод запроса **POST**
@@ -1412,206 +1412,7 @@
    }
  ]
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/notifications/find**
--)))
--
--Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "parentId": "" ~/~/ id клиента
--}
--
--Ответ:
--
--[
--  {
--    "id": 0, ~/~/ ID уведомления
--    "name": "string", ~/~/ Название уведомления
--    "active": true, ~/~/ Состояние true - активен, false - деактивирован
--    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
--    "userId": "", ~/~/ Пользователь, создавший уведомление
--    "parentId": "", ~/~/ Идентификатор клиента
--    "parentName": "string" ~/~/ Имя клиента
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/notifications/{id}**
--)))
--
--Метод возвращает данные правил формирования выбранного уведомления.
--
--(% style="text-align: left;" %)
--Метод запроса **GET**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)Ответ:
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %){
--  "id": 0, ~/~/ (%%)id уведомления
--(% style="color:#000000" %)  "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
--(% style="color:#000000" %)  "userId": "", /(%%)/ Пользователь, создавший уведомление
--(% style="color:#000000" %)  "parentId": "", (%%)~/~/ Идентификатор клиента
--(% style="color:#000000" %)  "parentName": "string", (%%)~/~/ Имя клиента
--(% style="color:#000000" %)  "name": "string", (%%)~/~/ Название уведомления
--(% style="color:#000000" %)  "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
--(% style="color:#000000" %)  "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
--(% style="color:#000000" %)    0
--  ],
--  "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
--(% style="color:#000000" %)    0
--  ],
--  "fieldids": [ ~/~/ (%%)Список id полей для анализа
--(% style="color:#000000" %)    0
--  ],
--  "settings": { ~/~/ Список параметров уведомления
--    "additionalProp1": "string",
--    "additionalProp2": "string",
--    "additionalProp3": "string"
--  },
--  "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
--(% style="color:#000000" %)  "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
--(% style="color:#000000" %)    ""
--  ],
--  "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
--(% style="color:#000000" %)  "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
--(% style="color:#000000" %)    "string"
--  ],
--  "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
--(% style="color:#000000" %)  "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
--(% style="color:#000000" %)    {
--      "id": 0, ~/~/ (%%)Идентификатор участника чата
--(% style="color:#000000" %)      "info": "string" ~/~/ (%%)Дополнительные сведения
--(% style="color:#000000" %)    }
--  ],
--  "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
--(% style="color:#000000" %)  "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
--(% style="color:#000000" %)  "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
--(% style="color:#000000" %)  "kind": 0, ~/~/ (%%)Определяет вид уведомления
--(% style="color:#000000" %)  "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
--(% style="color:#000000" %)  "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
--(% style="color:#000000" %)  "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
--(% style="color:#000000" %)  "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
--(% style="color:#000000" %)  "autoProlongation": true ~/~/ (%%)Автопродление срока действия
--(% style="color:#000000" %)}
--
--== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/notifications/**
--)))
--
--Метод позволяет отредактировать уведомление.
--
--Метод запроса **PUT**
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Тело запроса:
--{
-- "id": 0, ~/~/ id уведомления
--  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
--  "userId": "", ~/~/ Пользователь, создавший уведомление
--  "parentId": "", ~/~/ Идентификатор клиента
--  "parentName": "string", ~/~/ Имя клиента
--  "name": "string", ~/~/ Название уведомления
--  "active": true, ~/~/ Состояние true - активен, false - деактивирован
--  "vehicleIds": [ ~/~/ Список id объектов для анализа
--    0
--  ],
--   "geoids": [ ~/~/ Список id геообъектов для анализа
--    0
--  ],
--  "fieldids": [ ~/~/ Список id полей для анализа
--    0
--  ],
--  "settings": { ~/~/ Список параметров уведомления
--    "additionalProp1": "string",
--    "additionalProp2": "string",
--    "additionalProp3": "string"
--  },
--  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
--  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
--    ""
--  ],
--  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
--  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
--    "string"
--  ],
--  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
--  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
--    {
--      "id": 0, ~/~/ Идентификатор участника чата
--      "info": "string" ~/~/ Дополнительные сведения
--    }
--  ],
--  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
--  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
--  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
--  "kind": 0, ~/~/ Определяет вид уведомления
--  "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
--  "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
--  "timezone": 0, ~/~/ Сдвиг часового пояса
--  "validity": 0, ~/~/ Срок действия в днях (1-90)
--  "autoProlongation": true ~/~/ Автопродление срока действия
--}
--
--Ответ:
--
--Success
--
--== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/notifications/{id}**
--)))
--
--Метод позволяет удалить выбранное уведомление.
--
--Метод запроса **DELETE**
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
--
--Передаваемый параметр: {id} - id уведомления
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--Success
--
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню