Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2024/12/20 15:47
on 2024/12/20 15:47
edited by Андрей Калиновский
on 2025/06/27 13:52
on 2025/06/27 13:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -11,6 +11,11 @@ 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 13 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 14 14 15 15 **Содержание страницы:** 16 16 ))) ... ... @@ -118,29 +118,41 @@ 118 118 Запрос должен содержать данные параметра "**agentId**" 119 119 120 120 (% style="color:#000000" %)Ответ: 126 + 127 +((( 121 121 { 122 - "agentId": "", (%%) 123 - "parentId": "", 124 - "parentName": "string", 125 - "name": "string", 126 - "fullName": "string", 127 - "agentInfoType": 0, 128 - "isForeign": true/false, 129 - "district": "string", 130 - "region": "string", 131 - "city": "string", 132 - "inn": "string", 133 - "kpp": "string", 134 - "address": "string", 135 - "addressFact": "string", 136 - "email": "string", 137 - "director": "string", 138 - "bankName": "string", 139 - "bankBIK": "string", 140 - "bankRS": "string", 141 - "bankKS": "string" 142 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 143 143 160 + 144 144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 145 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 146 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -860,7 +860,7 @@ 860 860 { 861 861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 - "deleted": true,880 + "deleted": false, 864 864 "extId": "string", 865 865 "name": "string", 866 866 "picture": "string", ... ... @@ -879,7 +879,7 @@ 879 879 { 880 880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 - "deleted": true,899 + "deleted": false, 883 883 "extId": "string", 884 884 "name": "string", 885 885 "picture": "string", ... ... @@ -913,7 +913,7 @@ 913 913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 914 ))) 915 915 916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 917 917 918 918 (% style="color:#000000" %)Метод запроса: **PUT** 919 919 ... ... @@ -980,7 +980,7 @@ 980 980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 981 ))) 982 982 983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 984 985 985 (% style="color:#000000" %)Метод запроса: **DELETE** 986 986 ... ... @@ -1021,6 +1021,17 @@ 1021 1021 1022 1022 ((( 1023 1023 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 1024 1024 "vehicleId": "", ~/~/ ID объекта 1025 1025 "name": "", ~/~/ Имя объекта 1026 1026 "imei": "", ~/~/ IMEI объекта ... ... @@ -1115,6 +1115,7 @@ 1115 1115 ], 1116 1116 "showInTooltip": true, ~/~/ Отображать в подсказке 1117 1117 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1118 1118 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1119 1119 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1120 1120 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1172,11 +1172,21 @@ 1172 1172 "date": "2023-05-22T09:57:39.562Z", 1173 1173 "description": "string", 1174 1174 "additionalInfo": "string" 1175 - }1176 - ]1204 + 1205 +((( 1177 1177 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1178 1178 ))) 1179 1179 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1180 1180 (% style="text-align:left" %) 1181 1181 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1182 1182 ... ... @@ -1269,7 +1269,13 @@ 1269 1269 1270 1270 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1271 1271 1272 -(% style="color:#000000" %){(%%) 1311 +(% style="color:#000000" %){ 1312 + 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1273 1273 "parentId": "" , ~/~/ ID клиента 1274 1274 "name": "" , ~/~/ имя ТС 1275 1275 "imei": "" , ~/~/ IMEI ... ... @@ -1362,6 +1362,7 @@ 1362 1362 ], 1363 1363 "showInTooltip": true, ~/~/ Отображать в подсказке 1364 1364 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1365 1365 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1366 1366 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1367 1367 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1411,10 +1411,19 @@ 1411 1411 "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1412 1412 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1413 1413 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1414 - } 1415 - ] 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1416 1416 } 1470 +))) 1417 1417 1472 + 1418 1418 (% style="color:#000000" %)Ответ: 1419 1419 1420 1420 ... ... @@ -1523,6 +1523,7 @@ 1523 1523 ], 1524 1524 "showInTooltip": true, ~/~/ Отображение в подсказке 1525 1525 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1526 1526 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1527 1527 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1528 1528 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -1559,7 +1559,7 @@ 1559 1559 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1560 1560 } 1561 1561 ], 1562 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 -ByMotohoursSensor, 2 -ByRelativeMotohoursSensor1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1563 1563 } 1564 1564 ))) 1565 1565 ))) ... ... @@ -1572,77 +1572,6 @@ 1572 1572 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1573 1573 1574 1574 1575 -== **Импортировать историю ТС (Асинхронный запрос)** == 1576 - 1577 -(% class="box successmessage" %) 1578 -((( 1579 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1580 -))) 1581 - 1582 -Метод запроса: **POST** 1583 - 1584 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1585 - 1586 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1587 - 1588 - 1589 -Ответ: 1590 - 1591 -{ 1592 - 1593 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1594 - 1595 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1596 - 1597 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1598 - 1599 - "Message": "string", ~/~/ Информация о выполнении запроса 1600 - 1601 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1602 - 1603 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1604 - 1605 - "Data": "string" ~/~/ Данные 1606 - 1607 -} 1608 - 1609 - 1610 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1611 - 1612 -(% class="box infomessage" %) 1613 -((( 1614 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1615 -))) 1616 - 1617 -Метод запроса: **GET** 1618 - 1619 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1620 - 1621 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1622 - 1623 - 1624 -Ответ: 1625 - 1626 -{ 1627 - 1628 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1629 - 1630 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1631 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1632 - 1633 - "Message": "string", ~/~/ Информация о выполнении запроса 1634 - 1635 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1636 - 1637 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1638 - 1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 - 1641 - "Data": "string" ~/~/ Данные 1642 - 1643 -} 1644 - 1645 - 1646 1646 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1647 1647 1648 1648 (% class="box infomessage" %) ... ... @@ -1788,7 +1788,6 @@ 1788 1788 "stage": "", ~/~/ Состояние 1789 1789 (% style="color:#000000" %) } 1790 1790 1791 -== == 1792 1792 1793 1793 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1794 1794 ... ... @@ -1865,9 +1865,19 @@ 1865 1865 1866 1866 "drivers": [ ~/~/ Водители 1867 1867 { 1868 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1869 - "isDefault": true 1870 - } 1852 + 1853 +((( 1854 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1855 + "inputNumber": 0, ~/~/ № входа. 1856 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1857 + "comment": "string", ~/~/ Комментарий. 1858 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1859 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1860 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1861 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1862 +))) 1863 + 1864 + } 1871 1871 ], 1872 1872 "commandTemplates": [ ~/~/ Шаблон команды 1873 1873 { ... ... @@ -1903,6 +1903,11 @@ 1903 1903 ], 1904 1904 "showInTooltip": true, ~/~/ Отображать в подсказке 1905 1905 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1900 + 1901 +((( 1902 + "color": "string",** ~/~/ **Цвет датчика 1903 +))) 1904 + 1906 1906 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1907 1907 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1908 1908 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1949,7 +1949,12 @@ 1949 1949 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 1950 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1951 1951 } 1952 - ] 1951 + 1952 +((( 1953 + ], 1954 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1955 +))) 1956 + 1953 1953 } 1954 1954 1955 1955 ... ... @@ -2087,6 +2087,11 @@ 2087 2087 ], 2088 2088 "showInTooltip": true, ~/~/ Отображение в подсказке 2089 2089 "showLastValid": true, ~/~/ Отображать последнее валидное значение 2094 + 2095 +((( 2096 + "color": "string", ~/~/ цвет уведомлений 2097 +))) 2098 + 2090 2090 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2091 2091 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2092 2092 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -2403,6 +2403,8 @@ 2403 2403 "motohours": 0, ~/~/ Моточасы за период, секунды 2404 2404 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2405 2405 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2415 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2416 + 2406 2406 } 2407 2407 ] 2408 2408 } ... ... @@ -2444,8 +2444,12 @@ 2444 2444 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2445 2445 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2446 2446 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2447 2447 "fuelConsumption": 0, ~/~/ Расход топлива 2448 2448 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2449 2449 } 2450 2450 ] 2451 2451 } ... ... @@ -2491,7 +2491,8 @@ 2491 2491 "model": "string", ~/~/ Модель объекта 2492 2492 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2493 2493 { 2494 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2509 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2510 + 2495 2495 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2496 2496 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2497 2497 "valueFuel": 0, ~/~/ Количество ... ... @@ -2720,6 +2720,35 @@ 2720 2720 } 2721 2721 ] 2722 2722 2739 + 2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 + 2742 +(% class="box successmessage" %) 2743 +((( 2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 +))) 2746 + 2747 +(% style="color:#000000" %)Метод запроса: **PUT** 2748 + 2749 +Пример запроса: 2750 + 2751 +((( 2752 +{ 2753 + "id": 0, ~/~/ Идентификатор объекта геозоны 2754 + "name": "string", ~/~/ Наименование объекта геозоны 2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 + "description": "string", ~/~/ Описание объекта геозоны 2757 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 +} 2761 +))) 2762 + 2763 + 2764 +Пример ответа: 2765 + 2766 +200 ~/~/ Success 2767 + 2723 2723 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2724 2724 2725 2725 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2751,7 +2751,7 @@ 2751 2751 "id": 0, ~/~/ ID уведомления 2752 2752 "name": "string", ~/~/ Название уведомления 2753 2753 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2754 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2755 2755 "userId": "", ~/~/ Пользователь, создавший уведомление 2756 2756 "parentId": "", ~/~/ Идентификатор клиента 2757 2757 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2758,6 +2758,155 @@ 2758 2758 } 2759 2759 ] 2760 2760 2806 + 2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2808 + 2809 +(% class="box infomessage" %) 2810 +((( 2811 +**POST /api/v3/notifications** 2812 +))) 2813 + 2814 +Метод запроса **POST** 2815 + 2816 +(% style="text-align: left;" %) 2817 +(% style="color:#000000" %)Пример запроса 2818 + 2819 +((( 2820 +{ 2821 + "id": 0, ~/~/ ID правила 2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2825 + "name": "string", ~/~/ Имя правила 2826 + "active": true, ~/~/ Активность правила 2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2830 + ], 2831 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2832 + 0 2833 + ], 2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2835 + 0 2836 + ], 2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2838 + 0 2839 + ], 2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2841 + "additionalProp1": "string", 2842 + "additionalProp2": "string", 2843 + "additionalProp3": "string" 2844 + }, 2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2848 + ], 2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2851 + "string" 2852 + ], 2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2855 + { 2856 + "id": 0, ~/~/ Идентификатор участника чата. 2857 + "info": "string" ~/~/ Дополнительные сведения. 2858 + } 2859 + ], 2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2866 + "timezone": 0, ~/~/ часовой пояс 2867 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2868 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2869 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2870 + { 2871 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2874 + "additionalProp1": "string", 2875 + "additionalProp2": "string", 2876 + "additionalProp3": "string" 2877 + } 2878 + } 2879 + ] 2880 +} 2881 +))) 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +Ответ: 2892 + 2893 +{ 2894 + "id": 0, ~/~/ ID правила 2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2898 + "name": "string", ~/~/ Имя правила 2899 + "active": true, ~/~/ Активность правила 2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2903 + ], 2904 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата. 2930 + "info": "string" ~/~/ Дополнительные сведения. 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2939 + "timezone": 0, ~/~/ часовой пояс 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2941 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2942 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2943 + { 2944 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2947 + "additionalProp1": "string", 2948 + "additionalProp2": "string", 2949 + "additionalProp3": "string" 2950 + } 2951 + } 2952 + ] 2953 +} 2954 + 2761 2761 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2762 2762 2763 2763 (% class="box infomessage" %) ... ... @@ -3975,16 +3975,12 @@ 3975 3975 Тело запроса: 3976 3976 3977 3977 { 3978 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3979 - "Balance": 0 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Balance": 0 ~/~/ Значение баланса. 3980 3980 } 3981 3981 3982 3982 Ответ: Success 3983 3983 3984 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3985 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3986 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3987 - 3988 3988 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3989 3989 3990 3990 (% class="box warningmessage" %) ... ... @@ -3996,16 +3996,29 @@ 3996 3996 3997 3997 Тело запроса: 3998 3998 4189 +((( 3999 3999 { 4000 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4001 - " Balance": 04191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4192 + "amount": 0 ~/~/ Сумма пополнения баланса 4002 4002 } 4194 +))) 4003 4003 4196 +((( 4197 + 4198 +))) 4199 + 4004 4004 Ответ: Success 4005 4005 4006 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4007 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4008 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4202 +((( 4203 +{ 4204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4205 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4206 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4207 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4208 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4209 + "Description": "string" ~/~/ Описание корректировки. 4210 +} 4211 +))) 4009 4009 4010 4010 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4011 4011 ... ... @@ -4018,16 +4018,25 @@ 4018 4018 4019 4019 Тело запроса: 4020 4020 4224 +((( 4021 4021 { 4022 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4023 - " Balance": 04226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4227 + "amount": 0 ~/~/ Сумма списания с баланса 4024 4024 } 4229 +))) 4025 4025 4026 4026 Ответ: Success 4027 4027 4028 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4030 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4233 +((( 4234 +{ 4235 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4236 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4237 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4238 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4239 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4240 + "Description": "string" ~/~/ Описание корректировки 4241 +} 4242 +))) 4031 4031 4032 4032 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4033 4033 ... ... @@ -4038,28 +4038,35 @@ 4038 4038 4039 4039 Тело запроса: 4040 4040 4253 +((( 4041 4041 { 4042 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4043 - "CalculationType": 0, 4044 - "PermissibleBalance": 0, 4045 - "DefermentDays": 0, 4046 - "SendUiNotifications": true, 4047 - "SendEmailNotifications": true, 4048 - "IsPrivate": true, 4255 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4256 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4257 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4258 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4259 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4260 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4049 4049 } 4262 +))) 4050 4050 4264 +((( 4265 + 4266 +))) 4267 + 4051 4051 Ответ: Success 4052 4052 4053 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4054 -|ClientId|Идентификатор клиента 4055 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4056 -|PermissibleBalance|Допустимый баланс 4057 -|DefermentDays|((( 4058 -Отсрочка, количество дней 4270 +((( 4271 +{ 4272 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4273 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4274 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4275 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4276 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4277 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4278 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4279 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4280 +} 4059 4059 ))) 4060 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4061 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4062 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4063 4063 4064 4064 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4065 4065 ... ... @@ -4071,35 +4071,68 @@ 4071 4071 Тело запроса: 4072 4072 4073 4073 { 4074 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4075 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4076 - "Features": [ 4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4295 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4077 4077 { 4078 - "Feature": "string", 4079 - "IsEnabled": true, 4080 - "IsFactual": true, 4081 - "Limit": 0, 4082 - "Price": 0, 4083 - "DebitDate": "2023-10-18T13:26:58.987Z", 4084 - "PeriodValue": 0, 4085 - "PeriodType": 0 4297 + "Feature": "string", ~/~/ Код услуги. 4298 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4299 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4300 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4301 + "Price": 0, ~/~/ Цена за единицу. 4302 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4303 + "PeriodValue": 0, ~/~/ Значение периода. 4304 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4086 4086 } 4087 4087 ] 4088 4088 } 4089 4089 4309 + 4090 4090 Ответ: Success 4091 4091 4092 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 -|ClientId|Идентификатор клиента 4094 -|PlanId|Идентификатор тарифного плана 4095 -|Feature|Код услуги 4096 -|IsEnabled|Признак, определяющий активирована ли услуга 4097 -|IsFactual|Признак, определяющий расчёт по факту 4098 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4099 -|Price|Цена за единицу. 4100 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4101 -|PeriodValue|Значение периода. 4102 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4312 +((( 4313 +{ 4314 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4315 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4317 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4318 + "Name": "string", ~/~/ Наименование. 4319 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4320 + "Constraint": { ~/~/ Ограничения по тарифу 4321 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4322 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4323 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4324 + }, 4325 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4326 + { 4327 + "Feature": "string", ~/~/Код услуги. 4328 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4329 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4330 + "Price": 0, ~/~/ Цена за единицу. 4331 + "PeriodValue": 0, ~/~/ Значение периода. 4332 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4333 + } 4334 + ], 4335 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4336 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4337 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4338 + }, 4339 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4340 + { 4341 + "Feature": "string", ~/~/ Код услуги. 4342 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4343 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4344 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4345 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4346 + "Price": 0, ~/~/ Цена за единицу. 4347 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4348 + "PeriodValue": 0, ~/~/ Значение периода. 4349 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4350 + "Quantity": 0 ~/~/ Количество использования услуги. 4351 + } 4352 + ] 4353 +} 4354 +))) 4103 4103 4104 4104 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4105 4105 ... ... @@ -4204,6 +4204,43 @@ 4204 4204 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4205 4205 |msgCount|Кол-во обработанных сообщений всего 4206 4206 4459 +== **Импортировать историю ТС (Асинхронный запрос)** == 4460 + 4461 +(% class="box successmessage" %) 4462 +((( 4463 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4464 +))) 4465 + 4466 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4467 + 4468 +Метод запроса: **POST** 4469 + 4470 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 + 4472 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4473 + 4474 + 4475 +Ответ: 4476 + 4477 +{ 4478 + 4479 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4480 + 4481 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4482 + 4483 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4484 + 4485 + "Message": "string", ~/~/ Информация о выполнении запроса 4486 + 4487 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4488 + 4489 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4490 + 4491 + "Data": "string" ~/~/ Данные 4492 + 4493 +} 4494 + 4495 + 4207 4207 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4208 4208 4209 4209 (% class="box infomessage" %) ... ... @@ -4221,10 +4221,59 @@ 4221 4221 "message": "string" 4222 4222 } 4223 4223 4224 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4225 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4226 -|progress|Guid ТС 4513 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4514 +**Параметр** 4515 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4516 +**Описание** 4517 +))) 4518 +|((( 4519 +activity 4520 +)))|((( 4521 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4522 +))) 4523 +|((( 4524 +progress 4525 +)))|((( 4526 +Guid ТС 4527 +))) 4227 4227 4529 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4530 + 4531 +(% class="box infomessage" %) 4532 +((( 4533 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4534 +))) 4535 + 4536 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4537 + 4538 +Метод запроса: **GET** 4539 + 4540 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 + 4542 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4543 + 4544 + 4545 +Ответ: 4546 + 4547 +{ 4548 + 4549 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4550 + 4551 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4552 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4553 + 4554 + "Message": "string", ~/~/ Информация о выполнении запроса 4555 + 4556 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4557 + 4558 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4559 + 4560 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4561 + 4562 + "Data": "string" ~/~/ Данные 4563 + 4564 +} 4565 + 4228 4228 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4229 4229 4230 4230 (% class="box infomessage" %) ... ... @@ -4383,7 +4383,7 @@ 4383 4383 4384 4384 (% class="box infomessage" %) 4385 4385 ((( 4386 -POST /api/v3/fuelcards/transactions 4724 +**POST /api/v3/fuelcards/transactions** 4387 4387 ))) 4388 4388 4389 4389 Метод запроса: POST ... ... @@ -4421,7 +4421,32 @@ 4421 4421 "address": "string" ~/~/ Адрес АЗС 4422 4422 } 4423 4423 4762 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4424 4424 4764 +(% class="box infomessage" %) 4765 +((( 4766 +**GET /api/v3/fuelcards** 4767 +))) 4768 + 4769 +Метод запроса: GET 4770 + 4771 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4772 + 4773 +Ответ: 4774 + 4775 +[ 4776 + { 4777 + "Name": "string", ~/~/ Определяет наименование карты. 4778 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4779 + "Number": "string", ~/~/ Определяет № карты. 4780 + "Enabled": true, ~/~/ Определяет признак активности карты. 4781 + "Description": "string", ~/~/ Определяет описание карты. 4782 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4783 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4784 + "deleted": true ~/~/ Признак удаления 4785 + } 4786 +] 4787 + 4425 4425 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4426 4426 4427 4427 ... ... @@ -4600,7 +4600,7 @@ 4600 4600 4601 4601 (% class="box infomessage" %) 4602 4602 ((( 4603 -POST **/api/v3/Reports/harvesterUnloading**4966 +**POST /api/v3/Reports/harvesterUnloading** 4604 4604 ))) 4605 4605 4606 4606 Пример запроса: ... ... @@ -4672,140 +4672,174 @@ 4672 4672 ] 4673 4673 4674 4674 4675 -= (% style="color:#000000;font-size:18.6667px" %)**Раздел:Сельскохозяйственные поля**(%%)=5038 +== **Отчет трек-датчики** == 4676 4676 4677 -== **Получение поля по id** == 4678 - 4679 4679 (% class="box infomessage" %) 4680 4680 ((( 4681 - GET**/api/v3/agroLands/{id}**5042 +**POST /api/v3/Reports/sensorsWorks** 4682 4682 ))) 4683 4683 4684 -Пример запроса: 4685 -id ~/~/ Идентификатор поля 5045 +**Пример запроса:** 4686 4686 4687 -Пример ответа: 5047 +{ 5048 + "vehicleIds": [ ~/~/ Список ID объектов 5049 + 0 5050 + ], 5051 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5052 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5053 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5054 +} 4688 4688 5056 +**Пример ответа:** 5057 + 4689 4689 ((( 4690 4690 { 4691 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4692 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4693 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4694 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4695 - "cropRotations": [ ~/~/ Данные по севообороту 5060 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4696 4696 { 4697 - "landId": 0, ~/~/ ID поля 4698 - "landName": "string", ~/~/ Название поля 4699 - "year": 0, ~/~/ Год урожая 4700 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4701 - "cultureName": "string", ~/~/ Название культуры 4702 - "productivity": 0, ~/~/ Урожайность 4703 - "area": 0, ~/~/ Площадь поля, Га 4704 - "total": 0, ~/~/ Валовый сбор 4705 - "productivityFact": 0, ~/~/ Фактическая урожайность 4706 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4707 - "totalFact": 0, ~/~/ Фактический валовый сбор 4708 - "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 4709 - "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 4710 - "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 4711 - "isyearplan": true, ~/~/ План года 4712 - "comment": "string" ~/~/ Комментарий 4713 - } 4714 - ], 4715 - "cropVegetation": [ ~/~/ История вегетации поля 4716 - { 4717 - "values": [ ~/~/ Данные вегетации и состояния посева 5062 + "vehicleId": 0, ~/~/ Идентификатор ТС 5063 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4718 4718 { 4719 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4720 - "ndvi": 0 ~/~/ Индекс вегетации 5065 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5066 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5067 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5068 + "name": "string", ~/~/ Наименование оборудования. 5069 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5070 + "totalMileage": 0, ~/~/ Общий пробег. 5071 + "avgSpeed": 0 ~/~/ Средняя скорость. 4721 4721 } 4722 - ], 4723 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4724 - { 4725 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4726 - "type": "string", ~/~/ Тип 4727 - "pictureid": "string" ~/~/ Идентификатор ресурса 4728 - } 4729 - ], 4730 - "states": [ ~/~/ Ключевые даты развития поля 4731 - { 4732 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4733 - "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 4734 - } 4735 4735 ] 4736 4736 } 4737 - ], 4738 - "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 4739 - "counts": { 4740 - "fieldOperations": 0, ~/~/ Количество операций на поле 4741 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4742 - "facts": 0 ~/~/ Счётчик факта 4743 - }, 4744 - "planComment": "string", ~/~/ Комментарий к полю 4745 - "productivity": 0, ~/~/ Урожайность. 4746 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5075 + ] 5076 +} 5077 + 5078 + 5079 +== **Превышение скорости** == 5080 + 5081 +(% class="box infomessage" %) 5082 +((( 5083 +**POST /api/v3/Reports/overSpeedDuration** 4747 4747 ))) 4748 4748 5086 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5087 + 5088 +Пример запроса: 5089 + 4749 4749 ((( 4750 -((( 4751 - "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 4752 - "year": 0, ~/~/ Год поля 4753 - "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4754 - "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4755 - "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4756 - "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4757 - "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4758 - "id": 0, ~/~/ Идентификатор объекта геозоны 4759 - "name": "string", ~/~/ Название объекта геозоны 4760 - "type": 0, ~/~/ Тип объекта геозоны 4761 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4762 - "fname": "string", ~/~/ Имя файла 4763 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4764 - "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 4765 - "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 4766 - "description": "string", ~/~/ Описание объекта геозоны 4767 - "area": 0, ~/~/ Площадь, м2 4768 - "perimetr": 0, ~/~/ Периметр, м 4769 - "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5091 +{ 5092 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5093 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5094 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5095 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5096 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4770 4770 } 4771 4771 ))) 4772 4772 5100 +((( 5101 + 5102 +))) 4773 4773 4774 -== **Удалить поле** == 5104 +((( 5105 +Пример ответа: 5106 +))) 4775 4775 4776 -(% class="box errormessage" %) 4777 4777 ((( 4778 -DELETE **/api/v3/agroLands/{id}** 5109 +((( 5110 +[ 5111 + { 5112 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5113 + "duration": 0, ~/~/ Продолжительность события в секундах 5114 + "maxSpeed": 0, ~/~/ Максимальная скорость 5115 + "speedLimit": 0 ~/~/ Ограничение скорости 5116 + } 5117 +] 4779 4779 ))) 5119 +))) 5120 +))) 4780 4780 4781 -Пример запроса: 4782 -id ~/~/ Идентификатор поля 5122 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4783 4783 4784 -Пример ответа: 4785 4785 5125 +== **Запрос списка полей** == 5126 + 5127 +(% class="box successmessage" %) 4786 4786 ((( 4787 - 200~/~/Успех5129 +**POST /api/v3/agroLands/find** 4788 4788 ))) 4789 4789 5132 +Пример запроса: 5133 + 4790 4790 ((( 5135 +((( 5136 +((( 5137 +{ 5138 + "year": 0, ~/~/ Фильтр по году 5139 + "name": "string", ~/~/ Фильтр по названию 5140 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5141 +} 5142 +))) 5143 +))) 5144 + 4791 4791 4792 4792 ))) 4793 4793 5148 +Пример ответа: 5149 + 4794 4794 ((( 4795 -== **Сохранение поля** == 5151 +[ 5152 + { 5153 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5154 + "year": 0, ~/~/ Год поля 5155 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5156 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5157 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5158 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5159 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5160 + "counts": { ~/~/ Счётчики с/х поля 5161 + "fieldOperations": 0, ~/~/ Количество операций на поле 5162 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5163 + "facts": 0 ~/~/ Счётчик факта 5164 + }, 5165 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5166 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5167 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5168 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5169 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5170 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5171 + "planComment": "string", ~/~/ Комментарий к полю 5172 + "productivity": 0, ~/~/ Урожайность. 5173 + "id": 0, ~/~/ Идентификатор объекта геозоны 5174 + "name": "string", ~/~/ Название объекта геозоны 5175 + "type": 0, ~/~/ Тип объекта геозоны 5176 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5177 + "fname": "string", ~/~/ Имя файла 5178 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5179 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5180 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5181 + "description": "string", ~/~/ Описание объекта геозоны 5182 + "area": 0, ~/~/ Площадь, м2 5183 + "perimetr": 0, ~/~/ Периметр, м 5184 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5185 + } 5186 +] 4796 4796 5188 + 5189 +== **Создание нового поля ** == 5190 + 4797 4797 (% class="box successmessage" %) 4798 4798 ((( 4799 -POST **/api/v3/agroLands**5193 +**POST /api/v3/agroLands** 4800 4800 ))) 4801 4801 5196 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5197 +X-agent - ID клиента 5198 + 4802 4802 Пример запроса: 4803 4803 4804 4804 ((( 4805 4805 { 4806 4806 "extId": "string", 4807 - "shape": " string", ~/~/ Форма поля4808 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля5204 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5205 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4809 4809 "display": "string", ~/~/ Настройки отображения 4810 4810 "year": 0, ~/~/ Год поля 4811 4811 "name": "string", ~/~/ Наименование ... ... @@ -4924,18 +4924,141 @@ 4924 4924 "perimetr": 0, ~/~/ Периметр, м 4925 4925 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 4926 4926 } 5324 + 5325 + 4927 4927 ))) 5327 +))) 5328 +))) 4928 4928 5330 +== **Получение поля по id** == 5331 + 5332 +(% class="box infomessage" %) 4929 4929 ((( 5334 +**GET /api/v3/agroLands/{id}** 5335 +))) 5336 + 5337 +Пример запроса: 5338 +id ~/~/ Идентификатор поля 5339 + 5340 +Пример ответа: 5341 + 5342 +((( 5343 +{ 5344 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5345 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5346 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5347 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5348 + "cropRotations": [ ~/~/ Данные по севообороту 5349 + { 5350 + "landId": 0, ~/~/ ID поля 5351 + "landName": "string", ~/~/ Название поля 5352 + "year": 0, ~/~/ Год урожая 5353 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5354 + "cultureName": "string", ~/~/ Название культуры 5355 + "productivity": 0, ~/~/ Урожайность 5356 + "area": 0, ~/~/ Площадь поля, Га 5357 + "total": 0, ~/~/ Валовый сбор 5358 + "productivityFact": 0, ~/~/ Фактическая урожайность 5359 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5360 + "totalFact": 0, ~/~/ Фактический валовый сбор 5361 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5362 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5363 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5364 + "isyearplan": true, ~/~/ План года 5365 + "comment": "string" ~/~/ Комментарий 5366 + } 5367 + ], 5368 + "cropVegetation": [ ~/~/ История вегетации поля 5369 + { 5370 + "values": [ ~/~/ Данные вегетации и состояния посева 5371 + { 5372 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5373 + "ndvi": 0 ~/~/ Индекс вегетации 5374 + } 5375 + ], 5376 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5377 + { 5378 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5379 + "type": "string", ~/~/ Тип 5380 + "pictureid": "string" ~/~/ Идентификатор ресурса 5381 + } 5382 + ], 5383 + "states": [ ~/~/ Ключевые даты развития поля 5384 + { 5385 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5386 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5387 + } 5388 + ] 5389 + } 5390 + ], 5391 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5392 + "counts": { 5393 + "fieldOperations": 0, ~/~/ Количество операций на поле 5394 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5395 + "facts": 0 ~/~/ Счётчик факта 5396 + }, 5397 + "planComment": "string", ~/~/ Комментарий к полю 5398 + "productivity": 0, ~/~/ Урожайность. 5399 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5400 +))) 5401 + 5402 +((( 5403 +((( 5404 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5405 + "year": 0, ~/~/ Год поля 5406 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5407 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5408 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5409 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5410 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5411 + "id": 0, ~/~/ Идентификатор объекта геозоны 5412 + "name": "string", ~/~/ Название объекта геозоны 5413 + "type": 0, ~/~/ Тип объекта геозоны 5414 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5415 + "fname": "string", ~/~/ Имя файла 5416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5417 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5418 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5419 + "description": "string", ~/~/ Описание объекта геозоны 5420 + "area": 0, ~/~/ Площадь, м2 5421 + "perimetr": 0, ~/~/ Периметр, м 5422 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5423 +} 5424 +))) 5425 + 5426 + 5427 +== **Удаление существующего поля** == 5428 + 5429 +(% class="box errormessage" %) 5430 +((( 5431 +**DELETE /api/v3/agroLands/{id}** 5432 +))) 5433 + 5434 +Пример запроса: 5435 +id ~/~/ Идентификатор поля 5436 + 5437 +Пример ответа: 5438 + 5439 +((( 5440 +200 ~/~/ Успех 5441 +))) 5442 + 5443 +((( 4930 4930 4931 4931 ))) 4932 4932 4933 4933 ((( 5448 +((( 5449 +((( 5450 + 5451 +))) 5452 + 5453 +((( 4934 4934 == **Изменение поля** == 4935 4935 4936 4936 (% class="box infomessage" %) 4937 4937 ((( 4938 -PUT **/api/v3/agroLands**5458 +**PUT /api/v3/agroLands** 4939 4939 ))) 4940 4940 4941 4941 Пример запроса: ... ... @@ -5072,11 +5072,11 @@ 5072 5072 ))) 5073 5073 5074 5074 5075 -== ** Функция обновляет закрытие/открытие года урожая** ==5595 +== **Редактирование года урожая ** == 5076 5076 5077 5077 (% class="box successmessage" %) 5078 5078 ((( 5079 -POST **/api/v3/agroLands/updateOpenCloseYear**5599 +**POST /api/v3/agroLands/updateOpenCloseYear** 5080 5080 ))) 5081 5081 5082 5082 Пример запроса: ... ... @@ -5179,81 +5179,17 @@ 5179 5179 ))) 5180 5180 5181 5181 5182 -== **Возвращает список полей** == 5183 - 5184 -(% class="box successmessage" %) 5185 -((( 5186 -POST **/api/v3/agroLands/find** 5702 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5187 5187 ))) 5188 - 5189 -Пример запроса: 5190 - 5191 -((( 5192 -((( 5193 -((( 5194 -{ 5195 - "year": 0, ~/~/ Фильтр по году 5196 - "name": "string", ~/~/ Фильтр по названию 5197 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5198 -} 5199 5199 ))) 5200 5200 ))) 5201 5201 5202 - 5203 -))) 5204 - 5205 -Пример ответа: 5206 - 5207 -((( 5208 -[ 5209 - { 5210 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5211 - "year": 0, ~/~/ Год поля 5212 - "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5213 - "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5214 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5215 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5216 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5217 - "counts": { ~/~/ Счётчики с/х поля 5218 - "fieldOperations": 0, ~/~/ Количество операций на поле 5219 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5220 - "facts": 0 ~/~/ Счётчик факта 5221 - }, 5222 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5223 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5224 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5225 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5226 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5227 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5228 - "planComment": "string", ~/~/ Комментарий к полю 5229 - "productivity": 0, ~/~/ Урожайность. 5230 - "id": 0, ~/~/ Идентификатор объекта геозоны 5231 - "name": "string", ~/~/ Название объекта геозоны 5232 - "type": 0, ~/~/ Тип объекта геозоны 5233 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5234 - "fname": "string", ~/~/ Имя файла 5235 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5236 - "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5237 - "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5238 - "description": "string", ~/~/ Описание объекта геозоны 5239 - "area": 0, ~/~/ Площадь, м2 5240 - "perimetr": 0, ~/~/ Периметр, м 5241 - "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5242 - } 5243 -] 5244 -))) 5245 -))) 5246 -))) 5247 -))) 5248 - 5249 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5250 - 5251 5251 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5252 5252 5253 5253 5254 5254 (% class="box infomessage" %) 5255 5255 ((( 5256 -GET api/v3/Vehicles/recyclebin/all 5712 +**GET api/v3/Vehicles/recyclebin/all** 5257 5257 ))) 5258 5258 5259 5259 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту ... ... @@ -5288,11 +5288,11 @@ 5288 5288 ] 5289 5289 5290 5290 5291 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5747 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5292 5292 5293 5293 (% class="box infomessage" %) 5294 5294 ((( 5295 -POST /api/v3/Vehicles/recyclebin/erase5751 +**POST api/v3/Vehicles/recyclebin/erase** 5296 5296 ))) 5297 5297 5298 5298 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5334,7 +5334,7 @@ 5334 5334 5335 5335 (% class="box infomessage" %) 5336 5336 ((( 5337 -POST /api/v3/Vehicles/recyclebin/restore5793 +**POST api/v3/Vehicles/recyclebin/restore** 5338 5338 ))) 5339 5339 5340 5340 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5386,7 +5386,754 @@ 5386 5386 ] 5387 5387 5388 5388 5845 += **Раздел: Журнал заданий ** = 5389 5389 5847 + 5848 +== **Создание задания в Журнале заданий** == 5849 + 5850 +(% class="box infomessage" %) 5851 +((( 5852 +**POST /api/v3/vehicletasks** 5853 +))) 5854 + 5855 +Пример запроса: 5856 + 5857 +((( 5858 +{ 5859 + "vehicleId": 0, ~/~/ Идентификатор ТС 5860 + "description": "string", ~/~/ Описание 5861 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5863 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5864 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5865 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5866 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5867 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5868 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5869 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5870 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5871 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5872 + "cost": { 5873 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5874 + "Name": "string", ~/~/ Наименование 5875 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5876 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5877 + "Norm": 0 ~/~/ Норма внесения 5878 + }, 5879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5880 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5881 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5882 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5883 + "deleted": true, ~/~/ Признак удаления 5884 + "extId": "string", 5885 + "GeoIds": [ ~/~/ Cвязанные поля 5886 + 0 5887 + ] 5888 +} 5889 +))) 5890 + 5891 + 5892 +Пример ответа: 5893 + 5894 +{ 5895 + "vehicleId": 0, ~/~/ Идентификатор ТС 5896 + "description": "string", ~/~/ Описание 5897 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5898 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5899 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5900 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5901 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5902 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5903 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5904 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5905 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5906 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5907 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5908 + "cost": { 5909 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5910 + "Name": "string", ~/~/ Наименование 5911 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5912 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5913 + "Norm": 0 ~/~/ Норма внесения 5914 + }, 5915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5916 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5917 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5918 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5919 + "deleted": true, ~/~/ Признак удаления 5920 + "extId": "string", ~/~/ ExtId 5921 + "GeoIds": [ ~/~/ Связанные поля 5922 + 0 5923 + ] 5924 +} 5925 + 5926 + 5927 +== **Редактирование задания в Журнале заданий** == 5928 + 5929 +(% class="box successmessage" %) 5930 +((( 5931 +**PUT /api/v3/vehicletasks** 5932 +))) 5933 + 5934 +Пример запроса: 5935 + 5936 +((( 5937 +{ 5938 + "vehicleId": 0, ~/~/ Идентификатор ТС 5939 + "description": "string", ~/~/ Описание 5940 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5941 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5942 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5943 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5944 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5945 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5946 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5947 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5948 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5949 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5950 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5951 + "cost": { 5952 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5953 + "Name": "string", ~/~/ Наименование 5954 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5955 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5956 + "Norm": 0 ~/~/ Норма внесения 5957 + }, 5958 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5959 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5960 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5961 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5962 + "deleted": true, ~/~/ Признак удаления 5963 + "extId": "string", ~/~/ ExtId 5964 + "GeoIds": [ ~/~/ Связанные поля 5965 + 0 5966 + ] 5967 +} 5968 +))) 5969 + 5970 + 5971 +Пример ответа: 5972 + 5973 +{ 5974 + "vehicleId": 0, ~/~/ Идентификатор ТС 5975 + "description": "string", ~/~/ Описание 5976 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5977 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5978 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5979 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5980 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5981 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5982 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5983 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5984 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5985 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5986 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5987 + "cost": { 5988 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5989 + "Name": "string", ~/~/ Наименование 5990 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5991 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5992 + "Norm": 0 ~/~/ Норма внесения 5993 + }, 5994 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5995 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5996 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5997 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5998 + "deleted": true, ~/~/ Признак удаления 5999 + "extId": "string", ~/~/ ExtId 6000 + "GeoIds": [ ~/~/ Связанные поля 6001 + 0 6002 + ] 6003 +} 6004 + 6005 + 6006 +== **Удаление задания в Журнале заданий** == 6007 + 6008 +(% class="box warningmessage" %) 6009 +((( 6010 +**DELETE /api/v3/vehicletasks** 6011 +))) 6012 + 6013 +Пример запроса: 6014 + 6015 +((( 6016 +[ 6017 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6018 +] 6019 +))) 6020 + 6021 +((( 6022 + 6023 +))) 6024 + 6025 +Пример ответа: 6026 + 6027 +{ 6028 + "vehicleId": 0, ~/~/ Идентификатор ТС 6029 + "description": "string", ~/~/ Описание 6030 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6032 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6033 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6034 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6035 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6036 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6037 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6038 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6039 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6040 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6041 + "cost": { 6042 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6043 + "Name": "string", ~/~/ Наименование 6044 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6045 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6046 + "Norm": 0 ~/~/ Норма внесения 6047 + }, 6048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6049 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6050 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6051 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6052 + "deleted": true, ~/~/ Признак удаления 6053 + "extId": "string", ~/~/ ExtId 6054 + "GeoIds": [ ~/~/ Связанные поля 6055 + 0 6056 + ] 6057 +} 6058 + 6059 + 6060 +== **Получение списка Журнала заданий** == 6061 + 6062 +(% class="box infomessage" %) 6063 +((( 6064 +**POST /api/v3/vehicletasks/getbyperiod** 6065 +))) 6066 + 6067 +Пример запроса: 6068 + 6069 +((( 6070 +{ 6071 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6072 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6073 + "TimeZone": 0, ~/~/ Часовой пояс. 6074 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6075 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6076 + ], 6077 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6078 + 0 6079 + ], 6080 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6081 + 0 6082 + ], 6083 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6084 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6085 +} 6086 +))) 6087 + 6088 + 6089 +Пример ответа: 6090 + 6091 +((( 6092 +{ 6093 + "total": 0, ~/~/ Общее количество записей 6094 + "pages": 0, ~/~/ Общее количество страниц 6095 + "currentPage": 0, ~/~/ Текущая страница 6096 + "items": [ ~/~/ Записи 6097 + { 6098 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6099 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6100 + "name": "string", ~/~/ Название задания. 6101 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6102 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6103 + "workKind": "string", ~/~/ Вид работ 6104 + "techOp": "string", ~/~/ Тех. операция 6105 + "trailerModel": "string", ~/~/ Модель агрегата 6106 + "width": "string", ~/~/ Ширина, м 6107 + "speed": "string", ~/~/ Тех. скорость 6108 + "fields": "string", ~/~/ Поля 6109 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6110 + "vehicles": "string", ~/~/ Объект-модель 6111 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6112 + "drivers": "string", ~/~/ Водители 6113 + "tmc": "string", ~/~/ ТМЦ 6114 + "client": "string", ~/~/ Клиент 6115 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6116 + "dep": "string", ~/~/ Подразделение 6117 + "geoIds": [ ~/~/ Связанные поля 6118 + 0 6119 + ] 6120 + } 6121 + ] 6122 +} 6123 +))) 6124 + 6125 + 6126 += **Раздел: Роли** = 6127 + 6128 +== **Получение списка клиентских и системных ролей пользователя ** == 6129 + 6130 +(% class="box successmessage" %) 6131 +((( 6132 +**POST /api/v3/groups/find** 6133 +))) 6134 + 6135 +Пример запроса: 6136 + 6137 +((( 6138 +{ 6139 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6140 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6141 +} 6142 +))) 6143 + 6144 +((( 6145 + 6146 +))) 6147 + 6148 +((( 6149 +Пример ответа: 6150 +))) 6151 + 6152 +((( 6153 +((( 6154 +{ 6155 + "groups": [ ~/~/ Системные роли пользователя 6156 + { 6157 + "code": "string", ~/~/ Код роли. 6158 + "name": "string", ~/~/ Имя 6159 + "shortName": "string" ~/~/ Короткое имя 6160 + } 6161 + ], 6162 + "customGroups": [ ~/~/ Системные роли пользователя 6163 + { 6164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6165 + "name": "string", ~/~/ Наименование 6166 + "shortName": "string", ~/~/ Короткое наименование 6167 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6168 + } 6169 + ] 6170 +} 6171 +))) 6172 +))) 6173 + 6174 +((( 6175 + 6176 +))) 6177 + 6178 +((( 6179 + 6180 +))) 6181 + 6182 += **Раздел: Локатор ** = 6183 + 6184 + 6185 +== **Получение списка локаторов, доступных пользователю ** == 6186 + 6187 +(% class="box infomessage" %) 6188 +((( 6189 +**GET /api/v3/locators ** 6190 +))) 6191 + 6192 +В заголовках запроса: X-Auth: Токен авторизации 6193 + 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +((( 6199 +{ 6200 + "vehiclesIds": [ ~/~/ Объекты 6201 + 0 6202 + ], 6203 + "geoIds": [ ~/~/ Геозоны 6204 + 0 6205 + ], 6206 + "fieldsIds": [ ~/~/ Поля 6207 + 0 6208 + ], 6209 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6210 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6211 + "agentName": "string", ~/~/ Наименование агента. 6212 + "isEnabled": true, ~/~/ Активность 6213 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6214 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6215 + "name": "string", ~/~/ Наименование. 6216 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6217 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6218 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6219 + "validity": 0, ~/~/ Значение срока действия 6220 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6221 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6222 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6223 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6224 + "url": "string", ~/~/ Ссылка 6225 + "language": 0, ~/~/ Язык 6226 + "showVehicleName": true, ~/~/ Наименование объекта 6227 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6228 + "allowTrackReport": true, ~/~/ Трек 6229 + "showTrackTracing": true, ~/~/ Трассировка трека 6230 + "showSensors": true, ~/~/ Датчик 6231 + "availableMapLayers": [ ~/~/ Слои на карте 6232 + 0 6233 + ] 6234 +} 6235 +))) 6236 +))) 6237 + 6238 + 6239 +== **Получение перечня моделей ** == 6240 + 6241 +(% class="box successmessage" %) 6242 +((( 6243 +**POST /api/v3/models/find** 6244 +))) 6245 + 6246 +Пример запроса: 6247 + 6248 +((( 6249 +((( 6250 +{ 6251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6252 + "name": "string", ~/~/ Наименование локатора 6253 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6254 +))) 6255 + 6256 + 6257 + 6258 + Пример ответа: 6259 + 6260 + 6261 +((( 6262 +[ 6263 + { 6264 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6266 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6267 + "name": "string", ~/~/ Наименование локатора 6268 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6269 + } 6270 +] 6271 +))) 6272 +))) 6273 + 6274 + 6275 +== **Создание локатора** == 6276 + 6277 +(% class="box successmessage" %) 6278 +((( 6279 +**POST /api/v3/locators** 6280 +))) 6281 + 6282 +Пример запроса: 6283 + 6284 +((( 6285 +{ 6286 + "isEnabled": true, ~/~/ Активность 6287 + "name": "string", ~/~/ Наименование локатора 6288 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6289 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6290 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6291 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6292 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6293 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6294 + "vehiclesIds": [ ~/~/ Oбъекты 6295 + 0 6296 + ], 6297 + "geoIds": [ ~/~/ Геозоны 6298 + 0 6299 + ], 6300 + "fieldsIds": [ ~/~/ Поля 6301 + 0 6302 + ], 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6305 + "allowTrackReport": true, ~/~/ Трек 6306 + "showTrackTracing": true, ~/~/ Трассировка трека 6307 + "showSensors": true, ~/~/ Датчик 6308 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6309 + ] 6310 +} 6311 +))) 6312 + 6313 + 6314 +Пример ответа: 6315 + 6316 +((( 6317 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6318 +))) 6319 + 6320 + 6321 + 6322 +== **Изменение локатора** == 6323 + 6324 +(% class="box infomessage" %) 6325 +((( 6326 +**PUT /api/v3/locators** 6327 +))) 6328 + 6329 +Пример запроса: 6330 + 6331 +((( 6332 +{ 6333 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6334 + "isEnabled": true, ~/~/ Активность 6335 + "name": "string", ~/~/ Наименование 6336 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6337 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6338 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6339 + "autoProlongation": true, ~/~/ Автопродление срока действия 6340 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6341 + "vehiclesIds": [ ~/~/ Oбъекты 6342 + 0 6343 + ], 6344 + "geoIds": [ ~/~/ Геозоны 6345 + 0 6346 + ], 6347 + "fieldsIds": [ ~/~/ Поля 6348 + 0 6349 + ], 6350 + "showVehicleName": true, ~/~/ Наименование объекта 6351 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6352 + "allowTrackReport": true, ~/~/ Трек 6353 + "showTrackTracing": true, ~/~/ Трассировка трека 6354 + "showSensors": true, ~/~/ Датчик 6355 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6356 + ] 6357 +} 6358 + 6359 + 6360 +))) 6361 + 6362 +Пример ответа: 6363 + 6364 +200 ~/~/ Success 6365 + 6366 + 6367 +== **Удалить локатор** == 6368 + 6369 +(% class="box warningmessage" %) 6370 +((( 6371 +**DELETE /api/v3/locators** 6372 +))) 6373 + 6374 +Пример запроса: 6375 + 6376 +((( 6377 +[ 6378 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6379 +] 6380 +))) 6381 + 6382 + 6383 + 6384 += **Раздел: Яндекс Маршруты** = 6385 + 6386 + 6387 +== **Возвращение списка маршрутов** == 6388 + 6389 +(% class="box infomessage" %) 6390 +((( 6391 +**GET /api/v3/TransportRoutes** 6392 +))) 6393 + 6394 +Пример запроса: 6395 +Id ~/~/ Идентификатор поля 6396 + 6397 + 6398 +Пример ответа: 6399 + 6400 +((( 6401 +[ 6402 + { 6403 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6404 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6405 + "name": "string", ~/~/ Наименование маршрута. 6406 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6407 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6408 + 0 6409 + ] 6410 + } 6411 +] 6412 +))) 6413 + 6414 + 6415 + 6416 +== **Добавить маршрут** == 6417 + 6418 +(% class="box infomessage" %) 6419 +((( 6420 +**POST /api/v3/TransportRoutes** 6421 +))) 6422 + 6423 +Пример запроса: 6424 +{ 6425 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6427 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6428 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6429 + 0 6430 + ] 6431 +} 6432 + 6433 + 6434 +Пример ответа: 6435 + 6436 +((( 6437 +{ 6438 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6439 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6440 + "name": "string", ~/~/ Определяет наименование маршрута 6441 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6442 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6443 + 0 6444 + ] 6445 +} 6446 +))) 6447 + 6448 + 6449 +== **Обновление маршрута** == 6450 + 6451 +(% class="box successmessage" %) 6452 +((( 6453 +**PUT /api/v3/TransportRoutes** 6454 +))) 6455 + 6456 +Пример запроса: 6457 + 6458 +((( 6459 +{ 6460 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6461 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6462 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6463 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6464 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6465 + 0 6466 + ] 6467 +} 6468 +))) 6469 + 6470 + 6471 +Пример ответа: 6472 + 6473 +((( 6474 +{ 6475 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6476 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6477 + "name": "string", ~/~/ Определяет наименование маршрута 6478 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6479 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6480 + 0 6481 + ] 6482 +} 6483 +))) 6484 + 6485 + 6486 +== **Получить связки маршрутов ТС** == 6487 + 6488 +(% class="box infomessage" %) 6489 +((( 6490 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6491 +))) 6492 + 6493 +Пример запроса: 6494 + 6495 +((( 6496 +[ 6497 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6498 +] 6499 +))) 6500 + 6501 + 6502 +Пример ответа: 6503 + 6504 +((( 6505 +[ 6506 + { 6507 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6508 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6509 + } 6510 +] 6511 +))) 6512 + 6513 + 6514 +== **Удалить маршрут** == 6515 + 6516 +(% class="box warningmessage" %) 6517 +((( 6518 +**DELETE /api/v3/TransportRoutes/{id}** 6519 +))) 6520 + 6521 +Пример запроса: 6522 +Id ~/~/ Идентификатор поля 6523 + 6524 + 6525 + 6526 += **Раздел: Управление доступа к машинам** = 6527 + 6528 + 6529 +== Получение списка транспортных средств видимых пользователю == 6530 + 6531 +(% class="box infomessage" %) 6532 +((( 6533 +**GET /api/v3/UserVisibleVehicles/{userId}** 6534 +))) 6535 + 6536 +Пример ответа: 6537 + 6538 +((( 6539 +{ 6540 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6541 + 0 6542 + ] 6543 +} 6544 +))) 6545 + 6546 + 6547 + 6548 +== Задает видимость транспортных средств пользователю == 6549 + 6550 +(% class="box infomessage" %) 6551 +((( 6552 +**POST /api/v3/UserVisibleVehicles** 6553 +))) 6554 + 6555 +Пример запроса: 6556 + 6557 +((( 6558 +((( 6559 +{ 6560 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6561 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6562 + 0 6563 + ] 6564 +} 6565 +))) 6566 + 6567 +((( 6568 + 6569 +))) 6570 + 6571 +((( 6572 + 6573 +))) 6574 + 6575 +((( 6576 +Пример ответа : 6577 +))) 6578 + 6579 +((( 6580 + 6581 +))) 6582 + 6583 +((( 6584 +200 ~/~/ Success 6585 +))) 6586 +))) 6587 + 6588 + 6589 + 6590 + 6591 + 6592 + 5390 5390 (% class="box" lang="en-US" style="text-align: center;" %) 5391 5391 ((( 5392 5392 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **