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

Last modified by Андрей Калиновский on 2025/06/27 16:12

From version < 240.1 >

edited by Андрей Калиновский
on 2025/06/09 16:36

To version < 234.1 >

edited by Андрей Калиновский
on 2025/05/14 16:54

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -2455,8 +2455,6 @@
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
          "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
--        "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
--        "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
           "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
@@ -2796,7 +2796,7 @@
      "id": 0, ~/~/ ID уведомления
      "name": "string", ~/~/ Название уведомления
      "active": true, ~/~/ Состояние true - активен, false - деактивирован
--    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя)
++    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
      "userId": "", ~/~/ Пользователь, создавший уведомление
      "parentId": "", ~/~/ Идентификатор клиента
      "parentName": "string" ~/~/ Имя клиента
@@ -2803,155 +2803,6 @@
    }
  ]
--
--== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/notifications**
--)))
--
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)Пример запроса
--
--(((
--{
--  "id": 0, ~/~/ ID правила
--  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
--  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "name": "string", ~/~/ Имя правила
--  "active": true, ~/~/ Активность правила
--  "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
--  "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/
--  ],
--  "vehicleIds": [ ~/~/ Список объектов для анализа.
--    0
--  ],
--  "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
--    0
--  ],
--  "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
--    0
--  ],
--  "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
--    "additionalProp1": "string",
--    "additionalProp2": "string",
--    "additionalProp3": "string"
--  },
--  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
--  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
--  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
--    "string"
--  ],
--  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
--  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
--    {
--      "id": 0, ~/~/ Идентификатор участника чата.
--      "info": "string" ~/~/ Дополнительные сведения.
--    }
--  ],
--  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
--  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
--  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
--  "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение)
--  "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
--  "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
--  "timezone": 0, ~/~/ часовой пояс
--  "validity": 0, ~/~/ Срок действия в днях (1-90).
--  "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "templates": [ ~/~/  Переопределения шаблонов уведомлений.
--    {
--      "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
--      "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
--      "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      }
--    }
--  ]
--}
--)))
--
--(((
--
--)))
--
--(((
--
--)))
--
--Ответ:
--
--{
--  "id": 0, ~/~/ ID правила
--  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
--  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "name": "string", ~/~/ Имя правила
--  "active": true, ~/~/ Активность правила
--  "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
--  "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/
--  ],
--  "vehicleIds": [ ~/~/ Список объектов для анализа.
--    0
--  ],
--  "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
--    0
--  ],
--  "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
--    0
--  ],
--  "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
--    "additionalProp1": "string",
--    "additionalProp2": "string",
--    "additionalProp3": "string"
--  },
--  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
--  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
--  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
--    "string"
--  ],
--  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
--  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
--    {
--      "id": 0, ~/~/ Идентификатор участника чата.
--      "info": "string" ~/~/ Дополнительные сведения.
--    }
--  ],
--  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
--  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
--  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
--  "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение)
--  "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
--  "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
--  "timezone": 0, ~/~/ часовой пояс
--  "validity": 0, ~/~/ Срок действия в днях (1-90).
--  "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "templates": [ ~/~/  Переопределения шаблонов уведомлений.
--    {
--      "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
--      "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
--      "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      }
--    }
--  ]
--}
--
  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
  (% class="box infomessage" %)
@@ -6065,62 +6065,6 @@
  )))
--= **Раздел: Роли** =
--
--== **Получение списка клиентских и системных ролей пользователя ** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/groups/find**
--)))
--
--Пример запроса:
--
--(((
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
--  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
--}
--)))
--
--(((
--
--)))
--
--(((
--Пример ответа:
--)))
--
--(((
--(((
--{
--  "groups": [  ~/~/ Системные роли пользователя
--    {
--      "code": "string", ~/~/ Код роли.
--      "name": "string", ~/~/ Имя
--      "shortName": "string" ~/~/ Короткое имя
--    }
--  ],
--  "customGroups": [ ~/~/ Системные роли пользователя
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
--      "name": "string", ~/~/ Наименование
--      "shortName": "string", ~/~/ Короткое наименование
--      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
--    }
--  ]
--}
--)))
--)))
--
--(((
--
--)))
--
--(((
--
--)))
--
  = **Раздел: Локатор ** =
@@ -6128,7 +6128,7 @@
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators **
++**GET /api/v3/locators**
  )))
  В заголовках запроса: X-Auth: Токен авторизации
@@ -6137,83 +6137,33 @@
  Пример ответа:
  (((
--(((
--{
--  "vehiclesIds": [ ~/~/ Объекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    0
--  ],
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
--  "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
--  "agentName": "string", ~/~/ Наименование агента.
--  "isEnabled": true, ~/~/ Активность
--  "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
--  "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
--  "name": "string", ~/~/ Наименование.
--  "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
--  "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
--  "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
--  "validity": 0, ~/~/ Значение срока действия
--  "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2)
--  "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
--  "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
--  "url": "string", ~/~/ Ссылка
--  "language": 0, ~/~/ Язык
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/  Слои на карте
--    0
--  ]
--}
--)))
--)))
--
--
--== **Получение перечня моделей ** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/models/find**
--)))
--
--Пример запроса:
--
--(((
--(((
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
--  "name": "string", ~/~/ Наименование локатора
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
--)))
--
--
--
-- Пример ответа:
--
--
--(((
  [
    {
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
--    "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
--    "name": "string", ~/~/ Наименование локатора
--    "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины)
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
++    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
++    "agentName": "string", ~/~/ Наименование агента.
++    "isEnabled": true, ~/~/ Активен
++    "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
++    "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
++    "name": "string", ~/~/ Наименование
++    "status": 0, ~/~/
++    "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++    "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации)
++    "validity": 0, ~/~/ Срок действия в днях (1-90).
++    "autoProlongation": true, ~/~/ Автопродление срока действия.
++    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
++    "url": "string", ~/~/ Ссылка
++    "language": 0, ~/~/ Язык.
++    "vehiclesCount": 0, ~/~/ Количество объектов.
++    "geozonesCount": 0, ~/~/ Количество геозон.
++    "fieldsCount": 0 ~/~/ Количество полей.
    }
  ]
  )))
--)))
++
  == **Создание локатора** ==
  (% class="box successmessage" %)
@@ -6234,24 +6234,6 @@
    "autoProlongation": true, ~/~/ Автопродление срока действия.
    "url": "string", ~/~/ Ссылка
    "language": 0 ~/~/ Язык
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    0
--  ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--    0
--  ]
  }
  )))
@@ -6284,29 +6284,10 @@
    "autoProlongation": true, ~/~/ Автопродление срока действия
    "url": "string", ~/~/ Ссылка
    "language": 0 ~/~/ Язык
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    0
--  ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--    0
--  ]
  }
--
--
  )))
++
  Пример ответа:
 ~/~/ Success

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

Summary

Details

Меню