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

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

From version < 225.2 >

edited by Андрей Калиновский
on 2025/05/06 11:25

To version < 241.1 >

edited by Андрей Калиновский
on 2025/06/10 15:42

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -877,7 +877,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
++  "deleted": false,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -896,7 +896,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
++  "deleted": false,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -930,7 +930,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -997,7 +997,7 @@
  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1628,81 +1628,6 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== **Импортировать историю ТС (Асинхронный запрос)** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
--)))
--
--При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
--
--Метод запроса: **POST**
--
--URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
--
--Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
--
--~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
--== **Возвращает статус асинхронного запроса импорта истории ТС** ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
--)))
--
--При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
--
--Метод запроса: **GET**
--
--URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
--
--Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполения запроса
--~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
--
--~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
@@ -1848,7 +1848,6 @@
    "stage": "", ~/~/ Состояние
  (% style="color:#000000" %)  }
--==   ==
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
@@ -2531,6 +2531,8 @@
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
          "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
++        "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
++        "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
           "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
@@ -2870,7 +2870,7 @@
      "id": 0, ~/~/ ID уведомления
      "name": "string", ~/~/ Название уведомления
      "active": true, ~/~/ Состояние true - активен, false - деактивирован
--    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
++    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя)
      "userId": "", ~/~/ Пользователь, создавший уведомление
      "parentId": "", ~/~/ Идентификатор клиента
      "parentName": "string" ~/~/ Имя клиента
@@ -2877,6 +2877,155 @@
    }
  ]
++
++== (% 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" %)
@@ -4094,16 +4094,12 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "Balance": 0 ~/~/ Значение баланса.
  }
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
  (% class="box warningmessage" %)
@@ -4115,16 +4115,29 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "amount": 0 ~/~/ Сумма пополнения баланса
  }
++)))
++(((
++
++)))
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++(((
++{
++  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
++  "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
++  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
++  "Description": "string" ~/~/ Описание корректировки.
++}
++)))
  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
@@ -4137,16 +4137,25 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "amount": 0 ~/~/ Сумма списания с баланса
  }
++)))
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++(((
++{
++  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
++  "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
++  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
++  "Description": "string" ~/~/ Описание корректировки
++}
++)))
  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
@@ -4157,28 +4157,35 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "CalculationType": 0,
--  "PermissibleBalance": 0,
--  "DefermentDays": 0,
--  "SendUiNotifications": true,
--  "SendEmailNotifications": true,
--  "IsPrivate": true,
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
++  "PermissibleBalance": 0, ~/~/ Допустимый баланс
++  "DefermentDays": 0, ~/~/ Отсрочка (дни).
++  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
++  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
  }
++)))
++(((
++
++)))
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|(((
--Отсрочка, количество дней
++(((
++{
++  "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
++  "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
++  "PermissibleBalance": 0, ~/~/ Допустимый баланс.
++  "DefermentDays": 0, ~/~/ Отсрочка (дни)
++  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
++  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
++}
  )))
--|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
--|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
--|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
@@ -4190,35 +4190,68 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Features": [
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
++  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
++  "Features": [ ~/~/ Набор услуг по тарифу клиента.
      {
--      "Feature": "string",
--      "IsEnabled": true,
--      "IsFactual": true,
--      "Limit": 0,
--      "Price": 0,
--      "DebitDate": "2023-10-18T13:26:58.987Z",
--      "PeriodValue": 0,
--      "PeriodType": 0
++      "Feature": "string", ~/~/ Код услуги.
++      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
++      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
++      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
++      "Price": 0, ~/~/ Цена за единицу.
++      "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
++      "PeriodValue": 0, ~/~/ Значение периода.
++      "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
      }
    ]
  }
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|PlanId|Идентификатор тарифного плана
--|Feature|Код услуги
--|IsEnabled|Признак, определяющий активирована ли услуга
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|DebitDate|Следующий момент времени списания с баланса за услугу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++(((
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
++    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
++    "Name": "string", ~/~/ Наименование.
++    "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
++    "Constraint": { ~/~/ Ограничения по тарифу
++      "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни)
++      "PermissibleBalance": 0, ~/~/ Допустимый баланс.
++      "DefermentDays": 0 ~/~/ Отсрочка (дни)
++    },
++    "Features": [ ~/~/ Набор услуг по тарифному плану.
++      {
++        "Feature": "string", ~/~/Код услуги.
++        "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
++        "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++        "Price": 0, ~/~/ Цена за единицу.
++        "PeriodValue": 0, ~/~/ Значение периода.
++        "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни)
++      }
++    ],
++    "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
++    "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
++    "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
++  },
++  "Features": [ ~/~/ Набор услуг по тарифу клиента.
++    {
++      "Feature": "string", ~/~/ Код услуги.
++      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
++      "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
++      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
++      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++      "Price": 0, ~/~/ Цена за единицу.
++      "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
++      "PeriodValue": 0, ~/~/ Значение периода.
++      "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
++      "Quantity": 0 ~/~/ Количество использования услуги.
++    }
++  ]
++}
++)))
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
@@ -4323,6 +4323,43 @@
  |producedCount|Кол-во успешно отправленных в шину данных сообщений
  |msgCount|Кол-во обработанных сообщений всего
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -4340,10 +4340,59 @@
    "message": "string"
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
--|progress|Guid ТС
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
++**Параметр**
++)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
++**Описание**
++)))
++|(((
++activity
++)))|(((
++Активен ли экспорт/импорт истории сейчас, true - да, false - нет
++)))
++|(((
++progress
++)))|(((
++Guid ТС
++)))
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
  (% class="box infomessage" %)
@@ -5904,6 +5904,62 @@
  )))
++= **Раздел: Роли** =
++
++== **Получение списка клиентских и системных ролей пользователя ** ==
++
++(% 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" ~/~/ Идентификатор владельца
++    }
++  ]
++}
++)))
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
  = **Раздел: Локатор ** =
@@ -5911,7 +5911,7 @@
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators**
++**GET /api/v3/locators **
  )))
  В заголовках запроса: X-Auth: Токен авторизации
@@ -5920,33 +5920,83 @@
  Пример ответа:
  (((
++(((
++{
++  "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",  ~/~/ Идентификатор локатора.
--    "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 ~/~/ Количество полей.
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
++    "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
++    "name": "string", ~/~/ Наименование локатора
++    "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины)
    }
  ]
  )))
++)))
--
  == **Создание локатора** ==
  (% class="box successmessage" %)
@@ -5967,6 +5967,24 @@
    "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
++  ]
  }
  )))
@@ -5999,10 +5999,29 @@
    "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
@@ -6166,7 +6166,6 @@
  Id  ~/~/ Идентификатор поля
--====   ====
  = **Раздел: Управление доступа к машинам** =

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

Summary

Details

Меню