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

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

From version < 180.1 >

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

To version < 194.2 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,5 +1,17 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
++(% class="box warningmessage" %)
++(((
++(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
++просим вас соблюдать несколько простых правил при использовании API-команд:##
++)))
++
++* Формировать не более 3 отчётов одновременно.
++* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
++
++В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++
++
  **Содержание страницы:**
  )))
@@ -1182,13 +1182,15 @@
  Команда для отправки на тс.
  {
--"id": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
++"id": "",  ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
++"command": "", ~/~/  Текст отправляемой команды
++"retries": "",  ~/~/ Количество попыток отправки на терминал
++"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов).
  }
++В ответ получаем cmdid
++
  == **Получить ответ на отправленную на ТС команду** ==
  (% class="box infomessage" %)
@@ -1196,13 +1196,13 @@
  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
  )))
--Идентификатор команды: cmdid
++Идентификатор команды: cmdId
  Запрос от терминала на ответ команды
  Пример ответ от терминала:
--ID= "" ~/~/ идентификатор произвольного поля
++ID= "" ~/~/ идентификатор объекта
  Soft="" ~/~/ версия софта
  GPS=4 ~/~/ тип трекера
  Time=11:05:43 28.06.24 ~/~/ время запроса
@@ -1557,6 +1557,78 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
@@ -1598,9 +1598,12 @@
      "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
      "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
      "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
--    "parentId": null, ~/~/ ID клиента (Guid, опционально)
--    "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
--    "customFields": null ~/~/ значение любого из произвольных полей ТС
++     "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
++      "unitName": "string",  ~/~/ Название подразделения (опционально)
++    "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
++    "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
++    "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
++     "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
  }
  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
