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

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

From version < 176.1 >

edited by Михаил Жучков
on 2024/10/24 11:15

To version < 154.1 >

edited by Андрей Калиновский
on 2024/04/11 14:20

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

@@ -14,20 +14,11 @@
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
--
--(% style="color:#000000; font-size:16px" %)**Рекомендации**
--
--- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
--(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
--(((
--(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
--(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
--)))
++== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
  (% class="box successmessage" %)
  (((
@@ -53,8 +53,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" %)
  }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -234,6 +234,7 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++
  Ответ:
  {
@@ -427,6 +427,7 @@
      ],
      "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
++
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastName": "string",
@@ -440,8 +440,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": "" ,  ~/~/ Должность
@@ -458,9 +458,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" %)
@@ -480,16 +480,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": "" ,  ~/~/ имя
@@ -503,6 +503,7 @@
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
      "lastLogged": "", ~/~/ дата/время последней авторизации
++
  (% style="color:#000000" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
@@ -576,8 +576,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": "" ,  ~/~/ должность
@@ -599,7 +599,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" %)
@@ -606,8 +606,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": "" ,  ~/~/ должность
@@ -628,8 +628,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" %)
@@ -649,10 +649,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" %)
@@ -674,7 +674,7 @@
  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
   [
--   "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
++    "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
      "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
    ]
@@ -980,7 +980,7 @@
  Ответ: В случае успеха **Success 200**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -1016,15 +1016,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 поля
@@ -1047,7 +1047,8 @@
       "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
    "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
    "mileageCoeff": 0, ~/~/ коэффициент пробега
    "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
@@ -1077,6 +1077,7 @@
        "retries": 0 ~/~/ Количество попыток
      }
    ],
++
     "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
@@ -1117,19 +1117,31 @@
        },
  ~/~/ Характерные для произвольного:
++
  ~/~/                "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 ~/~/ Макс. значение
      }
++
      "drivers": [ ~/~/ Водители
            {
           "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1138,6 +1138,7 @@
           "isDefault": true ~/~/ По умолчанию
            }
      ],
++
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1154,7 +1154,8 @@
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
      ],
--"statusHistory": [ ~/~/ История статусов
++
++ "statusHistory": [ ~/~/ История статусов
      {
        "status": 0,
        "date": "2023-05-22T09:57:39.562Z",
@@ -1162,6 +1162,7 @@
        "additionalInfo": "string"
      }
    ]
++
  }
  )))
@@ -1171,73 +1171,6 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--
--== **Отправить команду на терминал** ==
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
--)))
--
--Команда для отправки на тс.
--
--{
--"id": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
--}
--
--
--== **Получить ответ на отправленную на ТС команду** ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
--)))
--
--Идентификатор команды: cmdid
--
--Запрос от терминала на ответ команды
--
--Пример ответ от терминала:
--
--ID= "" ~/~/ идентификатор произвольного поля
--Soft="" ~/~/ версия софта
--GPS=4 ~/~/ тип трекера
--Time=11:05:43 28.06.24 ~/~/ время запроса
--Lat=45.056221 ~/~/ широта
--Lon=39.035938 ~/~/ долгота
--Speed=0.0 ~/~/ скорость
--Course=181.4 ~/~/направление
--
--(((
--== **Список отправленных объекту команд с ответами** ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
--)))
--
--Идентификатор ТС: vehicleId
--
--В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
--
--Пример ответа терминала
--
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
--"commandText": "",   ~/~/Текст команды.
--"templateId": "",    ~/~/Идентификатор шаблона
--"updated": "",  ~/~/ Время отправки
--"tryCount": 0,  ~/~/ Количество попыток отправки команды
--"answer": "",    ~/~/ Ответ терминала.
--"status": "" ~/~/ Статус отправки
--}
--]
--)))
--
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
  (% class="box successmessage" %)
@@ -1255,7 +1255,8 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1276,6 +1276,7 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
       "mileageCalcMethod": 0,
       "mileageCoeff": 0,
       "locationByCellId": true,
@@ -1308,6 +1308,7 @@
        "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
++
  "drivers": [ ~/~/ Водители
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1322,7 +1322,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1360,17 +1360,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 ~/~/ Макс. значение
      }
@@ -1389,7 +1389,8 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "vehicleId": "", ~/~/ID ТС
      "parentId": "", ~/~/Guid владельца ТС
      "name": "", ~/~/Имя объекта
@@ -1427,6 +1427,8 @@
      "kind": "", ~/~/ Вид периодичности по времени
      "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
      }
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
  **Валидация:**
