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

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

From version < 156.1 >

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

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

@@ -1140,31 +1140,19 @@
        },
  ~/~/ Характерные для произвольного:
--
  ~/~/                "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",
@@ -1209,7 +1209,6 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--=====   =====
  == **Получить ответ на отправленную на ТС команду** ==
@@ -1220,31 +1220,19 @@
  Идентификатор команды: cmdid
--
  Запрос от терминала на ответ команды
--
  Пример ответ от терминала:
--
  ID= "" ~/~/ идентификатор произвольного поля
--
  Soft="" ~/~/ версия софта
--
  GPS=4 ~/~/ тип трекера
--
  Time=11:05:43 28.06.24 ~/~/ время запроса
--
  Lat=45.056221 ~/~/ широта
--
  Lon=39.035938 ~/~/ долгота
--
  Speed=0.0 ~/~/ скорость
--
  Course=181.4 ~/~/направление
--
--
  (((
  == **Список отправленных объекту команд с ответами** ==
@@ -1255,33 +1255,20 @@
  Идентификатор ТС: vehicleId
--
  В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
--
  Пример ответа терминала
--
--[
--
--{
--
--"id": "",  ~/~/ идентификатор пользователя
--
++[
++{
++"id": "",  ~/~/ идентификатор пользователя
  "commandText": "",   ~/~/Текст команды.
--
  "templateId": "",    ~/~/Идентификатор шаблона
--
--"updated": "",  ~/~/ Время отправки
--
--"tryCount": 0,  ~/~/ Количество попыток отправки команды
--
++"updated": "",  ~/~/ Время отправки
++"tryCount": 0,  ~/~/ Количество попыток отправки команды
  "answer": "",    ~/~/ Ответ терминала.
--
  "status": "" ~/~/ Статус отправки
--
  }
--
  ]
@@ -1640,17 +1640,11 @@
  Команда для отправки на тс.
--
--{
--
++{
  "id": "",  ~/~/идентификатор произвольного поля
--
  "command": "", ~/~/  Текст команды
--
  "retries": "",  ~/~/ Количество попыток
--
  "idTemplate": "" ~/~/ ID шаблона команды
--
  }
@@ -1940,13 +1940,10 @@
  (% 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" %)Раздел: **Сообщения**(%%) =
@@ -2263,74 +2263,42 @@
  Тело запроса:
  {
--
    "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" %)
@@ -4169,60 +4169,38 @@
  Параметры в теле запроса (JSON):
  {
--
    "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--
    "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
--
--  "ids": [
--
++  "ids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
--
    ],
--
    "timezone": 0 ~/~/Таймзона
--
  }
--Ответ:
++Ответ:
    {
--
      "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" ~/~/Адрес АЗС
--
    }
--==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
--==== **Получение полных данных о ретрансляторе** ====
++== **Получение полных данных о ретрансляторе** ==
  (% class="box infomessage" %)
  (((
@@ -4234,44 +4234,27 @@
  Пример ответа:
--{
--
++{
  "description": "",  ~/~/ Определяет описание
--
  "subscriberId": "",  ~/~/ Подписчик
--
  "protocolType": 0,  ~/~/ Тип протокола
--
  "isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--
  "address": "string",  ~/~/ Адрес события
--
  "objects": [    ~/~/Объекты для ретрансляции
--
--{
--
--"id": "",  ~/~/ Идентификатор объекта ретрансляции
--
--"name": "",   ~/~/ Наименование объекта ретрансляции
--
--"imei": "",     ~/~/ IMEI объекта
--
++{
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"name": "",   ~/~/ Наименование объекта ретрансляции
++"imei": "",     ~/~/ IMEI объекта
  "isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--
  }
--
--  ],
--
--"id": "",  ~/~/ идентификатор пользователя
--
++  ],
++"id": "",  ~/~/ идентификатор пользователя
  "parentId": "",  ~/~/Guid родителя
--
  "deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
--
  }
--==== **Удаление данных ретранслятора** ====
++== **Удаление данных ретранслятора** ==
  (% class="box infomessage" %)
  (((
@@ -4281,7 +4281,7 @@
  Параметр запроса: ID
--==== **Создание ретранслятора** ====
++== **Создание ретранслятора** ==
  (% class="box infomessage" %)
  (((
@@ -4290,77 +4290,45 @@
  Запрос:
--
--{
--
++{
  "description": "",  ~/~/ Описание
--
  "subscriberId": "",  ~/~/ Подписчик
--
  "protocolType": 0,  ~/~/ Тип протокола
--
  "address": "",  ~/~/ Адрес ретрансляции
--
  "isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--
  "objects": [    ~/~/Объекты для ретрансляции
--
--{
--
--"id": "",  ~/~/ идентификатор пользователя
--
++{
++"id": "",  ~/~/ идентификатор пользователя
  "imei": "",     ~/~/IMEI объекта
--
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--
    ]
--
  }
++Ответ:
--Ответ
--
--{
--
++{
  "description": "string",  ~/~/ Определяет описание
--
  "subscriberId": "",  ~/~/ идентификатор запроса
--
  "protocolType": 0,   ~/~/ Тип протокола
--
  "isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--
  "address": "",  ~/~/ Адрес события
--
  "objects": [    ~/~/Объекты для ретрансляции
--
--{
--
--"id": "",     ~/~/ идентификатор пользователя
--
--"name": "string",     ~/~/ Название уведомления
--
--"imei": "string",    ~/~/IMEI объекта
--
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--
++{
++"id": "",     ~/~/ идентификатор пользователя
++"name": "string",     ~/~/ Название уведомления
++"imei": "string",    ~/~/IMEI объекта
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--
--  ],
--
--"id": "",  ~/~/ идентификатор пользователя
--
++  ],
++"id": "",  ~/~/ идентификатор пользователя
  "parentId": "",  ~/~/ Guid идентификатор родителя
--
  "deleted": true ~/~/ Признак удаления
--
  }
--==== **Редактирование ретранслятора** ====
++== **Редактирование ретранслятора** ==
  (% class="box infomessage" %)
  (((
@@ -4369,81 +4369,48 @@
  Пример запроса:
--{
--
--"id": "",  ~/~/ идентификатор пользователя
--
++{
++"id": "",  ~/~/ идентификатор пользователя
  "description": "string",  ~/~/ Определяет описание
--
  "subscriberId": "",  ~/~/ идентификатор запроса
--
  "protocolType": 0,  ~/~/ Тип протокола
--
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
  "address": "string",   ~/~/ Адрес события
--
  "objects":  ~/~/Объекты для ретрансляции
--
--[
--
--{
--
--"id": "",  ~/~/ идентификатор пользователя
--
++[
++{
++"id": "",  ~/~/ идентификатор пользователя
  "imei": "",       ~/~/IMEI объекта
--
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--
    ]
--
  }
  Пример ответа:
--{
--
++{
  "description": "",  ~/~/ Определяет описание
--
  "subscriberId": "",  ~/~/ идентификатор запроса
--
  "protocolType": 0,  ~/~/ Тип протокола
--
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
  "address": "string",  ~/~/ Адрес события
--
  "objects": [     ~/~/Объекты для ретрансляции
--
--{
--
--"id": "",    ~/~/ идентификатор пользователя
--
--"name": "string",  ~/~/ Название уведомления
--
++{
++"id": "",    ~/~/ идентификатор пользователя
++"name": "string",  ~/~/ Название уведомления
  "imei": "",      ~/~/IMEI объекта
--
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--
    ],
--
--"id": "",  ~/~/ идентификатор пользователя
--
++"id": "",  ~/~/ идентификатор пользователя
  "parentId": "",  ~/~/ Guid идентификатор родителя
--
  "deleted": true ~/~/ Признак удаления
--
  }
++== **Получение списка ретранслятора клиента** ==
--==== **Получение списка ретранслятора клиента** ====
--
  (% class="box infomessage" %)
  (((
  **POST /api/v3/retranslations/find**
@@ -4451,53 +4451,32 @@
  Пример запроса:
--
--{
--
--"id": "",  ~/~/ идентификатор пользователя
--
++{
++"id": "",  ~/~/ идентификатор пользователя
  "search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--
  "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
--
  }
--
--
  Ответ
--
--[
--
--{
--
++[
++{
  "description": "",    ~/~/ Определяет описание
--
  "subscriberId": "",    ~/~/ идентификатор запроса
--
  "protocolType": 0,     ~/~/ Тип протокола
--
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
--
++"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
  "address": "string",    ~/~/ Адрес события
--
--"id": "",    ~/~/ идентификатор пользователя
--
++"id": "",    ~/~/ идентификатор пользователя
  "parentId": "",    ~/~/ Guid идентификатор родителя
--
  "deleted": true   ~/~/ Признак удаления
--
  }
--
  ]
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
++== **API для отчета по выгрузке комбайнов** ==
--==== **API для отчета по выгрузке комбайнов** ====
--
--
  (% class="box infomessage" %)
  (((
  POST **/api/v3/Reports/harvesterUnloading**
@@ -4505,134 +4505,70 @@
  Пример запроса:
--
  {
--
    "byTime": 0, ~/~/ Объединение событий по времени
--
    "byDist": 0,  ~/~/ Объединение событий по расстоянию
--
    "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
--
    "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
--
    "showNearestObjects": true,  ~/~/Показывать объекты рядом?
--
    "vehicleIds": [   ~/~/ Список id объектов для анализа
--
--
    ],
--
    "from": "", ~/~/ Дата и время начало запроса
--
    "to": "",  ~/~/ Дата и время окончания запроса
--
    "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--
  }
--
--
  Пример ответа:
--
--[
--
++[
    {
--
      "harvesterName": "",  ~/~/Комбайн, номер
--
      "harvesterId": 0, ~/~/Комбайн, id
--
  "harvesterModel": "", ~/~/ Модель комбайна
--
-- "hopperCapacity": 0, ~/~/ Объем бункера м3
--
++"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" ~/~/ имя пользователя
--
++            "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
--
        }
--
      ]
--
    }
--
  ]
@@ -4654,48 +4654,27 @@
  Ответ:
--[
--
++[
    {
--
      "recordTime": "",  ~/~/Время записи
--
      "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--
      "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--
      "objectId": 0, ~/~/ID объекта, помещённого в корзину
--
      "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
--
      "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--
      "details": { ~/~/Список деталей объекта, помещённого в корзину
--
--      "items": [ ~/~/ [
--
++      "items": [ ~/~/
  nullable: true  ~/~/Детали
--
          {
--
            "name": "string", ~/~/наименование столбца
--
            "value": "string" ~/~/содержание столбца
--
          }
--
        ]
--
      },
--
--    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--
++   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
        "string"
--
      ]
--
    }
--
  ]
@@ -4710,56 +4710,33 @@
  Пример запроса:
--
  [
--
--  0
--
++0
  ]
++
--
  Пример ответа:
--[
--
--  {
--
++[
++{
      "recordTime": "", ~/~/Время записи
--
      "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--
      "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--
      "objectId": 0, ~/~/ID объекта, помещённого в корзин
--
      "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
--
      "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--
      "details": { ~/~/Список деталей объекта, помещённого в корзину
--
        "items": [ ~/~/Детали
--
          {
--
            "name": "", ~/~/Имя свойства
--
            "value": "" ~/~/Значение свойства
--
          }
--
        ]
--
      },
--
      "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--
        ""
--
      ]
--
    }
--
  ]
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
@@ -4782,55 +4782,41 @@
  Пример запроса:
++(((
  [
++)))
++(((
++)))
++(((
  ]
++)))
  Пример ответа:
  [
--
--  {
--
++{
      "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"
--
      ]
--
    }
--
  ]

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

Summary

Details

Меню