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

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

From version < 80.2 >

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

To version < 89.1 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -436,7 +436,7 @@
      "email": "" ,  ~/~/ E-mail
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
--    "astLogged": "", ~/~/ дата/время последней авторизации
++    "lastLogged": "", ~/~/ дата/время последней авторизации
  (% 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**__> - идентификатор объекта (опционально)
++(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -717,20 +717,123 @@
      "deviceTypeId": , ~/~/ ID типа устройства
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
--    "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" ~/~/ временная метка редактирования/обновления счетчика моточасов
++    "sim2": "", ~/~/ Номер SIM2
++
++    "parentId": "", ~/~/ ID клиента-родителя
++    "parentName": "", ~/~/ Наименование клиента-родителя
++    "modelId": "", ~/~/ ID модели объекта
++    "modelName": "", ~/~/ Имя модели объекта
++
++    "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
++    "unitName": "string", ~/~/ Наименование подразделения
++    "status": 0, ~/~/ Статус объекта
++
++    "createdAt": "", ~/~/ Дата создания объекта
      },
++
++"customFields": [ ~/~/ Произвольные поля
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "name": "string",
++      "value": "string",
++      "forClient": true,
++      "forTooltip": true,
++      "forReport": true
++    }
++
++], ~/~/ Данные с вкладки нормы
++  "consumptionPer100Km": 0,
++  "consumptionPerHour": 0,
++  "consumptionIdle": 0,
++  "consumptionPer100KmSeasonal": 0,
++  "consumptionPerHourSeasonal": 0,
++  "consumptionIdleSeasonal": 0,
++  "consumptionPer100KmSeasonalBegin": "2023-05-22T09:57:39.562Z",
++  "consumptionPer100KmSeasonalEnd": "2023-05-22T09:57:39.562Z",
++  "consumptionPerHourSeasonalBegin": "2023-05-22T09:57:39.562Z",
++  "consumptionPerHourSeasonalEnd": "2023-05-22T09:57:39.562Z",
++  "consumptionIdleSeasonalBegin": "2023-05-22T09:57:39.562Z",
++  "consumptionIdleSeasonalEnd": "2023-05-22T09:57:39.562Z",
++  "mileageCalcMethod": 0,
++  "mileageCoeff": 0,
++  "locationByCellId": true,
++  "dottedLineTrackWhenNoCoords": true,
++  "counters": {
++    "mileageEnabled": true,
++    "motohoursEnabled": true,
++    "mileage": 0,
++    "motohours": 0,
++    "mileageTime": "2023-05-22T09:57:39.562Z",
++    "motohoursTime": "2023-05-22T09:57:39.562Z"
++  },
++
++"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
++    "id": "string",
++    "enabled": true,
++    "host": "string",
++    "login": "string",
++    "password": "string"
++  },
++
++"commandTemplates": [ ~/~/ Шаблоны команд
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "name": "string",
++      "command": "string",
++      "retries": 0
++    }
++  ],
++
++   "sensors": [ ~/~/ Датчики
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "kind": 0,
++      "type": 0,
++      "name": "string",
++      "inputType": 0,
++      "inputNumber": 0,
++      "pseudonym": "string",
++      "medianDegree": 0,
++      "isInverted": true,
++      "disabled": true,
++      "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  задания
@@ -746,7 +746,17 @@
              "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
--    ]
++    ],
++
++ "statusHistory": [ ~/~/ История статусов
++    {
++      "status": 0,
++      "date": "2023-05-22T09:57:39.562Z",
++      "description": "string",
++      "additionalInfo": "string"
++    }
++  ]
++
  }
  )))
@@ -763,7 +763,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -1011,7 +1011,7 @@
  (% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1140,7 +1140,7 @@
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1302,7 +1302,10 @@
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
--POST /api/v3/notifications/find
++(% class="box infomessage" %)
++(((
++**POST /api/v3/notifications/find**
++)))
  Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
@@ -1323,21 +1323,23 @@
  [
    {
--    "id": 0,
--    "name": "string",
--    "active": true,
--    "type": 0,
--    "userId": "",
--    "parentId": "",
--    "parentName": "string"
++    "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}**
++)))
--GET /api/v3/notifications/{id}
--
  Метод возвращает данные правил формирования выбранного уведомления.
  (% style="text-align: left;" %)
@@ -1344,7 +1344,7 @@
  Метод запроса **GET**
  (% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
  (% style="text-align: left;" %)
  (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
@@ -1357,54 +1357,142 @@
  (% style="text-align: left;" %)
  (% style="color:#000000" %){
--  "id": 0,
--  "type": 0,
--  "userId": "",
--  "parentId": "",
--  "parentName": "string",
--  "name": "string",
--  "active": true,
--  "vehicleIds": [
++  "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 объектов для анализа
    ],
--  "geoids": [
++   "geoids": [ ~/~/ Список id геообъектов для анализа
    ],
--  "fieldids": [
++  "fieldids": [ ~/~/ Список id полей для анализа
    ],
--  "settings": {
++  "settings": { ~/~/ Список параметров уведомления
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
--  "toEmail": true,
--  "recipientIds": [
++  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
++  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
      ""
    ],
--  "enableSideEmails": true,
--  "sideEmails": [
++  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
++  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
      "string"
    ],
--  "toTelegram": true,
--  "telegrams": [
++  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
++  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
      {
--      "id": 0,
--      "info": "string"
++      "id": 0, ~/~/ Идентификатор участника чата
++      "info": "string" ~/~/ Дополнительные сведения
      }
    ],
--  "toMobile": true,
--  "toClient": true,
--  "stored": true,
--  "kind": 0,
--  "activationMode": 0,
--  "activationTime": "2023-03-29T09:57:48.932Z",
--  "timezone": 0,
--  "validity": 0,
--  "autoProlongation": true
++  "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

Меню