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

Last modified by Андрей Калиновский on 2025/08/08 13:28

From version < 250.1 >

edited by Михаил Жучков
on 2025/07/10 13:02

To version < 237.1 >

edited by Андрей Калиновский
on 2025/05/26 15:33

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.SupportZhuchkov
++XWiki.Gadmin

Content

@@ -454,7 +454,7 @@
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
--    "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -766,8 +766,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--=   =
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
@@ -2391,7 +2391,7 @@
  Тело запроса:
  {
--  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2457,8 +2457,6 @@
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
          "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
--        "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
--        "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
           "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
@@ -2588,50 +2588,26 @@
  В заголовках запроса: X-Auth: Токен авторизации
--В массиве указываем id объектов через запятую
++В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
  Ответ:
--
--[
    {
--    "vehicleId": 55728, ~/~/ Идентификатор объекта
--    "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта
--    "vehicleNumber": "0105 КМ", ~/~/ Номер объекта
--    "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных
--    "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных
--    "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
--    "speed": 31, ~/~/ Скорость объекта
--    "course": 116, ~/~/ Курс движения [0;360]
--    "latitude": 45.722128, ~/~/ Широта [-90°;90°].
--    "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
--    "address": "\"   Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес
--    "geozones": [ ~/~/ Сведения по геозонам.
++    "vehicleId": 0, ~/~/Идентификатор объекта.
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
++    "vehicleNumber": "string",~/~/Номер объекта.
++    "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
++    "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
++    "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
++    "speed": 0,~/~/Скорость объекта.
++    "course": 0,~/~/Курс движения [0;360]
++    "latitude": 0,~/~/Широта [-90°;90°].
++    "longitude": 0,~/~/Долгота [-180°;180°].
++    "address": "string",~/~/Адрес.
++    "geozones": [ ~/~/Сведения по геозонам.
        {
--        "id": 10225647, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10282875, ~/~/ ID Геозоны
--        "name": "Ё2" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10226240, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 9747869, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10221123, ~/~/ ID Геозоны
--        "name": "53r" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10197638, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
++        "id": 0,
++        "name": "string"
        }
--    ]
--  }
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
@@ -2822,7 +2822,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" ~/~/ Имя клиента
@@ -2829,155 +2829,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" %)
@@ -4195,12 +4195,16 @@
  Тело запроса:
  {
--  "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" %)
@@ -4212,29 +4212,16 @@
  Тело запроса:
--(((
  {
--  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "amount": 0 ~/~/ Сумма пополнения баланса
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
  }
--)))
--(((
--
--)))
--
  Ответ: Success
--(((
--{
--  "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="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" %)**Списать с баланса**(%%) ==
@@ -4247,25 +4247,16 @@
  Тело запроса:
--(((
  {
--  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "amount": 0 ~/~/ Сумма списания с баланса
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
  }
--)))
  Ответ: Success
--(((
--{
--  "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="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" %)**Изменить ограничения клиента**(%%) ==
@@ -4276,35 +4276,28 @@
  Тело запроса:
--(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
--  "PermissibleBalance": 0, ~/~/ Допустимый баланс
--  "DefermentDays": 0, ~/~/ Отсрочка (дни).
--  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
--  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "CalculationType": 0,
++  "PermissibleBalance": 0,
++  "DefermentDays": 0,
++  "SendUiNotifications": true,
++  "SendEmailNotifications": true,
++  "IsPrivate": true,
  }
--)))
--(((
--
--)))
--
  Ответ: Success
--(((
--{
--  "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; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|PermissibleBalance|Допустимый баланс
++|DefermentDays|(((
++Отсрочка, количество дней
  )))
++|(% 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" %)**Изменить тариф клиента**(%%) ==
@@ -4316,68 +4316,35 @@
  Тело запроса:
  {
--  "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, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
--      "Price": 0, ~/~/ Цена за единицу.
--      "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
--      "PeriodValue": 0, ~/~/ Значение периода.
--      "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
++      "Feature": "string",
++      "IsEnabled": true,
++      "IsFactual": true,
++      "Limit": 0,
++      "Price": 0,
++      "DebitDate": "2023-10-18T13:26:58.987Z",
++      "PeriodValue": 0,
++      "PeriodType": 0
      }
    ]
  }
--
  Ответ: Success
--(((
--{
--  "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="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 - Месяцы
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
@@ -6208,14 +6208,14 @@
  = **Раздел: Локатор ** =
--== **Получение данных по локатору** ==
++== **Получение списка локаторов, доступных пользователю ** ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators/{locatorId}**
++**GET /api/v3/locators **
  )))
--В запросе указывается locatorid - идентификатор локатора
++В заголовках запроса: X-Auth: Токен авторизации
  Пример ответа:
@@ -6223,13 +6223,13 @@
  (((
  (((
  {
--  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "vehiclesIds": [ ~/~/ Объекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
@@ -6248,17 +6248,14 @@
    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
    "url": "string", ~/~/ Ссылка
--  "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
--
-- "showVehicleName": true, ~/~/ Наименование объекта
--    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
--    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
--    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
--    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
--    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
--
--  1
--
++  "language": 0, ~/~/ Язык
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": [ ~/~/  Слои на карте
++    0
    ]
  }
  )))
@@ -6265,9 +6265,38 @@
  )))
++== **Получение перечня моделей ** ==
++
++(% 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 - Машины)
++  }
++]
  )))
  )))
@@ -6283,6 +6283,7 @@
  (((
  {
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
    "isEnabled": true, ~/~/ Активность
    "name": "string", ~/~/ Наименование локатора
    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
@@ -6289,28 +6289,26 @@
    "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "vehiclesIds": [ ~/~/ Oбъекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
--
-- "showVehicleName": true, ~/~/ Наименование объекта
--    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
--    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
--    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
--    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
--    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
--
--    1
--
--      ]
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
++    0
++  ]
  }
  )))
@@ -6322,70 +6322,7 @@
  )))
--== **Выводит список локаторов ** ==
--(% class="box successmessage" %)
--(((
--**POST /api/v3/locators/find**
--)))
--
--Пример запроса:
--
--(((
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
--}
--)))
--
--(((
--
--)))
--
--(((
--
--)))
--
--
--Пример ответа:
--
--(((
--[
--  {
--    "vehiclesCount": 0, ~/~/ Количество объектов.
--    "geozonesCount": 0, ~/~/ Количество геозон.
--    "fieldsCount": 0, ~/~/ Количество полей.
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
--    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
--    "agentName": "string", ~/~/ Наименование агента.
--    "isEnabled": true, ~/~/ Активность локатора
--    "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
--    "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления
--    "name": "string", ~/~/ Наименование локатора
--    "status": 0,   ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
--    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени )
--    "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
--    "validity": 0, ~/~/ Срок действия в днях (1-90)
--    "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2)
--    "autoProlongation": true, ~/~/ Автоматическая пролонгация
--    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
--    "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора
--    "url": "string", ~/~/ ссылка на локатор
--    "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
--    "showVehicleName": true, ~/~/ Наименование объекта
--    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
--    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
--    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
--    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
--    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
--
--    0
--    ]
--  }
--]
--)))
--
--
--
  == **Изменение локатора** ==
  (% class="box infomessage" %)
@@ -6404,25 +6404,25 @@
    "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия
--  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
-- "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "vehiclesIds": [ ~/~/ Oбъекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
    "showVehicleName": true, ~/~/ Наименование объекта
--    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
--    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
--    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
--    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
--    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
--
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--
    ]
  }
@@ -6656,7 +6656,6 @@
  )))
--==   ==

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

Summary

Details

Меню