<
From version < 181.1 >
edited by Андрей Калиновский
on 2024/11/18 16:39
To version < 195.1 >
edited by Андрей Калиновский
on 2024/12/20 13:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,5 +1,21 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 +(% class="box warningmessage" %)
4 +(((
5 +
6 +
7 +
8 +
9 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
10 +просим вас соблюдать несколько простых правил при использовании API-команд:##
11 +)))
12 +
13 +* Формировать не более 3 отчётов одновременно.
14 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
15 +
16 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
17 +
18 +
3 3  **Содержание страницы:**
4 4  )))
5 5  
... ... @@ -1182,13 +1182,15 @@
1182 1182  Команда для отправки на тс.
1183 1183  
1184 1184  {  
1185 -"id": "", ~/~/идентификатор произвольного поля
1186 -"command": "", ~/~/ Текст команды
1187 -"retries": "", ~/~/ Количество попыток
1188 -"idTemplate": "" ~/~/ ID шаблона команды
1201 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1202 +"command": "", ~/~/ Текст отправляемой команды
1203 +"retries": "", ~/~/ Количество попыток отправки на терминал
1204 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1189 1189  }
1190 1190  
1207 +В ответ получаем cmdid
1191 1191  
1209 +
1192 1192  == **Получить ответ на отправленную на ТС команду** ==
1193 1193  
1194 1194  (% class="box infomessage" %)
... ... @@ -1196,13 +1196,13 @@
1196 1196  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1197 1197  )))
1198 1198  
1199 -Идентификатор команды: cmdid
1217 +Идентификатор команды: cmdId
1200 1200  
1201 1201  Запрос от терминала на ответ команды
1202 1202  
1203 1203  Пример ответ от терминала:
1204 1204  
1205 -ID= "" ~/~/ идентификатор произвольного поля
1223 +ID= "" ~/~/ идентификатор объекта
1206 1206  Soft="" ~/~/ версия софта
1207 1207  GPS=4 ~/~/ тип трекера
1208 1208  Time=11:05:43 28.06.24 ~/~/ время запроса
... ... @@ -1557,6 +1557,78 @@
1557 1557  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1558 1558  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1559 1559  
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 +
1560 1560  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1561 1561  
1562 1562  (% class="box infomessage" %)
... ... @@ -1598,9 +1598,12 @@
1598 1598   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1599 1599   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1600 1600   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1601 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1602 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1603 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1691 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1692 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1693 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1694 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1695 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1696 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1604 1604  }
1605 1605  
1606 1606  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1607,8 +1607,15 @@
1607 1607  
1608 1608  (% style="color:#000000" %)Ответ:
1609 1609  
1610 -(% style="color:#000000" %){
1611 - "vehicleId": "" ~/~/ идентификатор объекта
1703 +(% style="color:#000000" %)[
1704 +{
1705 +
1706 +(((
1707 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1708 +)))
1709 +
1710 +(((
1711 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1612 1612   "name": "" ~/~/ наименование объекта
1613 1613   "imei": "" ~/~/ IMEI объекта
1614 1614   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1633,9 +1633,21 @@
1633 1633   "forClient": true, ~/~/ право на отображение у клиента
1634 1634   "forTooltip": false, ~/~/ право на отображение в подсказке
1635 1635   "forReport": false ~/~/ право на отображение в отчетах
1636 - }(%%)
1637 -(% style="color:#000000" %)}
1736 +)))
1638 1638  
1738 +(((
1739 + }
1740 + ],
1741 + "vehicleGroups": [  ~/~/ Группы ТС
1742 + {
1743 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1744 + "name": "string" ~/~/ Наименование группы ТС
1745 + }
1746 + ]
1747 + }
1748 +]
1749 +)))
1750 +
1639 1639  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1640 1640  
1641 1641  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -4286,31 +4286,31 @@
4286 4286  Параметры в теле запроса (JSON):
4287 4287  
4288 4288  {
4289 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4290 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4401 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4402 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4291 4291   "ids": [ 
4292 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4404 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4293 4293   ],
4294 - "timezone": 0 ~/~/Таймзона
4406 + "timezone": 0 ~/~/ Часовой пояс
4295 4295  }
4296 4296  
4297 4297  
4298 4298  Ответ:
4299 4299   {
4300 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4301 - "driver": "string", ~/~/Водители, привязанные к ТК
4302 - "object": "string", ~/~/Наименование ТС
4303 - "amount": 0, ~/~/Количество топлива
4304 - "amountDut": 0, ~/~/Количество по ДУТ
4305 - "amountDiff": 0, ~/~/Разница, л
4306 - "amountDiffPerc": 0, ~/~/Разница, %
4307 - "summa": 0, ~/~/Стоимость, руб
4308 - "serviceName": "string", ~/~/Тип топлива
4309 - "price": 0, ~/~/Цена за литр, руб
4310 - "cardName": "string", ~/~/Наименование ТК
4311 - "cardNum": "string", ~/~/Номер ТК
4312 - "operator": "string", ~/~/Оператор ТК
4313 - "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" ~/~/ Адрес АЗС
4314 4314   }
4315 4315  
4316 4316  
... ... @@ -4324,28 +4324,28 @@
4324 4324  **GET ** **/api/v3/retranslations/{id}**
4325 4325  )))
4326 4326  
4327 -Идентификатор запроса: ID
4439 +id - Идентификатор ретранслятора
4328 4328  
4329 4329  
4330 4330  Пример ответа:
4331 4331  
4332 4332  {  
4333 -"description": "", ~/~/ Определяет описание
4334 -"subscriberId": "", ~/~/ Подписчик
4335 -"protocolType": 0, ~/~/ Тип протокола
4336 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4337 -"address": "string", ~/~/ Адрес события
4338 -"objects": [ ~/~/Объекты для ретрансляции
4445 +"description": "", ~/~/ Поле описания ретранслятора
4446 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4447 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4448 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4449 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4450 +"objects": [ ~/~/ Объекты для ретрансляции
4339 4339  {      
4340 4340  "id": "",  ~/~/ Идентификатор объекта ретрансляции
4341 4341  "name": "", ~/~/ Наименование объекта ретрансляции
4342 -"imei": "", ~/~/ IMEI объекта  
4343 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4454 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4455 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4344 4344  }
4345 4345   ],  
4346 -"id": "", ~/~/ идентификатор пользователя   
4347 -"parentId": "", ~/~/Guid родителя
4348 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4458 +"id": "", ~/~/ Идентификатор ретранслятора 
4459 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4460 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4349 4349  }
4350 4350  
4351 4351  
... ... @@ -4356,7 +4356,7 @@
4356 4356  **DELETE** **/api/v3/retranslations/{id}**
4357 4357  )))
4358 4358  
4359 -Параметр запроса: ID
4471 +id - Идентификатор ретранслятора
4360 4360  
4361 4361  
4362 4362  == **Создание ретранслятора** ==
... ... @@ -4369,16 +4369,16 @@
4369 4369  Запрос:
4370 4370  
4371 4371  {  
4372 -"description": "", ~/~/ Описание
4373 -"subscriberId": "", ~/~/ Подписчик
4374 -"protocolType": 0, ~/~/ Тип протокола
4375 -"address": "", ~/~/ Адрес ретрансляции
4376 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4484 +"description": "", ~/~/ Поле описания ретранслятора
4485 +"subscriberId": "", ~/~/ Идентификатор подписчика
4486 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4487 +"address": "", ~/~/ Адрес и порт принимающего сервера
4488 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4377 4377  "objects": [ ~/~/Объекты для ретрансляции
4378 4378  {      
4379 -"id": "", ~/~/ идентификатор пользователя     
4380 -"imei": "", ~/~/IMEI объекта
4381 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4491 +"id": "", ~/~/ Идентификатор ретранслятора 
4492 +"imei": "", ~/~/ IMEI объекта ретрансляции
4493 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4382 4382  }
4383 4383   ]
4384 4384  }
... ... @@ -4387,22 +4387,22 @@
4387 4387  Ответ:
4388 4388  
4389 4389  {  
4390 -"description": "string", ~/~/ Определяет описание
4391 -"subscriberId": "", ~/~/ идентификатор запроса
4392 -"protocolType": 0, ~/~/ Тип протокола
4393 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4394 -"address": "", ~/~/ Адрес события
4395 -"objects": [ ~/~/Объекты для ретрансляции
4502 +"description": "", ~/~/ Поле описания ретранслятора
4503 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4504 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4505 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4506 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4507 +"objects": [ ~/~/ Объекты для ретрансляции
4396 4396  {      
4397 -"id": "", ~/~/ идентификатор пользователя    
4398 -"name": "string", ~/~/ Название уведомления
4399 -"imei": "string", ~/~/IMEI объекта  
4400 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4509 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4510 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4511 +"imei": "", ~/~/ IMEI объекта ретрансляции
4512 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4401 4401  }
4402 - ],  
4403 -"id": "", ~/~/ идентификатор пользователя  
4404 -"parentId": "", ~/~/ Guid идентификатор родителя
4405 -"deleted": true ~/~/ Признак удаления
4514 + ],
4515 +"id": "", ~/~/ Идентификатор ретранслятора   
4516 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4517 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4406 4406  }
4407 4407  
4408 4408  
... ... @@ -4416,18 +4416,18 @@
4416 4416  Пример запроса:
4417 4417  
4418 4418  {  
4419 -"id": "", ~/~/ идентификатор пользователя   
4420 -"description": "string", ~/~/ Определяет описание
4421 -"subscriberId": "", ~/~/ идентификатор запроса
4422 -"protocolType": 0, ~/~/ Тип протокола
4423 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4424 -"address": "string", ~/~/ Адрес события
4425 -"objects": ~/~/Объекты для ретрансляции
4531 +"id": "", ~/~/ Идентификатор ретранслятора   
4532 +"description": "string", ~/~/ Поле описания ретранслятора
4533 +"subscriberId": "", ~/~/ Идентификатор подписчика
4534 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4535 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4536 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4537 +"objects": ~/~/ Объекты для ретрансляции
4426 4426  [    
4427 4427  {      
4428 -"id": "",  ~/~/ идентификатор пользователя         
4429 -"imei": "", ~/~/IMEI объекта
4430 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4540 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4541 +"imei": "", ~/~/ IMEI объекта ретрансляции
4542 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4431 4431  }
4432 4432   ]
4433 4433  }
... ... @@ -4436,22 +4436,22 @@
4436 4436  Пример ответа:
4437 4437  
4438 4438  {  
4439 -"description": "", ~/~/ Определяет описание
4440 -"subscriberId": "", ~/~/ идентификатор запроса
4441 -"protocolType": 0, ~/~/ Тип протокола
4442 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4443 -"address": "string", ~/~/ Адрес события
4444 -"objects": [ ~/~/Объекты для ретрансляции
4551 +"description": "", ~/~/ Поле описания ретранслятора
4552 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4553 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4554 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4555 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4556 +"objects": [ ~/~/ Объекты для ретрансляции
4445 4445  {      
4446 -"id": "", ~/~/ идентификатор пользователя     
4447 -"name": "string", ~/~/ Название уведомления    
4448 -"imei": "", ~/~/IMEI объекта
4449 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4558 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4559 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4560 +"imei": "", ~/~/ IMEI объекта ретрансляции
4561 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4450 4450  }
4451 4451   ],
4452 -"id": "", ~/~/ идентификатор пользователя   
4453 -"parentId": "", ~/~/ Guid идентификатор родителя
4454 -"deleted": true ~/~/ Признак удаления
4564 +"id": "", ~/~/ Идентификатор ретранслятора   
4565 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4566 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4455 4455  }
4456 4456  
4457 4457  
... ... @@ -4465,9 +4465,9 @@
4465 4465  Пример запроса:
4466 4466  
4467 4467  {  
4468 -"id": "", ~/~/ идентификатор пользователя   
4469 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4470 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4580 +"id": "", ~/~/ Идентификатор ретранслятора   
4581 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4582 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4471 4471  }
4472 4472  
4473 4473  Ответ:
... ... @@ -4474,14 +4474,14 @@
4474 4474  
4475 4475  [ 
4476 4476  {    
4477 -"description": "", ~/~/ Определяет описание
4478 -"subscriberId": "", ~/~/ идентификатор запроса
4479 -"protocolType": 0, ~/~/ Тип протокола
4480 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4481 -"address": "string", ~/~/ Адрес события
4482 -"id": "", ~/~/ идентификатор пользователя   
4483 -"parentId": "", ~/~/ Guid идентификатор родителя
4484 -"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 - не удален
4485 4485  }
4486 4486  ]
4487 4487  
... ... @@ -4564,6 +4564,342 @@
4564 4564  ]
4565 4565  
4566 4566  
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 +
4567 4567  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4568 4568  
4569 4569  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==

Меню

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