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

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

From version < 160.1 >

edited by Андрей Калиновский
on 2024/07/25 10:10

To version < 158.2 >

edited by Андрей Калиновский
on 2024/07/19 15:59

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -44,8 +44,12 @@
  (% lang="en-US" %)
  (% style="color:#000000" %){
--    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
--    "User": "testuser" ,  ~/~/ имя пользователя(%%)
++
++(% lang="en-US" %)
++(% style="color:#000000" %)    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
++    "User": "testuser" ,  ~/~/ имя пользователя
++
++(% lang="en-US" %)
  }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -225,6 +225,7 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++
  Ответ:
  {
@@ -418,6 +418,7 @@
      ],
      "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
++
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastName": "string",
@@ -431,8 +431,12 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
--{
--    "id": "" ,  ~/~/ ID пользователя
++
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %){
++
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ Фамилия ,
      "firstName": "" ,  ~/~/ Имя
      "position": "" ,  ~/~/ Должность
@@ -449,9 +449,11 @@
      "kind": "" ,  ~/~/ тип аутентификации
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %),  ~/~/ роли пользователя, перечислены названия групп пользователя
--}
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %)}
++
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
  (% class="box infomessage" %)
@@ -471,16 +471,19 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
    "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303",  ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
    "userId": "11111111-c384-43f8-8562-1c3d79a32303",  ~/~/ ID пользователя, по которому фильтруется, null - неважно
    "login": "qqqqqq",  ~/~/ Логин пользователя, по которому фильтруется, null - неважно
    "email": "eee",  ~/~/ Email пользователя, по которому фильтруется, null - неважно
++
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){         (%%)
++
      "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
@@ -494,6 +494,7 @@
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
      "lastLogged": "", ~/~/ дата/время последней авторизации
++
  (% style="color:#000000" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
@@ -567,8 +567,10 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--    "id": "" ,  ~/~/ ID пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -590,7 +590,9 @@
          "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
      },
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
--    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя(%%)
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
++
++(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
  (% lang="en-US" style="text-align:left" %)
@@ -597,8 +597,10 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--    "id": "" ,  ~/~/ идентификатор пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -619,8 +619,10 @@
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
--}
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
++
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
  (% class="box warningmessage" %)
@@ -640,10 +640,12 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "status": "" ,  ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
      "description": "" ,  ~/~/ описание
      "data": "" ,  ~/~/ данные, связанные со сменой статуса
++
  (% style="color:#000000" %)}
  (% style="text-align:left" %)
@@ -665,7 +665,7 @@
  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
   [
--   "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
++    "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
      "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
    ]
@@ -1007,15 +1007,19 @@
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
      "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", ~/~/ ID поля
@@ -1038,7 +1038,8 @@
       "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
    "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
    "mileageCoeff": 0, ~/~/ коэффициент пробега
    "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
@@ -1068,6 +1068,7 @@
        "retries": 0 ~/~/ Количество попыток
      }
    ],
++
     "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
@@ -1129,6 +1129,7 @@
           "isDefault": true ~/~/ По умолчанию
            }
      ],
++
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1145,7 +1145,8 @@
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
      ],
--"statusHistory": [ ~/~/ История статусов
++
++ "statusHistory": [ ~/~/ История статусов
      {
        "status": 0,
        "date": "2023-05-22T09:57:39.562Z",
@@ -1153,6 +1153,7 @@
        "additionalInfo": "string"
      }
    ]
++
  }
  )))
@@ -1210,6 +1210,8 @@
  "status": "" ~/~/ Статус отправки
  }
  ]
++
++
  )))
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
@@ -1229,7 +1229,8 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1250,6 +1250,7 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
       "mileageCalcMethod": 0,
       "mileageCoeff": 0,
       "locationByCellId": true,
@@ -1282,6 +1282,7 @@
        "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
++
  "drivers": [ ~/~/ Водители
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1296,7 +1296,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1334,17 +1334,29 @@
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
++
  ~/~/ Характерные для произвольного:
++
  ~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
++
  ~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
++
  ~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
++
  ~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
++
  ~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
++
  ~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
++
  ~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
++
  ~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
++
  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
++
  ~/~/ "ValueOn": "Вкл.",
++
  ~/~/ "ValueOff": "Выкл."
        "summaryMaxValue": 0 ~/~/ Макс. значение
      }
@@ -1363,7 +1363,8 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "vehicleId": "", ~/~/ID ТС
      "parentId": "", ~/~/Guid владельца ТС
      "name": "", ~/~/Имя объекта
@@ -1401,6 +1401,8 @@
      "kind": "", ~/~/ Вид периодичности по времени
      "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
      }
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
  **Валидация:**
@@ -1459,7 +1459,8 @@
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
--    "vehicleId": "" ~/~/ идентификатор объекта
++
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1518,11 +1518,13 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
++
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
    "status": "", ~/~/ значение статуса
    "date": "", ~/~/ Дата смены статуса
    "description": "", ~/~/ Описание
@@ -1529,9 +1529,12 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)  }
--== **Отправить команду на терминал** ==
++(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
++**Отправить команду на терминал**
  (% class="box successmessage" %)
  (((
@@ -1635,7 +1635,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1673,17 +1673,29 @@
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
++
  ~/~/ Характерные для произвольного:
++
  ~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
++
  ~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
++
  ~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
++
  ~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
++
  ~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
++
  ~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
++
  ~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
++
  ~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
++
  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
++
  ~/~/ "ValueOn": "Вкл.",
++
  ~/~/ "ValueOff": "Выкл."
        "summaryMaxValue": 0 ~/~/ Макс. значение
      }
@@ -1703,7 +1703,9 @@
  (% style="color:#000000" %)Ответ:
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++
++(% lang="en-US" style="text-align:left" %)
      "vehicleId": "", ~/~/ ID ТС
      "parentId": "", ~/~/ ID клиента
      "name": "", ~/~/ имя ТС
@@ -1744,6 +1744,8 @@
          "kind": "", ~/~/ Вид периодичности по времени
          "maxQuantity": "", ~/~/ Сколько раз выполнить задание
          }
++
++(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
  **Валидация:**
@@ -1790,9 +1790,12 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "deviceTypeId" : "", ~/~/ ID типа устройства
      "deviceTypeName" : "" ~/~/ Название типа устройства
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
@@ -2206,6 +2206,7 @@
        }
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -4191,7 +4191,7 @@
  "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
  }
--Ответ:
++Ответ
  [
  {
@@ -4207,7 +4207,7 @@
  ]
--= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
  == **API для отчета по выгрузке комбайнов** ==

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

Summary

Details

Меню