Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 160.1 >
edited by Андрей Калиновский
on 2024/07/25 10:10
To version < 195.1 >
edited by Андрей Калиновский
on 2024/12/20 13:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,5 +1,21 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 +(% class="box warningmessage" %)
4 +(((
5 +
6 +
7 +
8 +
9 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
10 +просим вас соблюдать несколько простых правил при использовании API-команд:##
11 +)))
12 +
13 +* Формировать не более 3 отчётов одновременно.
14 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
15 +
16 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
17 +
18 +
3 3  **Содержание страницы:**
4 4  )))
5 5  
... ... @@ -14,11 +14,20 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
33 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
35 +
36 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
37 +
38 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
39 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
42 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
43 +(((
44 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
45 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
46 +)))
22 22  
23 23  (% class="box successmessage" %)
24 24  (((
... ... @@ -971,7 +971,7 @@
971 971  
972 972  Ответ: В случае успеха **Success 200**
973 973  
974 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
999 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
975 975  
976 976  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
977 977  
... ... @@ -1163,6 +1163,25 @@
1163 1163  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1164 1164  
1165 1165  
1191 +== **Отправить команду на терминал** ==
1192 +
1193 +(% class="box successmessage" %)
1194 +(((
1195 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1196 +)))
1197 +
1198 +Команда для отправки на тс.
1199 +
1200 +{  
1201 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1202 +"command": "", ~/~/ Текст отправляемой команды
1203 +"retries": "", ~/~/ Количество попыток отправки на терминал
1204 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1205 +}
1206 +
1207 +В ответ получаем cmdid
1208 +
1209 +
1166 1166  == **Получить ответ на отправленную на ТС команду** ==
1167 1167  
1168 1168  (% class="box infomessage" %)
... ... @@ -1170,13 +1170,13 @@
1170 1170  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1171 1171  )))
1172 1172  
1173 -Идентификатор команды: cmdid
1217 +Идентификатор команды: cmdId
1174 1174  
1175 1175  Запрос от терминала на ответ команды
1176 1176  
1177 1177  Пример ответ от терминала:
1178 1178  
1179 -ID= "" ~/~/ идентификатор произвольного поля
1223 +ID= "" ~/~/ идентификатор объекта
1180 1180  Soft="" ~/~/ версия софта
1181 1181  GPS=4 ~/~/ тип трекера
1182 1182  Time=11:05:43 28.06.24 ~/~/ время запроса
... ... @@ -1346,17 +1346,31 @@
1346 1346  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1347 1347  ~/~/ "ValueOn": "Вкл.",
1348 1348  ~/~/ "ValueOff": "Выкл."
1349 - "summaryMaxValue": 0 ~/~/ Макс. значение
1393 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1394 +
1395 +(((
1396 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1397 + {
1398 + "from": 0, ~/~/ С какого значения
1399 + "color": "string", ~/~/ Каким цветом
1400 + "text": "string" ~/~/ Текст подписи к этому интервалу
1401 + }
1402 + ]
1350 1350   }
1351 1351   ],
1405 +)))
1406 +
1407 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1408 +
1409 +
1352 1352   "customFields": [ ~/~/ Произвольные поля
1353 1353   {
1354 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1355 - "name": "string",
1356 - "value": "string",
1357 - "forClient": true,
1358 - "forTooltip": true,
1359 - "forReport": true
1412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1413 + "name": "string", ~/~/ Наименование произвольного поля
1414 + "value": "string", ~/~/ Значение произвольного поля
1415 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1416 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1417 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1360 1360   }
1361 1361   ]
1362 1362  }
... ... @@ -1363,55 +1363,236 @@
1363 1363  
1364 1364  (% style="color:#000000" %)Ответ:
1365 1365  
1366 -(% style="color:#000000" %){(%%)
1367 - "vehicleId": "", ~/~/ID ТС 
1368 - "parentId": "", ~/~/Guid владельца ТС
1369 - "name": "", ~/~/Имя объекта
1370 - "imei": "", ~/~/IMEI
1371 - "deviceTypeId": "", ~/~/ID типа устройства
1372 - "modelId": "", ~/~/ID модели
1373 - "unitId": "", ~/~/ID подразделения
1374 - "sim1": "", ~/~/SIM1
1375 - "sim2": "", ~/~/SIM2
1376 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1377 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1378 - "counters": { ~/~/Счётчики
1379 - "mileageEnabled": true,
1380 - "motohoursEnabled": true,
1381 - "mileage": "",
1382 - "motohours": 345.0
1383 - },
1384 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1385 - "id": null,
1386 - "enabled": true, ~/~/флаг включения
1387 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1388 - "login": "", ~/~/ имя учетной записи
1389 - "password": "" ~/~/ пароль учетной записи
1390 - },
1391 - "inspectionTasks": { ~/~/ задания на ТО
1392 - "id": "", ~/~/ ID задачи
1393 - "enabled": false, ~/~/ Признак включения
1394 - "name": "", ~/~/ Имя задания
1395 - "description": "", ~/~/ Описание задания
1396 - "mileageCondition": "", ~/~/ Условие по пробегу
1397 - "lastMileage": "", ~/~/ Пробег (в метрах)
1398 - "motohoursCondition": "", ~/~/ Условие по моточасам
1399 - "lastMotohours": "", ~/~/ Моточасы
1400 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1401 - "kind": "", ~/~/ Вид периодичности по времени 
1402 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1424 +
1425 +(((
1426 +(((
1427 +(((
1428 +{
1429 + "vehicleId": 0,  ~/~/ ID ТС
1430 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1431 + "name": "string", ~/~/ Имя объекта
1432 + "imei": "string", ~/~/ IMEI
1433 + "deviceTypeId": 0, ~/~/ ID типа устройства
1434 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1435 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1436 + "sim1": "string", ~/~/ SIM1
1437 + "sim2": "string", ~/~/ SIM2
1438 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1439 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1440 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1441 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1442 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1443 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1444 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1445 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1446 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1447 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1448 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1449 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1450 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1451 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1452 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1453 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1454 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1455 + "counters": {  ~/~/ Dto для состояний счётчиков
1456 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1457 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1458 + "mileage": 0, ~/~/ Пробег
1459 + "motohours": 0 ~/~/ Моточасы
1460 + },
1461 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1462 + "id": "string", ~/~/ CMSV6 Идентификатор
1463 + "enabled": true, ~/~/ Признак включения
1464 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1465 + "login": "string", ~/~/ CMSV6 имя учетной записи
1466 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1467 + },
1468 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1469 + {
1470 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1471 + "enabled": true, ~/~/ Признак включения
1472 + "name": "string", ~/~/ Имя задания
1473 + "description": "string", ~/~/ Описание задания
1474 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1475 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1476 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1477 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1478 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1479 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1480 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1481 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1403 1403   }
1404 -(% style="color:#000000" %)}
1483 + ],
1484 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1485 + {
1486 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1487 + "inputNumber": 0, ~/~/ № входа.
1488 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1489 + "comment": "string", ~/~/ Комментарий
1490 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1491 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1492 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1493 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1494 + }
1495 + ],
1496 + "commandTemplates": [  ~/~/ Список шаблонов команд
1497 + {
1498 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1499 + "name": "string", ~/~/ Название шаблона команд
1500 + "command": "string", ~/~/ Команда на выполнение
1501 + "retries": 0 ~/~/ Лимит попыток отправки
1502 + }
1503 + ],
1504 + "sensors": [ ~/~/ Список датчиков
1505 + {
1506 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1507 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1508 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1509 + "name": "string",  ~/~/ Имя датчика
1510 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1511 + "inputNumber": 0, ~/~/ Номер входа
1512 + "pseudonym": "string", ~/~/ Псевдоним
1513 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1514 + "isInverted": true, ~/~/  Признак инверсии
1515 + "disabled": true, ~/~/ Датчик не участвует в обработке
1516 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1517 + "gradesTables": [ ~/~/ Тарировка
1518 + {
1519 + "grades": [ ~/~/ Таблицы тарировки
1520 + {
1521 + "input": 0, ~/~/ Вход
1522 + "output": 0 ~/~/ Выход
1523 + }
1524 + ],
1525 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1526 + }
1527 + ],
1528 + "showInTooltip": true, ~/~/ Отображение в подсказке
1529 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1530 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1531 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1532 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1533 + "expr": "string", ~/~/ Выражение
1534 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1535 + "string"
1536 + ],
1537 + "customParams": {
1538 + "additionalProp1": "string",
1539 + "additionalProp2": "string",
1540 + "additionalProp3": "string"
1541 + },
1542 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1543 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1544 + {
1545 + "from": 0, ~/~/ С какого значения
1546 + "color": "string", ~/~/ Каким цветом
1547 +)))
1405 1405  
1549 +(((
1550 + "text": "string" ~/~/ Текст подписи к этому интервалу
1551 + }
1552 + ]
1553 + }
1554 + ],
1555 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1556 + "customFields": [ ~/~/ Список произвольных полей
1557 + {
1558 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1559 + "name": "string", ~/~/ Наименование произвольного поля
1560 + "value": "string", ~/~/ Значение произвольного поля
1561 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1562 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1563 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1564 + }
1565 + ],
1566 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1567 +}
1568 +)))
1569 +)))
1570 +)))
1571 +
1572 +
1406 1406  **Валидация:**
1407 1407  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1408 1408  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1409 1409  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1410 1410  
1411 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1412 1412  
1579 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1580 +
1581 +(% class="box successmessage" %)
1582 +(((
1583 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1584 +)))
1585 +
1586 +Метод запроса: **POST**
1587 +
1588 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1589 +
1590 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1591 +
1592 +
1593 +Ответ:
1594 +
1595 +{
1596 +
1597 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1598 +
1599 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1600 +
1601 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1602 +
1603 + "Message": "string", ~/~/ Информация о выполнении запроса
1604 +
1605 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1606 +
1607 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1608 +
1609 + "Data": "string" ~/~/ Данные
1610 +
1611 +}
1612 +
1613 +
1614 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1615 +
1413 1413  (% class="box infomessage" %)
1414 1414  (((
1618 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1619 +)))
1620 +
1621 +Метод запроса: **GET**
1622 +
1623 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1624 +
1625 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1626 +
1627 +
1628 +Ответ:
1629 +
1630 +{
1631 +
1632 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 +
1634 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1635 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1636 +
1637 + "Message": "string", ~/~/ Информация о выполнении запроса
1638 +
1639 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1640 +
1641 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1642 +
1643 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1644 +
1645 + "Data": "string" ~/~/ Данные
1646 +
1647 +}
1648 +
1649 +
1650 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1651 +
1652 +(% class="box infomessage" %)
1653 +(((
1415 1415  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1416 1416  )))
1417 1417  
... ... @@ -1449,9 +1449,12 @@
1449 1449   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1450 1450   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1451 1451   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1452 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1453 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1454 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1691 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1692 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1693 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1694 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1695 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1696 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1455 1455  }
1456 1456  
1457 1457  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1458,8 +1458,15 @@
1458 1458  
1459 1459  (% style="color:#000000" %)Ответ:
1460 1460  
1461 -(% style="color:#000000" %){
1462 - "vehicleId": "" ~/~/ идентификатор объекта
1703 +(% style="color:#000000" %)[
1704 +{
1705 +
1706 +(((
1707 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1708 +)))
1709 +
1710 +(((
1711 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1463 1463   "name": "" ~/~/ наименование объекта
1464 1464   "imei": "" ~/~/ IMEI объекта
1465 1465   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1484,9 +1484,21 @@
1484 1484   "forClient": true, ~/~/ право на отображение у клиента
1485 1485   "forTooltip": false, ~/~/ право на отображение в подсказке
1486 1486   "forReport": false ~/~/ право на отображение в отчетах
1487 - }(%%)
1488 -(% style="color:#000000" %)}
1736 +)))
1489 1489  
1738 +(((
1739 + }
1740 + ],
1741 + "vehicleGroups": [  ~/~/ Группы ТС
1742 + {
1743 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1744 + "name": "string" ~/~/ Наименование группы ТС
1745 + }
1746 + ]
1747 + }
1748 +]
1749 +)))
1750 +
1490 1490  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1491 1491  
1492 1492  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1531,23 +1531,8 @@
1531 1531   "stage": "", ~/~/ Состояние
1532 1532  (% style="color:#000000" %) }
1533 1533  
1534 -== **Отправить команду на терминал** ==
1795 +== ==
1535 1535  
1536 -(% class="box successmessage" %)
1537 -(((
1538 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1539 -)))
1540 -
1541 -Команда для отправки на тс.
1542 -
1543 -{  
1544 -"id": "", ~/~/идентификатор произвольного поля
1545 -"command": "", ~/~/ Текст команды
1546 -"retries": "", ~/~/ Количество попыток
1547 -"idTemplate": "" ~/~/ ID шаблона команды
1548 -}
1549 -
1550 -
1551 1551  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1552 1552  
1553 1553  (% class="box warningmessage" %)
... ... @@ -1686,65 +1686,201 @@
1686 1686  ~/~/ "ValueOn": "Вкл.",
1687 1687  ~/~/ "ValueOff": "Выкл."
1688 1688   "summaryMaxValue": 0 ~/~/ Макс. значение
1935 +
1936 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1937 + {
1938 + "from": 0, ~/~/ С какого значения
1939 + "color": "string", ~/~/ Каким цветом
1940 + "text": "string" ~/~/ Текст подписи к этому интервалу
1941 + }
1942 + ]
1689 1689   }
1690 1690   ],
1945 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1946 +
1691 1691   "customFields": [ ~/~/ Произвольные поля
1692 - {
1693 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1694 - "name": "string",
1695 - "value": "string",
1696 - "forClient": true,
1697 - "forTooltip": true,
1698 - "forReport": true
1948 + {     
1949 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1950 + "name": "string", ~/~/ Наименование произвольного поля
1951 + "value": "string", ~/~/ Значение произвольного поля
1952 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1953 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1954 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1699 1699   }
1700 1700   ]
1701 1701  }
1702 1702  
1959 +
1703 1703  (% style="color:#000000" %)Ответ:
1704 1704  
1705 -(% lang="en-US" style="text-align:left" %)
1706 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1707 - "vehicleId": "", ~/~/ ID ТС
1708 - "parentId": "", ~/~/ ID клиента
1709 - "name": "", ~/~/ имя ТС
1710 - "imei": "", ~/~/ IMEI
1711 - "deviceTypeId": "", ~/~/ типа устройства
1712 - "modelId": "", ~/~/ ID модели
1713 - "unitId": "", ~/~/ ID подразделения
1714 - "sim1": "", ~/~/ SIM 1
1715 - "sim2": "", ~/~/ SIM2
1716 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1717 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1718 - "counters": 
1719 - {
1720 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1721 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1722 - "mileage": "", ~/~/ пробег
1723 - "motohours": "", ~/~/ моточасы
1724 - }
1725 - "cmsv6Parameters": ~/~/ параметры CMSv6
1962 +(((
1963 +{
1964 + "vehicleId": 0, ~/~/ ID ТС
1965 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1966 + "name": "string", ~/~/ Имя объекта
1967 + "imei": "string", ~/~/ IMEI
1968 + "deviceTypeId": 0, ~/~/ ID типа устройства
1969 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1970 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1971 + "sim1": "string", ~/~/ SIM1
1972 + "sim2": "string", ~/~/ SIM2
1973 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1974 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1975 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1976 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1977 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1978 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1979 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1980 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1981 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1982 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1983 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1984 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1985 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1986 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1987 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1988 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1989 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1990 + "counters": { ~/~/ состояний счётчиков
1991 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1992 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1993 + "mileage": 0, ~/~/ Пробег
1994 + "motohours": 0 ~/~/ Моточасы 
1995 + },
1996 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1997 + "id": "string", ~/~/ CMSV6 Идентификатор
1998 + "enabled": true, ~/~/ Признак включения
1999 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2000 +)))
2001 +
2002 +
2003 +(((
2004 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2005 + "login": "string", ~/~/ CMSV6 имя учетной записи
2006 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2007 + },
2008 + "inspectionTasks": [ ~/~/ Задания на ТО
2009 + {
2010 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2011 + "enabled": true, ~/~/ Признак включения
2012 + "name": "string", ~/~/ Имя задания
2013 + "description": "string", ~/~/ Описание задания
2014 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2015 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2016 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2017 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2018 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2019 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2020 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2021 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2022 + }
2023 + ],
2024 + "drivers": [  ~/~/ Список водителей
2025 + {
2026 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2027 + "inputNumber": 0, ~/~/ № входа.
2028 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2029 + "comment": "string", ~/~/ Комментарий.
2030 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2032 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2033 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2034 + }
2035 + ],
2036 + "commandTemplates": [ ~/~/ Список шаблонов команд
2037 + {
2038 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2039 + "name": "string", ~/~/ Название шаблона команд
2040 + "command": "string", ~/~/ Команда на выполнение
2041 + "retries": 0 ~/~/ Лимит попыток отправки
2042 + }
2043 + ],
2044 + "sensors": [  ~/~/ Список датчиков 
2045 + {
2046 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2047 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2048 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2049 +)))
2050 +
2051 +(((
2052 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2053 +)))
2054 +
2055 +(((
2056 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2057 +)))
2058 +
2059 +(((
2060 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2061 +)))
2062 +
2063 +(((
2064 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2065 +)))
2066 +
2067 +(((
2068 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2069 + "name": "string", ~/~/ Имя датчика
2070 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2071 +)))
2072 +
2073 +(((
2074 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2075 + "inputNumber": 0, ~/~/ Номер входа
2076 + "pseudonym": "string", ~/~/ Псевдоним
2077 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2078 + "isInverted": true, ~/~/ Признак инверсии
2079 + "disabled": true, ~/~/ Датчик не участвует в обработке
2080 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2081 + "gradesTables": [ ~/~/ Тарировка
1726 1726   {
1727 - "id": ~/~/ идентификатор
1728 - "enabled": true, ~/~/ флаг включения
1729 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1730 - "login": "", ~/~/ имя учетной записи
1731 - "password": "", ~/~/ пароль учетной записи
1732 - }
1733 - "inspectionTasks": ~/~/ задания на ТО
2083 + "grades": [ ~/~/ Таблицы тарировки
2084 + {
2085 + "input": 0, ~/~/ Вход
2086 + "output": 0 ~/~/ Выход
2087 + }
2088 + ],
2089 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2090 + }
2091 + ],
2092 + "showInTooltip": true, ~/~/ Отображение в подсказке
2093 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
2094 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2095 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2096 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2097 + "expr": "string", ~/~/ Выражение
2098 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2099 + "string" 
2100 + ],
2101 + "customParams": { ~/~/ Дополнительные настройки
2102 + "additionalProp1": "string",
2103 + "additionalProp2": "string",
2104 + "additionalProp3": "string"
2105 + },
2106 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2107 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1734 1734   {
1735 - "id": "", ~/~/ ID задания
1736 - "enabled": false, ~/~/ Признак включения
1737 - "name": "", ~/~/ Имя задания
1738 - "description": "", ~/~/ Описание задания
1739 - "mileageCondition": "", ~/~/ Условие по пробегу
1740 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1741 - "motohoursCondition": "", ~/~/ Условие по моточасам
1742 - "lastMotohours": "", ~/~/ Моточасы
1743 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1744 - "kind": "", ~/~/ Вид периодичности по времени
1745 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2109 + "from": 0, ~/~/ С какого значения
2110 + "color": "string", ~/~/ Каким цветом
2111 + "text": "string" ~/~/ Текст подписи к этому интервалу
1746 1746   }
1747 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2113 + ]
2114 + }
2115 + ],
2116 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2117 + "customFields": [ ~/~/ Список произвольных полей
2118 + {
2119 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2120 + "name": "string", ~/~/ Наименование произвольного поля
2121 + "value": "string", ~/~/ Значение произвольного поля
2122 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2123 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2124 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2125 + }
2126 + ],
2127 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2128 +}
2129 +)))
1748 1748  
1749 1749  **Валидация:**
1750 1750  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
... ... @@ -2019,10 +2019,12 @@
2019 2019   {
2020 2020   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2021 2021   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2022 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2023 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2024 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2025 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2404 + "mileage": 0, ~/~/ Пробег за период, километры
2405 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2406 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2407 + "motohours": 0, ~/~/ Моточасы за период, секунды
2408 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2409 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2026 2026   }
2027 2027   ]
2028 2028   }
... ... @@ -2071,6 +2071,12 @@
2071 2071   }
2072 2072  ]
2073 2073  
2458 +(% class="box warningmessage" %)
2459 +(((
2460 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2461 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2462 +)))
2463 +
2074 2074  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2075 2075  
2076 2076  (% class="box infomessage" %)
... ... @@ -2158,7 +2158,7 @@
2158 2158   ],
2159 2159   "stops": [ ~/~/ События стоянок
2160 2160   {
2161 - "address": "string", ~/~/ Адрес события
2551 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2162 2162   "eventId": 0, ~/~/ Идентификатор события
2163 2163   "eventName": "string", ~/~/ Название события
2164 2164   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
... ... @@ -2513,6 +2513,32 @@
2513 2513  
2514 2514  Success
2515 2515  
2906 +
2907 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2908 +
2909 +(% class="box warningmessage" %)
2910 +(((
2911 +**PUT** /api/v3/notifications/prolongation
2912 +)))
2913 +
2914 +Метод позволяет продлить уведомления.
2915 +
2916 +Метод запроса **PUT**
2917 +
2918 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2919 +
2920 +В заголовках запроса: X-Auth: Токен авторизации.
2921 +
2922 +Тело запроса:
2923 +
2924 +[
2925 +
2926 +0
2927 +
2928 +]
2929 +
2930 +где 0 идентификатор ids.
2931 +
2516 2516  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2517 2517  
2518 2518  (% class="box errormessage" %)
... ... @@ -3703,7 +3703,7 @@
3703 3703  **POST /api/v3/vehicles/import/{agentId}**
3704 3704  )))
3705 3705  
3706 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
4122 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3707 3707  
3708 3708  В пути указывается **agentId** - id клиента.
3709 3709  
... ... @@ -3715,7 +3715,7 @@
3715 3715  
3716 3716  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3717 3717  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3718 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
4134 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3719 3719  
3720 3720  В теле использовать тип **form-data,** тип значения** file**
3721 3721  
... ... @@ -3894,64 +3894,67 @@
3894 3894  Тело запроса:
3895 3895  
3896 3896  {
3897 - "vehicleIds": [vehicleId],
3898 - "from": "2023-11-22T09:29:48.051Z",
3899 - "to": "2023-11-22T09:29:48.051Z"
4313 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4314 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4315 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
3900 3900  }
3901 3901  
3902 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3903 -|vehicleIds|Массив ID объектов
3904 -|from|Дата начала запроса
3905 -|to|Дата окончания запроса
3906 -
3907 3907  Ответ:
3908 3908  
3909 3909  {
3910 - "items": [
4321 + "items": [  ~/~/ Список в разрезе ТС
3911 3911   {
3912 - "from": "2023-11-22T09:29:48.052Z",
3913 - "to": "2023-11-22T09:29:48.052Z",
3914 - "vehicleId": 0,
3915 - "vehicleName": "string",
3916 - "vehicleModel": "string",
3917 - "penalty": 0,
3918 - "score": 0,
3919 - "totalViolations": 0,
3920 - "violationsByType": {
3921 - "overspeedingViolations": 0,
3922 - "accelerationViolations": 0,
3923 - "brakingViolations": 0,
3924 - "turningViolations": 0,
3925 - "dangerousDrivingViolations": 0,
3926 - "sensorViolations": 0
4323 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4324 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4325 + "vehicleId": 0, ~/~/ ID ТС
4326 + "vehicleName": "string", ~/~/ Название ТС
4327 + "vehicleModel": "string", ~/~/ Модель ТС
4328 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4329 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4330 + "totalViolations": 0, ~/~/ Нарушений всего
4331 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4332 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4333 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4334 + "brakingViolations": 0, ~/~/ Нарушений торможения
4335 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4336 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4337 + "sensorViolations": 0 ~/~/ Нарушений по датчику
3927 3927   },
3928 - "moveTime": 0,
3929 - "mileage": 0,
3930 - "tripsCount": 0,
3931 - "trips": [
4339 +
4340 +(((
4341 +
4342 +)))
4343 +
4344 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4345 + "mileage": 0, ~/~/ Пробег, м
4346 + "tripsCount": 0, ~/~/ Кол-во рейсов
4347 + "trips": [  ~/~/ Информация по рейсу
3932 3932   {
3933 - "penalty": 0,
3934 - "score": 0,
3935 - "violationsCount": 0,
3936 - "violationsByType": {
3937 - "overspeedingViolations": 0,
3938 - "accelerationViolations": 0,
3939 - "brakingViolations": 0,
3940 - "turningViolations": 0,
3941 - "dangerousDrivingViolations": 0,
3942 - "sensorViolations": 0
4349 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4350 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4351 + "violationsCount": 0, ~/~/ Всего нарушений
4352 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4353 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4354 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4355 + "brakingViolations": 0, ~/~/ Нарушений торможения
4356 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4357 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4358 + "sensorViolations": 0 ~/~/ Нарушений по датчику
3943 3943   },
3944 - "moveTime": 0,
3945 - "mileage": 0,
3946 - "motohours": 0,
3947 - "maxSpeed": 0,
3948 - "startAddress": "string",
3949 - "endAddress": "string",
3950 - "drivers": [
4360 +
4361 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4362 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4363 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4364 + "mileage": 0, ~/~/ Пробег, м
4365 + "motohours": 0, ~/~/ Моточасы, секунды
4366 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4367 + "startAddress": "string", ~/~/ Адрес начала рейса
4368 + "endAddress": "string", ~/~/ Адрес конца рейса
4369 + "drivers": [  ~/~/ Список водителей
3951 3951   {
3952 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3953 - "driverName": "string",
3954 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4371 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4372 + "driverName": "string", ~/~/ФИО водителя
4373 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
3955 3955   }
3956 3956   ]
3957 3957   }
... ... @@ -3960,34 +3960,6 @@
3960 3960   ]
3961 3961  }
3962 3962  
3963 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 -|from|Дата начала запроса
3965 -|to|Дата  окончания
3966 -|vehicleId|ID объекта
3967 -|vehicleName|Имя объекта
3968 -|vehicleModel|Модель объекта
3969 -|penalty|Сумма штрафных баллов
3970 -|score|Оценка
3971 -|totalViolations|Суммарное количество нарушений
3972 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3973 -|overspeedingViolations|Превышение скорости
3974 -|accelerationViolations|Ускорение
3975 -|brakingViolations|Торможение
3976 -|turningViolations|Резкий поворот
3977 -|dangerousDrivingViolations|Резкое вождение
3978 -|sensorViolations|Нарушение по датчику
3979 -|moveTime|Время в движении
3980 -|mileage|Пробег
3981 -|tripsCount|Количество рейсов
3982 -|motohours|Моточасы
3983 -|maxSpeed|Максимальная скорость
3984 -|startAddress|Адрес начала рейса
3985 -|endAddress|Адрес окончания рейса
3986 -|drivers|Список водителей, которые были на объекте в течениии рейса
3987 -|driverGuid|Guid водителя
3988 -|driverName|Имя водителя
3989 -|driverRfid|Номер Карты-метки
3990 -
3991 3991  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3992 3992  
3993 3993  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
... ... @@ -4007,31 +4007,31 @@
4007 4007  Параметры в теле запроса (JSON):
4008 4008  
4009 4009  {
4010 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4011 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4401 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4402 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4012 4012   "ids": [ 
4013 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4404 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4014 4014   ],
4015 - "timezone": 0 ~/~/Таймзона
4406 + "timezone": 0 ~/~/ Часовой пояс
4016 4016  }
4017 4017  
4018 4018  
4019 4019  Ответ:
4020 4020   {
4021 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4022 - "driver": "string", ~/~/Водители, привязанные к ТК
4023 - "object": "string", ~/~/Наименование ТС
4024 - "amount": 0, ~/~/Количество топлива
4025 - "amountDut": 0, ~/~/Количество по ДУТ
4026 - "amountDiff": 0, ~/~/Разница, л
4027 - "amountDiffPerc": 0, ~/~/Разница, %
4028 - "summa": 0, ~/~/Стоимость, руб
4029 - "serviceName": "string", ~/~/Тип топлива
4030 - "price": 0, ~/~/Цена за литр, руб
4031 - "cardName": "string", ~/~/Наименование ТК
4032 - "cardNum": "string", ~/~/Номер ТК
4033 - "operator": "string", ~/~/Оператор ТК
4034 - "address": "string" ~/~/Адрес АЗС
4412 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4413 + "driver": "string", ~/~/ Водители, привязанные к ТК
4414 + "object": "string", ~/~/ Наименование ТС
4415 + "amount": 0, ~/~/ Количество топлива
4416 + "amountDut": 0, ~/~/ Количество по ДУТ
4417 + "amountDiff": 0, ~/~/ Разница, л
4418 + "amountDiffPerc": 0, ~/~/ Разница, %
4419 + "summa": 0, ~/~/ Стоимость, руб
4420 + "serviceName": "string", ~/~/ Тип топлива
4421 + "price": 0, ~/~/ Цена за литр, руб
4422 + "cardName": "string", ~/~/ Наименование ТК
4423 + "cardNum": "string", ~/~/ Номер ТК
4424 + "operator": "string", ~/~/ Оператор ТК
4425 + "address": "string" ~/~/ Адрес АЗС
4035 4035   }
4036 4036  
4037 4037  
... ... @@ -4045,28 +4045,28 @@
4045 4045  **GET ** **/api/v3/retranslations/{id}**
4046 4046  )))
4047 4047  
4048 -Идентификатор запроса: ID
4439 +id - Идентификатор ретранслятора
4049 4049  
4050 4050  
4051 4051  Пример ответа:
4052 4052  
4053 4053  {  
4054 -"description": "", ~/~/ Определяет описание
4055 -"subscriberId": "", ~/~/ Подписчик
4056 -"protocolType": 0, ~/~/ Тип протокола
4057 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4058 -"address": "string", ~/~/ Адрес события
4059 -"objects": [ ~/~/Объекты для ретрансляции
4445 +"description": "", ~/~/ Поле описания ретранслятора
4446 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4447 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4448 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4449 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4450 +"objects": [ ~/~/ Объекты для ретрансляции
4060 4060  {      
4061 4061  "id": "",  ~/~/ Идентификатор объекта ретрансляции
4062 4062  "name": "", ~/~/ Наименование объекта ретрансляции
4063 -"imei": "", ~/~/ IMEI объекта  
4064 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4454 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4455 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4065 4065  }
4066 4066   ],  
4067 -"id": "", ~/~/ идентификатор пользователя   
4068 -"parentId": "", ~/~/Guid родителя
4069 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4458 +"id": "", ~/~/ Идентификатор ретранслятора 
4459 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4460 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4070 4070  }
4071 4071  
4072 4072  
... ... @@ -4077,7 +4077,7 @@
4077 4077  **DELETE** **/api/v3/retranslations/{id}**
4078 4078  )))
4079 4079  
4080 -Параметр запроса: ID
4471 +id - Идентификатор ретранслятора
4081 4081  
4082 4082  
4083 4083  == **Создание ретранслятора** ==
... ... @@ -4090,16 +4090,16 @@
4090 4090  Запрос:
4091 4091  
4092 4092  {  
4093 -"description": "", ~/~/ Описание
4094 -"subscriberId": "", ~/~/ Подписчик
4095 -"protocolType": 0, ~/~/ Тип протокола
4096 -"address": "", ~/~/ Адрес ретрансляции
4097 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4484 +"description": "", ~/~/ Поле описания ретранслятора
4485 +"subscriberId": "", ~/~/ Идентификатор подписчика
4486 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4487 +"address": "", ~/~/ Адрес и порт принимающего сервера
4488 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4098 4098  "objects": [ ~/~/Объекты для ретрансляции
4099 4099  {      
4100 -"id": "", ~/~/ идентификатор пользователя     
4101 -"imei": "", ~/~/IMEI объекта
4102 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4491 +"id": "", ~/~/ Идентификатор ретранслятора 
4492 +"imei": "", ~/~/ IMEI объекта ретрансляции
4493 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4103 4103  }
4104 4104   ]
4105 4105  }
... ... @@ -4108,22 +4108,22 @@
4108 4108  Ответ:
4109 4109  
4110 4110  {  
4111 -"description": "string", ~/~/ Определяет описание
4112 -"subscriberId": "", ~/~/ идентификатор запроса
4113 -"protocolType": 0, ~/~/ Тип протокола
4114 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4115 -"address": "", ~/~/ Адрес события
4116 -"objects": [ ~/~/Объекты для ретрансляции
4502 +"description": "", ~/~/ Поле описания ретранслятора
4503 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4504 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4505 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4506 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4507 +"objects": [ ~/~/ Объекты для ретрансляции
4117 4117  {      
4118 -"id": "", ~/~/ идентификатор пользователя    
4119 -"name": "string", ~/~/ Название уведомления
4120 -"imei": "string", ~/~/IMEI объекта  
4121 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4509 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4510 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4511 +"imei": "", ~/~/ IMEI объекта ретрансляции
4512 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4122 4122  }
4123 - ],  
4124 -"id": "", ~/~/ идентификатор пользователя  
4125 -"parentId": "", ~/~/ Guid идентификатор родителя
4126 -"deleted": true ~/~/ Признак удаления
4514 + ],
4515 +"id": "", ~/~/ Идентификатор ретранслятора   
4516 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4517 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4127 4127  }
4128 4128  
4129 4129  
... ... @@ -4137,18 +4137,18 @@
4137 4137  Пример запроса:
4138 4138  
4139 4139  {  
4140 -"id": "", ~/~/ идентификатор пользователя   
4141 -"description": "string", ~/~/ Определяет описание
4142 -"subscriberId": "", ~/~/ идентификатор запроса
4143 -"protocolType": 0, ~/~/ Тип протокола
4144 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4145 -"address": "string", ~/~/ Адрес события
4146 -"objects": ~/~/Объекты для ретрансляции
4531 +"id": "", ~/~/ Идентификатор ретранслятора   
4532 +"description": "string", ~/~/ Поле описания ретранслятора
4533 +"subscriberId": "", ~/~/ Идентификатор подписчика
4534 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4535 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4536 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4537 +"objects": ~/~/ Объекты для ретрансляции
4147 4147  [    
4148 4148  {      
4149 -"id": "",  ~/~/ идентификатор пользователя         
4150 -"imei": "", ~/~/IMEI объекта
4151 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4540 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4541 +"imei": "", ~/~/ IMEI объекта ретрансляции
4542 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4152 4152  }
4153 4153   ]
4154 4154  }
... ... @@ -4157,22 +4157,22 @@
4157 4157  Пример ответа:
4158 4158  
4159 4159  {  
4160 -"description": "", ~/~/ Определяет описание
4161 -"subscriberId": "", ~/~/ идентификатор запроса
4162 -"protocolType": 0, ~/~/ Тип протокола
4163 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4164 -"address": "string", ~/~/ Адрес события
4165 -"objects": [ ~/~/Объекты для ретрансляции
4551 +"description": "", ~/~/ Поле описания ретранслятора
4552 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4553 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4554 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4555 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4556 +"objects": [ ~/~/ Объекты для ретрансляции
4166 4166  {      
4167 -"id": "", ~/~/ идентификатор пользователя     
4168 -"name": "string", ~/~/ Название уведомления    
4169 -"imei": "", ~/~/IMEI объекта
4170 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4558 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4559 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4560 +"imei": "", ~/~/ IMEI объекта ретрансляции
4561 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4171 4171  }
4172 4172   ],
4173 -"id": "", ~/~/ идентификатор пользователя   
4174 -"parentId": "", ~/~/ Guid идентификатор родителя
4175 -"deleted": true ~/~/ Признак удаления
4564 +"id": "", ~/~/ Идентификатор ретранслятора   
4565 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4566 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4176 4176  }
4177 4177  
4178 4178  
... ... @@ -4186,9 +4186,9 @@
4186 4186  Пример запроса:
4187 4187  
4188 4188  {  
4189 -"id": "", ~/~/ идентификатор пользователя   
4190 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4191 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4580 +"id": "", ~/~/ Идентификатор ретранслятора   
4581 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4582 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4192 4192  }
4193 4193  
4194 4194  Ответ:
... ... @@ -4195,14 +4195,14 @@
4195 4195  
4196 4196  [ 
4197 4197  {    
4198 -"description": "", ~/~/ Определяет описание
4199 -"subscriberId": "", ~/~/ идентификатор запроса
4200 -"protocolType": 0, ~/~/ Тип протокола
4201 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4202 -"address": "string", ~/~/ Адрес события
4203 -"id": "", ~/~/ идентификатор пользователя   
4204 -"parentId": "", ~/~/ Guid идентификатор родителя
4205 -"deleted": true ~/~/ Признак удаления
4589 +"description": "", ~/~/ Поле описания ретранслятора
4590 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4591 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4592 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4593 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4594 +"id": "", ~/~/ Идентификатор ретранслятора   
4595 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4596 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4206 4206  }
4207 4207  ]
4208 4208  
... ... @@ -4285,6 +4285,342 @@
4285 4285  ]
4286 4286  
4287 4287  
4679 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4680 +
4681 +== **Получение участка по id** ==
4682 +
4683 +(% class="box infomessage" %)
4684 +(((
4685 +GET **/api/v3/agroLands/{id}**
4686 +)))
4687 +
4688 +Пример запроса:
4689 +id  ~/~/ Идентификатор поля
4690 +
4691 +Пример ответа:
4692 +
4693 +(((
4694 +{
4695 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4696 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4697 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4698 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4699 + "cropRotations": [ ~/~/ Данные по севообороту
4700 + {
4701 + "landId": 0, ~/~/ ID поля
4702 + "landName": "string", ~/~/ Название поля
4703 + "year": 0, ~/~/ Год урожая
4704 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4705 + "cultureName": "string", ~/~/ Название культуры
4706 + "productivity": 0, ~/~/ Урожайность
4707 + "area": 0, ~/~/ Площадь поля, Га
4708 + "total": 0, ~/~/ Валовый сбор
4709 + "productivityFact": 0, ~/~/ Фактическая урожайность
4710 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4711 + "totalFact": 0, ~/~/ Фактический валовый сбор
4712 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
4713 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
4714 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
4715 + "isyearplan": true, ~/~/ План года 
4716 + "comment": "string" ~/~/ Комментарий
4717 + }
4718 + ],
4719 + "cropVegetation": [ ~/~/ История вегетации поля
4720 + {
4721 + "values": [ ~/~/ Данные вегетации и состояния посева
4722 + {
4723 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4724 + "ndvi": 0 ~/~/ Индекс вегетации
4725 + }
4726 + ],
4727 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
4728 + {
4729 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4730 + "type": "string", ~/~/ Тип 
4731 + "pictureid": "string" ~/~/ Идентификатор ресурса
4732 + }
4733 + ],
4734 + "states": [ ~/~/ Ключевые даты развития поля
4735 + {
4736 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
4737 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
4738 + }
4739 + ]
4740 + }
4741 + ],
4742 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
4743 + "counts": {
4744 + "fieldOperations": 0, ~/~/ Количество операций на поле
4745 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
4746 + "facts": 0 ~/~/ Счётчик факта
4747 + },
4748 + "planComment": "string", ~/~/ Комментарий к полю
4749 + "productivity": 0, ~/~/ Урожайность.
4750 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4751 +)))
4752 +
4753 +(((
4754 +(((
4755 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
4756 + "year": 0, ~/~/ Год поля
4757 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
4758 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
4759 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
4760 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
4761 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
4762 + "id": 0, ~/~/ Идентификатор объекта геозоны
4763 + "name": "string", ~/~/ Название объекта геозоны
4764 + "type": 0, ~/~/ Тип объекта геозоны 
4765 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4766 + "fname": "string", ~/~/ Имя файла
4767 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4768 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
4769 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
4770 + "description": "string", ~/~/ Описание объекта геозоны
4771 + "area": 0, ~/~/ Площадь, м2
4772 + "perimetr": 0, ~/~/ Периметр, м
4773 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
4774 +}
4775 +)))
4776 +
4777 +
4778 +== **Удалить участок** ==
4779 +
4780 +(% class="box errormessage" %)
4781 +(((
4782 +DELETE **/api/v3/agroLands/{id}**
4783 +)))
4784 +
4785 +Пример запроса:
4786 +id  ~/~/ Идентификатор поля
4787 +
4788 +Пример ответа:
4789 +
4790 +(((
4791 +200 ~/~/ Успех
4792 +)))
4793 +
4794 +(((
4795 +
4796 +)))
4797 +
4798 +(((
4799 +== **Сохранение участка** ==
4800 +
4801 +(% class="box successmessage" %)
4802 +(((
4803 +POST **/api/v3/agroLands**
4804 +)))
4805 +
4806 +Пример запроса:
4807 +
4808 +(((
4809 +{
4810 + "extId": "string", 
4811 + "shape": "string", ~/~/ Форма поля
4812 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4813 + "display": "string", ~/~/ Настройки отображения
4814 + "year": 0, ~/~/ Год поля
4815 + "name": "string", ~/~/ Наименование
4816 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4817 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4818 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4819 + "planComment": "string", ~/~/ Комментарий к полю
4820 + "cropRotations": [ ~/~/ Данные по севообороту
4821 + {
4822 + "landId": 0, ~/~/ ID поля
4823 + "landName": "string", ~/~/ Название поля
4824 + "year": 0, ~/~/ Год урожая
4825 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4826 + "cultureName": "string", ~/~/ Название культуры
4827 + "productivity": 0, ~/~/ Урожайность
4828 + "area": 0, ~/~/ Площадь поля, Га
4829 + "total": 0, ~/~/ Валовый сбор
4830 + "productivityFact": 0, ~/~/ Фактическая урожайность
4831 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4832 + "totalFact": 0, ~/~/ Фактический валовый сбор
4833 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4834 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4835 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4836 + "isyearplan": true, ~/~/ Годовой план 
4837 + "comment": "string" ~/~/ Комментарий
4838 + }
4839 + ]
4840 +}
4841 +)))
4842 +
4843 +(((
4844 +
4845 +)))
4846 +
4847 +(((
4848 +
4849 +)))
4850 +
4851 +Пример ответа:
4852 +
4853 +(((
4854 +(((
4855 +{
4856 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4857 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4858 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4859 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4860 + "cropRotations": [ ~/~/ Данные по севообороту
4861 + {
4862 + "landId": 0, ~/~/ ID поля
4863 + "landName": "string", ~/~/ Название поля
4864 + "year": 0, ~/~/ Год урожая 
4865 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4866 + "cultureName": "string", ~/~/ Название культуры
4867 + "productivity": 0, ~/~/ Урожайность
4868 + "area": 0, ~/~/ Площадь поля, Га.
4869 + "total": 0, ~/~/ Валовый сбор
4870 + "productivityFact": 0, ~/~/ Фактическая урожайность
4871 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4872 + "totalFact": 0, ~/~/ Фактический валовый сбор
4873 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4874 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4875 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4876 + "isyearplan": true, ~/~/ годовой план 
4877 + "comment": "string" ~/~/ Комментарий
4878 + }
4879 + ],
4880 + "cropVegetation": [ ~/~/ История вегетации поля
4881 + {
4882 + "values": [  ~/~/ Данные вегетации и состояния посева
4883 + {
4884 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4885 + "ndvi": 0 ~/~/ Индекс вегетации
4886 + }
4887 + ],
4888 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4889 + {
4890 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4891 + "type": "string", ~/~/ Тип
4892 + "pictureid": "string" ~/~/ Идентификатор ресурса
4893 + }
4894 + ],
4895 + "states": [ ~/~/ Ключевые даты развития поля
4896 + {
4897 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4898 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4899 + }
4900 + ]
4901 + }
4902 + ],
4903 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4904 + "counts": {
4905 + "fieldOperations": 0, ~/~/ Количество операций на поле
4906 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4907 + "facts": 0 ~/~/ Счётчик факта
4908 + },
4909 + "planComment": "string", ~/~/ Комментарий к полю
4910 +)))
4911 +
4912 +(((
4913 + "productivity": 0, ~/~/ Урожайность.
4914 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4915 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4916 + "year": 0, ~/~/ Год поля
4917 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4918 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4919 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4920 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4921 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
4922 + "id": 0, ~/~/ Идентификатор объекта геозоны
4923 + "name": "string", ~/~/ Название объекта геозоны
4924 + "type": 0, ~/~/ Тип объекта геозоны
4925 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4926 + "fname": "string", ~/~/ Имя файла
4927 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4928 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
4929 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
4930 + "description": "string", ~/~/ Описание объекта геозоны
4931 + "area": 0, ~/~/ Площадь, м2
4932 + "perimetr": 0, ~/~/ Периметр, м
4933 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
4934 +}
4935 +)))
4936 +
4937 +(((
4938 +
4939 +)))
4940 +
4941 +(((
4942 +
4943 +)))
4944 +
4945 +(((
4946 +== **Изменение участка** ==
4947 +
4948 +(% class="box successmessage" %)
4949 +(((
4950 +PUT /api/v3/agroLands
4951 +)))
4952 +
4953 +Пример запроса:
4954 +
4955 +(((
4956 +{
4957 + "extId": "string", 
4958 + "shape": "string", ~/~/ Форма поля
4959 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4960 + "display": "string", ~/~/ Настройки отображения
4961 + "year": 0, ~/~/ Год поля
4962 + "name": "string", ~/~/ Наименование
4963 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4964 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4965 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4966 + "planComment": "string", ~/~/ Комментарий к полю
4967 + "cropRotations": [ ~/~/ Данные по севообороту
4968 + {
4969 + "landId": 0, ~/~/ ID поля
4970 + "landName": "string", ~/~/ Название поля
4971 + "year": 0, ~/~/ Год урожая
4972 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4973 + "cultureName": "string", ~/~/ Название культуры
4974 + "productivity": 0, ~/~/ Урожайность
4975 + "area": 0, ~/~/ Площадь поля, Га
4976 + "total": 0, ~/~/ Валовый сбор
4977 + "productivityFact": 0, ~/~/ Фактическая урожайность
4978 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4979 + "totalFact": 0, ~/~/ Фактический валовый сбор
4980 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4981 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4982 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4983 + "isyearplan": true, ~/~/ Годовой план 
4984 + "comment": "string" ~/~/ Комментарий
4985 + }
4986 + ]
4987 +}
4988 +)))
4989 +
4990 +(((
4991 +
4992 +)))
4993 +
4994 +(((
4995 +
4996 +)))
4997 +
4998 +Пример ответа:
4999 +
5000 +(((
5001 +(((
5002 +{
5003 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5004 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5005 + "fieldId": 0, ~/~/ С
5006 +)))
5007 +)))
5008 +)))
5009 +)))
5010 +
5011 +
5012 +)))
5013 +)))
5014 +
4288 4288  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4289 4289  
4290 4290  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

Меню

ГЛОНАССSoft wiki - 2024 г.