Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2024/07/19 15:59
on 2024/07/19 15:59
edited by Андрей Калиновский
on 2025/06/27 13:52
on 2025/06/27 13:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,11 +14,20 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 36 + 37 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 38 + 39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 40 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 44 +((( 45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 47 +))) 22 22 23 23 (% class="box successmessage" %) 24 24 ((( ... ... @@ -44,12 +44,8 @@ 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - 48 -(% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 - "User": "testuser" , ~/~/ имя пользователя 51 - 52 -(% lang="en-US" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 53 53 } 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -101,29 +101,41 @@ 101 101 Запрос должен содержать данные параметра "**agentId**" 102 102 103 103 (% style="color:#000000" %)Ответ: 126 + 127 +((( 104 104 { 105 - "agentId": "", (%%) 106 - "parentId": "", 107 - "parentName": "string", 108 - "name": "string", 109 - "fullName": "string", 110 - "agentInfoType": 0, 111 - "isForeign": true/false, 112 - "district": "string", 113 - "region": "string", 114 - "city": "string", 115 - "inn": "string", 116 - "kpp": "string", 117 - "address": "string", 118 - "addressFact": "string", 119 - "email": "string", 120 - "director": "string", 121 - "bankName": "string", 122 - "bankBIK": "string", 123 - "bankRS": "string", 124 - "bankKS": "string" 125 - } 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 +))) 126 126 160 + 127 127 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 128 128 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 129 129 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -229,7 +229,6 @@ 229 229 "bankKS": "string" ~/~/ корр. счёт 230 230 } 231 231 232 - 233 233 Ответ: 234 234 235 235 { ... ... @@ -423,7 +423,6 @@ 423 423 ], 424 424 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 425 425 } 426 - 427 427 { 428 428 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 429 429 "lastName": "string", ... ... @@ -437,12 +437,8 @@ 437 437 438 438 (% style="text-align:left" %) 439 439 (% style="color:#000000; font-weight:normal" %)Ответ: 440 - 441 -(% style="text-align:left" %) 442 -(% style="color:#000000; font-weight:normal" %){ 443 - 444 -(% style="text-align:left" %) 445 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "id": "" , ~/~/ ID пользователя 446 446 "lastName": "" , ~/~/ Фамилия , 447 447 "firstName": "" , ~/~/ Имя 448 448 "position": "" , ~/~/ Должность ... ... @@ -459,11 +459,9 @@ 459 459 "kind": "" , ~/~/ тип аутентификации 460 460 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 461 461 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 462 462 463 -(% style="text-align:left" %) 464 -(% style="color:#000000; font-weight:normal" %)} 465 465 466 - 467 467 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 468 468 469 469 (% class="box infomessage" %) ... ... @@ -483,19 +483,16 @@ 483 483 484 484 (% style="color:#000000" %)Параметры в теле запроса (JSON): 485 485 486 -(% style="color:#000000" %){ 487 - 512 +(% style="color:#000000" %){(%%) 488 488 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 489 489 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 490 490 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 491 491 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 492 - 493 493 (% style="color:#000000" %)} 494 494 495 495 (% style="color:#000000" %)Ответ: 496 496 497 497 (% style="color:#000000" %){ (%%) 498 - 499 499 "id": "" , ~/~/ идентификатор пользователя 500 500 "lastName": "" , ~/~/ фамилия 501 501 "firstName": "" , ~/~/ имя ... ... @@ -509,7 +509,6 @@ 509 509 "sessionDuration":"", ~/~/ длительность сессии в минутах 510 510 "status": "1", ~/~/ статус пользователя 511 511 "lastLogged": "", ~/~/ дата/время последней авторизации 512 - 513 513 (% style="color:#000000" %)} 514 514 515 515 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -583,10 +583,8 @@ 583 583 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 584 584 585 585 (% lang="en-US" style="text-align:left" %) 586 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 - 588 -(% lang="en-US" style="text-align:left" %) 589 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "id": "" , ~/~/ ID пользователя 590 590 "lastName": "" , ~/~/ фамилия 591 591 "firstName": "" , ~/~/ имя 592 592 "position": "" , ~/~/ должность ... ... @@ -608,9 +608,7 @@ 608 608 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 609 609 }, 610 610 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 611 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 612 - 613 -(% lang="en-US" style="text-align:left" %) 631 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 614 614 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 615 615 616 616 (% lang="en-US" style="text-align:left" %) ... ... @@ -617,10 +617,8 @@ 617 617 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 618 618 619 619 (% lang="en-US" style="text-align:left" %) 620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 621 - 622 -(% lang="en-US" style="text-align:left" %) 623 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "id": "" , ~/~/ идентификатор пользователя 624 624 "lastName": "" , ~/~/ фамилия 625 625 "firstName": "" , ~/~/ имя 626 626 "position": "" , ~/~/ должность ... ... @@ -641,10 +641,8 @@ 641 641 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 642 642 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 643 643 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 660 +} 644 644 645 -(% lang="en-US" style="text-align:left" %) 646 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 647 - 648 648 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 649 649 650 650 (% class="box warningmessage" %) ... ... @@ -664,12 +664,10 @@ 664 664 665 665 (% style="color:#000000" %)Параметры в теле запроса (JSON): 666 666 667 -(% style="color:#000000" %){ 668 - 681 +(% style="color:#000000" %){(%%) 669 669 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 670 670 "description": "" , ~/~/ описание 671 671 "data": "" , ~/~/ данные, связанные со сменой статуса 672 - 673 673 (% style="color:#000000" %)} 674 674 675 675 (% style="text-align:left" %) ... ... @@ -691,7 +691,7 @@ 691 691 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 692 692 693 693 [ 694 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 695 695 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 696 696 ] 697 697 ... ... @@ -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,880 + "deleted": false, 869 869 "extId": "string", 870 870 "name": "string", 871 871 "picture": "string", ... ... @@ -884,7 +884,7 @@ 884 884 { 885 885 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 886 886 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 887 - "deleted": true,899 + "deleted": false, 888 888 "extId": "string", 889 889 "name": "string", 890 890 "picture": "string", ... ... @@ -918,7 +918,7 @@ 918 918 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 919 919 ))) 920 920 921 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 922 922 923 923 (% style="color:#000000" %)Метод запроса: **PUT** 924 924 ... ... @@ -985,7 +985,7 @@ 985 985 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 986 986 ))) 987 987 988 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 989 989 990 990 (% style="color:#000000" %)Метод запроса: **DELETE** 991 991 ... ... @@ -997,7 +997,7 @@ 997 997 998 998 Ответ: В случае успеха **Success 200** 999 999 1000 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1001 1001 1002 1002 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1003 1003 ... ... @@ -1026,6 +1026,17 @@ 1026 1026 1027 1027 ((( 1028 1028 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 1029 1029 "vehicleId": "", ~/~/ ID объекта 1030 1030 "name": "", ~/~/ Имя объекта 1031 1031 "imei": "", ~/~/ IMEI объекта ... ... @@ -1033,19 +1033,15 @@ 1033 1033 "deviceTypeName": "", ~/~/ Название типа устройства 1034 1034 "sim1": "", ~/~/ Номер SIM1 1035 1035 "sim2": "", ~/~/ Номер SIM2 1036 - 1037 1037 "parentId": "", ~/~/ ID клиента-родителя 1038 1038 "parentName": "", ~/~/ Наименование клиента-родителя 1039 1039 "modelId": "", ~/~/ ID модели объекта 1040 1040 "modelName": "", ~/~/ Имя модели объекта 1041 - 1042 1042 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1043 1043 "unitName": "string", ~/~/ Наименование подразделения 1044 1044 "status": 0, ~/~/ Статус объекта 1045 - 1046 1046 "createdAt": "", ~/~/ Дата создания объекта 1047 1047 }, 1048 - 1049 1049 "customFields": [ ~/~/ Произвольные поля 1050 1050 { 1051 1051 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1068,8 +1068,7 @@ 1068 1068 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1069 1069 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1070 1070 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1071 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1073 1073 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1074 1074 "mileageCoeff": 0, ~/~/ коэффициент пробега 1075 1075 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1099,7 +1099,6 @@ 1099 1099 "retries": 0 ~/~/ Количество попыток 1100 1100 } 1101 1101 ], 1102 - 1103 1103 "sensors": [ ~/~/ Датчики 1104 1104 { 1105 1105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1126,6 +1126,7 @@ 1126 1126 ], 1127 1127 "showInTooltip": true, ~/~/ Отображать в подсказке 1128 1128 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1129 1129 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1130 1130 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1131 1131 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1161,7 +1161,6 @@ 1161 1161 "isDefault": true ~/~/ По умолчанию 1162 1162 } 1163 1163 ], 1164 - 1165 1165 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1166 1166 { 1167 1167 "id": "", ~/~/ ID задания ... ... @@ -1178,19 +1178,27 @@ 1178 1178 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1179 1179 } 1180 1180 ], 1181 - 1182 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 1183 1183 { 1184 1184 "status": 0, 1185 1185 "date": "2023-05-22T09:57:39.562Z", 1186 1186 "description": "string", 1187 1187 "additionalInfo": "string" 1188 - } 1189 - ] 1190 1190 1205 +((( 1191 1191 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1192 1192 ))) 1193 1193 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1194 1194 (% style="text-align:left" %) 1195 1195 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1196 1196 ... ... @@ -1198,6 +1198,25 @@ 1198 1198 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1199 1199 1200 1200 1226 +== **Отправить команду на терминал** == 1227 + 1228 +(% class="box successmessage" %) 1229 +((( 1230 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1231 +))) 1232 + 1233 +Команда для отправки на тс. 1234 + 1235 +{ 1236 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1237 +"command": "", ~/~/ Текст отправляемой команды 1238 +"retries": "", ~/~/ Количество попыток отправки на терминал 1239 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1240 +} 1241 + 1242 +В ответ получаем cmdid 1243 + 1244 + 1201 1201 == **Получить ответ на отправленную на ТС команду** == 1202 1202 1203 1203 (% class="box infomessage" %) ... ... @@ -1205,13 +1205,13 @@ 1205 1205 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1206 1206 ))) 1207 1207 1208 -Идентификатор команды: cmd id1252 +Идентификатор команды: cmdId 1209 1209 1210 1210 Запрос от терминала на ответ команды 1211 1211 1212 1212 Пример ответ от терминала: 1213 1213 1214 -ID= "" ~/~/ идентификатор произвольного поля1258 +ID= "" ~/~/ идентификатор объекта 1215 1215 Soft="" ~/~/ версия софта 1216 1216 GPS=4 ~/~/ тип трекера 1217 1217 Time=11:05:43 28.06.24 ~/~/ время запроса ... ... @@ -1245,8 +1245,6 @@ 1245 1245 "status": "" ~/~/ Статус отправки 1246 1246 } 1247 1247 ] 1248 - 1249 - 1250 1250 ))) 1251 1251 1252 1252 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == ... ... @@ -1268,6 +1268,11 @@ 1268 1268 1269 1269 (% style="color:#000000" %){ 1270 1270 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1271 1271 "parentId": "" , ~/~/ ID клиента 1272 1272 "name": "" , ~/~/ имя ТС 1273 1273 "imei": "" , ~/~/ IMEI ... ... @@ -1288,7 +1288,6 @@ 1288 1288 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1289 1289 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1290 1290 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1291 - 1292 1292 "mileageCalcMethod": 0, 1293 1293 "mileageCoeff": 0, 1294 1294 "locationByCellId": true, ... ... @@ -1321,7 +1321,6 @@ 1321 1321 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1322 1322 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1323 1323 } 1324 - 1325 1325 "drivers": [ ~/~/ Водители 1326 1326 { 1327 1327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1336,8 +1336,7 @@ 1336 1336 "retries": 0 1337 1337 } 1338 1338 ], 1339 - 1340 - "sensors": [ ~/~/ Датчики 1384 +"sensors": [ ~/~/ Датчики 1341 1341 { 1342 1342 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1343 1343 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1363,6 +1363,7 @@ 1363 1363 ], 1364 1364 "showInTooltip": true, ~/~/ Отображать в подсказке 1365 1365 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1366 1366 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1367 1367 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1368 1368 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1375,97 +1375,216 @@ 1375 1375 "additionalProp2": "string", 1376 1376 "additionalProp3": "string" 1377 1377 }, 1378 - 1379 1379 ~/~/ Характерные для произвольного: 1380 - 1381 1381 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1382 - 1383 1383 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1384 - 1385 1385 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1386 - 1387 1387 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1388 - 1389 1389 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1390 - 1391 1391 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1392 - 1393 1393 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1394 - 1395 1395 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1396 - 1397 1397 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1398 - 1399 1399 ~/~/ "ValueOn": "Вкл.", 1400 - 1401 1401 ~/~/ "ValueOff": "Выкл." 1402 - "summaryMaxValue": 0 ~/~/ Макс. значение 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1403 1403 } 1404 1404 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1405 1405 "customFields": [ ~/~/ Произвольные поля 1406 1406 { 1407 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1408 - "name": "string", 1409 - "value": "string", 1410 - "forClient": true, 1411 - "forTooltip": true, 1412 - "forReport": true 1413 - } 1414 - ] 1454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1455 + "name": "string", ~/~/ Наименование произвольного поля 1456 + "value": "string", ~/~/ Значение произвольного поля 1457 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1458 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1459 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1415 1415 } 1470 +))) 1416 1416 1472 + 1417 1417 (% style="color:#000000" %)Ответ: 1418 1418 1419 -(% style="color:#000000" %){ 1420 1420 1421 - "vehicleId": "", ~/~/ID ТС 1422 - "parentId": "", ~/~/Guid владельца ТС 1423 - "name": "", ~/~/Имя объекта 1424 - "imei": "", ~/~/IMEI 1425 - "deviceTypeId": "", ~/~/ID типа устройства 1426 - "modelId": "", ~/~/ID модели 1427 - "unitId": "", ~/~/ID подразделения 1428 - "sim1": "", ~/~/SIM1 1429 - "sim2": "", ~/~/SIM2 1430 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1431 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1432 - "counters": { ~/~/Счётчики 1433 - "mileageEnabled": true, 1434 - "motohoursEnabled": true, 1435 - "mileage": "", 1436 - "motohours": 345.0 1437 - }, 1438 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1439 - "id": null, 1440 - "enabled": true, ~/~/флаг включения 1441 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1442 - "login": "", ~/~/ имя учетной записи 1443 - "password": "" ~/~/ пароль учетной записи 1444 - }, 1445 - "inspectionTasks": { ~/~/ задания на ТО 1446 - "id": "", ~/~/ ID задачи 1447 - "enabled": false, ~/~/ Признак включения 1448 - "name": "", ~/~/ Имя задания 1449 - "description": "", ~/~/ Описание задания 1450 - "mileageCondition": "", ~/~/ Условие по пробегу 1451 - "lastMileage": "", ~/~/ Пробег (в метрах) 1452 - "motohoursCondition": "", ~/~/ Условие по моточасам 1453 - "lastMotohours": "", ~/~/ Моточасы 1454 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1455 - "kind": "", ~/~/ Вид периодичности по времени 1456 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1476 +((( 1477 +((( 1478 +((( 1479 +{ 1480 + "vehicleId": 0, ~/~/ ID ТС 1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1482 + "name": "string", ~/~/ Имя объекта 1483 + "imei": "string", ~/~/ IMEI 1484 + "deviceTypeId": 0, ~/~/ ID типа устройства 1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1487 + "sim1": "string", ~/~/ SIM1 1488 + "sim2": "string", ~/~/ SIM2 1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1491 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1506 + "counters": { ~/~/ Dto для состояний счётчиков 1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1509 + "mileage": 0, ~/~/ Пробег 1510 + "motohours": 0 ~/~/ Моточасы 1511 + }, 1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1513 + "id": "string", ~/~/ CMSV6 Идентификатор 1514 + "enabled": true, ~/~/ Признак включения 1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1516 + "login": "string", ~/~/ CMSV6 имя учетной записи 1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1518 + }, 1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1522 + "enabled": true, ~/~/ Признак включения 1523 + "name": "string", ~/~/ Имя задания 1524 + "description": "string", ~/~/ Описание задания 1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1457 1457 } 1534 + ], 1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1536 + { 1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1538 + "inputNumber": 0, ~/~/ № входа. 1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1540 + "comment": "string", ~/~/ Комментарий 1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1545 + } 1546 + ], 1547 + "commandTemplates": [ ~/~/ Список шаблонов команд 1548 + { 1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1550 + "name": "string", ~/~/ Название шаблона команд 1551 + "command": "string", ~/~/ Команда на выполнение 1552 + "retries": 0 ~/~/ Лимит попыток отправки 1553 + } 1554 + ], 1555 + "sensors": [ ~/~/ Список датчиков 1556 + { 1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1559 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1560 + "name": "string", ~/~/ Имя датчика 1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1562 + "inputNumber": 0, ~/~/ Номер входа 1563 + "pseudonym": "string", ~/~/ Псевдоним 1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1565 + "isInverted": true, ~/~/ Признак инверсии 1566 + "disabled": true, ~/~/ Датчик не участвует в обработке 1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1568 + "gradesTables": [ ~/~/ Тарировка 1569 + { 1570 + "grades": [ ~/~/ Таблицы тарировки 1571 + { 1572 + "input": 0, ~/~/ Вход 1573 + "output": 0 ~/~/ Выход 1574 + } 1575 + ], 1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1577 + } 1578 + ], 1579 + "showInTooltip": true, ~/~/ Отображение в подсказке 1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1582 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1583 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1584 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1585 + "expr": "string", ~/~/ Выражение 1586 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1587 + "string" 1588 + ], 1589 + "customParams": { 1590 + "additionalProp1": "string", 1591 + "additionalProp2": "string", 1592 + "additionalProp3": "string" 1593 + }, 1594 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1595 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1596 + { 1597 + "from": 0, ~/~/ С какого значения 1598 + "color": "string", ~/~/ Каким цветом 1599 +))) 1458 1458 1459 -(% style="text-align:left" %) 1460 -(% style="color:#000000" %)} 1601 +((( 1602 + "text": "string" ~/~/ Текст подписи к этому интервалу 1603 + } 1604 + ] 1605 + } 1606 + ], 1607 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1608 + "customFields": [ ~/~/ Список произвольных полей 1609 + { 1610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1611 + "name": "string", ~/~/ Наименование произвольного поля 1612 + "value": "string", ~/~/ Значение произвольного поля 1613 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1614 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1615 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1616 + } 1617 + ], 1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1619 +} 1620 +))) 1621 +))) 1622 +))) 1461 1461 1624 + 1462 1462 **Валидация:** 1463 1463 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1464 1464 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1465 1465 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1466 1466 1467 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1468 1468 1631 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 + 1469 1469 (% class="box infomessage" %) 1470 1470 ((( 1471 1471 (% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -1505,9 +1505,12 @@ 1505 1505 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1506 1506 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1507 1507 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1508 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1509 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1510 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1672 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1673 + "unitName": "string", ~/~/ Название подразделения (опционально) 1674 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1675 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1676 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1677 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1511 1511 } 1512 1512 1513 1513 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1514,8 +1514,14 @@ 1514 1514 1515 1515 (% style="color:#000000" %)Ответ: 1516 1516 1517 -(% style="color:#000000" %){ 1684 +(% style="color:#000000" %)[ 1685 +{ 1518 1518 1687 +((( 1688 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1689 +))) 1690 + 1691 +((( 1519 1519 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1520 1520 "name": "" ~/~/ наименование объекта 1521 1521 "imei": "" ~/~/ IMEI объекта ... ... @@ -1541,9 +1541,21 @@ 1541 1541 "forClient": true, ~/~/ право на отображение у клиента 1542 1542 "forTooltip": false, ~/~/ право на отображение в подсказке 1543 1543 "forReport": false ~/~/ право на отображение в отчетах 1544 - }(%%) 1545 -(% style="color:#000000" %)} 1717 +))) 1546 1546 1719 +((( 1720 + } 1721 + ], 1722 + "vehicleGroups": [ ~/~/ Группы ТС 1723 + { 1724 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1725 + "name": "string" ~/~/ Наименование группы ТС 1726 + } 1727 + ] 1728 + } 1729 +] 1730 +))) 1731 + 1547 1547 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1548 1548 1549 1549 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1575,13 +1575,11 @@ 1575 1575 "data": "", ~/~/ Данные 1576 1576 "overwrite": false, ~/~/ Флаг перезаписи 1577 1577 "stage": "", ~/~/ Состояние, может быть null 1578 - 1579 1579 (% style="color:#000000" %)} 1580 1580 1581 1581 (% style="color:#000000" %)Ответ: 1582 1582 1583 -(% style="color:#000000" %){ 1584 - 1767 +(% style="color:#000000" %){(%%) 1585 1585 "status": "", ~/~/ значение статуса 1586 1586 "date": "", ~/~/ Дата смены статуса 1587 1587 "description": "", ~/~/ Описание ... ... @@ -1588,28 +1588,9 @@ 1588 1588 "data": "", ~/~/ Данные 1589 1589 "overwrite": false, ~/~/ Флаг перезаписи 1590 1590 "stage": "", ~/~/ Состояние 1591 - 1592 -(% style="text-align:left" %) 1593 1593 (% style="color:#000000" %) } 1594 1594 1595 -(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1596 -**Отправить команду на терминал** 1597 1597 1598 -(% class="box successmessage" %) 1599 -((( 1600 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1601 -))) 1602 - 1603 -Команда для отправки на тс. 1604 - 1605 -{ 1606 -"id": "", ~/~/идентификатор произвольного поля 1607 -"command": "", ~/~/ Текст команды 1608 -"retries": "", ~/~/ Количество попыток 1609 -"idTemplate": "" ~/~/ ID шаблона команды 1610 -} 1611 - 1612 - 1613 1613 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1614 1614 1615 1615 (% class="box warningmessage" %) ... ... @@ -1685,9 +1685,19 @@ 1685 1685 1686 1686 "drivers": [ ~/~/ Водители 1687 1687 { 1688 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1689 - "isDefault": true 1690 - } 1852 + 1853 +((( 1854 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1855 + "inputNumber": 0, ~/~/ № входа. 1856 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1857 + "comment": "string", ~/~/ Комментарий. 1858 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1859 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1860 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1861 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1862 +))) 1863 + 1864 + } 1691 1691 ], 1692 1692 "commandTemplates": [ ~/~/ Шаблон команды 1693 1693 { ... ... @@ -1697,8 +1697,7 @@ 1697 1697 "retries": 0 1698 1698 } 1699 1699 ], 1700 - 1701 - "sensors": [ ~/~/ Датчики 1874 +"sensors": [ ~/~/ Датчики 1702 1702 { 1703 1703 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1704 1704 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1724,6 +1724,11 @@ 1724 1724 ], 1725 1725 "showInTooltip": true, ~/~/ Отображать в подсказке 1726 1726 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1900 + 1901 +((( 1902 + "color": "string",** ~/~/ **Цвет датчика 1903 +))) 1904 + 1727 1727 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1728 1728 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1729 1729 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1736,95 +1736,225 @@ 1736 1736 "additionalProp2": "string", 1737 1737 "additionalProp3": "string" 1738 1738 }, 1739 - 1740 1740 ~/~/ Характерные для произвольного: 1741 - 1742 1742 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1743 - 1744 1744 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1745 - 1746 1746 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1747 - 1748 1748 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1749 - 1750 1750 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1751 - 1752 1752 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1753 - 1754 1754 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1755 - 1756 1756 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1757 - 1758 1758 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1759 - 1760 1760 ~/~/ "ValueOn": "Вкл.", 1761 - 1762 1762 ~/~/ "ValueOff": "Выкл." 1763 1763 "summaryMaxValue": 0 ~/~/ Макс. значение 1930 + 1931 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1932 + { 1933 + "from": 0, ~/~/ С какого значения 1934 + "color": "string", ~/~/ Каким цветом 1935 + "text": "string" ~/~/ Текст подписи к этому интервалу 1936 + } 1937 + ] 1764 1764 } 1765 1765 ], 1940 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1941 + 1766 1766 "customFields": [ ~/~/ Произвольные поля 1767 - { 1768 - 1769 - "name": "string", 1770 - "value": "string", 1771 - "forClient": true, 1772 - "forTooltip": true, 1773 - "forReport": true 1943 + { 1944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1945 + "name": "string", ~/~/ Наименование произвольного поля 1946 + "value": "string", ~/~/ Значение произвольного поля 1947 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1948 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1949 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1774 1774 } 1775 - ] 1951 + 1952 +((( 1953 + ], 1954 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1955 +))) 1956 + 1776 1776 } 1777 1777 1959 + 1778 1778 (% style="color:#000000" %)Ответ: 1779 1779 1780 -(% lang="en-US" style="text-align:left" %) 1781 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1962 +((( 1963 +{ 1964 + "vehicleId": 0, ~/~/ ID ТС 1965 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1966 + "name": "string", ~/~/ Имя объекта 1967 + "imei": "string", ~/~/ IMEI 1968 + "deviceTypeId": 0, ~/~/ ID типа устройства 1969 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1970 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1971 + "sim1": "string", ~/~/ SIM1 1972 + "sim2": "string", ~/~/ SIM2 1973 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1974 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1975 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1976 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1977 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1978 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1979 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1980 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1981 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1982 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1983 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1984 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1985 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1986 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1987 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1988 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1989 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1990 + "counters": { ~/~/ состояний счётчиков 1991 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1992 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1993 + "mileage": 0, ~/~/ Пробег 1994 + "motohours": 0 ~/~/ Моточасы 1995 + }, 1996 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1997 + "id": "string", ~/~/ CMSV6 Идентификатор 1998 + "enabled": true, ~/~/ Признак включения 1999 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2000 +))) 1782 1782 1783 -(% lang="en-US" style="text-align:left" %) 1784 - "vehicleId": "", ~/~/ ID ТС 1785 - "parentId": "", ~/~/ ID клиента 1786 - "name": "", ~/~/ имя ТС 1787 - "imei": "", ~/~/ IMEI 1788 - "deviceTypeId": "", ~/~/ типа устройства 1789 - "modelId": "", ~/~/ ID модели 1790 - "unitId": "", ~/~/ ID подразделения 1791 - "sim1": "", ~/~/ SIM 1 1792 - "sim2": "", ~/~/ SIM2 1793 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1794 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1795 - "counters": 1796 - { 1797 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1798 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1799 - "mileage": "", ~/~/ пробег 1800 - "motohours": "", ~/~/ моточасы 1801 - } 1802 - "cmsv6Parameters": ~/~/ параметры CMSv6 2002 + 2003 +((( 2004 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2005 + "login": "string", ~/~/ CMSV6 имя учетной записи 2006 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2007 + }, 2008 + "inspectionTasks": [ ~/~/ Задания на ТО 2009 + { 2010 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2011 + "enabled": true, ~/~/ Признак включения 2012 + "name": "string", ~/~/ Имя задания 2013 + "description": "string", ~/~/ Описание задания 2014 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2015 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2016 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2017 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2018 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2019 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2020 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2021 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2022 + } 2023 + ], 2024 + "drivers": [ ~/~/ Список водителей 2025 + { 2026 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2027 + "inputNumber": 0, ~/~/ № входа. 2028 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2029 + "comment": "string", ~/~/ Комментарий. 2030 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2032 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2033 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2034 + } 2035 + ], 2036 + "commandTemplates": [ ~/~/ Список шаблонов команд 2037 + { 2038 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2039 + "name": "string", ~/~/ Название шаблона команд 2040 + "command": "string", ~/~/ Команда на выполнение 2041 + "retries": 0 ~/~/ Лимит попыток отправки 2042 + } 2043 + ], 2044 + "sensors": [ ~/~/ Список датчиков 2045 + { 2046 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2047 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2048 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2049 +))) 2050 + 2051 +((( 2052 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2053 +))) 2054 + 2055 +((( 2056 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2057 +))) 2058 + 2059 +((( 2060 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2061 +))) 2062 + 2063 +((( 2064 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2065 +))) 2066 + 2067 +((( 2068 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2069 + "name": "string", ~/~/ Имя датчика 2070 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2071 +))) 2072 + 2073 +((( 2074 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2075 + "inputNumber": 0, ~/~/ Номер входа 2076 + "pseudonym": "string", ~/~/ Псевдоним 2077 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2078 + "isInverted": true, ~/~/ Признак инверсии 2079 + "disabled": true, ~/~/ Датчик не участвует в обработке 2080 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2081 + "gradesTables": [ ~/~/ Тарировка 1803 1803 { 1804 - "id": ~/~/ идентификатор 1805 - "enabled": true, ~/~/ флаг включения 1806 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1807 - "login": "", ~/~/ имя учетной записи 1808 - "password": "", ~/~/ пароль учетной записи 1809 - } 1810 - "inspectionTasks": ~/~/ задания на ТО 1811 - { 1812 - "id": "", ~/~/ ID задания 1813 - "enabled": false, ~/~/ Признак включения 1814 - "name": "", ~/~/ Имя задания 1815 - "description": "", ~/~/ Описание задания 1816 - "mileageCondition": "", ~/~/ Условие по пробегу 1817 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1818 - "motohoursCondition": "", ~/~/ Условие по моточасам 1819 - "lastMotohours": "", ~/~/ Моточасы 1820 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1821 - "kind": "", ~/~/ Вид периодичности по времени 1822 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2083 + "grades": [ ~/~/ Таблицы тарировки 2084 + { 2085 + "input": 0, ~/~/ Вход 2086 + "output": 0 ~/~/ Выход 2087 + } 2088 + ], 2089 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1823 1823 } 2091 + ], 2092 + "showInTooltip": true, ~/~/ Отображение в подсказке 2093 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1824 1824 1825 -(% lang="en-US" style="text-align:left" %) 1826 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2095 +((( 2096 + "color": "string", ~/~/ цвет уведомлений 2097 +))) 1827 1827 2099 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2100 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2101 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2102 + "expr": "string", ~/~/ Выражение 2103 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2104 + "string" 2105 + ], 2106 + "customParams": { ~/~/ Дополнительные настройки 2107 + "additionalProp1": "string", 2108 + "additionalProp2": "string", 2109 + "additionalProp3": "string" 2110 + }, 2111 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2112 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2113 + { 2114 + "from": 0, ~/~/ С какого значения 2115 + "color": "string", ~/~/ Каким цветом 2116 + "text": "string" ~/~/ Текст подписи к этому интервалу 2117 + } 2118 + ] 2119 + } 2120 + ], 2121 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2122 + "customFields": [ ~/~/ Список произвольных полей 2123 + { 2124 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2125 + "name": "string", ~/~/ Наименование произвольного поля 2126 + "value": "string", ~/~/ Значение произвольного поля 2127 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2128 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2129 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2130 + } 2131 + ], 2132 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2133 +} 2134 +))) 2135 + 1828 1828 **Валидация:** 1829 1829 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1830 1830 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1869,12 +1869,9 @@ 1869 1869 1870 1870 (% style="color:#000000" %)Ответ: 1871 1871 1872 -(% style="color:#000000" %){ 1873 - 2180 +(% style="color:#000000" %){(%%) 1874 1874 "deviceTypeId" : "", ~/~/ ID типа устройства 1875 1875 "deviceTypeName" : "" ~/~/ Название типа устройства 1876 - 1877 -(% style="text-align:left" %) 1878 1878 (% style="color:#000000" %)} 1879 1879 1880 1880 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -2101,10 +2101,14 @@ 2101 2101 { 2102 2102 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2103 2103 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2104 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2105 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2106 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2107 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2409 + "mileage": 0, ~/~/ Пробег за период, километры 2410 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2411 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2412 + "motohours": 0, ~/~/ Моточасы за период, секунды 2413 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2414 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2415 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2416 + 2108 2108 } 2109 2109 ] 2110 2110 } ... ... @@ -2146,13 +2146,23 @@ 2146 2146 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2147 2147 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2148 2148 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2149 2149 "fuelConsumption": 0, ~/~/ Расход топлива 2150 2150 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2151 2151 } 2152 2152 ] 2153 2153 } 2154 2154 ] 2155 2155 2469 +(% class="box warningmessage" %) 2470 +((( 2471 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2472 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2473 +))) 2474 + 2156 2156 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2157 2157 2158 2158 (% class="box infomessage" %) ... ... @@ -2187,7 +2187,8 @@ 2187 2187 "model": "string", ~/~/ Модель объекта 2188 2188 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2189 2189 { 2190 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2509 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2510 + 2191 2191 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2192 2192 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2193 2193 "valueFuel": 0, ~/~/ Количество ... ... @@ -2240,7 +2240,7 @@ 2240 2240 ], 2241 2241 "stops": [ ~/~/ События стоянок 2242 2242 { 2243 - "address": "strin g", ~/~/ Адрес события2563 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2244 2244 "eventId": 0, ~/~/ Идентификатор события 2245 2245 "eventName": "string", ~/~/ Название события 2246 2246 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события ... ... @@ -2288,7 +2288,6 @@ 2288 2288 } 2289 2289 2290 2290 2291 - 2292 2292 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2293 2293 2294 2294 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2417,6 +2417,35 @@ 2417 2417 } 2418 2418 ] 2419 2419 2739 + 2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 + 2742 +(% class="box successmessage" %) 2743 +((( 2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 +))) 2746 + 2747 +(% style="color:#000000" %)Метод запроса: **PUT** 2748 + 2749 +Пример запроса: 2750 + 2751 +((( 2752 +{ 2753 + "id": 0, ~/~/ Идентификатор объекта геозоны 2754 + "name": "string", ~/~/ Наименование объекта геозоны 2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 + "description": "string", ~/~/ Описание объекта геозоны 2757 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 +} 2761 +))) 2762 + 2763 + 2764 +Пример ответа: 2765 + 2766 +200 ~/~/ Success 2767 + 2420 2420 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2421 2421 2422 2422 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2448,7 +2448,7 @@ 2448 2448 "id": 0, ~/~/ ID уведомления 2449 2449 "name": "string", ~/~/ Название уведомления 2450 2450 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2451 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2452 2452 "userId": "", ~/~/ Пользователь, создавший уведомление 2453 2453 "parentId": "", ~/~/ Идентификатор клиента 2454 2454 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2455,6 +2455,155 @@ 2455 2455 } 2456 2456 ] 2457 2457 2806 + 2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2808 + 2809 +(% class="box infomessage" %) 2810 +((( 2811 +**POST /api/v3/notifications** 2812 +))) 2813 + 2814 +Метод запроса **POST** 2815 + 2816 +(% style="text-align: left;" %) 2817 +(% style="color:#000000" %)Пример запроса 2818 + 2819 +((( 2820 +{ 2821 + "id": 0, ~/~/ ID правила 2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2825 + "name": "string", ~/~/ Имя правила 2826 + "active": true, ~/~/ Активность правила 2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2830 + ], 2831 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2832 + 0 2833 + ], 2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2835 + 0 2836 + ], 2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2838 + 0 2839 + ], 2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2841 + "additionalProp1": "string", 2842 + "additionalProp2": "string", 2843 + "additionalProp3": "string" 2844 + }, 2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2848 + ], 2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2851 + "string" 2852 + ], 2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2855 + { 2856 + "id": 0, ~/~/ Идентификатор участника чата. 2857 + "info": "string" ~/~/ Дополнительные сведения. 2858 + } 2859 + ], 2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2866 + "timezone": 0, ~/~/ часовой пояс 2867 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2868 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2869 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2870 + { 2871 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2874 + "additionalProp1": "string", 2875 + "additionalProp2": "string", 2876 + "additionalProp3": "string" 2877 + } 2878 + } 2879 + ] 2880 +} 2881 +))) 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +Ответ: 2892 + 2893 +{ 2894 + "id": 0, ~/~/ ID правила 2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2898 + "name": "string", ~/~/ Имя правила 2899 + "active": true, ~/~/ Активность правила 2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2903 + ], 2904 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата. 2930 + "info": "string" ~/~/ Дополнительные сведения. 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2939 + "timezone": 0, ~/~/ часовой пояс 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2941 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2942 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2943 + { 2944 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2947 + "additionalProp1": "string", 2948 + "additionalProp2": "string", 2949 + "additionalProp3": "string" 2950 + } 2951 + } 2952 + ] 2953 +} 2954 + 2458 2458 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2459 2459 2460 2460 (% class="box infomessage" %) ... ... @@ -2596,6 +2596,32 @@ 2596 2596 2597 2597 Success 2598 2598 3096 + 3097 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3098 + 3099 +(% class="box warningmessage" %) 3100 +((( 3101 +**PUT** /api/v3/notifications/prolongation 3102 +))) 3103 + 3104 +Метод позволяет продлить уведомления. 3105 + 3106 +Метод запроса **PUT** 3107 + 3108 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3109 + 3110 +В заголовках запроса: X-Auth: Токен авторизации. 3111 + 3112 +Тело запроса: 3113 + 3114 +[ 3115 + 3116 +0 3117 + 3118 +] 3119 + 3120 +где 0 идентификатор ids. 3121 + 2599 2599 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2600 2600 2601 2601 (% class="box errormessage" %) ... ... @@ -3646,16 +3646,12 @@ 3646 3646 Тело запроса: 3647 3647 3648 3648 { 3649 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3650 - "Balance": 0 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Balance": 0 ~/~/ Значение баланса. 3651 3651 } 3652 3652 3653 3653 Ответ: Success 3654 3654 3655 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3656 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3657 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3658 - 3659 3659 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3660 3660 3661 3661 (% class="box warningmessage" %) ... ... @@ -3667,16 +3667,29 @@ 3667 3667 3668 3668 Тело запроса: 3669 3669 4189 +((( 3670 3670 { 3671 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",3672 - " Balance": 04191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4192 + "amount": 0 ~/~/ Сумма пополнения баланса 3673 3673 } 4194 +))) 3674 3674 4196 +((( 4197 + 4198 +))) 4199 + 3675 3675 Ответ: Success 3676 3676 3677 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3678 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3679 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4202 +((( 4203 +{ 4204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4205 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4206 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4207 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4208 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4209 + "Description": "string" ~/~/ Описание корректировки. 4210 +} 4211 +))) 3680 3680 3681 3681 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3682 3682 ... ... @@ -3689,16 +3689,25 @@ 3689 3689 3690 3690 Тело запроса: 3691 3691 4224 +((( 3692 3692 { 3693 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",3694 - " Balance": 04226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4227 + "amount": 0 ~/~/ Сумма списания с баланса 3695 3695 } 4229 +))) 3696 3696 3697 3697 Ответ: Success 3698 3698 3699 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3700 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3701 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4233 +((( 4234 +{ 4235 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4236 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4237 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4238 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4239 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4240 + "Description": "string" ~/~/ Описание корректировки 4241 +} 4242 +))) 3702 3702 3703 3703 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3704 3704 ... ... @@ -3709,28 +3709,35 @@ 3709 3709 3710 3710 Тело запроса: 3711 3711 4253 +((( 3712 3712 { 3713 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3714 - "CalculationType": 0, 3715 - "PermissibleBalance": 0, 3716 - "DefermentDays": 0, 3717 - "SendUiNotifications": true, 3718 - "SendEmailNotifications": true, 3719 - "IsPrivate": true, 4255 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4256 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4257 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4258 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4259 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4260 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 3720 3720 } 4262 +))) 3721 3721 4264 +((( 4265 + 4266 +))) 4267 + 3722 3722 Ответ: Success 3723 3723 3724 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3725 -|ClientId|Идентификатор клиента 3726 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3727 -|PermissibleBalance|Допустимый баланс 3728 -|DefermentDays|((( 3729 -Отсрочка, количество дней 4270 +((( 4271 +{ 4272 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4273 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4274 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4275 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4276 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4277 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4278 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4279 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4280 +} 3730 3730 ))) 3731 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3732 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3733 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3734 3734 3735 3735 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3736 3736 ... ... @@ -3742,35 +3742,68 @@ 3742 3742 Тело запроса: 3743 3743 3744 3744 { 3745 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3746 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3747 - "Features": [ 4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4295 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 3748 3748 { 3749 - "Feature": "string", 3750 - "IsEnabled": true, 3751 - "IsFactual": true, 3752 - "Limit": 0, 3753 - "Price": 0, 3754 - "DebitDate": "2023-10-18T13:26:58.987Z", 3755 - "PeriodValue": 0, 3756 - "PeriodType": 0 4297 + "Feature": "string", ~/~/ Код услуги. 4298 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4299 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4300 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4301 + "Price": 0, ~/~/ Цена за единицу. 4302 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4303 + "PeriodValue": 0, ~/~/ Значение периода. 4304 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 3757 3757 } 3758 3758 ] 3759 3759 } 3760 3760 4309 + 3761 3761 Ответ: Success 3762 3762 3763 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3764 -|ClientId|Идентификатор клиента 3765 -|PlanId|Идентификатор тарифного плана 3766 -|Feature|Код услуги 3767 -|IsEnabled|Признак, определяющий активирована ли услуга 3768 -|IsFactual|Признак, определяющий расчёт по факту 3769 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3770 -|Price|Цена за единицу. 3771 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3772 -|PeriodValue|Значение периода. 3773 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4312 +((( 4313 +{ 4314 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4315 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4317 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4318 + "Name": "string", ~/~/ Наименование. 4319 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4320 + "Constraint": { ~/~/ Ограничения по тарифу 4321 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4322 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4323 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4324 + }, 4325 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4326 + { 4327 + "Feature": "string", ~/~/Код услуги. 4328 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4329 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4330 + "Price": 0, ~/~/ Цена за единицу. 4331 + "PeriodValue": 0, ~/~/ Значение периода. 4332 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4333 + } 4334 + ], 4335 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4336 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4337 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4338 + }, 4339 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4340 + { 4341 + "Feature": "string", ~/~/ Код услуги. 4342 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4343 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4344 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4345 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4346 + "Price": 0, ~/~/ Цена за единицу. 4347 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4348 + "PeriodValue": 0, ~/~/ Значение периода. 4349 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4350 + "Quantity": 0 ~/~/ Количество использования услуги. 4351 + } 4352 + ] 4353 +} 4354 +))) 3774 3774 3775 3775 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3776 3776 ... ... @@ -3786,7 +3786,7 @@ 3786 3786 **POST /api/v3/vehicles/import/{agentId}** 3787 3787 ))) 3788 3788 3789 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 4370 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3790 3790 3791 3791 В пути указывается **agentId** - id клиента. 3792 3792 ... ... @@ -3798,7 +3798,7 @@ 3798 3798 3799 3799 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3800 3800 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3801 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление4382 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3802 3802 3803 3803 В теле использовать тип **form-data,** тип значения** file** 3804 3804 ... ... @@ -3875,6 +3875,43 @@ 3875 3875 |producedCount|Кол-во успешно отправленных в шину данных сообщений 3876 3876 |msgCount|Кол-во обработанных сообщений всего 3877 3877 4459 +== **Импортировать историю ТС (Асинхронный запрос)** == 4460 + 4461 +(% class="box successmessage" %) 4462 +((( 4463 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4464 +))) 4465 + 4466 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4467 + 4468 +Метод запроса: **POST** 4469 + 4470 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 + 4472 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4473 + 4474 + 4475 +Ответ: 4476 + 4477 +{ 4478 + 4479 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4480 + 4481 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4482 + 4483 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4484 + 4485 + "Message": "string", ~/~/ Информация о выполнении запроса 4486 + 4487 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4488 + 4489 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4490 + 4491 + "Data": "string" ~/~/ Данные 4492 + 4493 +} 4494 + 4495 + 3878 3878 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3879 3879 3880 3880 (% class="box infomessage" %) ... ... @@ -3892,10 +3892,59 @@ 3892 3892 "message": "string" 3893 3893 } 3894 3894 3895 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3896 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3897 -|progress|Guid ТС 4513 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4514 +**Параметр** 4515 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4516 +**Описание** 4517 +))) 4518 +|((( 4519 +activity 4520 +)))|((( 4521 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4522 +))) 4523 +|((( 4524 +progress 4525 +)))|((( 4526 +Guid ТС 4527 +))) 3898 3898 4529 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4530 + 4531 +(% class="box infomessage" %) 4532 +((( 4533 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4534 +))) 4535 + 4536 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4537 + 4538 +Метод запроса: **GET** 4539 + 4540 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 + 4542 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4543 + 4544 + 4545 +Ответ: 4546 + 4547 +{ 4548 + 4549 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4550 + 4551 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4552 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4553 + 4554 + "Message": "string", ~/~/ Информация о выполнении запроса 4555 + 4556 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4557 + 4558 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4559 + 4560 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4561 + 4562 + "Data": "string" ~/~/ Данные 4563 + 4564 +} 4565 + 3899 3899 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3900 3900 3901 3901 (% class="box infomessage" %) ... ... @@ -3977,64 +3977,67 @@ 3977 3977 Тело запроса: 3978 3978 3979 3979 { 3980 - "vehicleIds": [vehicleId], 3981 - "from": "2023-11-22T09:29:48.051Z", 3982 - "to": "2023-11-22T09:29:48.051Z" 4647 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4648 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4649 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 3983 3983 } 3984 3984 3985 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3986 -|vehicleIds|Массив ID объектов 3987 -|from|Дата начала запроса 3988 -|to|Дата окончания запроса 3989 - 3990 3990 Ответ: 3991 3991 3992 3992 { 3993 - "items": [ 4655 + "items": [ ~/~/ Список в разрезе ТС 3994 3994 { 3995 - "from": "2023-11-22T09:29:48.052Z", 3996 - "to": "2023-11-22T09:29:48.052Z", 3997 - "vehicleId": 0, 3998 - "vehicleName": "string", 3999 - "vehicleModel": "string", 4000 - "penalty": 0, 4001 - "score": 0, 4002 - "totalViolations": 0, 4003 - "violationsByType": { 4004 - "overspeedingViolations": 0, 4005 - "accelerationViolations": 0, 4006 - "brakingViolations": 0, 4007 - "turningViolations": 0, 4008 - "dangerousDrivingViolations": 0, 4009 - "sensorViolations": 0 4657 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4658 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4659 + "vehicleId": 0, ~/~/ ID ТС 4660 + "vehicleName": "string", ~/~/ Название ТС 4661 + "vehicleModel": "string", ~/~/ Модель ТС 4662 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4663 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4664 + "totalViolations": 0, ~/~/ Нарушений всего 4665 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4666 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4667 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4668 + "brakingViolations": 0, ~/~/ Нарушений торможения 4669 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4670 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4671 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4010 4010 }, 4011 - "moveTime": 0, 4012 - "mileage": 0, 4013 - "tripsCount": 0, 4014 - "trips": [ 4673 + 4674 +((( 4675 + 4676 +))) 4677 + 4678 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4679 + "mileage": 0, ~/~/ Пробег, м 4680 + "tripsCount": 0, ~/~/ Кол-во рейсов 4681 + "trips": [ ~/~/ Информация по рейсу 4015 4015 { 4016 - "penalty": 0, 4017 - "score": 0, 4018 - "violationsCount": 0, 4019 - "violationsByType": { 4020 - "overspeedingViolations": 0, 4021 - "accelerationViolations": 0, 4022 - "brakingViolations": 0, 4023 - "turningViolations": 0, 4024 - "dangerousDrivingViolations": 0, 4025 - "sensorViolations": 0 4683 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4684 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4685 + "violationsCount": 0, ~/~/ Всего нарушений 4686 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4687 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4688 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4689 + "brakingViolations": 0, ~/~/ Нарушений торможения 4690 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4691 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4692 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4026 4026 }, 4027 - "moveTime": 0, 4028 - "mileage": 0, 4029 - "motohours": 0, 4030 - "maxSpeed": 0, 4031 - "startAddress": "string", 4032 - "endAddress": "string", 4033 - "drivers": [ 4694 + 4695 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4696 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4697 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4698 + "mileage": 0, ~/~/ Пробег, м 4699 + "motohours": 0, ~/~/ Моточасы, секунды 4700 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4701 + "startAddress": "string", ~/~/ Адрес начала рейса 4702 + "endAddress": "string", ~/~/ Адрес конца рейса 4703 + "drivers": [ ~/~/ Список водителей 4034 4034 { 4035 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4036 - "driverName": "string", 4037 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4705 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4706 + "driverName": "string", ~/~/ФИО водителя 4707 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4038 4038 } 4039 4039 ] 4040 4040 } ... ... @@ -4043,34 +4043,6 @@ 4043 4043 ] 4044 4044 } 4045 4045 4046 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4047 -|from|Дата начала запроса 4048 -|to|Дата окончания 4049 -|vehicleId|ID объекта 4050 -|vehicleName|Имя объекта 4051 -|vehicleModel|Модель объекта 4052 -|penalty|Сумма штрафных баллов 4053 -|score|Оценка 4054 -|totalViolations|Суммарное количество нарушений 4055 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4056 -|overspeedingViolations|Превышение скорости 4057 -|accelerationViolations|Ускорение 4058 -|brakingViolations|Торможение 4059 -|turningViolations|Резкий поворот 4060 -|dangerousDrivingViolations|Резкое вождение 4061 -|sensorViolations|Нарушение по датчику 4062 -|moveTime|Время в движении 4063 -|mileage|Пробег 4064 -|tripsCount|Количество рейсов 4065 -|motohours|Моточасы 4066 -|maxSpeed|Максимальная скорость 4067 -|startAddress|Адрес начала рейса 4068 -|endAddress|Адрес окончания рейса 4069 -|drivers|Список водителей, которые были на объекте в течениии рейса 4070 -|driverGuid|Guid водителя 4071 -|driverName|Имя водителя 4072 -|driverRfid|Номер Карты-метки 4073 - 4074 4074 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4075 4075 4076 4076 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == ... ... @@ -4079,7 +4079,7 @@ 4079 4079 4080 4080 (% class="box infomessage" %) 4081 4081 ((( 4082 -POST /api/v3/fuelcards/transactions 4724 +**POST /api/v3/fuelcards/transactions** 4083 4083 ))) 4084 4084 4085 4085 Метод запроса: POST ... ... @@ -4090,34 +4090,59 @@ 4090 4090 Параметры в теле запроса (JSON): 4091 4091 4092 4092 { 4093 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4094 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4735 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4736 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4095 4095 "ids": [ 4096 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ гуиды4738 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4097 4097 ], 4098 - "timezone": 0 ~/~/ Таймзона4740 + "timezone": 0 ~/~/ Часовой пояс 4099 4099 } 4100 4100 4101 4101 4102 4102 Ответ: 4103 4103 { 4104 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4105 - "driver": "string", ~/~/Водители, привязанные к ТК 4106 - "object": "string", ~/~/Наименование ТС 4107 - "amount": 0, ~/~/Количество топлива 4108 - "amountDut": 0, ~/~/Количество по ДУТ 4109 - "amountDiff": 0, ~/~/Разница, л 4110 - "amountDiffPerc": 0, ~/~/Разница, % 4111 - "summa": 0, ~/~/Стоимость, руб 4112 - "serviceName": "string", ~/~/Тип топлива 4113 - "price": 0, ~/~/Цена за литр, руб 4114 - "cardName": "string", ~/~/Наименование ТК 4115 - "cardNum": "string", ~/~/Номер ТК 4116 - "operator": "string", ~/~/Оператор ТК 4117 - "address": "string" ~/~/Адрес АЗС 4746 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4747 + "driver": "string", ~/~/ Водители, привязанные к ТК 4748 + "object": "string", ~/~/ Наименование ТС 4749 + "amount": 0, ~/~/ Количество топлива 4750 + "amountDut": 0, ~/~/ Количество по ДУТ 4751 + "amountDiff": 0, ~/~/ Разница, л 4752 + "amountDiffPerc": 0, ~/~/ Разница, % 4753 + "summa": 0, ~/~/ Стоимость, руб 4754 + "serviceName": "string", ~/~/ Тип топлива 4755 + "price": 0, ~/~/ Цена за литр, руб 4756 + "cardName": "string", ~/~/ Наименование ТК 4757 + "cardNum": "string", ~/~/ Номер ТК 4758 + "operator": "string", ~/~/ Оператор ТК 4759 + "address": "string" ~/~/ Адрес АЗС 4118 4118 } 4119 4119 4762 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4120 4120 4764 +(% class="box infomessage" %) 4765 +((( 4766 +**GET /api/v3/fuelcards** 4767 +))) 4768 + 4769 +Метод запроса: GET 4770 + 4771 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4772 + 4773 +Ответ: 4774 + 4775 +[ 4776 + { 4777 + "Name": "string", ~/~/ Определяет наименование карты. 4778 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4779 + "Number": "string", ~/~/ Определяет № карты. 4780 + "Enabled": true, ~/~/ Определяет признак активности карты. 4781 + "Description": "string", ~/~/ Определяет описание карты. 4782 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4783 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4784 + "deleted": true ~/~/ Признак удаления 4785 + } 4786 +] 4787 + 4121 4121 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4122 4122 4123 4123 ... ... @@ -4128,28 +4128,28 @@ 4128 4128 **GET ** **/api/v3/retranslations/{id}** 4129 4129 ))) 4130 4130 4131 -Идентификатор запроса:ID4798 +id - Идентификатор ретранслятора 4132 4132 4133 4133 4134 4134 Пример ответа: 4135 4135 4136 4136 { 4137 -"description": "", ~/~/ Определяетописание4138 -"subscriberId": "", ~/~/ Подписчик4139 -"protocolType": 0, ~/~/ Тип протокола 4140 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен4141 -"address": "string", ~/~/ Адрес события4142 -"objects": [ ~/~/Объекты для ретрансляции 4804 +"description": "", ~/~/ Поле описания ретранслятора 4805 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4806 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4807 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4808 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4809 +"objects": [ ~/~/ Объекты для ретрансляции 4143 4143 { 4144 4144 "id": "", ~/~/ Идентификатор объекта ретрансляции 4145 4145 "name": "", ~/~/ Наименование объекта ретрансляции 4146 -"imei": "", ~/~/ IMEI объекта 4147 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4813 +"imei": "", ~/~/ IMEI объекта ретрансляции 4814 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4148 4148 } 4149 4149 ], 4150 -"id": "", ~/~/ идентификаторпользователя4151 -"parentId": "", ~/~/ Guidродителя4152 -"deleted": "" ~/~/ Признак удаления ,Включен,true - включен, false - отключен4817 +"id": "", ~/~/ Идентификатор ретранслятора 4818 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4819 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4153 4153 } 4154 4154 4155 4155 ... ... @@ -4160,7 +4160,7 @@ 4160 4160 **DELETE** **/api/v3/retranslations/{id}** 4161 4161 ))) 4162 4162 4163 - Параметрзапроса:ID4830 +id - Идентификатор ретранслятора 4164 4164 4165 4165 4166 4166 == **Создание ретранслятора** == ... ... @@ -4173,16 +4173,16 @@ 4173 4173 Запрос: 4174 4174 4175 4175 { 4176 -"description": "", ~/~/ Описание4177 -"subscriberId": "", ~/~/ Подписчик4178 -"protocolType": 0, ~/~/ Тип протокола 4179 -"address": "", ~/~/ Адрес р етрансляции4180 -"isEnabled": "", ~/~/ признак,Включен, true - включен, false - отключен4843 +"description": "", ~/~/ Поле описания ретранслятора 4844 +"subscriberId": "", ~/~/ Идентификатор подписчика 4845 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4846 +"address": "", ~/~/ Адрес и порт принимающего сервера 4847 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4181 4181 "objects": [ ~/~/Объекты для ретрансляции 4182 4182 { 4183 -"id": "", ~/~/ идентификаторпользователя4184 -"imei": "", ~/~/IMEI объекта 4185 -"isEnabled": "" ~/~/ признак,Включен,true - включен, false - отключен4850 +"id": "", ~/~/ Идентификатор ретранслятора 4851 +"imei": "", ~/~/ IMEI объекта ретрансляции 4852 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4186 4186 } 4187 4187 ] 4188 4188 } ... ... @@ -4191,22 +4191,22 @@ 4191 4191 Ответ: 4192 4192 4193 4193 { 4194 -"description": " string", ~/~/Определяетописание4195 -"subscriberId": "", ~/~/ идентификаторзапроса4196 -"protocolType": 0, 4197 -"isEnabled": "", ~/~/признак,Включен,true - включен, false - отключен4198 -"address": "", ~/~/ Адрес события4199 -"objects": [ ~/~/Объекты для ретрансляции 4861 +"description": "", ~/~/ Поле описания ретранслятора 4862 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4863 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4864 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4865 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4866 +"objects": [ ~/~/ Объекты для ретрансляции 4200 4200 { 4201 -"id": "", идентификаторпользователя4202 -"name": "string", званиеуведомления4203 -"imei": " string", ~/~/IMEI объекта4204 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4868 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4869 +"name": "string", ~/~/ Наименование объекта ретрансляции 4870 +"imei": "", ~/~/ IMEI объекта ретрансляции 4871 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4205 4205 } 4206 - ], 4207 -"id": "", ~/~/ идентификаторпользователя4208 -"parentId": "", ~/~/ Guid идентификатор родителя4209 -"deleted": true ~/~/ Признак удаления 4873 + ], 4874 +"id": "", ~/~/ Идентификатор ретранслятора 4875 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4876 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4210 4210 } 4211 4211 4212 4212 ... ... @@ -4220,18 +4220,18 @@ 4220 4220 Пример запроса: 4221 4221 4222 4222 { 4223 -"id": "", ~/~/ идентификаторпользователя4224 -"description": "string", ~/~/ Определяетописание4225 -"subscriberId": "", ~/~/ идентификаторзапроса4226 -"protocolType": 0, ~/~/ Тип протокола 4227 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4228 -"address": "string", ~/~/ Адрес события4229 -"objects": ~/~/Объекты для ретрансляции 4890 +"id": "", ~/~/ Идентификатор ретранслятора 4891 +"description": "string", ~/~/ Поле описания ретранслятора 4892 +"subscriberId": "", ~/~/ Идентификатор подписчика 4893 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4894 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4895 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4896 +"objects": ~/~/ Объекты для ретрансляции 4230 4230 [ 4231 4231 { 4232 -"id": "", ~/~/ идентификаторпользователя4233 -"imei": "", ~/~/IMEI объекта 4234 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4899 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4900 +"imei": "", ~/~/ IMEI объекта ретрансляции 4901 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4235 4235 } 4236 4236 ] 4237 4237 } ... ... @@ -4240,22 +4240,22 @@ 4240 4240 Пример ответа: 4241 4241 4242 4242 { 4243 -"description": "", ~/~/ Определяетописание4244 -"subscriberId": "", ~/~/ идентификаторзапроса4245 -"protocolType": 0, ~/~/ Тип протокола 4246 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4247 -"address": "string", ~/~/ Адрес события4248 -"objects": [ ~/~/Объекты для ретрансляции 4910 +"description": "", ~/~/ Поле описания ретранслятора 4911 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4912 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4913 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4914 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4915 +"objects": [ ~/~/ Объекты для ретрансляции 4249 4249 { 4250 -"id": "", ~/~/ идентификаторпользователя4251 -"name": "string", ~/~/ На званиеуведомления4252 -"imei": "", ~/~/IMEI объекта 4253 -"isEnabled": true ~/~/ признак,Включен,true - включен, false - отключен4917 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4918 +"name": "string", ~/~/ Наименование объекта ретрансляции 4919 +"imei": "", ~/~/ IMEI объекта ретрансляции 4920 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4254 4254 } 4255 4255 ], 4256 -"id": "", ~/~/ идентификаторпользователя4257 -"parentId": "", ~/~/ Guid идентификатор родителя4258 -"deleted": true ~/~/ Признак удаления 4923 +"id": "", ~/~/ Идентификатор ретранслятора 4924 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4925 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4259 4259 } 4260 4260 4261 4261 ... ... @@ -4269,34 +4269,34 @@ 4269 4269 Пример запроса: 4270 4270 4271 4271 { 4272 -"id": "", ~/~/ идентификаторпользователя4273 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4274 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4939 +"id": "", ~/~/ Идентификатор ретранслятора 4940 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4941 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4275 4275 } 4276 4276 4277 -Ответ 4944 +Ответ: 4278 4278 4279 4279 [ 4280 4280 { 4281 -"description": "", ~/~/ Определяетописание4282 -"subscriberId": "", ~/~/ идентификаторзапроса4283 -"protocolType": 0, ~/~/ Тип протокола 4284 -"isEnabled": true, ~/~/ признак,Включен,true - включен, false - отключен4285 -"address": "string", ~/~/ Адрес события4286 -"id": "", ~/~/ идентификаторпользователя4287 -"parentId": "", ~/~/ Guid идентификатор родителя4288 -"deleted": true ~/~/ Признак удаления 4948 +"description": "", ~/~/ Поле описания ретранслятора 4949 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4950 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4951 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4952 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4953 +"id": "", ~/~/ Идентификатор ретранслятора 4954 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4955 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4289 4289 } 4290 4290 ] 4291 4291 4292 4292 4293 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =4960 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4294 4294 4295 4295 == **API для отчета по выгрузке комбайнов** == 4296 4296 4297 4297 (% class="box infomessage" %) 4298 4298 ((( 4299 -POST **/api/v3/Reports/harvesterUnloading**4966 +**POST /api/v3/Reports/harvesterUnloading** 4300 4300 ))) 4301 4301 4302 4302 Пример запроса: ... ... @@ -4368,7 +4368,674 @@ 4368 4368 ] 4369 4369 4370 4370 5038 +== **Отчет трек-датчики** == 5039 + 5040 +(% class="box infomessage" %) 5041 +((( 5042 +**POST /api/v3/Reports/sensorsWorks** 5043 +))) 5044 + 5045 +**Пример запроса:** 5046 + 5047 +{ 5048 + "vehicleIds": [ ~/~/ Список ID объектов 5049 + 0 5050 + ], 5051 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5052 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5053 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5054 +} 5055 + 5056 +**Пример ответа:** 5057 + 5058 +((( 5059 +{ 5060 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5061 + { 5062 + "vehicleId": 0, ~/~/ Идентификатор ТС 5063 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5064 + { 5065 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5066 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5067 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5068 + "name": "string", ~/~/ Наименование оборудования. 5069 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5070 + "totalMileage": 0, ~/~/ Общий пробег. 5071 + "avgSpeed": 0 ~/~/ Средняя скорость. 5072 + } 5073 + ] 5074 + } 5075 + ] 5076 +} 5077 + 5078 + 5079 +== **Превышение скорости** == 5080 + 5081 +(% class="box infomessage" %) 5082 +((( 5083 +**POST /api/v3/Reports/overSpeedDuration** 5084 +))) 5085 + 5086 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5087 + 5088 +Пример запроса: 5089 + 5090 +((( 5091 +{ 5092 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5093 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5094 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5095 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5096 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5097 +} 5098 +))) 5099 + 5100 +((( 5101 + 5102 +))) 5103 + 5104 +((( 5105 +Пример ответа: 5106 +))) 5107 + 5108 +((( 5109 +((( 5110 +[ 5111 + { 5112 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5113 + "duration": 0, ~/~/ Продолжительность события в секундах 5114 + "maxSpeed": 0, ~/~/ Максимальная скорость 5115 + "speedLimit": 0 ~/~/ Ограничение скорости 5116 + } 5117 +] 5118 +))) 5119 +))) 5120 +))) 5121 + 5122 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5123 + 5124 + 5125 +== **Запрос списка полей** == 5126 + 5127 +(% class="box successmessage" %) 5128 +((( 5129 +**POST /api/v3/agroLands/find** 5130 +))) 5131 + 5132 +Пример запроса: 5133 + 5134 +((( 5135 +((( 5136 +((( 5137 +{ 5138 + "year": 0, ~/~/ Фильтр по году 5139 + "name": "string", ~/~/ Фильтр по названию 5140 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5141 +} 5142 +))) 5143 +))) 5144 + 5145 + 5146 +))) 5147 + 5148 +Пример ответа: 5149 + 5150 +((( 5151 +[ 5152 + { 5153 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5154 + "year": 0, ~/~/ Год поля 5155 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5156 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5157 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5158 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5159 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5160 + "counts": { ~/~/ Счётчики с/х поля 5161 + "fieldOperations": 0, ~/~/ Количество операций на поле 5162 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5163 + "facts": 0 ~/~/ Счётчик факта 5164 + }, 5165 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5166 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5167 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5168 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5169 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5170 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5171 + "planComment": "string", ~/~/ Комментарий к полю 5172 + "productivity": 0, ~/~/ Урожайность. 5173 + "id": 0, ~/~/ Идентификатор объекта геозоны 5174 + "name": "string", ~/~/ Название объекта геозоны 5175 + "type": 0, ~/~/ Тип объекта геозоны 5176 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5177 + "fname": "string", ~/~/ Имя файла 5178 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5179 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5180 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5181 + "description": "string", ~/~/ Описание объекта геозоны 5182 + "area": 0, ~/~/ Площадь, м2 5183 + "perimetr": 0, ~/~/ Периметр, м 5184 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5185 + } 5186 +] 5187 + 5188 + 5189 +== **Создание нового поля ** == 5190 + 5191 +(% class="box successmessage" %) 5192 +((( 5193 +**POST /api/v3/agroLands** 5194 +))) 5195 + 5196 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5197 +X-agent - ID клиента 5198 + 5199 +Пример запроса: 5200 + 5201 +((( 5202 +{ 5203 + "extId": "string", 5204 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5205 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5206 + "display": "string", ~/~/ Настройки отображения 5207 + "year": 0, ~/~/ Год поля 5208 + "name": "string", ~/~/ Наименование 5209 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5210 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5211 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5212 + "planComment": "string", ~/~/ Комментарий к полю 5213 + "cropRotations": [ ~/~/ Данные по севообороту 5214 + { 5215 + "landId": 0, ~/~/ ID поля 5216 + "landName": "string", ~/~/ Название поля 5217 + "year": 0, ~/~/ Год урожая 5218 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5219 + "cultureName": "string", ~/~/ Название культуры 5220 + "productivity": 0, ~/~/ Урожайность 5221 + "area": 0, ~/~/ Площадь поля, Га 5222 + "total": 0, ~/~/ Валовый сбор 5223 + "productivityFact": 0, ~/~/ Фактическая урожайность 5224 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5225 + "totalFact": 0, ~/~/ Фактический валовый сбор 5226 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5227 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5228 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5229 + "isyearplan": true, ~/~/ Годовой план 5230 + "comment": "string" ~/~/ Комментарий 5231 + } 5232 + ] 5233 +} 5234 +))) 5235 + 5236 +((( 5237 + 5238 +))) 5239 + 5240 +Пример ответа: 5241 + 5242 +((( 5243 +((( 5244 +{ 5245 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5246 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5247 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5248 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5249 + "cropRotations": [ ~/~/ Данные по севообороту 5250 + { 5251 + "landId": 0, ~/~/ ID поля 5252 + "landName": "string", ~/~/ Название поля 5253 + "year": 0, ~/~/ Год урожая 5254 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5255 + "cultureName": "string", ~/~/ Название культуры 5256 + "productivity": 0, ~/~/ Урожайность 5257 + "area": 0, ~/~/ Площадь поля, Га. 5258 + "total": 0, ~/~/ Валовый сбор 5259 + "productivityFact": 0, ~/~/ Фактическая урожайность 5260 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5261 + "totalFact": 0, ~/~/ Фактический валовый сбор 5262 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5263 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5264 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5265 + "isyearplan": true, ~/~/ годовой план 5266 + "comment": "string" ~/~/ Комментарий 5267 + } 5268 + ], 5269 + "cropVegetation": [ ~/~/ История вегетации поля 5270 + { 5271 + "values": [ ~/~/ Данные вегетации и состояния посева 5272 + { 5273 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5274 + "ndvi": 0 ~/~/ Индекс вегетации 5275 + } 5276 + ], 5277 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5278 + { 5279 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5280 + "type": "string", ~/~/ Тип 5281 + "pictureid": "string" ~/~/ Идентификатор ресурса 5282 + } 5283 + ], 5284 + "states": [ ~/~/ Ключевые даты развития поля 5285 + { 5286 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5287 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5288 + } 5289 + ] 5290 + } 5291 + ], 5292 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5293 + "counts": { 5294 + "fieldOperations": 0, ~/~/ Количество операций на поле 5295 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5296 + "facts": 0 ~/~/ Счётчик факта 5297 + }, 5298 + "planComment": "string", ~/~/ Комментарий к полю 5299 +))) 5300 + 5301 +((( 5302 + "productivity": 0, ~/~/ Урожайность. 5303 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5304 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5305 + "year": 0, ~/~/ Год поля 5306 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5307 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5308 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5309 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5310 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5311 + "id": 0, ~/~/ Идентификатор объекта геозоны 5312 + "name": "string", ~/~/ Название объекта геозоны 5313 + "type": 0, ~/~/ Тип объекта геозоны 5314 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5315 + "fname": "string", ~/~/ Имя файла 5316 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5317 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5318 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5319 + "description": "string", ~/~/ Описание объекта геозоны 5320 + "area": 0, ~/~/ Площадь, м2 5321 + "perimetr": 0, ~/~/ Периметр, м 5322 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5323 +} 5324 + 5325 + 5326 +))) 5327 +))) 5328 +))) 5329 + 5330 +== **Получение поля по id** == 5331 + 5332 +(% class="box infomessage" %) 5333 +((( 5334 +**GET /api/v3/agroLands/{id}** 5335 +))) 5336 + 5337 +Пример запроса: 5338 +id ~/~/ Идентификатор поля 5339 + 5340 +Пример ответа: 5341 + 5342 +((( 5343 +{ 5344 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5345 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5346 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5347 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5348 + "cropRotations": [ ~/~/ Данные по севообороту 5349 + { 5350 + "landId": 0, ~/~/ ID поля 5351 + "landName": "string", ~/~/ Название поля 5352 + "year": 0, ~/~/ Год урожая 5353 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5354 + "cultureName": "string", ~/~/ Название культуры 5355 + "productivity": 0, ~/~/ Урожайность 5356 + "area": 0, ~/~/ Площадь поля, Га 5357 + "total": 0, ~/~/ Валовый сбор 5358 + "productivityFact": 0, ~/~/ Фактическая урожайность 5359 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5360 + "totalFact": 0, ~/~/ Фактический валовый сбор 5361 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5362 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5363 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5364 + "isyearplan": true, ~/~/ План года 5365 + "comment": "string" ~/~/ Комментарий 5366 + } 5367 + ], 5368 + "cropVegetation": [ ~/~/ История вегетации поля 5369 + { 5370 + "values": [ ~/~/ Данные вегетации и состояния посева 5371 + { 5372 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5373 + "ndvi": 0 ~/~/ Индекс вегетации 5374 + } 5375 + ], 5376 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5377 + { 5378 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5379 + "type": "string", ~/~/ Тип 5380 + "pictureid": "string" ~/~/ Идентификатор ресурса 5381 + } 5382 + ], 5383 + "states": [ ~/~/ Ключевые даты развития поля 5384 + { 5385 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5386 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5387 + } 5388 + ] 5389 + } 5390 + ], 5391 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5392 + "counts": { 5393 + "fieldOperations": 0, ~/~/ Количество операций на поле 5394 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5395 + "facts": 0 ~/~/ Счётчик факта 5396 + }, 5397 + "planComment": "string", ~/~/ Комментарий к полю 5398 + "productivity": 0, ~/~/ Урожайность. 5399 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5400 +))) 5401 + 5402 +((( 5403 +((( 5404 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5405 + "year": 0, ~/~/ Год поля 5406 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5407 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5408 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5409 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5410 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5411 + "id": 0, ~/~/ Идентификатор объекта геозоны 5412 + "name": "string", ~/~/ Название объекта геозоны 5413 + "type": 0, ~/~/ Тип объекта геозоны 5414 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5415 + "fname": "string", ~/~/ Имя файла 5416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5417 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5418 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5419 + "description": "string", ~/~/ Описание объекта геозоны 5420 + "area": 0, ~/~/ Площадь, м2 5421 + "perimetr": 0, ~/~/ Периметр, м 5422 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5423 +} 5424 +))) 5425 + 5426 + 5427 +== **Удаление существующего поля** == 5428 + 5429 +(% class="box errormessage" %) 5430 +((( 5431 +**DELETE /api/v3/agroLands/{id}** 5432 +))) 5433 + 5434 +Пример запроса: 5435 +id ~/~/ Идентификатор поля 5436 + 5437 +Пример ответа: 5438 + 5439 +((( 5440 +200 ~/~/ Успех 5441 +))) 5442 + 5443 +((( 5444 + 5445 +))) 5446 + 5447 +((( 5448 +((( 5449 +((( 5450 + 5451 +))) 5452 + 5453 +((( 5454 +== **Изменение поля** == 5455 + 5456 +(% class="box infomessage" %) 5457 +((( 5458 +**PUT /api/v3/agroLands** 5459 +))) 5460 + 5461 +Пример запроса: 5462 + 5463 +((( 5464 +((( 5465 +{ 5466 + "id": 0, ~/~/ Идентификатор поля 5467 + "extId": "string", ~/~/ ExtId 5468 + "shape": "string", ~/~/ Форма поля 5469 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5470 + "display": "string", ~/~/ Настройки отображения 5471 + "year": 0, ~/~/ Год поля 5472 + "name": "string", ~/~/ Наименование 5473 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5474 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5475 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5476 + "planComment": "string", ~/~/Комментарий к полю 5477 + "cropRotations": [ ~/~/ Данные по севообороту 5478 + { 5479 + "landId": 0, ~/~/ ID поля 5480 + "landName": "string", ~/~/ Название поля 5481 + "year": 0, ~/~/ Год урожая 5482 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5483 + "cultureName": "string", ~/~/ Название культуры 5484 + "productivity": 0, ~/~/ Урожайность 5485 + "area": 0, ~/~/ Площадь поля, Га. 5486 + "total": 0, ~/~/ Валовый сбор 5487 + "productivityFact": 0, ~/~/ Фактическая урожайность 5488 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5489 + "totalFact": 0, ~/~/ Фактический валовый сбор 5490 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5491 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5492 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5493 + "isyearplan": true, 5494 + "comment": "string" ~/~/ Комментарий 5495 + } 5496 + ], 5497 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5498 +} 5499 +))) 5500 +))) 5501 + 5502 +((( 5503 + 5504 +))) 5505 + 5506 +Пример ответа: 5507 + 5508 +((( 5509 +((( 5510 +((( 5511 +{ 5512 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5513 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5514 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5515 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5516 + "cropRotations": [ ~/~/ Данные по севообороту 5517 + { 5518 + "landId": 0, ~/~/ ID поля 5519 + "landName": "string", ~/~/ Название поля 5520 + "year": 0, ~/~/ Год урожая 5521 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5522 + "cultureName": "string", ~/~/ Название культуры 5523 + "productivity": 0, ~/~/ Урожайность 5524 + "area": 0, ~/~/ Площадь поля, Га 5525 + "total": 0, ~/~/ Валовый сбор 5526 + "productivityFact": 0, ~/~/ Фактическая урожайность 5527 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5528 + "totalFact": 0, ~/~/ Фактический валовый сбор 5529 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5530 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5531 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5532 + "isyearplan": true, ~/~/ 5533 + "comment": "string" ~/~/ Комментарий 5534 + } 5535 + ], 5536 + "cropVegetation": [ ~/~/ История вегетации поля 5537 + { 5538 + "values": [ ~/~/ Данные вегетации и состояния посева 5539 + { 5540 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5541 + "ndvi": 0 ~/~/ Индекс вегетации 5542 + } 5543 + ], 5544 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5545 + { 5546 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5547 + "type": "string", ~/~/ Тип 5548 + "pictureid": "string" ~/~/ Идентификатор ресурса 5549 + } 5550 + ], 5551 + "states": [ ~/~/ Ключевые даты развития поля 5552 + { 5553 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5554 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5555 + } 5556 + ] 5557 + } 5558 + ], 5559 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5560 + "counts": { 5561 + "fieldOperations": 0, ~/~/ Количество операций на поле 5562 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5563 + "facts": 0 ~/~/ Счётчик факта 5564 + }, 5565 + "planComment": "string", ~/~/ Комментарий к полю 5566 + "productivity": 0, ~/~/ Урожайность. 5567 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5568 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5569 + "year": 0, ~/~/ Год поля 5570 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5571 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5572 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5573 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5574 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5575 + "id": 0, ~/~/ Идентификатор объекта геозоны 5576 + "name": "string", ~/~/ Название объекта геозоны 5577 + "type": 0, ~/~/ Тип объекта геозоны 5578 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5579 + "fname": "string", ~/~/ Имя файла 5580 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5581 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5582 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5583 + "description": "string", ~/~/ Описание объекта геозоны 5584 + "area": 0, ~/~/ Площадь, м2 5585 + "perimetr": 0, ~/~/ Периметр, м 5586 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5587 +} 5588 +))) 5589 +))) 5590 +))) 5591 +))) 5592 +))) 5593 + 5594 + 5595 +== **Редактирование года урожая ** == 5596 + 5597 +(% class="box successmessage" %) 5598 +((( 5599 +**POST /api/v3/agroLands/updateOpenCloseYear** 5600 +))) 5601 + 5602 +Пример запроса: 5603 + 5604 +((( 5605 +((( 5606 +{ 5607 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5608 + 0 5609 + ], 5610 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5611 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5612 +} 5613 +))) 5614 + 5615 + 5616 +))) 5617 + 5618 +Пример ответа: 5619 + 5620 +((( 5621 +((( 5622 +{ 5623 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5624 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5625 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5626 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5627 + "cropRotations": [ ~/~/ Данные по севообороту 5628 + { 5629 + "landId": 0, ~/~/ ID поля 5630 + "landName": "string", ~/~/ Название поля 5631 + "year": 0, ~/~/ Год урожая 5632 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5633 + "cultureName": "string", ~/~/ Название культуры 5634 + "productivity": 0, ~/~/ Урожайность 5635 + "area": 0, ~/~/ Площадь поля, Га. 5636 + "total": 0, ~/~/ Валовый сбор 5637 + "productivityFact": 0, ~/~/ Фактическая урожайность 5638 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5639 + "totalFact": 0, ~/~/ Фактический валовый сбор 5640 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5641 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5642 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5643 + "isyearplan": true, ~/~/ 5644 + "comment": "string" ~/~/ Комментарий 5645 + } 5646 + ], 5647 + "cropVegetation": [ ~/~/ История вегетации поля 5648 + { 5649 + "values": [ ~/~/ Данные вегетации и состояния посева 5650 + { 5651 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5652 + "ndvi": 0 ~/~/ Индекс вегетации 5653 + } 5654 + ], 5655 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5656 + { 5657 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5658 + "type": "string", ~/~/ Тип 5659 + "pictureid": "string" ~/~/ Идентификатор ресурса 5660 + } 5661 + ], 5662 + "states": [ ~/~/ Ключевые даты развития поля 5663 + { 5664 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5665 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5666 + } 5667 + ] 5668 + } 5669 + ], 5670 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5671 + "counts": { 5672 + "fieldOperations": 0, ~/~/ Количество операций на поле 5673 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5674 + "facts": 0 ~/~/ Счётчик факта 5675 + }, 5676 + "planComment": "string", ~/~/ Комментарий к полю 5677 + "productivity": 0, ~/~/ Урожайность. 5678 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5679 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5680 + "year": 0, ~/~/ Год поля 5681 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5682 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5683 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5684 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5685 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5686 + "id": 0, ~/~/ Идентификатор объекта геозоны 5687 + "name": "string", ~/~/ Название объекта геозоны 5688 + "type": 0, ~/~/ Тип объекта геозоны 5689 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5690 + "fname": "string", ~/~/ Имя файла 5691 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5692 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5693 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5694 + "description": "string", ~/~/ Описание объекта геозоны 5695 + "area": 0, ~/~/ Площадь, м2 5696 + "perimetr": 0, ~/~/ ериметр, м 5697 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5698 +} 5699 +))) 5700 + 5701 + 4371 4371 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5703 +))) 5704 +))) 5705 +))) 4372 4372 4373 4373 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4374 4374 ... ... @@ -4375,7 +4375,7 @@ 4375 4375 4376 4376 (% class="box infomessage" %) 4377 4377 ((( 4378 -GET api/v3/Vehicles/recyclebin/all 5712 +**GET api/v3/Vehicles/recyclebin/all** 4379 4379 ))) 4380 4380 4381 4381 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту ... ... @@ -4410,11 +4410,11 @@ 4410 4410 ] 4411 4411 4412 4412 4413 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5747 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 4414 4414 4415 4415 (% class="box infomessage" %) 4416 4416 ((( 4417 -POST /api/v3/Vehicles/recyclebin/erase5751 +**POST api/v3/Vehicles/recyclebin/erase** 4418 4418 ))) 4419 4419 4420 4420 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -4456,7 +4456,7 @@ 4456 4456 4457 4457 (% class="box infomessage" %) 4458 4458 ((( 4459 -POST /api/v3/Vehicles/recyclebin/restore5793 +**POST api/v3/Vehicles/recyclebin/restore** 4460 4460 ))) 4461 4461 4462 4462 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -4508,7 +4508,754 @@ 4508 4508 ] 4509 4509 4510 4510 5845 += **Раздел: Журнал заданий ** = 4511 4511 5847 + 5848 +== **Создание задания в Журнале заданий** == 5849 + 5850 +(% class="box infomessage" %) 5851 +((( 5852 +**POST /api/v3/vehicletasks** 5853 +))) 5854 + 5855 +Пример запроса: 5856 + 5857 +((( 5858 +{ 5859 + "vehicleId": 0, ~/~/ Идентификатор ТС 5860 + "description": "string", ~/~/ Описание 5861 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5863 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5864 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5865 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5866 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5867 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5868 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5869 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5870 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5871 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5872 + "cost": { 5873 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5874 + "Name": "string", ~/~/ Наименование 5875 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5876 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5877 + "Norm": 0 ~/~/ Норма внесения 5878 + }, 5879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5880 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5881 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5882 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5883 + "deleted": true, ~/~/ Признак удаления 5884 + "extId": "string", 5885 + "GeoIds": [ ~/~/ Cвязанные поля 5886 + 0 5887 + ] 5888 +} 5889 +))) 5890 + 5891 + 5892 +Пример ответа: 5893 + 5894 +{ 5895 + "vehicleId": 0, ~/~/ Идентификатор ТС 5896 + "description": "string", ~/~/ Описание 5897 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5898 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5899 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5900 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5901 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5902 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5903 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5904 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5905 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5906 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5907 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5908 + "cost": { 5909 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5910 + "Name": "string", ~/~/ Наименование 5911 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5912 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5913 + "Norm": 0 ~/~/ Норма внесения 5914 + }, 5915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5916 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5917 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5918 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5919 + "deleted": true, ~/~/ Признак удаления 5920 + "extId": "string", ~/~/ ExtId 5921 + "GeoIds": [ ~/~/ Связанные поля 5922 + 0 5923 + ] 5924 +} 5925 + 5926 + 5927 +== **Редактирование задания в Журнале заданий** == 5928 + 5929 +(% class="box successmessage" %) 5930 +((( 5931 +**PUT /api/v3/vehicletasks** 5932 +))) 5933 + 5934 +Пример запроса: 5935 + 5936 +((( 5937 +{ 5938 + "vehicleId": 0, ~/~/ Идентификатор ТС 5939 + "description": "string", ~/~/ Описание 5940 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5941 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5942 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5943 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5944 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5945 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5946 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5947 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5948 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5949 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5950 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5951 + "cost": { 5952 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5953 + "Name": "string", ~/~/ Наименование 5954 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5955 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5956 + "Norm": 0 ~/~/ Норма внесения 5957 + }, 5958 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5959 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5960 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5961 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5962 + "deleted": true, ~/~/ Признак удаления 5963 + "extId": "string", ~/~/ ExtId 5964 + "GeoIds": [ ~/~/ Связанные поля 5965 + 0 5966 + ] 5967 +} 5968 +))) 5969 + 5970 + 5971 +Пример ответа: 5972 + 5973 +{ 5974 + "vehicleId": 0, ~/~/ Идентификатор ТС 5975 + "description": "string", ~/~/ Описание 5976 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5977 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5978 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5979 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5980 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5981 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5982 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5983 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5984 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5985 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5986 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5987 + "cost": { 5988 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5989 + "Name": "string", ~/~/ Наименование 5990 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5991 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5992 + "Norm": 0 ~/~/ Норма внесения 5993 + }, 5994 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5995 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5996 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5997 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5998 + "deleted": true, ~/~/ Признак удаления 5999 + "extId": "string", ~/~/ ExtId 6000 + "GeoIds": [ ~/~/ Связанные поля 6001 + 0 6002 + ] 6003 +} 6004 + 6005 + 6006 +== **Удаление задания в Журнале заданий** == 6007 + 6008 +(% class="box warningmessage" %) 6009 +((( 6010 +**DELETE /api/v3/vehicletasks** 6011 +))) 6012 + 6013 +Пример запроса: 6014 + 6015 +((( 6016 +[ 6017 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6018 +] 6019 +))) 6020 + 6021 +((( 6022 + 6023 +))) 6024 + 6025 +Пример ответа: 6026 + 6027 +{ 6028 + "vehicleId": 0, ~/~/ Идентификатор ТС 6029 + "description": "string", ~/~/ Описание 6030 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6032 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6033 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6034 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6035 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6036 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6037 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6038 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6039 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6040 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6041 + "cost": { 6042 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6043 + "Name": "string", ~/~/ Наименование 6044 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6045 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6046 + "Norm": 0 ~/~/ Норма внесения 6047 + }, 6048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6049 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6050 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6051 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6052 + "deleted": true, ~/~/ Признак удаления 6053 + "extId": "string", ~/~/ ExtId 6054 + "GeoIds": [ ~/~/ Связанные поля 6055 + 0 6056 + ] 6057 +} 6058 + 6059 + 6060 +== **Получение списка Журнала заданий** == 6061 + 6062 +(% class="box infomessage" %) 6063 +((( 6064 +**POST /api/v3/vehicletasks/getbyperiod** 6065 +))) 6066 + 6067 +Пример запроса: 6068 + 6069 +((( 6070 +{ 6071 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6072 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6073 + "TimeZone": 0, ~/~/ Часовой пояс. 6074 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6075 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6076 + ], 6077 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6078 + 0 6079 + ], 6080 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6081 + 0 6082 + ], 6083 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6084 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6085 +} 6086 +))) 6087 + 6088 + 6089 +Пример ответа: 6090 + 6091 +((( 6092 +{ 6093 + "total": 0, ~/~/ Общее количество записей 6094 + "pages": 0, ~/~/ Общее количество страниц 6095 + "currentPage": 0, ~/~/ Текущая страница 6096 + "items": [ ~/~/ Записи 6097 + { 6098 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6099 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6100 + "name": "string", ~/~/ Название задания. 6101 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6102 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6103 + "workKind": "string", ~/~/ Вид работ 6104 + "techOp": "string", ~/~/ Тех. операция 6105 + "trailerModel": "string", ~/~/ Модель агрегата 6106 + "width": "string", ~/~/ Ширина, м 6107 + "speed": "string", ~/~/ Тех. скорость 6108 + "fields": "string", ~/~/ Поля 6109 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6110 + "vehicles": "string", ~/~/ Объект-модель 6111 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6112 + "drivers": "string", ~/~/ Водители 6113 + "tmc": "string", ~/~/ ТМЦ 6114 + "client": "string", ~/~/ Клиент 6115 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6116 + "dep": "string", ~/~/ Подразделение 6117 + "geoIds": [ ~/~/ Связанные поля 6118 + 0 6119 + ] 6120 + } 6121 + ] 6122 +} 6123 +))) 6124 + 6125 + 6126 += **Раздел: Роли** = 6127 + 6128 +== **Получение списка клиентских и системных ролей пользователя ** == 6129 + 6130 +(% class="box successmessage" %) 6131 +((( 6132 +**POST /api/v3/groups/find** 6133 +))) 6134 + 6135 +Пример запроса: 6136 + 6137 +((( 6138 +{ 6139 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6140 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6141 +} 6142 +))) 6143 + 6144 +((( 6145 + 6146 +))) 6147 + 6148 +((( 6149 +Пример ответа: 6150 +))) 6151 + 6152 +((( 6153 +((( 6154 +{ 6155 + "groups": [ ~/~/ Системные роли пользователя 6156 + { 6157 + "code": "string", ~/~/ Код роли. 6158 + "name": "string", ~/~/ Имя 6159 + "shortName": "string" ~/~/ Короткое имя 6160 + } 6161 + ], 6162 + "customGroups": [ ~/~/ Системные роли пользователя 6163 + { 6164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6165 + "name": "string", ~/~/ Наименование 6166 + "shortName": "string", ~/~/ Короткое наименование 6167 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6168 + } 6169 + ] 6170 +} 6171 +))) 6172 +))) 6173 + 6174 +((( 6175 + 6176 +))) 6177 + 6178 +((( 6179 + 6180 +))) 6181 + 6182 += **Раздел: Локатор ** = 6183 + 6184 + 6185 +== **Получение списка локаторов, доступных пользователю ** == 6186 + 6187 +(% class="box infomessage" %) 6188 +((( 6189 +**GET /api/v3/locators ** 6190 +))) 6191 + 6192 +В заголовках запроса: X-Auth: Токен авторизации 6193 + 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +((( 6199 +{ 6200 + "vehiclesIds": [ ~/~/ Объекты 6201 + 0 6202 + ], 6203 + "geoIds": [ ~/~/ Геозоны 6204 + 0 6205 + ], 6206 + "fieldsIds": [ ~/~/ Поля 6207 + 0 6208 + ], 6209 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6210 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6211 + "agentName": "string", ~/~/ Наименование агента. 6212 + "isEnabled": true, ~/~/ Активность 6213 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6214 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6215 + "name": "string", ~/~/ Наименование. 6216 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6217 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6218 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6219 + "validity": 0, ~/~/ Значение срока действия 6220 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6221 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6222 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6223 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6224 + "url": "string", ~/~/ Ссылка 6225 + "language": 0, ~/~/ Язык 6226 + "showVehicleName": true, ~/~/ Наименование объекта 6227 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6228 + "allowTrackReport": true, ~/~/ Трек 6229 + "showTrackTracing": true, ~/~/ Трассировка трека 6230 + "showSensors": true, ~/~/ Датчик 6231 + "availableMapLayers": [ ~/~/ Слои на карте 6232 + 0 6233 + ] 6234 +} 6235 +))) 6236 +))) 6237 + 6238 + 6239 +== **Получение перечня моделей ** == 6240 + 6241 +(% class="box successmessage" %) 6242 +((( 6243 +**POST /api/v3/models/find** 6244 +))) 6245 + 6246 +Пример запроса: 6247 + 6248 +((( 6249 +((( 6250 +{ 6251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6252 + "name": "string", ~/~/ Наименование локатора 6253 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6254 +))) 6255 + 6256 + 6257 + 6258 + Пример ответа: 6259 + 6260 + 6261 +((( 6262 +[ 6263 + { 6264 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6266 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6267 + "name": "string", ~/~/ Наименование локатора 6268 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6269 + } 6270 +] 6271 +))) 6272 +))) 6273 + 6274 + 6275 +== **Создание локатора** == 6276 + 6277 +(% class="box successmessage" %) 6278 +((( 6279 +**POST /api/v3/locators** 6280 +))) 6281 + 6282 +Пример запроса: 6283 + 6284 +((( 6285 +{ 6286 + "isEnabled": true, ~/~/ Активность 6287 + "name": "string", ~/~/ Наименование локатора 6288 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6289 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6290 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6291 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6292 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6293 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6294 + "vehiclesIds": [ ~/~/ Oбъекты 6295 + 0 6296 + ], 6297 + "geoIds": [ ~/~/ Геозоны 6298 + 0 6299 + ], 6300 + "fieldsIds": [ ~/~/ Поля 6301 + 0 6302 + ], 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6305 + "allowTrackReport": true, ~/~/ Трек 6306 + "showTrackTracing": true, ~/~/ Трассировка трека 6307 + "showSensors": true, ~/~/ Датчик 6308 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6309 + ] 6310 +} 6311 +))) 6312 + 6313 + 6314 +Пример ответа: 6315 + 6316 +((( 6317 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6318 +))) 6319 + 6320 + 6321 + 6322 +== **Изменение локатора** == 6323 + 6324 +(% class="box infomessage" %) 6325 +((( 6326 +**PUT /api/v3/locators** 6327 +))) 6328 + 6329 +Пример запроса: 6330 + 6331 +((( 6332 +{ 6333 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6334 + "isEnabled": true, ~/~/ Активность 6335 + "name": "string", ~/~/ Наименование 6336 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6337 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6338 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6339 + "autoProlongation": true, ~/~/ Автопродление срока действия 6340 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6341 + "vehiclesIds": [ ~/~/ Oбъекты 6342 + 0 6343 + ], 6344 + "geoIds": [ ~/~/ Геозоны 6345 + 0 6346 + ], 6347 + "fieldsIds": [ ~/~/ Поля 6348 + 0 6349 + ], 6350 + "showVehicleName": true, ~/~/ Наименование объекта 6351 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6352 + "allowTrackReport": true, ~/~/ Трек 6353 + "showTrackTracing": true, ~/~/ Трассировка трека 6354 + "showSensors": true, ~/~/ Датчик 6355 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6356 + ] 6357 +} 6358 + 6359 + 6360 +))) 6361 + 6362 +Пример ответа: 6363 + 6364 +200 ~/~/ Success 6365 + 6366 + 6367 +== **Удалить локатор** == 6368 + 6369 +(% class="box warningmessage" %) 6370 +((( 6371 +**DELETE /api/v3/locators** 6372 +))) 6373 + 6374 +Пример запроса: 6375 + 6376 +((( 6377 +[ 6378 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6379 +] 6380 +))) 6381 + 6382 + 6383 + 6384 += **Раздел: Яндекс Маршруты** = 6385 + 6386 + 6387 +== **Возвращение списка маршрутов** == 6388 + 6389 +(% class="box infomessage" %) 6390 +((( 6391 +**GET /api/v3/TransportRoutes** 6392 +))) 6393 + 6394 +Пример запроса: 6395 +Id ~/~/ Идентификатор поля 6396 + 6397 + 6398 +Пример ответа: 6399 + 6400 +((( 6401 +[ 6402 + { 6403 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6404 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6405 + "name": "string", ~/~/ Наименование маршрута. 6406 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6407 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6408 + 0 6409 + ] 6410 + } 6411 +] 6412 +))) 6413 + 6414 + 6415 + 6416 +== **Добавить маршрут** == 6417 + 6418 +(% class="box infomessage" %) 6419 +((( 6420 +**POST /api/v3/TransportRoutes** 6421 +))) 6422 + 6423 +Пример запроса: 6424 +{ 6425 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6427 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6428 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6429 + 0 6430 + ] 6431 +} 6432 + 6433 + 6434 +Пример ответа: 6435 + 6436 +((( 6437 +{ 6438 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6439 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6440 + "name": "string", ~/~/ Определяет наименование маршрута 6441 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6442 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6443 + 0 6444 + ] 6445 +} 6446 +))) 6447 + 6448 + 6449 +== **Обновление маршрута** == 6450 + 6451 +(% class="box successmessage" %) 6452 +((( 6453 +**PUT /api/v3/TransportRoutes** 6454 +))) 6455 + 6456 +Пример запроса: 6457 + 6458 +((( 6459 +{ 6460 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6461 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6462 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6463 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6464 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6465 + 0 6466 + ] 6467 +} 6468 +))) 6469 + 6470 + 6471 +Пример ответа: 6472 + 6473 +((( 6474 +{ 6475 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6476 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6477 + "name": "string", ~/~/ Определяет наименование маршрута 6478 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6479 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6480 + 0 6481 + ] 6482 +} 6483 +))) 6484 + 6485 + 6486 +== **Получить связки маршрутов ТС** == 6487 + 6488 +(% class="box infomessage" %) 6489 +((( 6490 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6491 +))) 6492 + 6493 +Пример запроса: 6494 + 6495 +((( 6496 +[ 6497 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6498 +] 6499 +))) 6500 + 6501 + 6502 +Пример ответа: 6503 + 6504 +((( 6505 +[ 6506 + { 6507 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6508 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6509 + } 6510 +] 6511 +))) 6512 + 6513 + 6514 +== **Удалить маршрут** == 6515 + 6516 +(% class="box warningmessage" %) 6517 +((( 6518 +**DELETE /api/v3/TransportRoutes/{id}** 6519 +))) 6520 + 6521 +Пример запроса: 6522 +Id ~/~/ Идентификатор поля 6523 + 6524 + 6525 + 6526 += **Раздел: Управление доступа к машинам** = 6527 + 6528 + 6529 +== Получение списка транспортных средств видимых пользователю == 6530 + 6531 +(% class="box infomessage" %) 6532 +((( 6533 +**GET /api/v3/UserVisibleVehicles/{userId}** 6534 +))) 6535 + 6536 +Пример ответа: 6537 + 6538 +((( 6539 +{ 6540 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6541 + 0 6542 + ] 6543 +} 6544 +))) 6545 + 6546 + 6547 + 6548 +== Задает видимость транспортных средств пользователю == 6549 + 6550 +(% class="box infomessage" %) 6551 +((( 6552 +**POST /api/v3/UserVisibleVehicles** 6553 +))) 6554 + 6555 +Пример запроса: 6556 + 6557 +((( 6558 +((( 6559 +{ 6560 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6561 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6562 + 0 6563 + ] 6564 +} 6565 +))) 6566 + 6567 +((( 6568 + 6569 +))) 6570 + 6571 +((( 6572 + 6573 +))) 6574 + 6575 +((( 6576 +Пример ответа : 6577 +))) 6578 + 6579 +((( 6580 + 6581 +))) 6582 + 6583 +((( 6584 +200 ~/~/ Success 6585 +))) 6586 +))) 6587 + 6588 + 6589 + 6590 + 6591 + 6592 + 4512 4512 (% class="box" lang="en-US" style="text-align: center;" %) 4513 4513 ((( 4514 4514 (% 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]] **