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

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

From version < 206.3 >

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

To version < 201.1 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1021,17 +1021,6 @@
  (((
  {
--
--(((
--   "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
--   "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
--)))
--
--(((
--                                      ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
--   "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
--)))
--
      "vehicleId": "", ~/~/ ID объекта
      "name": "", ~/~/ Имя объекта
      "imei": "", ~/~/ IMEI объекта
@@ -1126,7 +1126,6 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "color": "string", ~/~/ Код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -1184,21 +1184,11 @@
        "date": "2023-05-22T09:57:39.562Z",
        "description": "string",
        "additionalInfo": "string"
--
--(((
++    }
++  ]
  }
--  ],
--  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
--  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
  )))
--(((
--                                               ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
--}
--
--)))
--)))
--
  (% style="text-align:left" %)
  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
@@ -1291,13 +1291,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){
--
--
--(((
--    "vehicleId": 0, ~/~/ ID ТС
--)))
--
++(% style="color:#000000" %){(%%)
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1390,7 +1390,6 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "color": "string", ~/~/ код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -1440,19 +1440,10 @@
        "forClient": true, ~/~/ Отобразить произвольное поле у клиента
        "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
--
--(((
-- }
--  ],
--  "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
--)))
--
--(((
--                                              ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
++    }
++  ]
  }
--)))
--
  (% style="color:#000000" %)Ответ:
@@ -1561,7 +1561,6 @@
        ],
        "showInTooltip": true, ~/~/ Отображение в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "color": "string", ~/~/ код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
        "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
@@ -1598,7 +1598,7 @@
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
    ],
--  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
  }
  )))
  )))
@@ -1904,19 +1904,9 @@
  "drivers": [ ~/~/ Водители
      {
--
--(((
--      "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
--      "inputNumber": 0, ~/~/ № входа.
--      "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
--      "comment": "string", ~/~/ Комментарий.
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
--      "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
--      "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
--      "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
--)))
--
--    }
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "isDefault": true
++    }
    ],
    "commandTemplates": [ ~/~/ Шаблон команды
      {
@@ -1952,11 +1952,6 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
--
--(((
--      "color": "string",** ~/~/ **Цвет датчика
--)))
--
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -2003,12 +2003,7 @@
        "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
--
--(((
--  ],
--  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
--)))
--
++  ]
  }
@@ -2146,11 +2146,6 @@
        ],
        "showInTooltip": true, ~/~/ Отображение в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
--
--(((
--      "color": "string", ~/~/ цвет уведомлений
--)))
--
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
        "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
@@ -4447,7 +4447,7 @@
  (% class="box infomessage" %)
  (((
--**POST /api/v3/fuelcards/transactions**
++POST /api/v3/fuelcards/transactions
  )))
  Метод запроса: POST
@@ -4485,32 +4485,7 @@
      "address": "string" ~/~/ Адрес АЗС
    }
--== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
--(% class="box infomessage" %)
--(((
--**GET /api/v3/fuelcards**
--)))
--
--Метод запроса: GET
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
--
--Ответ:
--
--[
--  {
--    "Name": "string", ~/~/ Определяет наименование карты.
--    "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
--    "Number": "string", ~/~/ Определяет № карты.
--    "Enabled": true, ~/~/ Определяет признак активности карты.
--    "Description": "string", ~/~/ Определяет описание карты.
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
--    "deleted": true ~/~/ Признак удаления
--  }
--]
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
@@ -4764,7 +4764,7 @@
  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
--== **Запрос списка полей** ==
++== **Возвращает список полей** ==
  (% class="box successmessage" %)
  (((
@@ -4827,9 +4827,129 @@
    }
  ]
++
++)))
--== **Создание нового поля ** ==
++== **Получение поля по 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**
@@ -4960,136 +4960,13 @@
    "perimetr": 0, ~/~/ Периметр, м
    "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
  }
--
--
  )))
--)))
--)))
--== **Получение поля по 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 infomessage" %)
@@ -5231,7 +5231,7 @@
  )))
--== **Редактирование года урожая ** ==
++== **Функция обновляет закрытие/открытие года урожая** ==
  (% class="box successmessage" %)
  (((
@@ -5338,11 +5338,17 @@
  )))
--== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
++==   ==
++
++(((
++
  )))
  )))
  )))
++)))
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
++
  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

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

Summary

Details

Меню