@@ -1434,7 +1434,7 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
  (% class="box infomessage" %)
  (((
@@ -1485,7 +1485,8 @@
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
--    "vehicleId": "" ~/~/ идентификатор объекта
++
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1544,11 +1544,13 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
++
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
    "status": "", ~/~/ значение статуса
    "date": "", ~/~/ Дата смены статуса
    "description": "", ~/~/ Описание
@@ -1555,10 +1555,10 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)  }
--==   ==
--
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -1646,7 +1646,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1684,17 +1684,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 ~/~/ Макс. значение
      }
@@ -1714,7 +1714,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": "", ~/~/ имя ТС
@@ -1755,6 +1755,8 @@
          "kind": "", ~/~/ Вид периодичности по времени
          "maxQuantity": "", ~/~/ Сколько раз выполнить задание
          }
++
++(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
  **Валидация:**
@@ -1801,9 +1801,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" %)Раздел: **Датчики**(%%) =
@@ -1825,10 +1825,13 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "id": "", ~/~/ ID типа датчика
      "name": "", ~/~/ Название
      "description": "", ~/~/ Описание
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
@@ -2030,12 +2030,10 @@
        {
          "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "mileage": 0, ~/~/ Пробег за период, километры
--        "mileageBegin": 0, ~/~/ Пробег на начало периода, километры
--        "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
--        "motohours": 0, ~/~/ Моточасы за период, секунды
--        "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
--        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
++        "mileageBegin": 0, ~/~/ Пробег на начало периода
++        "mileageEnd": 0, ~/~/ Пробег на окончание периода
++        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
++        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
        }
      ]
    }
@@ -2084,12 +2084,6 @@
    }
  ]
--(% class="box warningmessage" %)
--(((
--Максимальное кол-во периодов - 1440 (maxPeriodsCount = 1440)
--\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
--)))
--
  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
  (% class="box infomessage" %)
@@ -2153,42 +2153,74 @@
  Тело запроса:
  {
++
    "vehicleIds": [ ], ~/~/ Список ID объектов
++
    "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
++
    "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
++
    "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++
  }
  Ответ:
--[
++[
++
    {
++
      "vehicleId": 0, ~/~/ ID объекта
++
      "vehicleName": "string", ~/~/ Имя объекта
++
      "moves": [      ~/~/ Событие движения
++
        {
++
          "mileage": 0, ~/~/ Пробег, км
++
          "eventId": 0, ~/~/ Идентификатор события
++
          "eventName": "string", ~/~/ Название события
++
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
          "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
          "duration": 0 ~/~/ Продолжительность события, секунд
++
        }
++
      ],
++
      "stops": [       ~/~/ События стоянок
++
        {
++
          "address": "string", ~/~/ Адрес события
++
          "eventId": 0, ~/~/ Идентификатор события
++
          "eventName": "string", ~/~/ Название события
++
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
          "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
          "duration": 0 ~/~/ Продолжительность события, секунд
++
++
        }
++
      ]
++
    }
++
  ]
++
  == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
  (% class="box infomessage" %)
@@ -2225,6 +2225,7 @@
        }
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -2532,32 +2532,6 @@
  Success
--
--== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT** /api/v3/notifications/prolongation
--)))
--
--Метод позволяет продлить уведомления.
--
--Метод запроса **PUT**
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
--
--В заголовках запроса: X-Auth: Токен авторизации.
--
--Тело запроса:
--
--[
--
--0
--
--]
--
--где 0 идентификатор ids.
--
  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
  (% class="box errormessage" %)
@@ -3748,7 +3748,7 @@
  **POST /api/v3/vehicles/import/{agentId}**
  )))
--Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
  В пути указывается **agentId** - id клиента.
@@ -3760,7 +3760,7 @@
  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
--|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
++|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
  В теле использовать тип **form-data,** тип значения** file**
@@ -4022,7 +4022,7 @@
  |dangerousDrivingViolations|Резкое вождение
  |sensorViolations|Нарушение по датчику
  |moveTime|Время в движении
--|mileage|Пробег (км)
++|mileage|Пробег
  |tripsCount|Количество рейсов
  |motohours|Моточасы
  |maxSpeed|Максимальная скорость