@@ -1607,8 +1607,15 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--    "vehicleId": "" ~/~/ идентификатор объекта
++(% style="color:#000000" %)[
++{
++
++(((
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
++)))
++
++(((
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1633,9 +1633,21 @@
                  "forClient": true, ~/~/ право на отображение у клиента
                  "forTooltip": false, ~/~/ право на отображение в подсказке
                  "forReport": false ~/~/ право на отображение в отчетах
--            }(%%)
--(% style="color:#000000" %)}
++)))
++(((
++      }
++    ],
++    "vehicleGroups": [  ~/~/ Группы ТС
++      {
++        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
++        "name": "string" ~/~/ Наименование группы ТС
++      }
++    ]
++  }
++]
++)))
++
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
@@ -4198,64 +4198,67 @@
  Тело запроса:
  {
--  "vehicleIds": [vehicleId],
--  "from": "2023-11-22T09:29:48.051Z",
--  "to": "2023-11-22T09:29:48.051Z"
++  "vehicleIds": [vehicleId], ~/~/Массив ID объектов
++  "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
++  "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|vehicleIds|Массив ID объектов
--|from|Дата начала запроса
--|to|Дата окончания запроса
--
  Ответ:
  {
--  "items": [
++  "items": [  ~/~/ Список в разрезе ТС
      {
--      "from": "2023-11-22T09:29:48.052Z",
--      "to": "2023-11-22T09:29:48.052Z",
--      "vehicleId": 0,
--      "vehicleName": "string",
--      "vehicleModel": "string",
--      "penalty": 0,
--      "score": 0,
--      "totalViolations": 0,
--      "violationsByType": {
--        "overspeedingViolations": 0,
--        "accelerationViolations": 0,
--        "brakingViolations": 0,
--        "turningViolations": 0,
--        "dangerousDrivingViolations": 0,
--        "sensorViolations": 0
++      "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
++      "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
++      "vehicleId": 0, ~/~/ ID ТС
++      "vehicleName": "string", ~/~/ Название ТС
++      "vehicleModel": "string", ~/~/ Модель ТС
++      "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
++      "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
++      "totalViolations": 0, ~/~/ Нарушений всего
++      "violationsByType": { ~/~/ Информация о нарушениях по типу
++        "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
++        "accelerationViolations": 0, ~/~/ Нарушений ускорения
++        "brakingViolations": 0, ~/~/ Нарушений торможения
++        "turningViolations": 0, ~/~/ Нарушений опасного поворота
++        "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
++        "sensorViolations": 0 ~/~/ Нарушений по датчику
        },
--      "moveTime": 0,
--      "mileage": 0,
--      "tripsCount": 0,
--      "trips": [
++
++(((
++
++)))
++
++      "moveTime": 0, ~/~/ Продолжительность движения, сек
++      "mileage": 0, ~/~/ Пробег, м
++      "tripsCount": 0, ~/~/ Кол-во рейсов
++      "trips": [  ~/~/ Информация по рейсу
          {
--          "penalty": 0,
--          "score": 0,
--          "violationsCount": 0,
--          "violationsByType": {
--            "overspeedingViolations": 0,
--            "accelerationViolations": 0,
--            "brakingViolations": 0,
--            "turningViolations": 0,
--            "dangerousDrivingViolations": 0,
--            "sensorViolations": 0
++          "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
++          "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
++          "violationsCount": 0, ~/~/ Всего нарушений
++          "violationsByType": { ~/~/ Информация о нарушениях по типу
++            "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
++            "accelerationViolations": 0, ~/~/ Нарушений ускорения
++            "brakingViolations": 0, ~/~/ Нарушений торможения
++            "turningViolations": 0, ~/~/ Нарушений опасного поворота
++            "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
++            "sensorViolations": 0 ~/~/ Нарушений по датчику
            },
--          "moveTime": 0,
--          "mileage": 0,
--          "motohours": 0,
--          "maxSpeed": 0,
--          "startAddress": "string",
--          "endAddress": "string",
--          "drivers": [
++
++         "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
++          "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
++          "moveTime": 0, ~/~/ Продолжительность движения, сек
++          "mileage": 0, ~/~/ Пробег, м
++          "motohours": 0, ~/~/ Моточасы, секунды
++          "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
++          "startAddress": "string", ~/~/ Адрес начала рейса
++          "endAddress": "string", ~/~/ Адрес конца рейса
++          "drivers": [  ~/~/ Список водителей
              {
--              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--              "driverName": "string",
--              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
++              "driverName": "string", ~/~/ФИО водителя
++              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
              }
            ]
          }
@@ -4264,34 +4264,6 @@
    ]
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|from|Дата начала запроса
--|to|Дата  окончания
--|vehicleId|ID объекта
--|vehicleName|Имя объекта
--|vehicleModel|Модель объекта
--|penalty|Сумма штрафных баллов
--|score|Оценка
--|totalViolations|Суммарное количество нарушений
--|violationsByType|Список типов нарушений и количество нарушений для каждого типа
--|overspeedingViolations|Превышение скорости
--|accelerationViolations|Ускорение
--|brakingViolations|Торможение
--|turningViolations|Резкий поворот
--|dangerousDrivingViolations|Резкое вождение
--|sensorViolations|Нарушение по датчику
--|moveTime|Время в движении
--|mileage|Пробег (км)
--|tripsCount|Количество рейсов
--|motohours|Моточасы
--|maxSpeed|Максимальная скорость
--|startAddress|Адрес начала рейса
--|endAddress|Адрес окончания рейса
--|drivers|Список водителей, которые были на объекте в течениии рейса
--|driverGuid|Guid водителя
--|driverName|Имя водителя
--|driverRfid|Номер Карты-метки
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
@@ -4311,31 +4311,31 @@
  Параметры в теле запроса (JSON):
  {
--  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
    "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
    ],
--  "timezone": 0 ~/~/Таймзона
++  "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" ~/~/Адрес АЗС
++    "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" ~/~/ Адрес АЗС
    }
@@ -4349,28 +4349,28 @@
  **GET ** **/api/v3/retranslations/{id}**
  )))
--Идентификатор запроса: ID
++id - Идентификатор ретранслятора
  Пример ответа:
  {
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [    ~/~/ Объекты для ретрансляции
  {
  "id": "",  ~/~/ Идентификатор объекта ретрансляции
  "name": "",   ~/~/ Наименование объекта ретрансляции
--"imei": "",     ~/~/ IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"imei": "",     ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/Guid родителя
--"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
  }
@@ -4381,7 +4381,7 @@
  **DELETE** **/api/v3/retranslations/{id}**
  )))
--Параметр запроса: ID
++id - Идентификатор ретранслятора
  == **Создание ретранслятора** ==
@@ -4394,16 +4394,16 @@
  Запрос:
  {
--"description": "",  ~/~/ Описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"address": "",  ~/~/ Адрес ретрансляции
--"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"address": "",  ~/~/ Адрес и порт принимающего сервера
++"isEnabled": "",  ~/~/ Признак включения ретранслятора, true - включен, false - отключен
  "objects": [    ~/~/Объекты для ретрансляции
  {
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",     ~/~/IMEI объекта
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор ретранслятора
++"imei": "",     ~/~/ IMEI объекта ретрансляции
++"isEnabled":  ""  ~/~/ Признак включения объекта  ретрансляции: true - включен, false - отключен
  }
    ]
  }
@@ -4412,22 +4412,22 @@
  Ответ:
  {
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,   ~/~/ Тип протокола
--"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
  {
--"id": "",     ~/~/ идентификатор пользователя
--"name": "string",     ~/~/ Название уведомления
--"imei": "string",    ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
++  ],
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
@@ -4441,18 +4441,18 @@
  Пример запроса:
  {
--"id": "",  ~/~/ идентификатор пользователя
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",   ~/~/ Адрес события
--"objects":  ~/~/Объекты для ретрансляции
++"id": "",  ~/~/ Идентификатор ретранслятора
++"description": "string",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",   ~/~/ Адрес и порт принимающего сервера
++"objects":  ~/~/ Объекты для ретрансляции
  [
  {
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",       ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"imei": "",       ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ]
  }
@@ -4461,22 +4461,22 @@
  Пример ответа:
  {
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [     ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
  {
--"id": "",    ~/~/ идентификатор пользователя
--"name": "string",  ~/~/ Название уведомления
--"imei": "",      ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
@@ -4490,9 +4490,9 @@
  Пример запроса:
  {
--"id": "",  ~/~/ идентификатор пользователя
--"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++"id": "",  ~/~/ Идентификатор ретранслятора
++"search": "string",  ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
  }
  Ответ:
@@ -4499,14 +4499,14 @@
  [
  {
--"description": "",    ~/~/ Определяет описание
--"subscriberId": "",    ~/~/ идентификатор запроса
--"protocolType": 0,     ~/~/ Тип протокола
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",    ~/~/ Адрес события
--"id": "",    ~/~/ идентификатор пользователя
--"parentId": "",    ~/~/ Guid идентификатор родителя
--"deleted": true   ~/~/ Признак удаления
++"description": "",    ~/~/ Поле описания ретранслятора
++"subscriberId": "",    ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,     ~/~/ Тип протокола ретрансляции
++"isEnabled": true,    ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",    ~/~/ Адрес и порт принимающего сервера
++"id": "",    ~/~/ Идентификатор ретранслятора
++"parentId": "",    ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true   ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
  ]
@@ -4589,6 +4589,269 @@
  ]
++= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
++
++== **Получение участка по id** ==
++
++(% class="box infomessage" %)
++(((
++GET **/api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ План года
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [ ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++)))
++
++(((
++(((
++ "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ Периметр, м
++  "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
++}
++)))
++
++
++== **Удалить участок** ==
++
++(% class="box errormessage" %)
++(((
++DELETE **/api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
++(((
++200 ~/~/ Успех
++)))
++
++(((
++
++)))
++
++(((
++== **Сохранение участка** ==
++
++(% class="box successmessage" %)
++(((
++POST **/api/v3/agroLands**
++)))
++
++Пример запроса:
++
++(((
++{
++  "extId": "string",
++  "shape": "string", ~/~/ Форма поля
++  "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
++  "display": "string", ~/~/ Настройки отображения
++  "year": 0, ~/~/ Год поля
++  "name": "string", ~/~/ Наименование
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
++  "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
++  "planComment": "string", ~/~/ Комментарий к полю
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ Годовой план
++      "comment": "string" ~/~/ Комментарий
++    }
++  ]
++}
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++Пример ответа:
++
++(((
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га.
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ годовой план
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [  ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++)))
++
++(((
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++  "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ Периметр, м
++  "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
++}
++)))
++)))
++
++
++)))
++)))
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

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

Summary

Details

Меню