Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/08/20 11:29
<
>
edited by Андрей Калиновский
on 2024/11/22 13:26
on 2024/11/22 13:26
edited by Андрей Калиновский
on 2025/07/29 15:51
on 2025/07/29 15:51
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,9 +1,28 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 -**Содержание страницы:**\ 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 4 4 ))) 5 5 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 6 6 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 20 +**Содержание страницы:** 21 +))) 22 + 23 +{{toc/}} 24 + 25 + 7 7 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 8 9 9 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -104,29 +104,41 @@ 104 104 Запрос должен содержать данные параметра "**agentId**" 105 105 106 106 (% style="color:#000000" %)Ответ: 126 + 127 +((( 107 107 { 108 - "agentId": "", (%%) 109 - "parentId": "", 110 - "parentName": "string", 111 - "name": "string", 112 - "fullName": "string", 113 - "agentInfoType": 0, 114 - "isForeign": true/false, 115 - "district": "string", 116 - "region": "string", 117 - "city": "string", 118 - "inn": "string", 119 - "kpp": "string", 120 - "address": "string", 121 - "addressFact": "string", 122 - "email": "string", 123 - "director": "string", 124 - "bankName": "string", 125 - "bankBIK": "string", 126 - "bankRS": "string", 127 - "bankKS": "string" 128 - } 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 +))) 129 129 160 + 130 130 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 131 131 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 132 132 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -256,28 +256,6 @@ 256 256 "bankKS": "string" ~/~/ корр. счёт 257 257 } 258 258 259 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 260 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 261 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 262 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 263 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 264 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 265 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 266 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 267 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 268 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 269 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 270 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 271 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 272 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 273 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 274 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 275 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 276 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 277 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 278 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 279 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 280 - 281 281 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 282 282 283 283 (% class="box warningmessage" %) ... ... @@ -423,7 +423,7 @@ 423 423 [ 424 424 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 425 425 ], 426 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 427 427 } 428 428 { 429 429 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -735,6 +735,11 @@ 735 735 (% style="text-align:left" %) 736 736 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 737 737 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 751 + 738 738 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 739 739 740 740 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -846,7 +846,7 @@ 846 846 { 847 847 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 848 848 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 849 - "deleted": true,863 + "deleted": false, 850 850 "extId": "string", 851 851 "name": "string", 852 852 "picture": "string", ... ... @@ -865,7 +865,7 @@ 865 865 { 866 866 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 867 867 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 868 - "deleted": true,882 + "deleted": false, 869 869 "extId": "string", 870 870 "name": "string", 871 871 "picture": "string", ... ... @@ -899,7 +899,7 @@ 899 899 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 900 900 ))) 901 901 902 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 903 903 904 904 (% style="color:#000000" %)Метод запроса: **PUT** 905 905 ... ... @@ -966,7 +966,7 @@ 966 966 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 967 967 ))) 968 968 969 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 970 970 971 971 (% style="color:#000000" %)Метод запроса: **DELETE** 972 972 ... ... @@ -1007,6 +1007,17 @@ 1007 1007 1008 1008 ((( 1009 1009 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 1010 1010 "vehicleId": "", ~/~/ ID объекта 1011 1011 "name": "", ~/~/ Имя объекта 1012 1012 "imei": "", ~/~/ IMEI объекта ... ... @@ -1101,6 +1101,7 @@ 1101 1101 ], 1102 1102 "showInTooltip": true, ~/~/ Отображать в подсказке 1103 1103 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 1104 1104 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1105 1105 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1106 1106 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1158,11 +1158,21 @@ 1158 1158 "date": "2023-05-22T09:57:39.562Z", 1159 1159 "description": "string", 1160 1160 "additionalInfo": "string" 1161 - }1162 - ]1187 + 1188 +((( 1163 1163 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1164 1164 ))) 1165 1165 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 1166 1166 (% style="text-align:left" %) 1167 1167 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1168 1168 ... ... @@ -1170,77 +1170,6 @@ 1170 1170 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1171 1171 1172 1172 1173 -== **Импортировать историю ТС (Асинхронный запрос)** == 1174 - 1175 -(% class="box successmessage" %) 1176 -((( 1177 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1178 -))) 1179 - 1180 -(% style="color:#000000" %)Метод запроса: **POST** 1181 - 1182 -(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1183 - 1184 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства 1185 - 1186 - 1187 -Ответ: 1188 - 1189 -{ 1190 - 1191 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1192 - 1193 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1194 - 1195 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1196 - 1197 - "Message": "string", ~/~/ Информация о выполнении запроса 1198 - 1199 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1200 - 1201 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1202 - 1203 - "Data": "string" ~/~/ Данные 1204 - 1205 -} 1206 - 1207 - 1208 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1209 - 1210 -(% class="box infomessage" %) 1211 -((( 1212 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1213 -))) 1214 - 1215 -(% style="color:#000000" %)Метод запроса: **GET** 1216 - 1217 -(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1218 - 1219 -(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса 1220 - 1221 - 1222 -Ответ: 1223 - 1224 -{ 1225 - 1226 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1227 - 1228 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1229 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1230 - 1231 - "Message": "string", ~/~/ Информация о выполнении запроса 1232 - 1233 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1234 - 1235 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1236 - 1237 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1238 - 1239 - "Data": "string" ~/~/ Данные 1240 - 1241 -} 1242 - 1243 - 1244 1244 == **Отправить команду на терминал** == 1245 1245 1246 1246 (% class="box successmessage" %) ... ... @@ -1251,13 +1251,15 @@ 1251 1251 Команда для отправки на тс. 1252 1252 1253 1253 { 1254 -"id": "", ~/~/идентификатор произвольногополя1255 -"command": "", ~/~/ Текст команды 1256 -"retries": "", ~/~/ Количество попыток 1257 -"idTemplate": "" ~/~/ ID шаблона команды 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1258 1258 } 1259 1259 1225 +В ответ получаем cmdid 1260 1260 1227 + 1261 1261 == **Получить ответ на отправленную на ТС команду** == 1262 1262 1263 1263 (% class="box infomessage" %) ... ... @@ -1265,13 +1265,13 @@ 1265 1265 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1266 1266 ))) 1267 1267 1268 -Идентификатор команды: cmd id1235 +Идентификатор команды: cmdId 1269 1269 1270 1270 Запрос от терминала на ответ команды 1271 1271 1272 1272 Пример ответ от терминала: 1273 1273 1274 -ID= "" ~/~/ идентификатор произвольного поля1241 +ID= "" ~/~/ идентификатор объекта 1275 1275 Soft="" ~/~/ версия софта 1276 1276 GPS=4 ~/~/ тип трекера 1277 1277 Time=11:05:43 28.06.24 ~/~/ время запроса ... ... @@ -1324,7 +1324,13 @@ 1324 1324 1325 1325 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1326 1326 1327 -(% style="color:#000000" %){(%%) 1294 +(% style="color:#000000" %){ 1295 + 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 1328 1328 "parentId": "" , ~/~/ ID клиента 1329 1329 "name": "" , ~/~/ имя ТС 1330 1330 "imei": "" , ~/~/ IMEI ... ... @@ -1417,6 +1417,7 @@ 1417 1417 ], 1418 1418 "showInTooltip": true, ~/~/ Отображать в подсказке 1419 1419 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1420 1420 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1421 1421 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1422 1422 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1466,10 +1466,19 @@ 1466 1466 "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1467 1467 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1468 1468 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1469 - } 1470 - ] 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1471 1471 } 1453 +))) 1472 1472 1455 + 1473 1473 (% style="color:#000000" %)Ответ: 1474 1474 1475 1475 ... ... @@ -1578,6 +1578,7 @@ 1578 1578 ], 1579 1579 "showInTooltip": true, ~/~/ Отображение в подсказке 1580 1580 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1581 1581 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1582 1582 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1583 1583 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -1614,7 +1614,7 @@ 1614 1614 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1615 1615 } 1616 1616 ], 1617 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 -ByMotohoursSensor, 2 -ByRelativeMotohoursSensor1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1618 1618 } 1619 1619 ))) 1620 1620 ))) ... ... @@ -1626,6 +1626,7 @@ 1626 1626 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1627 1627 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1628 1628 1613 + 1629 1629 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1630 1630 1631 1631 (% class="box infomessage" %) ... ... @@ -1771,7 +1771,6 @@ 1771 1771 "stage": "", ~/~/ Состояние 1772 1772 (% style="color:#000000" %) } 1773 1773 1774 -== == 1775 1775 1776 1776 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1777 1777 ... ... @@ -1848,9 +1848,19 @@ 1848 1848 1849 1849 "drivers": [ ~/~/ Водители 1850 1850 { 1851 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1852 - "isDefault": true 1853 - } 1835 + 1836 +((( 1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1838 + "inputNumber": 0, ~/~/ № входа. 1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1840 + "comment": "string", ~/~/ Комментарий. 1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1845 +))) 1846 + 1847 + } 1854 1854 ], 1855 1855 "commandTemplates": [ ~/~/ Шаблон команды 1856 1856 { ... ... @@ -1886,6 +1886,11 @@ 1886 1886 ], 1887 1887 "showInTooltip": true, ~/~/ Отображать в подсказке 1888 1888 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1883 + 1884 +((( 1885 + "color": "string",** ~/~/ **Цвет датчика 1886 +))) 1887 + 1889 1889 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1890 1890 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1891 1891 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1932,7 +1932,12 @@ 1932 1932 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1933 1933 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1934 1934 } 1935 - ] 1934 + 1935 +((( 1936 + ], 1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1938 +))) 1939 + 1936 1936 } 1937 1937 1938 1938 ... ... @@ -2070,6 +2070,11 @@ 2070 2070 ], 2071 2071 "showInTooltip": true, ~/~/ Отображение в подсказке 2072 2072 "showLastValid": true, ~/~/ Отображать последнее валидное значение 2077 + 2078 +((( 2079 + "color": "string", ~/~/ цвет уведомлений 2080 +))) 2081 + 2073 2073 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2074 2074 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2075 2075 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -2363,7 +2363,7 @@ 2363 2363 Тело запроса: 2364 2364 2365 2365 { 2366 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2367 2367 "vehicleIds": [0], ~/~/ Список ID объектов 2368 2368 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2369 2369 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2386,6 +2386,8 @@ 2386 2386 "motohours": 0, ~/~/ Моточасы за период, секунды 2387 2387 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2388 2388 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2398 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2399 + 2389 2389 } 2390 2390 ] 2391 2391 } ... ... @@ -2408,7 +2408,7 @@ 2408 2408 Тело запроса: 2409 2409 2410 2410 { 2411 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2422 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2412 2412 "vehicleIds": [0], ~/~/ Список ID объектов 2413 2413 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2414 2414 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2427,8 +2427,12 @@ 2427 2427 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2428 2428 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2429 2429 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2430 2430 "fuelConsumption": 0, ~/~/ Расход топлива 2431 2431 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2446 + 2432 2432 } 2433 2433 ] 2434 2434 } ... ... @@ -2474,7 +2474,8 @@ 2474 2474 "model": "string", ~/~/ Модель объекта 2475 2475 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2476 2476 { 2477 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2492 + "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 2493 + 2478 2478 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2479 2479 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2480 2480 "valueFuel": 0, ~/~/ Количество ... ... @@ -2553,26 +2553,50 @@ 2553 2553 В заголовках запроса: X-Auth: Токен авторизации 2554 2554 2555 2555 2556 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2572 +В массиве указываем id объектов через запятую 2557 2557 2558 2558 Ответ: 2575 + 2576 +[ 2559 2559 { 2560 - "vehicleId": 0, ~/~/Идентификатор объекта.2561 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2562 - "vehicleNumber": " string",~/~/Номер объекта.2563 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2564 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2565 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2566 - "speed": 0,~/~/Скорость объекта.2567 - "course": 0,~/~/Курс движения [0;360]2568 - "latitude": 0,~/~/Широта [-90°;90°].2569 - "longitude": 0,~/~/Долгота [-180°;180°]. 2570 - "address": " string",~/~/Адрес.2571 - "geozones": [ ~/~/Сведения по геозонам. 2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2584 + "speed": 31, ~/~/ Скорость объекта 2585 + "course": 116, ~/~/ Курс движения [0;360] 2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2589 + "geozones": [ ~/~/ Сведения по геозонам. 2572 2572 { 2573 - "id": 0, 2574 - "name": "string" 2591 + "id": 10225647, ~/~/ ID Геозоны 2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2593 + }, 2594 + { 2595 + "id": 10282875, ~/~/ ID Геозоны 2596 + "name": "Ё2" ~/~/ Наименование геозоны 2597 + }, 2598 + { 2599 + "id": 10226240, ~/~/ ID Геозоны 2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2601 + }, 2602 + { 2603 + "id": 9747869, ~/~/ ID Геозоны 2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2605 + }, 2606 + { 2607 + "id": 10221123, ~/~/ ID Геозоны 2608 + "name": "53r" ~/~/ Наименование геозоны 2609 + }, 2610 + { 2611 + "id": 10197638, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2575 2575 } 2614 + ] 2615 + } 2576 2576 2577 2577 2578 2578 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2703,6 +2703,35 @@ 2703 2703 } 2704 2704 ] 2705 2705 2746 + 2747 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2748 + 2749 +(% class="box successmessage" %) 2750 +((( 2751 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2752 +))) 2753 + 2754 +(% style="color:#000000" %)Метод запроса: **PUT** 2755 + 2756 +Пример запроса: 2757 + 2758 +((( 2759 +{ 2760 + "id": 0, ~/~/ Идентификатор объекта геозоны 2761 + "name": "string", ~/~/ Наименование объекта геозоны 2762 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2763 + "description": "string", ~/~/ Описание объекта геозоны 2764 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2765 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2766 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2767 +} 2768 +))) 2769 + 2770 + 2771 +Пример ответа: 2772 + 2773 +200 ~/~/ Success 2774 + 2706 2706 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2707 2707 2708 2708 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2734,7 +2734,7 @@ 2734 2734 "id": 0, ~/~/ ID уведомления 2735 2735 "name": "string", ~/~/ Название уведомления 2736 2736 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2737 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2806 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2738 2738 "userId": "", ~/~/ Пользователь, создавший уведомление 2739 2739 "parentId": "", ~/~/ Идентификатор клиента 2740 2740 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2741,6 +2741,155 @@ 2741 2741 } 2742 2742 ] 2743 2743 2813 + 2814 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2815 + 2816 +(% class="box infomessage" %) 2817 +((( 2818 +**POST /api/v3/notifications** 2819 +))) 2820 + 2821 +Метод запроса **POST** 2822 + 2823 +(% style="text-align: left;" %) 2824 +(% style="color:#000000" %)Пример запроса 2825 + 2826 +((( 2827 +{ 2828 + "id": 0, ~/~/ ID правила 2829 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2830 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2832 + "name": "string", ~/~/ Имя правила 2833 + "active": true, ~/~/ Активность правила 2834 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2835 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2836 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2837 + ], 2838 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2839 + 0 2840 + ], 2841 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2842 + 0 2843 + ], 2844 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2845 + 0 2846 + ], 2847 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2848 + "additionalProp1": "string", 2849 + "additionalProp2": "string", 2850 + "additionalProp3": "string" 2851 + }, 2852 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2853 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2854 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2855 + ], 2856 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2857 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2858 + "string" 2859 + ], 2860 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2861 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2862 + { 2863 + "id": 0, ~/~/ Идентификатор участника чата. 2864 + "info": "string" ~/~/ Дополнительные сведения. 2865 + } 2866 + ], 2867 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2868 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2869 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2870 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2871 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2872 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2873 + "timezone": 0, ~/~/ часовой пояс 2874 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2875 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2876 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2877 + { 2878 + "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 - Срок действия правила истек 2879 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2880 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2881 + "additionalProp1": "string", 2882 + "additionalProp2": "string", 2883 + "additionalProp3": "string" 2884 + } 2885 + } 2886 + ] 2887 +} 2888 +))) 2889 + 2890 +((( 2891 + 2892 +))) 2893 + 2894 +((( 2895 + 2896 +))) 2897 + 2898 +Ответ: 2899 + 2900 +{ 2901 + "id": 0, ~/~/ ID правила 2902 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2903 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2904 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2905 + "name": "string", ~/~/ Имя правила 2906 + "active": true, ~/~/ Активность правила 2907 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2908 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2909 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2910 + ], 2911 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2912 + 0 2913 + ], 2914 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2915 + 0 2916 + ], 2917 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2918 + 0 2919 + ], 2920 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2921 + "additionalProp1": "string", 2922 + "additionalProp2": "string", 2923 + "additionalProp3": "string" 2924 + }, 2925 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2926 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2927 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2928 + ], 2929 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2930 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2931 + "string" 2932 + ], 2933 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2934 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2935 + { 2936 + "id": 0, ~/~/ Идентификатор участника чата. 2937 + "info": "string" ~/~/ Дополнительные сведения. 2938 + } 2939 + ], 2940 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2941 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2942 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2943 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2944 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2945 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2946 + "timezone": 0, ~/~/ часовой пояс 2947 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2948 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2949 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2950 + { 2951 + "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 - Срок действия правила истек 2952 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2953 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2954 + "additionalProp1": "string", 2955 + "additionalProp2": "string", 2956 + "additionalProp3": "string" 2957 + } 2958 + } 2959 + ] 2960 +} 2961 + 2744 2744 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2745 2745 2746 2746 (% class="box infomessage" %) ... ... @@ -3958,16 +3958,12 @@ 3958 3958 Тело запроса: 3959 3959 3960 3960 { 3961 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3962 - "Balance": 0 4179 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4180 + "Balance": 0 ~/~/ Значение баланса. 3963 3963 } 3964 3964 3965 3965 Ответ: Success 3966 3966 3967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3968 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3969 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3970 - 3971 3971 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3972 3972 3973 3973 (% class="box warningmessage" %) ... ... @@ -3979,16 +3979,29 @@ 3979 3979 3980 3980 Тело запроса: 3981 3981 4196 +((( 3982 3982 { 3983 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",3984 - " Balance": 04198 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4199 + "amount": 0 ~/~/ Сумма пополнения баланса 3985 3985 } 4201 +))) 3986 3986 4203 +((( 4204 + 4205 +))) 4206 + 3987 3987 Ответ: Success 3988 3988 3989 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3990 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3991 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4209 +((( 4210 +{ 4211 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4212 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4213 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4214 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4215 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4216 + "Description": "string" ~/~/ Описание корректировки. 4217 +} 4218 +))) 3992 3992 3993 3993 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3994 3994 ... ... @@ -4001,16 +4001,25 @@ 4001 4001 4002 4002 Тело запроса: 4003 4003 4231 +((( 4004 4004 { 4005 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4006 - " Balance": 04233 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4234 + "amount": 0 ~/~/ Сумма списания с баланса 4007 4007 } 4236 +))) 4008 4008 4009 4009 Ответ: Success 4010 4010 4011 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4012 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4013 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4240 +((( 4241 +{ 4242 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4244 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4245 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4246 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4247 + "Description": "string" ~/~/ Описание корректировки 4248 +} 4249 +))) 4014 4014 4015 4015 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4016 4016 ... ... @@ -4021,28 +4021,35 @@ 4021 4021 4022 4022 Тело запроса: 4023 4023 4260 +((( 4024 4024 { 4025 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4026 - "CalculationType": 0, 4027 - "PermissibleBalance": 0, 4028 - "DefermentDays": 0, 4029 - "SendUiNotifications": true, 4030 - "SendEmailNotifications": true, 4031 - "IsPrivate": true, 4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4263 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4264 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4265 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4266 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4267 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4032 4032 } 4269 +))) 4033 4033 4271 +((( 4272 + 4273 +))) 4274 + 4034 4034 Ответ: Success 4035 4035 4036 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4037 -|ClientId|Идентификатор клиента 4038 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4039 -|PermissibleBalance|Допустимый баланс 4040 -|DefermentDays|((( 4041 -Отсрочка, количество дней 4277 +((( 4278 +{ 4279 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4280 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4287 +} 4042 4042 ))) 4043 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4044 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4045 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4046 4046 4047 4047 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4048 4048 ... ... @@ -4054,35 +4054,68 @@ 4054 4054 Тело запроса: 4055 4055 4056 4056 { 4057 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4058 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4059 - "Features": [ 4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4301 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4302 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4060 4060 { 4061 - "Feature": "string", 4062 - "IsEnabled": true, 4063 - "IsFactual": true, 4064 - "Limit": 0, 4065 - "Price": 0, 4066 - "DebitDate": "2023-10-18T13:26:58.987Z", 4067 - "PeriodValue": 0, 4068 - "PeriodType": 0 4304 + "Feature": "string", ~/~/ Код услуги. 4305 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4306 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4307 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4308 + "Price": 0, ~/~/ Цена за единицу. 4309 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4310 + "PeriodValue": 0, ~/~/ Значение периода. 4311 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4069 4069 } 4070 4070 ] 4071 4071 } 4072 4072 4316 + 4073 4073 Ответ: Success 4074 4074 4075 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4076 -|ClientId|Идентификатор клиента 4077 -|PlanId|Идентификатор тарифного плана 4078 -|Feature|Код услуги 4079 -|IsEnabled|Признак, определяющий активирована ли услуга 4080 -|IsFactual|Признак, определяющий расчёт по факту 4081 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4082 -|Price|Цена за единицу. 4083 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4084 -|PeriodValue|Значение периода. 4085 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4319 +((( 4320 +{ 4321 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4322 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4323 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4324 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4325 + "Name": "string", ~/~/ Наименование. 4326 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4327 + "Constraint": { ~/~/ Ограничения по тарифу 4328 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4329 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4330 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4331 + }, 4332 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4333 + { 4334 + "Feature": "string", ~/~/Код услуги. 4335 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4336 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4337 + "Price": 0, ~/~/ Цена за единицу. 4338 + "PeriodValue": 0, ~/~/ Значение периода. 4339 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4340 + } 4341 + ], 4342 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4343 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4344 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4345 + }, 4346 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4347 + { 4348 + "Feature": "string", ~/~/ Код услуги. 4349 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4350 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4351 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4352 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4353 + "Price": 0, ~/~/ Цена за единицу. 4354 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4355 + "PeriodValue": 0, ~/~/ Значение периода. 4356 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4357 + "Quantity": 0 ~/~/ Количество использования услуги. 4358 + } 4359 + ] 4360 +} 4361 +))) 4086 4086 4087 4087 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4088 4088 ... ... @@ -4187,6 +4187,43 @@ 4187 4187 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4188 4188 |msgCount|Кол-во обработанных сообщений всего 4189 4189 4466 +== **Импортировать историю ТС (Асинхронный запрос)** == 4467 + 4468 +(% class="box successmessage" %) 4469 +((( 4470 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 +))) 4472 + 4473 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4474 + 4475 +Метод запроса: **POST** 4476 + 4477 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4478 + 4479 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4480 + 4481 + 4482 +Ответ: 4483 + 4484 +{ 4485 + 4486 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4487 + 4488 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4489 + 4490 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4491 + 4492 + "Message": "string", ~/~/ Информация о выполнении запроса 4493 + 4494 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4495 + 4496 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4497 + 4498 + "Data": "string" ~/~/ Данные 4499 + 4500 +} 4501 + 4502 + 4190 4190 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4191 4191 4192 4192 (% class="box infomessage" %) ... ... @@ -4204,10 +4204,59 @@ 4204 4204 "message": "string" 4205 4205 } 4206 4206 4207 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4208 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4209 -|progress|Guid ТС 4520 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4521 +**Параметр** 4522 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4523 +**Описание** 4524 +))) 4525 +|((( 4526 +activity 4527 +)))|((( 4528 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4529 +))) 4530 +|((( 4531 +progress 4532 +)))|((( 4533 +Guid ТС 4534 +))) 4210 4210 4536 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4537 + 4538 +(% class="box infomessage" %) 4539 +((( 4540 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 +))) 4542 + 4543 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4544 + 4545 +Метод запроса: **GET** 4546 + 4547 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4548 + 4549 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4550 + 4551 + 4552 +Ответ: 4553 + 4554 +{ 4555 + 4556 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4557 + 4558 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4559 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4560 + 4561 + "Message": "string", ~/~/ Информация о выполнении запроса 4562 + 4563 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4564 + 4565 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4566 + 4567 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4568 + 4569 + "Data": "string" ~/~/ Данные 4570 + 4571 +} 4572 + 4211 4211 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4212 4212 4213 4213 (% class="box infomessage" %) ... ... @@ -4366,7 +4366,7 @@ 4366 4366 4367 4367 (% class="box infomessage" %) 4368 4368 ((( 4369 -POST /api/v3/fuelcards/transactions 4731 +**POST /api/v3/fuelcards/transactions** 4370 4370 ))) 4371 4371 4372 4372 Метод запроса: POST ... ... @@ -4377,34 +4377,59 @@ 4377 4377 Параметры в теле запроса (JSON): 4378 4378 4379 4379 { 4380 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4381 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4742 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4743 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4382 4382 "ids": [ 4383 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ гуиды4745 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4384 4384 ], 4385 - "timezone": 0 ~/~/ Таймзона4747 + "timezone": 0 ~/~/ Часовой пояс 4386 4386 } 4387 4387 4388 4388 4389 4389 Ответ: 4390 4390 { 4391 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4392 - "driver": "string", ~/~/Водители, привязанные к ТК 4393 - "object": "string", ~/~/Наименование ТС 4394 - "amount": 0, ~/~/Количество топлива 4395 - "amountDut": 0, ~/~/Количество по ДУТ 4396 - "amountDiff": 0, ~/~/Разница, л 4397 - "amountDiffPerc": 0, ~/~/Разница, % 4398 - "summa": 0, ~/~/Стоимость, руб 4399 - "serviceName": "string", ~/~/Тип топлива 4400 - "price": 0, ~/~/Цена за литр, руб 4401 - "cardName": "string", ~/~/Наименование ТК 4402 - "cardNum": "string", ~/~/Номер ТК 4403 - "operator": "string", ~/~/Оператор ТК 4404 - "address": "string" ~/~/Адрес АЗС 4753 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4754 + "driver": "string", ~/~/ Водители, привязанные к ТК 4755 + "object": "string", ~/~/ Наименование ТС 4756 + "amount": 0, ~/~/ Количество топлива 4757 + "amountDut": 0, ~/~/ Количество по ДУТ 4758 + "amountDiff": 0, ~/~/ Разница, л 4759 + "amountDiffPerc": 0, ~/~/ Разница, % 4760 + "summa": 0, ~/~/ Стоимость, руб 4761 + "serviceName": "string", ~/~/ Тип топлива 4762 + "price": 0, ~/~/ Цена за литр, руб 4763 + "cardName": "string", ~/~/ Наименование ТК 4764 + "cardNum": "string", ~/~/ Номер ТК 4765 + "operator": "string", ~/~/ Оператор ТК 4766 + "address": "string" ~/~/ Адрес АЗС 4405 4405 } 4406 4406 4769 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4407 4407 4771 +(% class="box infomessage" %) 4772 +((( 4773 +**GET /api/v3/fuelcards** 4774 +))) 4775 + 4776 +Метод запроса: GET 4777 + 4778 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4779 + 4780 +Ответ: 4781 + 4782 +[ 4783 + { 4784 + "Name": "string", ~/~/ Определяет наименование карты. 4785 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4786 + "Number": "string", ~/~/ Определяет № карты. 4787 + "Enabled": true, ~/~/ Определяет признак активности карты. 4788 + "Description": "string", ~/~/ Определяет описание карты. 4789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4790 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4791 + "deleted": true ~/~/ Признак удаления 4792 + } 4793 +] 4794 + 4408 4408 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4409 4409 4410 4410 ... ... @@ -4415,28 +4415,28 @@ 4415 4415 **GET ** **/api/v3/retranslations/{id}** 4416 4416 ))) 4417 4417 4418 -Идентификатор запроса:ID4805 +id - Идентификатор ретранслятора 4419 4419 4420 4420 4421 4421 Пример ответа: 4422 4422 4423 4423 { 4424 -"description": "", ~/~/ Определяетописание4425 -"subscriberId": "", ~/~/ Подписчик4426 -"protocolType": 0, ~/~/ Тип протокола 4427 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен4428 -"address": "string", ~/~/ Адрес события4429 -"objects": [ ~/~/Объекты для ретрансляции 4811 +"description": "", ~/~/ Поле описания ретранслятора 4812 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4813 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4814 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4815 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4816 +"objects": [ ~/~/ Объекты для ретрансляции 4430 4430 { 4431 4431 "id": "", ~/~/ Идентификатор объекта ретрансляции 4432 4432 "name": "", ~/~/ Наименование объекта ретрансляции 4433 -"imei": "", ~/~/ IMEI объекта 4434 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4820 +"imei": "", ~/~/ IMEI объекта ретрансляции 4821 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4435 4435 } 4436 4436 ], 4437 -"id": "", ~/~/ идентификаторпользователя4438 -"parentId": "", ~/~/ Guidродителя4439 -"deleted": "" ~/~/ Признак удаления ,Включен,true - включен, false - отключен4824 +"id": "", ~/~/ Идентификатор ретранслятора 4825 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4826 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4440 4440 } 4441 4441 4442 4442 ... ... @@ -4447,7 +4447,7 @@ 4447 4447 **DELETE** **/api/v3/retranslations/{id}** 4448 4448 ))) 4449 4449 4450 - Параметрзапроса:ID4837 +id - Идентификатор ретранслятора 4451 4451 4452 4452 4453 4453 == **Создание ретранслятора** == ... ... @@ -4460,16 +4460,16 @@ 4460 4460 Запрос: 4461 4461 4462 4462 { 4463 -"description": "", ~/~/ Описание4464 -"subscriberId": "", ~/~/ Подписчик4465 -"protocolType": 0, ~/~/ Тип протокола 4466 -"address": "", ~/~/ Адрес р етрансляции4467 -"isEnabled": "", ~/~/ признак,Включен, true - включен, false - отключен4850 +"description": "", ~/~/ Поле описания ретранслятора 4851 +"subscriberId": "", ~/~/ Идентификатор подписчика 4852 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4853 +"address": "", ~/~/ Адрес и порт принимающего сервера 4854 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4468 4468 "objects": [ ~/~/Объекты для ретрансляции 4469 4469 { 4470 -"id": "", ~/~/ идентификаторпользователя4471 -"imei": "", ~/~/IMEI объекта 4472 -"isEnabled": "" ~/~/ признак,Включен,true - включен, false - отключен4857 +"id": "", ~/~/ Идентификатор ретранслятора 4858 +"imei": "", ~/~/ IMEI объекта ретрансляции 4859 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4473 4473 } 4474 4474 ] 4475 4475 } ... ... @@ -4478,22 +4478,22 @@ 4478 4478 Ответ: 4479 4479 4480 4480 { 4481 -"description": " string", ~/~/Определяетописание4482 -"subscriberId": "", ~/~/ идентификаторзапроса4483 -"protocolType": 0, 4484 -"isEnabled": "", ~/~/признак,Включен,true - включен, false - отключен4485 -"address": "", ~/~/ Адрес события4486 -"objects": [ ~/~/Объекты для ретрансляции 4868 +"description": "", ~/~/ Поле описания ретранслятора 4869 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4870 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4871 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4872 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4873 +"objects": [ ~/~/ Объекты для ретрансляции 4487 4487 { 4488 -"id": "", идентификаторпользователя4489 -"name": "string", званиеуведомления4490 -"imei": " string", ~/~/IMEI объекта4491 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4875 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4876 +"name": "string", ~/~/ Наименование объекта ретрансляции 4877 +"imei": "", ~/~/ IMEI объекта ретрансляции 4878 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4492 4492 } 4493 - ], 4494 -"id": "", ~/~/ идентификаторпользователя4495 -"parentId": "", ~/~/ Guid идентификатор родителя4496 -"deleted": true ~/~/ Признак удаления 4880 + ], 4881 +"id": "", ~/~/ Идентификатор ретранслятора 4882 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4883 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4497 4497 } 4498 4498 4499 4499 ... ... @@ -4507,18 +4507,18 @@ 4507 4507 Пример запроса: 4508 4508 4509 4509 { 4510 -"id": "", ~/~/ идентификаторпользователя4511 -"description": "string", ~/~/ Определяетописание4512 -"subscriberId": "", ~/~/ идентификаторзапроса4513 -"protocolType": 0, ~/~/ Тип протокола 4514 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4515 -"address": "string", ~/~/ Адрес события4516 -"objects": ~/~/Объекты для ретрансляции 4897 +"id": "", ~/~/ Идентификатор ретранслятора 4898 +"description": "string", ~/~/ Поле описания ретранслятора 4899 +"subscriberId": "", ~/~/ Идентификатор подписчика 4900 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4901 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4902 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4903 +"objects": ~/~/ Объекты для ретрансляции 4517 4517 [ 4518 4518 { 4519 -"id": "", ~/~/ идентификаторпользователя4520 -"imei": "", ~/~/IMEI объекта 4521 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4906 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4907 +"imei": "", ~/~/ IMEI объекта ретрансляции 4908 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4522 4522 } 4523 4523 ] 4524 4524 } ... ... @@ -4527,22 +4527,22 @@ 4527 4527 Пример ответа: 4528 4528 4529 4529 { 4530 -"description": "", ~/~/ Определяетописание4531 -"subscriberId": "", ~/~/ идентификаторзапроса4532 -"protocolType": 0, ~/~/ Тип протокола 4533 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4534 -"address": "string", ~/~/ Адрес события4535 -"objects": [ ~/~/Объекты для ретрансляции 4917 +"description": "", ~/~/ Поле описания ретранслятора 4918 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4919 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4920 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4921 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4922 +"objects": [ ~/~/ Объекты для ретрансляции 4536 4536 { 4537 -"id": "", ~/~/ идентификаторпользователя4538 -"name": "string", ~/~/ На званиеуведомления4539 -"imei": "", ~/~/IMEI объекта 4540 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4924 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4925 +"name": "string", ~/~/ Наименование объекта ретрансляции 4926 +"imei": "", ~/~/ IMEI объекта ретрансляции 4927 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4541 4541 } 4542 4542 ], 4543 -"id": "", ~/~/ идентификаторпользователя4544 -"parentId": "", ~/~/ Guid идентификатор родителя4545 -"deleted": true ~/~/ Признак удаления 4930 +"id": "", ~/~/ Идентификатор ретранслятора 4931 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4932 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4546 4546 } 4547 4547 4548 4548 ... ... @@ -4556,9 +4556,9 @@ 4556 4556 Пример запроса: 4557 4557 4558 4558 { 4559 -"id": "", ~/~/ идентификаторпользователя4560 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4561 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4946 +"id": "", ~/~/ Идентификатор ретранслятора 4947 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4948 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4562 4562 } 4563 4563 4564 4564 Ответ: ... ... @@ -4565,14 +4565,14 @@ 4565 4565 4566 4566 [ 4567 4567 { 4568 -"description": "", ~/~/ Определяетописание4569 -"subscriberId": "", ~/~/ идентификаторзапроса4570 -"protocolType": 0, ~/~/ Тип протокола 4571 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4572 -"address": "string", ~/~/ Адрес события4573 -"id": "", ~/~/ идентификаторпользователя4574 -"parentId": "", ~/~/ Guid идентификатор родителя4575 -"deleted": true ~/~/ Признак удаления 4955 +"description": "", ~/~/ Поле описания ретранслятора 4956 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4957 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4958 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4959 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4960 +"id": "", ~/~/ Идентификатор ретранслятора 4961 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4962 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4576 4576 } 4577 4577 ] 4578 4578 ... ... @@ -4583,7 +4583,7 @@ 4583 4583 4584 4584 (% class="box infomessage" %) 4585 4585 ((( 4586 -POST **/api/v3/Reports/harvesterUnloading**4973 +**POST /api/v3/Reports/harvesterUnloading** 4587 4587 ))) 4588 4588 4589 4589 Пример запроса: ... ... @@ -4655,7 +4655,743 @@ 4655 4655 ] 4656 4656 4657 4657 5045 +== **Отчет трек-датчики** == 5046 + 5047 +(% class="box infomessage" %) 5048 +((( 5049 +**POST /api/v3/Reports/sensorsWorks** 5050 +))) 5051 + 5052 +**Пример запроса:** 5053 + 5054 +{ 5055 + "vehicleIds": [ ~/~/ Список ID объектов 5056 + 0 5057 + ], 5058 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5059 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5060 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5061 +} 5062 + 5063 +**Пример ответа:** 5064 + 5065 +((( 5066 +{ 5067 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5068 + { 5069 + "vehicleId": 0, ~/~/ Идентификатор ТС 5070 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5071 + { 5072 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5073 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5074 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5075 + "name": "string", ~/~/ Наименование оборудования. 5076 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5077 + "totalMileage": 0, ~/~/ Общий пробег. 5078 + "avgSpeed": 0 ~/~/ Средняя скорость. 5079 + } 5080 + ] 5081 + } 5082 + ] 5083 +} 5084 + 5085 + 5086 +== **Превышение скорости** == 5087 + 5088 +(% class="box infomessage" %) 5089 +((( 5090 +**POST /api/v3/Reports/overSpeedDuration** 5091 +))) 5092 + 5093 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5094 + 5095 +Пример запроса: 5096 + 5097 +((( 5098 +{ 5099 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5100 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5101 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5102 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5103 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5104 +} 5105 +))) 5106 + 5107 +((( 5108 + 5109 +))) 5110 + 5111 +((( 5112 +Пример ответа: 5113 +))) 5114 + 5115 +((( 5116 +((( 5117 +[ 5118 + { 5119 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5120 + "duration": 0, ~/~/ Продолжительность события в секундах 5121 + "maxSpeed": 0, ~/~/ Максимальная скорость 5122 + "speedLimit": 0 ~/~/ Ограничение скорости 5123 + } 5124 +] 5125 +))) 5126 +))) 5127 +))) 5128 + 5129 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5130 + 5131 + 5132 +== **Запрос списка полей** == 5133 + 5134 +(% class="box successmessage" %) 5135 +((( 5136 +**POST /api/v3/agroLands/find** 5137 +))) 5138 + 5139 +Пример запроса: 5140 + 5141 +((( 5142 +((( 5143 +((( 5144 +{ 5145 + "year": 0, ~/~/ Фильтр по году 5146 + "name": "string", ~/~/ Фильтр по названию 5147 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5148 +} 5149 +))) 5150 +))) 5151 + 5152 + 5153 +))) 5154 + 5155 +Пример ответа: 5156 + 5157 +((( 5158 +[ 5159 + { 5160 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5161 + "year": 0, ~/~/ Год поля 5162 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5163 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5164 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5165 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5166 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5167 + "counts": { ~/~/ Счётчики с/х поля 5168 + "fieldOperations": 0, ~/~/ Количество операций на поле 5169 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5170 + "facts": 0 ~/~/ Счётчик факта 5171 + }, 5172 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5173 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5174 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5175 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5176 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5177 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5178 + "planComment": "string", ~/~/ Комментарий к полю 5179 + "productivity": 0, ~/~/ Урожайность. 5180 + "id": 0, ~/~/ Идентификатор объекта геозоны 5181 + "name": "string", ~/~/ Название объекта геозоны 5182 + "type": 0, ~/~/ Тип объекта геозоны 5183 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5184 + "fname": "string", ~/~/ Имя файла 5185 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5186 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5187 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5188 + "description": "string", ~/~/ Описание объекта геозоны 5189 + "area": 0, ~/~/ Площадь, м2 5190 + "perimetr": 0, ~/~/ Периметр, м 5191 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5192 + } 5193 +] 5194 + 5195 + 5196 +== **Создание нового поля ** == 5197 + 5198 +(% class="box successmessage" %) 5199 +((( 5200 +**POST /api/v3/agroLands** 5201 +))) 5202 + 5203 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5204 +X-agent - ID клиента 5205 + 5206 +Пример запроса: 5207 + 5208 +((( 5209 +{ 5210 + "extId": "string", 5211 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5212 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5213 + "display": "string", ~/~/ Настройки отображения 5214 + "year": 0, ~/~/ Год поля 5215 + "name": "string", ~/~/ Наименование 5216 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5217 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5218 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5219 + "planComment": "string", ~/~/ Комментарий к полю 5220 + "cropRotations": [ ~/~/ Данные по севообороту 5221 + { 5222 + "landId": 0, ~/~/ ID поля 5223 + "landName": "string", ~/~/ Название поля 5224 + "year": 0, ~/~/ Год урожая 5225 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5226 + "cultureName": "string", ~/~/ Название культуры 5227 + "productivity": 0, ~/~/ Урожайность 5228 + "area": 0, ~/~/ Площадь поля, Га 5229 + "total": 0, ~/~/ Валовый сбор 5230 + "productivityFact": 0, ~/~/ Фактическая урожайность 5231 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5232 + "totalFact": 0, ~/~/ Фактический валовый сбор 5233 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5234 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5235 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5236 + "isyearplan": true, ~/~/ Годовой план 5237 + "comment": "string" ~/~/ Комментарий 5238 + } 5239 + ] 5240 +} 5241 +))) 5242 + 5243 +((( 5244 + 5245 +))) 5246 + 5247 +Пример ответа: 5248 + 5249 +((( 5250 +((( 5251 +{ 5252 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5253 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5254 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5255 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5256 + "cropRotations": [ ~/~/ Данные по севообороту 5257 + { 5258 + "landId": 0, ~/~/ ID поля 5259 + "landName": "string", ~/~/ Название поля 5260 + "year": 0, ~/~/ Год урожая 5261 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5262 + "cultureName": "string", ~/~/ Название культуры 5263 + "productivity": 0, ~/~/ Урожайность 5264 + "area": 0, ~/~/ Площадь поля, Га. 5265 + "total": 0, ~/~/ Валовый сбор 5266 + "productivityFact": 0, ~/~/ Фактическая урожайность 5267 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5268 + "totalFact": 0, ~/~/ Фактический валовый сбор 5269 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5270 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5271 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5272 + "isyearplan": true, ~/~/ годовой план 5273 + "comment": "string" ~/~/ Комментарий 5274 + } 5275 + ], 5276 + "cropVegetation": [ ~/~/ История вегетации поля 5277 + { 5278 + "values": [ ~/~/ Данные вегетации и состояния посева 5279 + { 5280 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5281 + "ndvi": 0 ~/~/ Индекс вегетации 5282 + } 5283 + ], 5284 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5285 + { 5286 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5287 + "type": "string", ~/~/ Тип 5288 + "pictureid": "string" ~/~/ Идентификатор ресурса 5289 + } 5290 + ], 5291 + "states": [ ~/~/ Ключевые даты развития поля 5292 + { 5293 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5294 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5295 + } 5296 + ] 5297 + } 5298 + ], 5299 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5300 + "counts": { 5301 + "fieldOperations": 0, ~/~/ Количество операций на поле 5302 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5303 + "facts": 0 ~/~/ Счётчик факта 5304 + }, 5305 + "planComment": "string", ~/~/ Комментарий к полю 5306 +))) 5307 + 5308 +((( 5309 + "productivity": 0, ~/~/ Урожайность. 5310 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5311 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5312 + "year": 0, ~/~/ Год поля 5313 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5314 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5315 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5316 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5317 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5318 + "id": 0, ~/~/ Идентификатор объекта геозоны 5319 + "name": "string", ~/~/ Название объекта геозоны 5320 + "type": 0, ~/~/ Тип объекта геозоны 5321 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5322 + "fname": "string", ~/~/ Имя файла 5323 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5324 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5325 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5326 + "description": "string", ~/~/ Описание объекта геозоны 5327 + "area": 0, ~/~/ Площадь, м2 5328 + "perimetr": 0, ~/~/ Периметр, м 5329 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5330 +} 5331 + 5332 + 5333 +))) 5334 +))) 5335 +))) 5336 + 5337 +== **Получение поля по id** == 5338 + 5339 +(% class="box infomessage" %) 5340 +((( 5341 +**GET /api/v3/agroLands/{id}** 5342 +))) 5343 + 5344 +Пример запроса: 5345 +id ~/~/ Идентификатор поля 5346 + 5347 +Пример ответа: 5348 + 5349 +((( 5350 +{ 5351 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5352 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5353 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5354 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5355 + "cropRotations": [ ~/~/ Данные по севообороту 5356 + { 5357 + "landId": 0, ~/~/ ID поля 5358 + "landName": "string", ~/~/ Название поля 5359 + "year": 0, ~/~/ Год урожая 5360 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5361 + "cultureName": "string", ~/~/ Название культуры 5362 + "productivity": 0, ~/~/ Урожайность 5363 + "area": 0, ~/~/ Площадь поля, Га 5364 + "total": 0, ~/~/ Валовый сбор 5365 + "productivityFact": 0, ~/~/ Фактическая урожайность 5366 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5367 + "totalFact": 0, ~/~/ Фактический валовый сбор 5368 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5369 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5370 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5371 + "isyearplan": true, ~/~/ План года 5372 + "comment": "string" ~/~/ Комментарий 5373 + } 5374 + ], 5375 + "cropVegetation": [ ~/~/ История вегетации поля 5376 + { 5377 + "values": [ ~/~/ Данные вегетации и состояния посева 5378 + { 5379 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5380 + "ndvi": 0 ~/~/ Индекс вегетации 5381 + } 5382 + ], 5383 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5384 + { 5385 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5386 + "type": "string", ~/~/ Тип 5387 + "pictureid": "string" ~/~/ Идентификатор ресурса 5388 + } 5389 + ], 5390 + "states": [ ~/~/ Ключевые даты развития поля 5391 + { 5392 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5393 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5394 + } 5395 + ] 5396 + } 5397 + ], 5398 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5399 + "counts": { 5400 + "fieldOperations": 0, ~/~/ Количество операций на поле 5401 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5402 + "facts": 0 ~/~/ Счётчик факта 5403 + }, 5404 + "planComment": "string", ~/~/ Комментарий к полю 5405 + "productivity": 0, ~/~/ Урожайность. 5406 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5407 +))) 5408 + 5409 +((( 5410 +((( 5411 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5412 + "year": 0, ~/~/ Год поля 5413 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5414 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5415 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5416 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5417 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5418 + "id": 0, ~/~/ Идентификатор объекта геозоны 5419 + "name": "string", ~/~/ Название объекта геозоны 5420 + "type": 0, ~/~/ Тип объекта геозоны 5421 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5422 + "fname": "string", ~/~/ Имя файла 5423 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5424 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5425 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5426 + "description": "string", ~/~/ Описание объекта геозоны 5427 + "area": 0, ~/~/ Площадь, м2 5428 + "perimetr": 0, ~/~/ Периметр, м 5429 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5430 +} 5431 +))) 5432 + 5433 + 5434 +((( 5435 +((( 5436 +((( 5437 +== **Изменение поля** == 5438 + 5439 +(% class="box infomessage" %) 5440 +((( 5441 +**PUT /api/v3/agroLands** 5442 +))) 5443 + 5444 +Пример запроса: 5445 + 5446 +((( 5447 +((( 5448 +{ 5449 + "id": 0, ~/~/ Идентификатор поля 5450 + "extId": "string", ~/~/ ExtId 5451 + "shape": "string", ~/~/ Форма поля 5452 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5453 + "display": "string", ~/~/ Настройки отображения 5454 + "year": 0, ~/~/ Год поля 5455 + "name": "string", ~/~/ Наименование 5456 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5457 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5458 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5459 + "planComment": "string", ~/~/Комментарий к полю 5460 + "cropRotations": [ ~/~/ Данные по севообороту 5461 + { 5462 + "landId": 0, ~/~/ ID поля 5463 + "landName": "string", ~/~/ Название поля 5464 + "year": 0, ~/~/ Год урожая 5465 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5466 + "cultureName": "string", ~/~/ Название культуры 5467 + "productivity": 0, ~/~/ Урожайность 5468 + "area": 0, ~/~/ Площадь поля, Га. 5469 + "total": 0, ~/~/ Валовый сбор 5470 + "productivityFact": 0, ~/~/ Фактическая урожайность 5471 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5472 + "totalFact": 0, ~/~/ Фактический валовый сбор 5473 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5474 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5475 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5476 + "isyearplan": true, 5477 + "comment": "string" ~/~/ Комментарий 5478 + } 5479 + ], 5480 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5481 +} 5482 +))) 5483 +))) 5484 + 5485 +((( 5486 + 5487 +))) 5488 + 5489 +Пример ответа: 5490 + 5491 +((( 5492 +((( 5493 +((( 5494 +{ 5495 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5496 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5497 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5498 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5499 + "cropRotations": [ ~/~/ Данные по севообороту 5500 + { 5501 + "landId": 0, ~/~/ ID поля 5502 + "landName": "string", ~/~/ Название поля 5503 + "year": 0, ~/~/ Год урожая 5504 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5505 + "cultureName": "string", ~/~/ Название культуры 5506 + "productivity": 0, ~/~/ Урожайность 5507 + "area": 0, ~/~/ Площадь поля, Га 5508 + "total": 0, ~/~/ Валовый сбор 5509 + "productivityFact": 0, ~/~/ Фактическая урожайность 5510 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5511 + "totalFact": 0, ~/~/ Фактический валовый сбор 5512 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5513 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5514 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5515 + "isyearplan": true, ~/~/ 5516 + "comment": "string" ~/~/ Комментарий 5517 + } 5518 + ], 5519 + "cropVegetation": [ ~/~/ История вегетации поля 5520 + { 5521 + "values": [ ~/~/ Данные вегетации и состояния посева 5522 + { 5523 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5524 + "ndvi": 0 ~/~/ Индекс вегетации 5525 + } 5526 + ], 5527 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5528 + { 5529 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5530 + "type": "string", ~/~/ Тип 5531 + "pictureid": "string" ~/~/ Идентификатор ресурса 5532 + } 5533 + ], 5534 + "states": [ ~/~/ Ключевые даты развития поля 5535 + { 5536 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5537 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5538 + } 5539 + ] 5540 + } 5541 + ], 5542 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5543 + "counts": { 5544 + "fieldOperations": 0, ~/~/ Количество операций на поле 5545 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5546 + "facts": 0 ~/~/ Счётчик факта 5547 + }, 5548 + "planComment": "string", ~/~/ Комментарий к полю 5549 + "productivity": 0, ~/~/ Урожайность. 5550 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5551 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5552 + "year": 0, ~/~/ Год поля 5553 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5554 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5555 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5556 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5557 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5558 + "id": 0, ~/~/ Идентификатор объекта геозоны 5559 + "name": "string", ~/~/ Название объекта геозоны 5560 + "type": 0, ~/~/ Тип объекта геозоны 5561 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5562 + "fname": "string", ~/~/ Имя файла 5563 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5564 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5565 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5566 + "description": "string", ~/~/ Описание объекта геозоны 5567 + "area": 0, ~/~/ Площадь, м2 5568 + "perimetr": 0, ~/~/ Периметр, м 5569 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5570 +} 5571 +))) 5572 +))) 5573 +))) 5574 +))) 5575 +))) 5576 + 5577 + 5578 +== **Редактирование года урожая ** == 5579 + 5580 +(% class="box successmessage" %) 5581 +((( 5582 +**POST /api/v3/agroLands/updateOpenCloseYear** 5583 +))) 5584 + 5585 +Пример запроса: 5586 + 5587 +((( 5588 +((( 5589 +{ 5590 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5591 + 0 5592 + ], 5593 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5594 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5595 +} 5596 +))) 5597 + 5598 + 5599 +))) 5600 + 5601 +Пример ответа: 5602 + 5603 +((( 5604 +((( 5605 +{ 5606 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5607 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5608 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5609 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5610 + "cropRotations": [ ~/~/ Данные по севообороту 5611 + { 5612 + "landId": 0, ~/~/ ID поля 5613 + "landName": "string", ~/~/ Название поля 5614 + "year": 0, ~/~/ Год урожая 5615 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5616 + "cultureName": "string", ~/~/ Название культуры 5617 + "productivity": 0, ~/~/ Урожайность 5618 + "area": 0, ~/~/ Площадь поля, Га. 5619 + "total": 0, ~/~/ Валовый сбор 5620 + "productivityFact": 0, ~/~/ Фактическая урожайность 5621 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5622 + "totalFact": 0, ~/~/ Фактический валовый сбор 5623 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5624 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5625 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5626 + "isyearplan": true, ~/~/ 5627 + "comment": "string" ~/~/ Комментарий 5628 + } 5629 + ], 5630 + "cropVegetation": [ ~/~/ История вегетации поля 5631 + { 5632 + "values": [ ~/~/ Данные вегетации и состояния посева 5633 + { 5634 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5635 + "ndvi": 0 ~/~/ Индекс вегетации 5636 + } 5637 + ], 5638 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5639 + { 5640 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5641 + "type": "string", ~/~/ Тип 5642 + "pictureid": "string" ~/~/ Идентификатор ресурса 5643 + } 5644 + ], 5645 + "states": [ ~/~/ Ключевые даты развития поля 5646 + { 5647 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5648 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5649 + } 5650 + ] 5651 + } 5652 + ], 5653 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5654 + "counts": { 5655 + "fieldOperations": 0, ~/~/ Количество операций на поле 5656 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5657 + "facts": 0 ~/~/ Счётчик факта 5658 + }, 5659 + "planComment": "string", ~/~/ Комментарий к полю 5660 + "productivity": 0, ~/~/ Урожайность. 5661 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5662 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5663 + "year": 0, ~/~/ Год поля 5664 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5665 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5666 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5667 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5668 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5669 + "id": 0, ~/~/ Идентификатор объекта геозоны 5670 + "name": "string", ~/~/ Название объекта геозоны 5671 + "type": 0, ~/~/ Тип объекта геозоны 5672 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5673 + "fname": "string", ~/~/ Имя файла 5674 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5675 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5676 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5677 + "description": "string", ~/~/ Описание объекта геозоны 5678 + "area": 0, ~/~/ Площадь, м2 5679 + "perimetr": 0, ~/~/ ериметр, м 5680 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5681 +} 5682 + 5683 + 5684 +== **Какие поля посещал объект** == 5685 + 5686 +(% class="box successmessage" %) 5687 +((( 5688 +**POST /api/v3/agroLands/visitingByVehicle** 5689 +))) 5690 + 5691 +Пример запроса: 5692 + 5693 +{ 5694 + "vehicleId": 0, ~/~/ id объекта 5695 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5696 + "byTime": 0, ~/~/ Объединение событий по времени 5697 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5698 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5699 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5700 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5701 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5702 +} 5703 + 5704 +Пример ответа: 5705 + 5706 +[ 5707 + { 5708 + "fieldId": 0, ~/~/ id объекта 5709 + "vehicleName": "string", ~/~/ Наименование объекта 5710 + "fieldName": "string", ~/~/ Наименование поля 5711 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5712 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5713 + "vehicleId": 0, ~/~/ Идентификатор ТС 5714 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5715 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5716 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5717 + "mileage": 0 ~/~/ Пробег 5718 + } 5719 +] 5720 +))) 5721 + 5722 + 5723 +== **Посещение поля объектами ** == 5724 + 5725 +(% class="box successmessage" %) 5726 +((( 5727 +**POST /api/v3/agroLands/visitingByField** 5728 +))) 5729 + 5730 +Пример запроса: 5731 +{ 5732 + "fieldId": 0, ~/~/ ID поля 5733 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5734 + "byTime": 0, ~/~/ Объединение событий по времени 5735 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5736 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5737 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5738 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5739 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5740 +} 5741 + 5742 +Пример ответа: 5743 + 5744 +[ 5745 + { 5746 + "fieldId": 0, ~/~/ ID поля 5747 + "vehicleName": "string", ~/~/ Наименование объекта 5748 + "fieldName": "string", ~/~/ Имя поля 5749 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5750 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5751 + "vehicleId": 0, ~/~/ Идентификатор ТС 5752 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5753 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5754 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5755 + "mileage": 0 ~/~/ Пробег 5756 + } 5757 +] 5758 + 5759 + 5760 +== **Удаление существующего поля** == 5761 + 5762 +(% class="box errormessage" %) 5763 +((( 5764 +**DELETE /api/v3/agroLands/{id}** 5765 +))) 5766 + 5767 +Пример запроса: 5768 +id ~/~/ Идентификатор поля 5769 + 5770 +Пример ответа: 5771 + 5772 +((( 5773 +200 ~/~/ Успех 5774 + 5775 + 5776 +))) 5777 + 4658 4658 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5779 +))) 5780 +))) 5781 +))) 4659 4659 4660 4660 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4661 4661 ... ... @@ -4662,7 +4662,7 @@ 4662 4662 4663 4663 (% class="box infomessage" %) 4664 4664 ((( 4665 -GET api/v3/Vehicles/recyclebin/all 5788 +**GET api/v3/Vehicles/recyclebin/all** 4666 4666 ))) 4667 4667 4668 4668 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту ... ... @@ -4697,11 +4697,11 @@ 4697 4697 ] 4698 4698 4699 4699 4700 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5823 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 4701 4701 4702 4702 (% class="box infomessage" %) 4703 4703 ((( 4704 -POST /api/v3/Vehicles/recyclebin/erase5827 +**POST api/v3/Vehicles/recyclebin/erase** 4705 4705 ))) 4706 4706 4707 4707 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -4743,7 +4743,7 @@ 4743 4743 4744 4744 (% class="box infomessage" %) 4745 4745 ((( 4746 -POST /api/v3/Vehicles/recyclebin/restore5869 +**POST api/v3/Vehicles/recyclebin/restore** 4747 4747 ))) 4748 4748 4749 4749 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -4795,7 +4795,782 @@ 4795 4795 ] 4796 4796 4797 4797 5921 += **Раздел: Журнал заданий ** = 4798 4798 5923 + 5924 +== **Создание задания в Журнале заданий** == 5925 + 5926 +(% class="box infomessage" %) 5927 +((( 5928 +**POST /api/v3/vehicletasks** 5929 +))) 5930 + 5931 +Пример запроса: 5932 + 5933 +((( 5934 +{ 5935 + "vehicleId": 0, ~/~/ Идентификатор ТС 5936 + "description": "string", ~/~/ Описание 5937 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5938 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5939 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5940 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5941 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5942 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5943 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5944 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5945 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5946 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5947 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5948 + "cost": { 5949 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5950 + "Name": "string", ~/~/ Наименование 5951 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5952 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5953 + "Norm": 0 ~/~/ Норма внесения 5954 + }, 5955 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5956 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5957 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5958 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5959 + "deleted": true, ~/~/ Признак удаления 5960 + "extId": "string", 5961 + "GeoIds": [ ~/~/ Cвязанные поля 5962 + 0 5963 + ] 5964 +} 5965 +))) 5966 + 5967 + 5968 +Пример ответа: 5969 + 5970 +{ 5971 + "vehicleId": 0, ~/~/ Идентификатор ТС 5972 + "description": "string", ~/~/ Описание 5973 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5974 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5975 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5976 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5977 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5978 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5979 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5980 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5981 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5982 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5983 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5984 + "cost": { 5985 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5986 + "Name": "string", ~/~/ Наименование 5987 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5988 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5989 + "Norm": 0 ~/~/ Норма внесения 5990 + }, 5991 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5992 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5993 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5994 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5995 + "deleted": true, ~/~/ Признак удаления 5996 + "extId": "string", ~/~/ ExtId 5997 + "GeoIds": [ ~/~/ Связанные поля 5998 + 0 5999 + ] 6000 +} 6001 + 6002 + 6003 +== **Редактирование задания в Журнале заданий** == 6004 + 6005 +(% class="box successmessage" %) 6006 +((( 6007 +**PUT /api/v3/vehicletasks** 6008 +))) 6009 + 6010 +Пример запроса: 6011 + 6012 +((( 6013 +{ 6014 + "vehicleId": 0, ~/~/ Идентификатор ТС 6015 + "description": "string", ~/~/ Описание 6016 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6017 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6018 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 6019 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 6020 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6021 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6022 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6023 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6024 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6025 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6026 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6027 + "cost": { 6028 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6029 + "Name": "string", ~/~/ Наименование 6030 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6031 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6032 + "Norm": 0 ~/~/ Норма внесения 6033 + }, 6034 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6035 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6036 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 6037 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 6038 + "deleted": true, ~/~/ Признак удаления 6039 + "extId": "string", ~/~/ ExtId 6040 + "GeoIds": [ ~/~/ Связанные поля 6041 + 0 6042 + ] 6043 +} 6044 +))) 6045 + 6046 + 6047 +Пример ответа: 6048 + 6049 +{ 6050 + "vehicleId": 0, ~/~/ Идентификатор ТС 6051 + "description": "string", ~/~/ Описание 6052 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6053 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6054 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6055 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6056 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6057 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6058 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6059 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6060 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6061 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6062 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6063 + "cost": { 6064 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6065 + "Name": "string", ~/~/ Наименование 6066 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6067 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6068 + "Norm": 0 ~/~/ Норма внесения 6069 + }, 6070 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6071 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6072 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6073 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6074 + "deleted": true, ~/~/ Признак удаления 6075 + "extId": "string", ~/~/ ExtId 6076 + "GeoIds": [ ~/~/ Связанные поля 6077 + 0 6078 + ] 6079 +} 6080 + 6081 + 6082 +== **Удаление задания в Журнале заданий** == 6083 + 6084 +(% class="box warningmessage" %) 6085 +((( 6086 +**DELETE /api/v3/vehicletasks** 6087 +))) 6088 + 6089 +Пример запроса: 6090 + 6091 +((( 6092 +[ 6093 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6094 +] 6095 +))) 6096 + 6097 +((( 6098 + 6099 +))) 6100 + 6101 +Пример ответа: 6102 + 6103 +{ 6104 + "vehicleId": 0, ~/~/ Идентификатор ТС 6105 + "description": "string", ~/~/ Описание 6106 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6107 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6108 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6109 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6110 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6111 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6112 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6113 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6114 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6115 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6116 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6117 + "cost": { 6118 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6119 + "Name": "string", ~/~/ Наименование 6120 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6121 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6122 + "Norm": 0 ~/~/ Норма внесения 6123 + }, 6124 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6125 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6126 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6127 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6128 + "deleted": true, ~/~/ Признак удаления 6129 + "extId": "string", ~/~/ ExtId 6130 + "GeoIds": [ ~/~/ Связанные поля 6131 + 0 6132 + ] 6133 +} 6134 + 6135 + 6136 +== **Получение списка Журнала заданий** == 6137 + 6138 +(% class="box infomessage" %) 6139 +((( 6140 +**POST /api/v3/vehicletasks/getbyperiod** 6141 +))) 6142 + 6143 +Пример запроса: 6144 + 6145 +((( 6146 +{ 6147 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6148 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6149 + "TimeZone": 0, ~/~/ Часовой пояс. 6150 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6151 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6152 + ], 6153 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6154 + 0 6155 + ], 6156 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6157 + 0 6158 + ], 6159 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6160 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6161 +} 6162 +))) 6163 + 6164 + 6165 +Пример ответа: 6166 + 6167 +((( 6168 +{ 6169 + "total": 0, ~/~/ Общее количество записей 6170 + "pages": 0, ~/~/ Общее количество страниц 6171 + "currentPage": 0, ~/~/ Текущая страница 6172 + "items": [ ~/~/ Записи 6173 + { 6174 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6175 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6176 + "name": "string", ~/~/ Название задания. 6177 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6178 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6179 + "workKind": "string", ~/~/ Вид работ 6180 + "techOp": "string", ~/~/ Тех. операция 6181 + "trailerModel": "string", ~/~/ Модель агрегата 6182 + "width": "string", ~/~/ Ширина, м 6183 + "speed": "string", ~/~/ Тех. скорость 6184 + "fields": "string", ~/~/ Поля 6185 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6186 + "vehicles": "string", ~/~/ Объект-модель 6187 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6188 + "drivers": "string", ~/~/ Водители 6189 + "tmc": "string", ~/~/ ТМЦ 6190 + "client": "string", ~/~/ Клиент 6191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6192 + "dep": "string", ~/~/ Подразделение 6193 + "geoIds": [ ~/~/ Связанные поля 6194 + 0 6195 + ] 6196 + } 6197 + ] 6198 +} 6199 +))) 6200 + 6201 + 6202 += **Раздел: Роли** = 6203 + 6204 +== **Получение списка клиентских и системных ролей пользователя ** == 6205 + 6206 +(% class="box successmessage" %) 6207 +((( 6208 +**POST /api/v3/groups/find** 6209 +))) 6210 + 6211 +Пример запроса: 6212 + 6213 +((( 6214 +{ 6215 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6216 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6217 +} 6218 +))) 6219 + 6220 +((( 6221 + 6222 +))) 6223 + 6224 +((( 6225 +Пример ответа: 6226 +))) 6227 + 6228 +((( 6229 +((( 6230 +{ 6231 + "groups": [ ~/~/ Системные роли пользователя 6232 + { 6233 + "code": "string", ~/~/ Код роли. 6234 + "name": "string", ~/~/ Имя 6235 + "shortName": "string" ~/~/ Короткое имя 6236 + } 6237 + ], 6238 + "customGroups": [ ~/~/ Системные роли пользователя 6239 + { 6240 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6241 + "name": "string", ~/~/ Наименование 6242 + "shortName": "string", ~/~/ Короткое наименование 6243 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6244 + } 6245 + ] 6246 +} 6247 +))) 6248 +))) 6249 + 6250 +((( 6251 + 6252 +))) 6253 + 6254 +((( 6255 + 6256 +))) 6257 + 6258 += **Раздел: Локатор ** = 6259 + 6260 + 6261 +== **Получение данных по локатору** == 6262 + 6263 +(% class="box infomessage" %) 6264 +((( 6265 +**GET /api/v3/locators/{locatorId}** 6266 +))) 6267 + 6268 +В запросе указывается locatorid - идентификатор локатора 6269 + 6270 + 6271 +Пример ответа: 6272 + 6273 +((( 6274 +((( 6275 +{ 6276 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6277 + 0 6278 + ], 6279 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6280 + 0 6281 + ], 6282 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6283 + 0 6284 + ], 6285 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6286 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6287 + "agentName": "string", ~/~/ Наименование агента. 6288 + "isEnabled": true, ~/~/ Активность 6289 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6290 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6291 + "name": "string", ~/~/ Наименование. 6292 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6293 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6294 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6295 + "validity": 0, ~/~/ Значение срока действия 6296 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6297 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6298 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6299 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6300 + "url": "string", ~/~/ Ссылка 6301 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6302 + 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6305 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6306 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6307 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6308 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию 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 + 1 6311 + 6312 + ] 6313 +} 6314 +))) 6315 +))) 6316 + 6317 + 6318 +((( 6319 +((( 6320 + 6321 +))) 6322 +))) 6323 + 6324 + 6325 +== **Создание локатора** == 6326 + 6327 +(% class="box successmessage" %) 6328 +((( 6329 +**POST /api/v3/locators** 6330 +))) 6331 + 6332 +Пример запроса: 6333 + 6334 +((( 6335 +{ 6336 + "isEnabled": true, ~/~/ Активность 6337 + "name": "string", ~/~/ Наименование локатора 6338 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6339 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6340 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6341 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6342 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6343 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6344 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6345 + 0 6346 + ], 6347 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6348 + 0 6349 + ], 6350 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6351 + 0 6352 + ], 6353 + 6354 + "showVehicleName": true, ~/~/ Наименование объекта 6355 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6356 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6357 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6358 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6359 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию 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ГИС) 6360 + 6361 + 1 6362 + 6363 + ] 6364 +} 6365 +))) 6366 + 6367 + 6368 +Пример ответа: 6369 + 6370 +((( 6371 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6372 +))) 6373 + 6374 + 6375 +== **Выводит список локаторов ** == 6376 + 6377 +(% class="box successmessage" %) 6378 +((( 6379 +**POST /api/v3/locators/find** 6380 +))) 6381 + 6382 +Пример запроса: 6383 + 6384 +((( 6385 +{ 6386 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6387 +} 6388 +))) 6389 + 6390 +((( 6391 + 6392 +))) 6393 + 6394 +((( 6395 + 6396 +))) 6397 + 6398 + 6399 +Пример ответа: 6400 + 6401 +((( 6402 +[ 6403 + { 6404 + "vehiclesCount": 0, ~/~/ Количество объектов. 6405 + "geozonesCount": 0, ~/~/ Количество геозон. 6406 + "fieldsCount": 0, ~/~/ Количество полей. 6407 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6408 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6409 + "agentName": "string", ~/~/ Наименование агента. 6410 + "isEnabled": true, ~/~/ Активность локатора 6411 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6412 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6413 + "name": "string", ~/~/ Наименование локатора 6414 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6415 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6416 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6417 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6418 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6419 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6420 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6421 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6422 + "url": "string", ~/~/ ссылка на локатор 6423 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6424 + "showVehicleName": true, ~/~/ Наименование объекта 6425 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6426 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6427 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6428 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6429 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию 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ГИС) 6430 + 6431 + 0 6432 + ] 6433 + } 6434 +] 6435 +))) 6436 + 6437 + 6438 +== **Изменение локатора** == 6439 + 6440 +(% class="box infomessage" %) 6441 +((( 6442 +**PUT /api/v3/locators** 6443 +))) 6444 + 6445 +Пример запроса: 6446 + 6447 +((( 6448 +{ 6449 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6450 + "isEnabled": true, ~/~/ Активность 6451 + "name": "string", ~/~/ Наименование 6452 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6453 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6454 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6455 + "autoProlongation": true, ~/~/ Автопродление срока действия 6456 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6457 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6458 + 0 6459 + ], 6460 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6461 + 0 6462 + ], 6463 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6464 + 0 6465 + ], 6466 + "showVehicleName": true, ~/~/ Наименование объекта 6467 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6468 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6469 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6470 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6471 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию 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ГИС) 6472 + 6473 + 0 6474 + 6475 + ] 6476 +} 6477 + 6478 + 6479 +))) 6480 + 6481 +Пример ответа: 6482 + 6483 +200 ~/~/ Success 6484 + 6485 + 6486 +== **Удалить локатор** == 6487 + 6488 +(% class="box warningmessage" %) 6489 +((( 6490 +**DELETE /api/v3/locators** 6491 +))) 6492 + 6493 +Пример запроса: 6494 + 6495 +((( 6496 +[ 6497 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6498 +] 6499 +))) 6500 + 6501 + 6502 += **Раздел: Яндекс Маршруты** = 6503 + 6504 + 6505 +== **Возвращение списка маршрутов** == 6506 + 6507 +(% class="box infomessage" %) 6508 +((( 6509 +**GET /api/v3/TransportRoutes** 6510 +))) 6511 + 6512 +Пример запроса: 6513 +Id ~/~/ Идентификатор поля 6514 + 6515 +Пример ответа: 6516 + 6517 +((( 6518 +[ 6519 + { 6520 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6521 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6522 + "name": "string", ~/~/ Наименование маршрута. 6523 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6524 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6525 + 0 6526 + ] 6527 + } 6528 +] 6529 +))) 6530 + 6531 + 6532 +== **Добавить маршрут** == 6533 + 6534 +(% class="box infomessage" %) 6535 +((( 6536 +**POST /api/v3/TransportRoutes** 6537 +))) 6538 + 6539 +Пример запроса: 6540 +{ 6541 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6542 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6543 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6544 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6545 + 0 6546 + ] 6547 +} 6548 + 6549 + 6550 +Пример ответа: 6551 + 6552 +((( 6553 +{ 6554 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6555 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6556 + "name": "string", ~/~/ Определяет наименование маршрута 6557 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6558 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6559 + 0 6560 + ] 6561 +} 6562 +))) 6563 + 6564 + 6565 +== **Обновление маршрута** == 6566 + 6567 +(% class="box successmessage" %) 6568 +((( 6569 +**PUT /api/v3/TransportRoutes** 6570 +))) 6571 + 6572 +Пример запроса: 6573 + 6574 +((( 6575 +{ 6576 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6577 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6578 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6579 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6580 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6581 + 0 6582 + ] 6583 +} 6584 +))) 6585 + 6586 +Пример ответа: 6587 + 6588 +((( 6589 +{ 6590 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6591 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6592 + "name": "string", ~/~/ Определяет наименование маршрута 6593 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6594 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6595 + 0 6596 + ] 6597 +} 6598 +))) 6599 + 6600 + 6601 +== **Получить связки маршрутов ТС** == 6602 + 6603 +(% class="box infomessage" %) 6604 +((( 6605 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6606 +))) 6607 + 6608 +Пример запроса: 6609 + 6610 +((( 6611 +[ 6612 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6613 +] 6614 +))) 6615 + 6616 +Пример ответа: 6617 + 6618 +((( 6619 +[ 6620 + { 6621 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6622 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6623 + } 6624 +] 6625 +))) 6626 + 6627 + 6628 +== **Удалить маршрут** == 6629 + 6630 +(% class="box warningmessage" %) 6631 +((( 6632 +**DELETE /api/v3/TransportRoutes/{id}** 6633 +))) 6634 + 6635 +Пример запроса: 6636 +Id ~/~/ Идентификатор поля 6637 + 6638 + 6639 += **Раздел: Управление доступа к машинам** = 6640 + 6641 + 6642 +== Получение списка транспортных средств видимых пользователю == 6643 + 6644 +(% class="box infomessage" %) 6645 +((( 6646 +**GET /api/v3/UserVisibleVehicles/{userId}** 6647 +))) 6648 + 6649 +Пример ответа: 6650 + 6651 +((( 6652 +{ 6653 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6654 + 0 6655 + ] 6656 +} 6657 +))) 6658 + 6659 + 6660 +== Задает видимость транспортных средств пользователю == 6661 + 6662 +(% class="box infomessage" %) 6663 +((( 6664 +**POST /api/v3/UserVisibleVehicles** 6665 +))) 6666 + 6667 +Пример запроса: 6668 + 6669 +((( 6670 +((( 6671 +{ 6672 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6673 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6674 + 0 6675 + ] 6676 +} 6677 +))) 6678 + 6679 +((( 6680 + 6681 +))) 6682 + 6683 +((( 6684 +Пример ответа : 6685 +))) 6686 + 6687 +((( 6688 + 6689 +))) 6690 + 6691 +((( 6692 +200 ~/~/ Success 6693 +))) 6694 +))) 6695 + 6696 + 4799 4799 (% class="box" lang="en-US" style="text-align: center;" %) 4800 4800 ((( 4801 4801 (% 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]] **