@@ -4052,284 +4052,55 @@
  Параметры в теле запроса (JSON):
  {
++
    "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
++
    "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
--  "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
--  ],
--  "timezone": 0 ~/~/Таймзона
--}
++  "ids": [
--Ответ:
--  {
--    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
--    "driver": "string", ~/~/Водители, привязанные к ТК
--    "object": "string", ~/~/Наименование ТС
--    "amount": 0, ~/~/Количество топлива
--    "amountDut": 0, ~/~/Количество по ДУТ
--    "amountDiff": 0, ~/~/Разница, л
--    "amountDiffPerc": 0, ~/~/Разница, %
--    "summa": 0, ~/~/Стоимость, руб
--    "serviceName": "string", ~/~/Тип топлива
--    "price": 0, ~/~/Цена за литр, руб
--    "cardName": "string", ~/~/Наименование ТК
--    "cardNum": "string", ~/~/Номер ТК
--    "operator": "string", ~/~/Оператор ТК
--    "address": "string" ~/~/Адрес АЗС
--  }
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
++  ],
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
++  "timezone": 0 ~/~/Таймзона
--
--== **Получение полных данных о ретрансляторе** ==
--
--(% class="box infomessage" %)
--(((
--**GET ** **/api/v3/retranslations/{id}**
--)))
--
--Идентификатор запроса: ID
--
--
--Пример ответа:
--
--{
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ Идентификатор объекта ретрансляции
--"name": "",   ~/~/ Наименование объекта ретрансляции
--"imei": "",     ~/~/ IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/Guid родителя
--"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
--}
--
--== **Удаление данных ретранслятора** ==
--
--(% class="box infomessage" %)
--(((
--**DELETE** **/api/v3/retranslations/{id}**
--)))
--
--Параметр запроса: ID
--
--
--== **Создание ретранслятора** ==
--
--(% class="box infomessage" %)
--(((
--**POST ** **/api/v3/retranslations/{id}**
--)))
--
--Запрос:
--
--{
--"description": "",  ~/~/ Описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"address": "",  ~/~/ Адрес ретрансляции
--"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",     ~/~/IMEI объекта
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ]
--}
--
--
  Ответ:
--{
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,   ~/~/ Тип протокола
--"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",     ~/~/ идентификатор пользователя
--"name": "string",     ~/~/ Название уведомления
--"imei": "string",    ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
--}
++  {
++    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
--== **Редактирование ретранслятора** ==
++    "driver": "string", ~/~/Водители, привязанные к ТК
--(% class="box infomessage" %)
--(((
--**PUT** **/api/v3/retranslations**
--)))
++    "object": "string", ~/~/Наименование ТС
--Пример запроса:
++    "amount": 0, ~/~/Количество топлива
--{
--"id": "",  ~/~/ идентификатор пользователя
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",   ~/~/ Адрес события
--"objects":  ~/~/Объекты для ретрансляции
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",       ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ]
--}
++    "amountDut": 0, ~/~/Количество по ДУТ
++    "amountDiff": 0, ~/~/Разница, л
--Пример ответа:
++    "amountDiffPerc": 0, ~/~/Разница, %
--{
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [     ~/~/Объекты для ретрансляции
--{
--"id": "",    ~/~/ идентификатор пользователя
--"name": "string",  ~/~/ Название уведомления
--"imei": "",      ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
--}
++    "summa": 0, ~/~/Стоимость, руб
++    "serviceName": "string", ~/~/Тип топлива
--== **Получение списка ретранслятора клиента** ==
++    "price": 0, ~/~/Цена за литр, руб
--(% class="box infomessage" %)
--(((
--**POST /api/v3/retranslations/find**
--)))
++    "cardName": "string", ~/~/Наименование ТК
--Пример запроса:
++    "cardNum": "string", ~/~/Номер ТК
--{
--"id": "",  ~/~/ идентификатор пользователя
--"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
--}
++    "operator": "string", ~/~/Оператор ТК
--Ответ:
++    "address": "string" ~/~/Адрес АЗС
--[
--{
--"description": "",    ~/~/ Определяет описание
--"subscriberId": "",    ~/~/ идентификатор запроса
--"protocolType": 0,     ~/~/ Тип протокола
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",    ~/~/ Адрес события
--"id": "",    ~/~/ идентификатор пользователя
--"parentId": "",    ~/~/ Guid идентификатор родителя
--"deleted": true   ~/~/ Признак удаления
--}
--]
--
--
--= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
--
--== **API для отчета по выгрузке комбайнов** ==
--
--(% class="box infomessage" %)
--(((
--POST **/api/v3/Reports/harvesterUnloading**
--)))
--
--Пример запроса:
--
--{
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0,  ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
--  "showNearestObjects": true,  ~/~/Показывать объекты рядом?
--  "vehicleIds": [   ~/~/ Список id объектов для анализа
--    0
--  ],
--  "from": "", ~/~/ Дата и время начало запроса
--  "to": "",  ~/~/ Дата и время окончания запроса
--  "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Пример ответа:
--
--[
--  {
--    "harvesterName": "",  ~/~/Комбайн, номер
--    "harvesterId": 0, ~/~/Комбайн, id
--"harvesterModel": "", ~/~/ Модель комбайна
--"hopperCapacity": 0, ~/~/ Объем бункера м3
--    "hopperDischargeSpeed": 0,  ~/~/ Скорость выгрузки из бункера, л/сек
--    "events": [  ~/~/Список событий в разрезе комбайна
--      {
--        "driverId": "",  ~/~/Идентификатор водителя
--        "driverName": "", ~/~/Водитель комбайна, ФИО
--        "RFID": "", ~/~/ идентификатор карты-метки
--        "rfidName": "", ~/~/Водитель комбайна, имя метки
--        "vehicleId": 0, ~/~/идентификатор объекта
--        "vehicleName": "string", ~/~/ Имя объекта
--        "modelName": "string", ~/~/  Имя модели объекта
--        "nearestVehicles": [  ~/~/Объекты рядом
--          {
--            "vehicleId": 0, ~/~/идентификатор объекта
--            "vehicleName": "string" ~/~/ Имя объекта
--          }
--        ],
--        "fields": [  ~/~/Поля, где происходила выгрузка
--          {
--            "id": 0, ~/~/ идентификатор пользователя
--            "name": "string" ~/~/ имя пользователя
--          }
--        ],
--        "event": "string", ~/~/Событие
--        "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
--        "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
--        "durationSeconds": 0,  ~/~/Продолжительность события, в секундах
--        "cultureName": "string",  ~/~/ название культуры
--        "bunkerLowLevelStart": 0,  ~/~/Бункер, нижний уровень (на начало события)
--        "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
--        "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
--        "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
--        "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
--        "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
--        "issued": 0, ~/~/Выдано, бункеров
--        "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
--        "latitude": 0,  ~/~/Широта
--        "longitude": 0, ~/~/ Долгота
--        "litresAway": 0, ~/~/Отдано, л
--        "m3Away": 0 ~/~/Отдано, м3
--      }
--    ]
    }
--]
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
@@ -4348,29 +4348,32 @@
  Ответ:
--[
--  {
--    "recordTime": "",  ~/~/Время записи
--    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзину
--    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/
--nullable: true  ~/~/Детали
--        {
--          "name": "string", ~/~/наименование столбца
--          "value": "string" ~/~/содержание столбца
--        }
--      ]
--    },
--   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--      "string"
--    ]
--  }
--]
++"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
++"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
++"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
++"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
++"objectType": "Vehicle", - Тип объекта
++"details": {
++"items": [ {
++"name": "ObjectName", - наименование столбца
++"value": "01" - содержание столбца
++},
++{
++"parentName": "string",
++"name": "string",
++"picture": "string",
++"minspeed": 0,
++"maxspeed": 0,
++"width": 0,
++"imbeddedtrailer": true,
++"hoppercapacity": 0,
++"hopperdischargespeed": 0,
++"modelType": 0,
++"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++"deleted": true
++}
  (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
@@ -4381,37 +4381,12 @@
  В заголовках запроса: X-Auth: Токен авторизации
--Пример запроса:
--
++Параметры в теле запроса (JSON):
  [
--0
++"eb737fdf-c422-4df7-8727-bd61439b8460",
++"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
  ]
--
--Пример ответа:
--
--[
--{
--    "recordTime": "", ~/~/Время записи
--    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзин
--    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/Детали
--        {
--          "name": "", ~/~/Имя свойства
--          "value": "" ~/~/Значение свойства
--        }
--      ]
--    },
--    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--      ""
--    ]
--  }
--]
--
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
  == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
@@ -4424,53 +4424,15 @@
  В заголовках запроса: X-Auth: Токен авторизации
  Параметры в теле запроса (JSON):
--
--Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--
--Пример запроса:
--
--(((
  [
--)))
--
--(((
--  0
--)))
--
--(((
++"eb737fdf-c422-4df7-8727-bd61439b8460",
++"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
  ]
--)))
++Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
--Пример ответа:
--[
--{
--    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
--    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзину
--    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/Детали
--        {
--          "name": "string",  ~/~/Имя свойства
--          "value": "string" ~/~/Значение свойства
--        }
--      ]
--    },
--    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
--      "string"
--    ]
--  }
--]
--
--
  (% 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

Меню