Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/14 11:58
<
>
edited by Андрей Калиновский
on 2024/11/22 13:26
on 2024/11/22 13:26
edited by Андрей Калиновский
on 2024/12/20 13:14
on 2024/12/20 13:14
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,9 +1,27 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 -**Содержание страницы:**\ 3 +(% class="box warningmessage" %) 4 +((( 5 + 6 + 7 + 8 + 9 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 10 +просим вас соблюдать несколько простых правил при использовании API-команд:## 4 4 ))) 5 5 13 +* Формировать не более 3 отчётов одновременно. 14 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 6 6 16 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 17 + 18 + 19 +**Содержание страницы:** 20 +))) 21 + 22 +{{toc/}} 23 + 24 + 7 7 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 8 9 9 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -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 шаблона команды 1201 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1202 +"command": "", ~/~/ Текст отправляемой команды 1203 +"retries": "", ~/~/ Количество попыток отправки на терминал 1204 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1258 1258 } 1259 1259 1207 +В ответ получаем cmdid 1260 1260 1209 + 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 id1217 +Идентификатор команды: cmdId 1269 1269 1270 1270 Запрос от терминала на ответ команды 1271 1271 1272 1272 Пример ответ от терминала: 1273 1273 1274 -ID= "" ~/~/ идентификатор произвольного поля1223 +ID= "" ~/~/ идентификатор объекта 1275 1275 Soft="" ~/~/ версия софта 1276 1276 GPS=4 ~/~/ тип трекера 1277 1277 Time=11:05:43 28.06.24 ~/~/ время запроса ... ... @@ -1626,6 +1626,78 @@ 1626 1626 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1627 1627 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1628 1628 1578 + 1579 +== **Импортировать историю ТС (Асинхронный запрос)** == 1580 + 1581 +(% class="box successmessage" %) 1582 +((( 1583 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1584 +))) 1585 + 1586 +Метод запроса: **POST** 1587 + 1588 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1589 + 1590 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1591 + 1592 + 1593 +Ответ: 1594 + 1595 +{ 1596 + 1597 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1598 + 1599 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1600 + 1601 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1602 + 1603 + "Message": "string", ~/~/ Информация о выполнении запроса 1604 + 1605 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1606 + 1607 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1608 + 1609 + "Data": "string" ~/~/ Данные 1610 + 1611 +} 1612 + 1613 + 1614 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1615 + 1616 +(% class="box infomessage" %) 1617 +((( 1618 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1619 +))) 1620 + 1621 +Метод запроса: **GET** 1622 + 1623 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1624 + 1625 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1626 + 1627 + 1628 +Ответ: 1629 + 1630 +{ 1631 + 1632 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1633 + 1634 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1635 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1636 + 1637 + "Message": "string", ~/~/ Информация о выполнении запроса 1638 + 1639 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1640 + 1641 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1642 + 1643 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1644 + 1645 + "Data": "string" ~/~/ Данные 1646 + 1647 +} 1648 + 1649 + 1629 1629 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1630 1630 1631 1631 (% class="box infomessage" %) ... ... @@ -4377,31 +4377,31 @@ 4377 4377 Параметры в теле запроса (JSON): 4378 4378 4379 4379 { 4380 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4381 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4401 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4402 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4382 4382 "ids": [ 4383 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ гуиды4404 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4384 4384 ], 4385 - "timezone": 0 ~/~/ Таймзона4406 + "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" ~/~/Адрес АЗС 4412 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4413 + "driver": "string", ~/~/ Водители, привязанные к ТК 4414 + "object": "string", ~/~/ Наименование ТС 4415 + "amount": 0, ~/~/ Количество топлива 4416 + "amountDut": 0, ~/~/ Количество по ДУТ 4417 + "amountDiff": 0, ~/~/ Разница, л 4418 + "amountDiffPerc": 0, ~/~/ Разница, % 4419 + "summa": 0, ~/~/ Стоимость, руб 4420 + "serviceName": "string", ~/~/ Тип топлива 4421 + "price": 0, ~/~/ Цена за литр, руб 4422 + "cardName": "string", ~/~/ Наименование ТК 4423 + "cardNum": "string", ~/~/ Номер ТК 4424 + "operator": "string", ~/~/ Оператор ТК 4425 + "address": "string" ~/~/ Адрес АЗС 4405 4405 } 4406 4406 4407 4407 ... ... @@ -4415,28 +4415,28 @@ 4415 4415 **GET ** **/api/v3/retranslations/{id}** 4416 4416 ))) 4417 4417 4418 -Идентификатор запроса:ID4439 +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": [ ~/~/Объекты для ретрансляции 4445 +"description": "", ~/~/ Поле описания ретранслятора 4446 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4447 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4448 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4449 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4450 +"objects": [ ~/~/ Объекты для ретрансляции 4430 4430 { 4431 4431 "id": "", ~/~/ Идентификатор объекта ретрансляции 4432 4432 "name": "", ~/~/ Наименование объекта ретрансляции 4433 -"imei": "", ~/~/ IMEI объекта 4434 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4454 +"imei": "", ~/~/ IMEI объекта ретрансляции 4455 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4435 4435 } 4436 4436 ], 4437 -"id": "", ~/~/ идентификаторпользователя4438 -"parentId": "", ~/~/ Guidродителя4439 -"deleted": "" ~/~/ Признак удаления ,Включен,true - включен, false - отключен4458 +"id": "", ~/~/ Идентификатор ретранслятора 4459 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4460 +"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 - Параметрзапроса:ID4471 +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 - отключен4484 +"description": "", ~/~/ Поле описания ретранслятора 4485 +"subscriberId": "", ~/~/ Идентификатор подписчика 4486 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4487 +"address": "", ~/~/ Адрес и порт принимающего сервера 4488 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4468 4468 "objects": [ ~/~/Объекты для ретрансляции 4469 4469 { 4470 -"id": "", ~/~/ идентификаторпользователя4471 -"imei": "", ~/~/IMEI объекта 4472 -"isEnabled": "" ~/~/ признак,Включен,true - включен, false - отключен4491 +"id": "", ~/~/ Идентификатор ретранслятора 4492 +"imei": "", ~/~/ IMEI объекта ретрансляции 4493 +"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": [ ~/~/Объекты для ретрансляции 4502 +"description": "", ~/~/ Поле описания ретранслятора 4503 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4504 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4505 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4506 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4507 +"objects": [ ~/~/ Объекты для ретрансляции 4487 4487 { 4488 -"id": "", идентификаторпользователя4489 -"name": "string", званиеуведомления4490 -"imei": " string", ~/~/IMEI объекта4491 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4509 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4510 +"name": "string", ~/~/ Наименование объекта ретрансляции 4511 +"imei": "", ~/~/ IMEI объекта ретрансляции 4512 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4492 4492 } 4493 - ], 4494 -"id": "", ~/~/ идентификаторпользователя4495 -"parentId": "", ~/~/ Guid идентификатор родителя4496 -"deleted": true ~/~/ Признак удаления 4514 + ], 4515 +"id": "", ~/~/ Идентификатор ретранслятора 4516 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4517 +"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": ~/~/Объекты для ретрансляции 4531 +"id": "", ~/~/ Идентификатор ретранслятора 4532 +"description": "string", ~/~/ Поле описания ретранслятора 4533 +"subscriberId": "", ~/~/ Идентификатор подписчика 4534 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4535 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4536 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4537 +"objects": ~/~/ Объекты для ретрансляции 4517 4517 [ 4518 4518 { 4519 -"id": "", ~/~/ идентификаторпользователя4520 -"imei": "", ~/~/IMEI объекта 4521 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4540 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4541 +"imei": "", ~/~/ IMEI объекта ретрансляции 4542 +"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": [ ~/~/Объекты для ретрансляции 4551 +"description": "", ~/~/ Поле описания ретранслятора 4552 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4553 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4554 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4555 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4556 +"objects": [ ~/~/ Объекты для ретрансляции 4536 4536 { 4537 -"id": "", ~/~/ идентификаторпользователя4538 -"name": "string", ~/~/ На званиеуведомления4539 -"imei": "", ~/~/IMEI объекта 4540 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4558 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4559 +"name": "string", ~/~/ Наименование объекта ретрансляции 4560 +"imei": "", ~/~/ IMEI объекта ретрансляции 4561 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4541 4541 } 4542 4542 ], 4543 -"id": "", ~/~/ идентификаторпользователя4544 -"parentId": "", ~/~/ Guid идентификатор родителя4545 -"deleted": true ~/~/ Признак удаления 4564 +"id": "", ~/~/ Идентификатор ретранслятора 4565 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4566 +"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": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4580 +"id": "", ~/~/ Идентификатор ретранслятора 4581 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4582 +"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 ~/~/ Признак удаления 4589 +"description": "", ~/~/ Поле описания ретранслятора 4590 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4591 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4592 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4593 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4594 +"id": "", ~/~/ Идентификатор ретранслятора 4595 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4596 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4576 4576 } 4577 4577 ] 4578 4578 ... ... @@ -4655,6 +4655,342 @@ 4655 4655 ] 4656 4656 4657 4657 4679 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4680 + 4681 +== **Получение участка по id** == 4682 + 4683 +(% class="box infomessage" %) 4684 +((( 4685 +GET **/api/v3/agroLands/{id}** 4686 +))) 4687 + 4688 +Пример запроса: 4689 +id ~/~/ Идентификатор поля 4690 + 4691 +Пример ответа: 4692 + 4693 +((( 4694 +{ 4695 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4696 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4697 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4698 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4699 + "cropRotations": [ ~/~/ Данные по севообороту 4700 + { 4701 + "landId": 0, ~/~/ ID поля 4702 + "landName": "string", ~/~/ Название поля 4703 + "year": 0, ~/~/ Год урожая 4704 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4705 + "cultureName": "string", ~/~/ Название культуры 4706 + "productivity": 0, ~/~/ Урожайность 4707 + "area": 0, ~/~/ Площадь поля, Га 4708 + "total": 0, ~/~/ Валовый сбор 4709 + "productivityFact": 0, ~/~/ Фактическая урожайность 4710 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4711 + "totalFact": 0, ~/~/ Фактический валовый сбор 4712 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 4713 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 4714 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 4715 + "isyearplan": true, ~/~/ План года 4716 + "comment": "string" ~/~/ Комментарий 4717 + } 4718 + ], 4719 + "cropVegetation": [ ~/~/ История вегетации поля 4720 + { 4721 + "values": [ ~/~/ Данные вегетации и состояния посева 4722 + { 4723 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4724 + "ndvi": 0 ~/~/ Индекс вегетации 4725 + } 4726 + ], 4727 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4728 + { 4729 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4730 + "type": "string", ~/~/ Тип 4731 + "pictureid": "string" ~/~/ Идентификатор ресурса 4732 + } 4733 + ], 4734 + "states": [ ~/~/ Ключевые даты развития поля 4735 + { 4736 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4737 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 4738 + } 4739 + ] 4740 + } 4741 + ], 4742 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 4743 + "counts": { 4744 + "fieldOperations": 0, ~/~/ Количество операций на поле 4745 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4746 + "facts": 0 ~/~/ Счётчик факта 4747 + }, 4748 + "planComment": "string", ~/~/ Комментарий к полю 4749 + "productivity": 0, ~/~/ Урожайность. 4750 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4751 +))) 4752 + 4753 +((( 4754 +((( 4755 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 4756 + "year": 0, ~/~/ Год поля 4757 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4758 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4759 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4760 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4761 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 4762 + "id": 0, ~/~/ Идентификатор объекта геозоны 4763 + "name": "string", ~/~/ Название объекта геозоны 4764 + "type": 0, ~/~/ Тип объекта геозоны 4765 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4766 + "fname": "string", ~/~/ Имя файла 4767 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4768 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 4769 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 4770 + "description": "string", ~/~/ Описание объекта геозоны 4771 + "area": 0, ~/~/ Площадь, м2 4772 + "perimetr": 0, ~/~/ Периметр, м 4773 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 4774 +} 4775 +))) 4776 + 4777 + 4778 +== **Удалить участок** == 4779 + 4780 +(% class="box errormessage" %) 4781 +((( 4782 +DELETE **/api/v3/agroLands/{id}** 4783 +))) 4784 + 4785 +Пример запроса: 4786 +id ~/~/ Идентификатор поля 4787 + 4788 +Пример ответа: 4789 + 4790 +((( 4791 +200 ~/~/ Успех 4792 +))) 4793 + 4794 +((( 4795 + 4796 +))) 4797 + 4798 +((( 4799 +== **Сохранение участка** == 4800 + 4801 +(% class="box successmessage" %) 4802 +((( 4803 +POST **/api/v3/agroLands** 4804 +))) 4805 + 4806 +Пример запроса: 4807 + 4808 +((( 4809 +{ 4810 + "extId": "string", 4811 + "shape": "string", ~/~/ Форма поля 4812 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4813 + "display": "string", ~/~/ Настройки отображения 4814 + "year": 0, ~/~/ Год поля 4815 + "name": "string", ~/~/ Наименование 4816 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4817 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4818 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4819 + "planComment": "string", ~/~/ Комментарий к полю 4820 + "cropRotations": [ ~/~/ Данные по севообороту 4821 + { 4822 + "landId": 0, ~/~/ ID поля 4823 + "landName": "string", ~/~/ Название поля 4824 + "year": 0, ~/~/ Год урожая 4825 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4826 + "cultureName": "string", ~/~/ Название культуры 4827 + "productivity": 0, ~/~/ Урожайность 4828 + "area": 0, ~/~/ Площадь поля, Га 4829 + "total": 0, ~/~/ Валовый сбор 4830 + "productivityFact": 0, ~/~/ Фактическая урожайность 4831 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4832 + "totalFact": 0, ~/~/ Фактический валовый сбор 4833 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4834 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4835 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4836 + "isyearplan": true, ~/~/ Годовой план 4837 + "comment": "string" ~/~/ Комментарий 4838 + } 4839 + ] 4840 +} 4841 +))) 4842 + 4843 +((( 4844 + 4845 +))) 4846 + 4847 +((( 4848 + 4849 +))) 4850 + 4851 +Пример ответа: 4852 + 4853 +((( 4854 +((( 4855 +{ 4856 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4857 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4858 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4859 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4860 + "cropRotations": [ ~/~/ Данные по севообороту 4861 + { 4862 + "landId": 0, ~/~/ ID поля 4863 + "landName": "string", ~/~/ Название поля 4864 + "year": 0, ~/~/ Год урожая 4865 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4866 + "cultureName": "string", ~/~/ Название культуры 4867 + "productivity": 0, ~/~/ Урожайность 4868 + "area": 0, ~/~/ Площадь поля, Га. 4869 + "total": 0, ~/~/ Валовый сбор 4870 + "productivityFact": 0, ~/~/ Фактическая урожайность 4871 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4872 + "totalFact": 0, ~/~/ Фактический валовый сбор 4873 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 4874 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 4875 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 4876 + "isyearplan": true, ~/~/ годовой план 4877 + "comment": "string" ~/~/ Комментарий 4878 + } 4879 + ], 4880 + "cropVegetation": [ ~/~/ История вегетации поля 4881 + { 4882 + "values": [ ~/~/ Данные вегетации и состояния посева 4883 + { 4884 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4885 + "ndvi": 0 ~/~/ Индекс вегетации 4886 + } 4887 + ], 4888 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4889 + { 4890 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4891 + "type": "string", ~/~/ Тип 4892 + "pictureid": "string" ~/~/ Идентификатор ресурса 4893 + } 4894 + ], 4895 + "states": [ ~/~/ Ключевые даты развития поля 4896 + { 4897 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4898 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 4899 + } 4900 + ] 4901 + } 4902 + ], 4903 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 4904 + "counts": { 4905 + "fieldOperations": 0, ~/~/ Количество операций на поле 4906 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4907 + "facts": 0 ~/~/ Счётчик факта 4908 + }, 4909 + "planComment": "string", ~/~/ Комментарий к полю 4910 +))) 4911 + 4912 +((( 4913 + "productivity": 0, ~/~/ Урожайность. 4914 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4915 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 4916 + "year": 0, ~/~/ Год поля 4917 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4918 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4919 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4920 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4921 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 4922 + "id": 0, ~/~/ Идентификатор объекта геозоны 4923 + "name": "string", ~/~/ Название объекта геозоны 4924 + "type": 0, ~/~/ Тип объекта геозоны 4925 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4926 + "fname": "string", ~/~/ Имя файла 4927 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4928 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 4929 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 4930 + "description": "string", ~/~/ Описание объекта геозоны 4931 + "area": 0, ~/~/ Площадь, м2 4932 + "perimetr": 0, ~/~/ Периметр, м 4933 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 4934 +} 4935 +))) 4936 + 4937 +((( 4938 + 4939 +))) 4940 + 4941 +((( 4942 + 4943 +))) 4944 + 4945 +((( 4946 +== **Изменение участка** == 4947 + 4948 +(% class="box successmessage" %) 4949 +((( 4950 +PUT /api/v3/agroLands 4951 +))) 4952 + 4953 +Пример запроса: 4954 + 4955 +((( 4956 +{ 4957 + "extId": "string", 4958 + "shape": "string", ~/~/ Форма поля 4959 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4960 + "display": "string", ~/~/ Настройки отображения 4961 + "year": 0, ~/~/ Год поля 4962 + "name": "string", ~/~/ Наименование 4963 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4964 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4965 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4966 + "planComment": "string", ~/~/ Комментарий к полю 4967 + "cropRotations": [ ~/~/ Данные по севообороту 4968 + { 4969 + "landId": 0, ~/~/ ID поля 4970 + "landName": "string", ~/~/ Название поля 4971 + "year": 0, ~/~/ Год урожая 4972 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4973 + "cultureName": "string", ~/~/ Название культуры 4974 + "productivity": 0, ~/~/ Урожайность 4975 + "area": 0, ~/~/ Площадь поля, Га 4976 + "total": 0, ~/~/ Валовый сбор 4977 + "productivityFact": 0, ~/~/ Фактическая урожайность 4978 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4979 + "totalFact": 0, ~/~/ Фактический валовый сбор 4980 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4981 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4982 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4983 + "isyearplan": true, ~/~/ Годовой план 4984 + "comment": "string" ~/~/ Комментарий 4985 + } 4986 + ] 4987 +} 4988 +))) 4989 + 4990 +((( 4991 + 4992 +))) 4993 + 4994 +((( 4995 + 4996 +))) 4997 + 4998 +Пример ответа: 4999 + 5000 +((( 5001 +((( 5002 +{ 5003 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5004 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5005 + "fieldId": 0, ~/~/ С 5006 +))) 5007 +))) 5008 +))) 5009 +))) 5010 + 5011 + 5012 +))) 5013 +))) 5014 + 4658 4658 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4659 4659 4660 4660 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==