Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - 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 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -60,6 +60,9 @@ 60 60 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 61 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 62 85 +(% class="wikigeneratedid" %) 86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 87 + 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -98,29 +98,41 @@ 98 98 Запрос должен содержать данные параметра "**agentId**" 99 99 100 100 (% style="color:#000000" %)Ответ: 126 + 127 +((( 101 101 { 102 - "agentId": "", (%%) 103 - "parentId": "", 104 - "parentName": "string", 105 - "name": "string", 106 - "fullName": "string", 107 - "agentInfoType": 0, 108 - "isForeign": true/false, 109 - "district": "string", 110 - "region": "string", 111 - "city": "string", 112 - "inn": "string", 113 - "kpp": "string", 114 - "address": "string", 115 - "addressFact": "string", 116 - "email": "string", 117 - "director": "string", 118 - "bankName": "string", 119 - "bankBIK": "string", 120 - "bankRS": "string", 121 - "bankKS": "string" 122 - } 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 +))) 123 123 160 + 124 124 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 125 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 126 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -173,7 +173,6 @@ 173 173 { 174 174 "agentId": "",(% style="color:#000000" %) (%%) 175 175 "parentId": "", 176 - "parentName": "string", 177 177 "name": "string", 178 178 "fullName": "string", 179 179 "agentInfoType": 0, ... ... @@ -184,7 +184,6 @@ 184 184 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 185 185 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 186 186 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 188 188 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 189 189 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 190 190 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) ... ... @@ -228,7 +228,6 @@ 228 228 "bankKS": "string" ~/~/ корр. счёт 229 229 } 230 230 231 - 232 232 Ответ: 233 233 234 234 { ... ... @@ -356,6 +356,21 @@ 356 356 357 357 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 358 358 393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 394 + 395 +(% class="box warningmessage" %) 396 +((( 397 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 398 +))) 399 + 400 +Метод позволяет изменить статус клиента, указанного в запросе. 401 + 402 +В пути указывается GUID клиента и статус клиента. 403 + 404 +**status **- значение 0 - заблокирован, 1 - активен. 405 + 406 +Ответ: Code 204 407 + 359 359 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 360 360 361 361 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -407,7 +407,6 @@ 407 407 ], 408 408 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 409 409 } 410 - 411 411 { 412 412 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 413 413 "lastName": "string", ... ... @@ -421,12 +421,8 @@ 421 421 422 422 (% style="text-align:left" %) 423 423 (% style="color:#000000; font-weight:normal" %)Ответ: 424 - 425 -(% style="text-align:left" %) 426 -(% style="color:#000000; font-weight:normal" %){ 427 - 428 -(% style="text-align:left" %) 429 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "id": "" , ~/~/ ID пользователя 430 430 "lastName": "" , ~/~/ Фамилия , 431 431 "firstName": "" , ~/~/ Имя 432 432 "position": "" , ~/~/ Должность ... ... @@ -443,11 +443,9 @@ 443 443 "kind": "" , ~/~/ тип аутентификации 444 444 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 445 445 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 446 446 447 -(% style="text-align:left" %) 448 -(% style="color:#000000; font-weight:normal" %)} 449 449 450 - 451 451 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 452 452 453 453 (% class="box infomessage" %) ... ... @@ -467,19 +467,16 @@ 467 467 468 468 (% style="color:#000000" %)Параметры в теле запроса (JSON): 469 469 470 -(% style="color:#000000" %){ 471 - 512 +(% style="color:#000000" %){(%%) 472 472 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 473 473 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 474 474 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 475 475 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 476 - 477 477 (% style="color:#000000" %)} 478 478 479 479 (% style="color:#000000" %)Ответ: 480 480 481 481 (% style="color:#000000" %){ (%%) 482 - 483 483 "id": "" , ~/~/ идентификатор пользователя 484 484 "lastName": "" , ~/~/ фамилия 485 485 "firstName": "" , ~/~/ имя ... ... @@ -493,7 +493,6 @@ 493 493 "sessionDuration":"", ~/~/ длительность сессии в минутах 494 494 "status": "1", ~/~/ статус пользователя 495 495 "lastLogged": "", ~/~/ дата/время последней авторизации 496 - 497 497 (% style="color:#000000" %)} 498 498 499 499 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -567,10 +567,8 @@ 567 567 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 568 569 569 (% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - 572 -(% lang="en-US" style="text-align:left" %) 573 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "id": "" , ~/~/ ID пользователя 574 574 "lastName": "" , ~/~/ фамилия 575 575 "firstName": "" , ~/~/ имя 576 576 "position": "" , ~/~/ должность ... ... @@ -592,9 +592,7 @@ 592 592 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 593 593 }, 594 594 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 595 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 596 - 597 -(% lang="en-US" style="text-align:left" %) 631 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 598 598 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 599 599 600 600 (% lang="en-US" style="text-align:left" %) ... ... @@ -601,10 +601,8 @@ 601 601 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 602 602 603 603 (% lang="en-US" style="text-align:left" %) 604 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 605 - 606 -(% lang="en-US" style="text-align:left" %) 607 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "id": "" , ~/~/ идентификатор пользователя 608 608 "lastName": "" , ~/~/ фамилия 609 609 "firstName": "" , ~/~/ имя 610 610 "position": "" , ~/~/ должность ... ... @@ -625,10 +625,8 @@ 625 625 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 626 626 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 627 627 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 660 +} 628 628 629 -(% lang="en-US" style="text-align:left" %) 630 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 631 - 632 632 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 633 633 634 634 (% class="box warningmessage" %) ... ... @@ -648,12 +648,10 @@ 648 648 649 649 (% style="color:#000000" %)Параметры в теле запроса (JSON): 650 650 651 -(% style="color:#000000" %){ 652 - 681 +(% style="color:#000000" %){(%%) 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 656 - 657 657 (% style="color:#000000" %)} 658 658 659 659 (% style="text-align:left" %) ... ... @@ -675,7 +675,7 @@ 675 675 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 676 676 677 677 [ 678 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 679 679 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 680 680 ] 681 681 ... ... @@ -981,7 +981,7 @@ 981 981 982 982 Ответ: В случае успеха **Success 200** 983 983 984 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 985 985 986 986 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 987 987 ... ... @@ -1010,6 +1010,17 @@ 1010 1010 1011 1011 ((( 1012 1012 { 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 + 1013 1013 "vehicleId": "", ~/~/ ID объекта 1014 1014 "name": "", ~/~/ Имя объекта 1015 1015 "imei": "", ~/~/ IMEI объекта ... ... @@ -1017,19 +1017,15 @@ 1017 1017 "deviceTypeName": "", ~/~/ Название типа устройства 1018 1018 "sim1": "", ~/~/ Номер SIM1 1019 1019 "sim2": "", ~/~/ Номер SIM2 1020 - 1021 1021 "parentId": "", ~/~/ ID клиента-родителя 1022 1022 "parentName": "", ~/~/ Наименование клиента-родителя 1023 1023 "modelId": "", ~/~/ ID модели объекта 1024 1024 "modelName": "", ~/~/ Имя модели объекта 1025 - 1026 1026 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1027 1027 "unitName": "string", ~/~/ Наименование подразделения 1028 1028 "status": 0, ~/~/ Статус объекта 1029 - 1030 1030 "createdAt": "", ~/~/ Дата создания объекта 1031 1031 }, 1032 - 1033 1033 "customFields": [ ~/~/ Произвольные поля 1034 1034 { 1035 1035 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1052,8 +1052,7 @@ 1052 1052 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1053 1053 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1054 1054 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1055 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1056 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1057 1057 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1058 1058 "mileageCoeff": 0, ~/~/ коэффициент пробега 1059 1059 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1083,7 +1083,6 @@ 1083 1083 "retries": 0 ~/~/ Количество попыток 1084 1084 } 1085 1085 ], 1086 - 1087 1087 "sensors": [ ~/~/ Датчики 1088 1088 { 1089 1089 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1110,6 +1110,7 @@ 1110 1110 ], 1111 1111 "showInTooltip": true, ~/~/ Отображать в подсказке 1112 1112 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1113 1113 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1114 1114 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1115 1115 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1124,31 +1124,19 @@ 1124 1124 }, 1125 1125 1126 1126 ~/~/ Характерные для произвольного: 1127 - 1128 1128 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1129 - 1130 1130 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1131 - 1132 1132 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1133 - 1134 1134 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1135 - 1136 1136 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1137 - 1138 1138 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1139 - 1140 1140 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1141 - 1142 1142 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1143 - 1144 1144 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1145 - 1146 1146 ~/~/ "ValueOn": "Вкл.", 1147 - 1148 1148 ~/~/ "ValueOff": "Выкл." 1149 1149 "summaryMaxValue": 0 ~/~/ Макс. значение 1150 1150 } 1151 - 1152 1152 "drivers": [ ~/~/ Водители 1153 1153 { 1154 1154 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1157,7 +1157,6 @@ 1157 1157 "isDefault": true ~/~/ По умолчанию 1158 1158 } 1159 1159 ], 1160 - 1161 1161 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1162 1162 { 1163 1163 "id": "", ~/~/ ID задания ... ... @@ -1174,19 +1174,27 @@ 1174 1174 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1175 1175 } 1176 1176 ], 1177 - 1178 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 1179 1179 { 1180 1180 "status": 0, 1181 1181 "date": "2023-05-22T09:57:39.562Z", 1182 1182 "description": "string", 1183 1183 "additionalInfo": "string" 1184 - } 1185 - ] 1186 1186 1205 +((( 1187 1187 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1188 1188 ))) 1189 1189 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1190 1190 (% style="text-align:left" %) 1191 1191 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1192 1192 ... ... @@ -1193,6 +1193,75 @@ 1193 1193 (% style="text-align:left" %) 1194 1194 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1195 1195 1225 + 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 + 1245 +== **Получить ответ на отправленную на ТС команду** == 1246 + 1247 +(% class="box infomessage" %) 1248 +((( 1249 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1250 +))) 1251 + 1252 +Идентификатор команды: cmdId 1253 + 1254 +Запрос от терминала на ответ команды 1255 + 1256 +Пример ответ от терминала: 1257 + 1258 +ID= "" ~/~/ идентификатор объекта 1259 +Soft="" ~/~/ версия софта 1260 +GPS=4 ~/~/ тип трекера 1261 +Time=11:05:43 28.06.24 ~/~/ время запроса 1262 +Lat=45.056221 ~/~/ широта 1263 +Lon=39.035938 ~/~/ долгота 1264 +Speed=0.0 ~/~/ скорость 1265 +Course=181.4 ~/~/направление 1266 + 1267 +((( 1268 +== **Список отправленных объекту команд с ответами** == 1269 + 1270 +(% class="box infomessage" %) 1271 +((( 1272 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1273 +))) 1274 + 1275 +Идентификатор ТС: vehicleId 1276 + 1277 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1278 + 1279 +Пример ответа терминала 1280 + 1281 +[ 1282 +{ 1283 +"id": "", ~/~/ идентификатор пользователя 1284 +"commandText": "", ~/~/Текст команды. 1285 +"templateId": "", ~/~/Идентификатор шаблона 1286 +"updated": "", ~/~/ Время отправки 1287 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1288 +"answer": "", ~/~/ Ответ терминала. 1289 +"status": "" ~/~/ Статус отправки 1290 +} 1291 +] 1292 +))) 1293 + 1196 1196 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1197 1197 1198 1198 (% class="box successmessage" %) ... ... @@ -1212,6 +1212,11 @@ 1212 1212 1213 1213 (% style="color:#000000" %){ 1214 1214 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1215 1215 "parentId": "" , ~/~/ ID клиента 1216 1216 "name": "" , ~/~/ имя ТС 1217 1217 "imei": "" , ~/~/ IMEI ... ... @@ -1232,7 +1232,6 @@ 1232 1232 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1233 1233 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1234 1234 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1235 - 1236 1236 "mileageCalcMethod": 0, 1237 1237 "mileageCoeff": 0, 1238 1238 "locationByCellId": true, ... ... @@ -1265,7 +1265,6 @@ 1265 1265 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1266 1266 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1267 1267 } 1268 - 1269 1269 "drivers": [ ~/~/ Водители 1270 1270 { 1271 1271 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1280,8 +1280,7 @@ 1280 1280 "retries": 0 1281 1281 } 1282 1282 ], 1283 - 1284 - "sensors": [ ~/~/ Датчики 1384 +"sensors": [ ~/~/ Датчики 1285 1285 { 1286 1286 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1287 1287 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1307,6 +1307,7 @@ 1307 1307 ], 1308 1308 "showInTooltip": true, ~/~/ Отображать в подсказке 1309 1309 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1310 1310 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1311 1311 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1312 1312 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1319,103 +1319,222 @@ 1319 1319 "additionalProp2": "string", 1320 1320 "additionalProp3": "string" 1321 1321 }, 1322 - 1323 1323 ~/~/ Характерные для произвольного: 1324 - 1325 1325 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1326 - 1327 1327 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1328 - 1329 1329 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1330 - 1331 1331 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1332 - 1333 1333 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1334 - 1335 1335 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1336 - 1337 1337 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1338 - 1339 1339 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1340 - 1341 1341 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1342 - 1343 1343 ~/~/ "ValueOn": "Вкл.", 1344 - 1345 1345 ~/~/ "ValueOff": "Выкл." 1346 - "summaryMaxValue": 0 ~/~/ Макс. значение 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1347 1347 } 1348 1348 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1349 1349 "customFields": [ ~/~/ Произвольные поля 1350 1350 { 1351 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1352 - "name": "string", 1353 - "value": "string", 1354 - "forClient": true, 1355 - "forTooltip": true, 1356 - "forReport": true 1357 - } 1358 - ] 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 - По датчику относительных Моточасов 1359 1359 } 1470 +))) 1360 1360 1472 + 1361 1361 (% style="color:#000000" %)Ответ: 1362 1362 1363 -(% style="color:#000000" %){ 1364 1364 1365 - "vehicleId": "", ~/~/ID ТС 1366 - "parentId": "", ~/~/Guid владельца ТС 1367 - "name": "", ~/~/Имя объекта 1368 - "imei": "", ~/~/IMEI 1369 - "deviceTypeId": "", ~/~/ID типа устройства 1370 - "modelId": "", ~/~/ID модели 1371 - "unitId": "", ~/~/ID подразделения 1372 - "sim1": "", ~/~/SIM1 1373 - "sim2": "", ~/~/SIM2 1374 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1375 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1376 - "counters": { ~/~/Счётчики 1377 - "mileageEnabled": true, 1378 - "motohoursEnabled": true, 1379 - "mileage": "", 1380 - "motohours": 345.0 1381 - }, 1382 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1383 - "id": null, 1384 - "enabled": true, ~/~/флаг включения 1385 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1386 - "login": "", ~/~/ имя учетной записи 1387 - "password": "" ~/~/ пароль учетной записи 1388 - }, 1389 - "inspectionTasks": { ~/~/ задания на ТО 1390 - "id": "", ~/~/ ID задачи 1391 - "enabled": false, ~/~/ Признак включения 1392 - "name": "", ~/~/ Имя задания 1393 - "description": "", ~/~/ Описание задания 1394 - "mileageCondition": "", ~/~/ Условие по пробегу 1395 - "lastMileage": "", ~/~/ Пробег (в метрах) 1396 - "motohoursCondition": "", ~/~/ Условие по моточасам 1397 - "lastMotohours": "", ~/~/ Моточасы 1398 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1399 - "kind": "", ~/~/ Вид периодичности по времени 1400 - "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 ~/~/ Условие по количеству записей для деактивации 1401 1401 } 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 +))) 1402 1402 1403 -(% style="text-align:left" %) 1404 -(% 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 +))) 1405 1405 1624 + 1406 1406 **Валидация:** 1407 1407 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1408 1408 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1409 1409 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1410 1410 1411 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1412 1412 1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1632 + 1413 1413 (% class="box infomessage" %) 1414 1414 ((( 1415 1415 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 1416 ))) 1417 1417 1418 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1638 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1419 1419 1420 1420 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1421 1421 ... ... @@ -1449,9 +1449,12 @@ 1449 1449 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1450 1450 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1451 1451 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1452 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1453 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1454 - "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" ~/~/ Идентификатор агента, для которого надо получить данные 1455 1455 } 1456 1456 1457 1457 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1458,8 +1458,14 @@ 1458 1458 1459 1459 (% style="color:#000000" %)Ответ: 1460 1460 1461 -(% style="color:#000000" %){ 1684 +(% style="color:#000000" %)[ 1685 +{ 1462 1462 1687 +((( 1688 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1689 +))) 1690 + 1691 +((( 1463 1463 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1464 1464 "name": "" ~/~/ наименование объекта 1465 1465 "imei": "" ~/~/ IMEI объекта ... ... @@ -1485,9 +1485,21 @@ 1485 1485 "forClient": true, ~/~/ право на отображение у клиента 1486 1486 "forTooltip": false, ~/~/ право на отображение в подсказке 1487 1487 "forReport": false ~/~/ право на отображение в отчетах 1488 - }(%%) 1489 -(% style="color:#000000" %)} 1717 +))) 1490 1490 1719 +((( 1720 + } 1721 + ], 1722 + "vehicleGroups": [ ~/~/ Группы ТС 1723 + { 1724 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1725 + "name": "string" ~/~/ Наименование группы ТС 1726 + } 1727 + ] 1728 + } 1729 +] 1730 +))) 1731 + 1491 1491 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1492 1492 1493 1493 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1519,13 +1519,11 @@ 1519 1519 "data": "", ~/~/ Данные 1520 1520 "overwrite": false, ~/~/ Флаг перезаписи 1521 1521 "stage": "", ~/~/ Состояние, может быть null 1522 - 1523 1523 (% style="color:#000000" %)} 1524 1524 1525 1525 (% style="color:#000000" %)Ответ: 1526 1526 1527 -(% style="color:#000000" %){ 1528 - 1767 +(% style="color:#000000" %){(%%) 1529 1529 "status": "", ~/~/ значение статуса 1530 1530 "date": "", ~/~/ Дата смены статуса 1531 1531 "description": "", ~/~/ Описание ... ... @@ -1532,10 +1532,10 @@ 1532 1532 "data": "", ~/~/ Данные 1533 1533 "overwrite": false, ~/~/ Флаг перезаписи 1534 1534 "stage": "", ~/~/ Состояние 1535 - 1536 -(% style="text-align:left" %) 1537 1537 (% style="color:#000000" %) } 1538 1538 1776 +== == 1777 + 1539 1539 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1540 1540 1541 1541 (% class="box warningmessage" %) ... ... @@ -1611,9 +1611,19 @@ 1611 1611 1612 1612 "drivers": [ ~/~/ Водители 1613 1613 { 1614 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1615 - "isDefault": true 1616 - } 1853 + 1854 +((( 1855 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1856 + "inputNumber": 0, ~/~/ № входа. 1857 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1858 + "comment": "string", ~/~/ Комментарий. 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1860 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1861 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1862 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1863 +))) 1864 + 1865 + } 1617 1617 ], 1618 1618 "commandTemplates": [ ~/~/ Шаблон команды 1619 1619 { ... ... @@ -1623,8 +1623,7 @@ 1623 1623 "retries": 0 1624 1624 } 1625 1625 ], 1626 - 1627 - "sensors": [ ~/~/ Датчики 1875 +"sensors": [ ~/~/ Датчики 1628 1628 { 1629 1629 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1630 1630 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1650,6 +1650,11 @@ 1650 1650 ], 1651 1651 "showInTooltip": true, ~/~/ Отображать в подсказке 1652 1652 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1901 + 1902 +((( 1903 + "color": "string",** ~/~/ **Цвет датчика 1904 +))) 1905 + 1653 1653 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1654 1654 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1655 1655 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1662,95 +1662,225 @@ 1662 1662 "additionalProp2": "string", 1663 1663 "additionalProp3": "string" 1664 1664 }, 1665 - 1666 1666 ~/~/ Характерные для произвольного: 1667 - 1668 1668 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1669 - 1670 1670 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1671 - 1672 1672 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1673 - 1674 1674 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1675 - 1676 1676 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1677 - 1678 1678 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1679 - 1680 1680 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1681 - 1682 1682 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1683 - 1684 1684 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1685 - 1686 1686 ~/~/ "ValueOn": "Вкл.", 1687 - 1688 1688 ~/~/ "ValueOff": "Выкл." 1689 1689 "summaryMaxValue": 0 ~/~/ Макс. значение 1931 + 1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1933 + { 1934 + "from": 0, ~/~/ С какого значения 1935 + "color": "string", ~/~/ Каким цветом 1936 + "text": "string" ~/~/ Текст подписи к этому интервалу 1937 + } 1938 + ] 1690 1690 } 1691 1691 ], 1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1942 + 1692 1692 "customFields": [ ~/~/ Произвольные поля 1693 - { 1694 - 1695 - "name": "string", 1696 - "value": "string", 1697 - "forClient": true, 1698 - "forTooltip": true, 1699 - "forReport": true 1944 + { 1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1946 + "name": "string", ~/~/ Наименование произвольного поля 1947 + "value": "string", ~/~/ Значение произвольного поля 1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1700 1700 } 1701 - ] 1952 + 1953 +((( 1954 + ], 1955 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1956 +))) 1957 + 1702 1702 } 1703 1703 1960 + 1704 1704 (% style="color:#000000" %)Ответ: 1705 1705 1706 -(% lang="en-US" style="text-align:left" %) 1707 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1963 +((( 1964 +{ 1965 + "vehicleId": 0, ~/~/ ID ТС 1966 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1967 + "name": "string", ~/~/ Имя объекта 1968 + "imei": "string", ~/~/ IMEI 1969 + "deviceTypeId": 0, ~/~/ ID типа устройства 1970 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1971 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1972 + "sim1": "string", ~/~/ SIM1 1973 + "sim2": "string", ~/~/ SIM2 1974 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1975 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1976 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1977 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1978 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1979 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1980 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1981 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1982 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1983 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1984 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1985 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1986 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1987 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1988 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1989 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1990 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1991 + "counters": { ~/~/ состояний счётчиков 1992 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1993 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1994 + "mileage": 0, ~/~/ Пробег 1995 + "motohours": 0 ~/~/ Моточасы 1996 + }, 1997 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1998 + "id": "string", ~/~/ CMSV6 Идентификатор 1999 + "enabled": true, ~/~/ Признак включения 2000 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2001 +))) 1708 1708 1709 -(% lang="en-US" style="text-align:left" %) 1710 - "vehicleId": "", ~/~/ ID ТС 1711 - "parentId": "", ~/~/ ID клиента 1712 - "name": "", ~/~/ имя ТС 1713 - "imei": "", ~/~/ IMEI 1714 - "deviceTypeId": "", ~/~/ типа устройства 1715 - "modelId": "", ~/~/ ID модели 1716 - "unitId": "", ~/~/ ID подразделения 1717 - "sim1": "", ~/~/ SIM 1 1718 - "sim2": "", ~/~/ SIM2 1719 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1720 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1721 - "counters": 1722 - { 1723 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1724 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1725 - "mileage": "", ~/~/ пробег 1726 - "motohours": "", ~/~/ моточасы 1727 - } 1728 - "cmsv6Parameters": ~/~/ параметры CMSv6 2003 + 2004 +((( 2005 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2006 + "login": "string", ~/~/ CMSV6 имя учетной записи 2007 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2008 + }, 2009 + "inspectionTasks": [ ~/~/ Задания на ТО 2010 + { 2011 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2012 + "enabled": true, ~/~/ Признак включения 2013 + "name": "string", ~/~/ Имя задания 2014 + "description": "string", ~/~/ Описание задания 2015 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2016 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2017 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2018 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2019 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2020 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2021 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2022 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2023 + } 2024 + ], 2025 + "drivers": [ ~/~/ Список водителей 2026 + { 2027 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2028 + "inputNumber": 0, ~/~/ № входа. 2029 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2030 + "comment": "string", ~/~/ Комментарий. 2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2032 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2033 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2034 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2035 + } 2036 + ], 2037 + "commandTemplates": [ ~/~/ Список шаблонов команд 2038 + { 2039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2040 + "name": "string", ~/~/ Название шаблона команд 2041 + "command": "string", ~/~/ Команда на выполнение 2042 + "retries": 0 ~/~/ Лимит попыток отправки 2043 + } 2044 + ], 2045 + "sensors": [ ~/~/ Список датчиков 2046 + { 2047 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2048 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2049 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2050 +))) 2051 + 2052 +((( 2053 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2058 +))) 2059 + 2060 +((( 2061 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2062 +))) 2063 + 2064 +((( 2065 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2066 +))) 2067 + 2068 +((( 2069 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2070 + "name": "string", ~/~/ Имя датчика 2071 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2072 +))) 2073 + 2074 +((( 2075 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2076 + "inputNumber": 0, ~/~/ Номер входа 2077 + "pseudonym": "string", ~/~/ Псевдоним 2078 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2079 + "isInverted": true, ~/~/ Признак инверсии 2080 + "disabled": true, ~/~/ Датчик не участвует в обработке 2081 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2082 + "gradesTables": [ ~/~/ Тарировка 1729 1729 { 1730 - "id": ~/~/ идентификатор 1731 - "enabled": true, ~/~/ флаг включения 1732 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1733 - "login": "", ~/~/ имя учетной записи 1734 - "password": "", ~/~/ пароль учетной записи 1735 - } 1736 - "inspectionTasks": ~/~/ задания на ТО 1737 - { 1738 - "id": "", ~/~/ ID задания 1739 - "enabled": false, ~/~/ Признак включения 1740 - "name": "", ~/~/ Имя задания 1741 - "description": "", ~/~/ Описание задания 1742 - "mileageCondition": "", ~/~/ Условие по пробегу 1743 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1744 - "motohoursCondition": "", ~/~/ Условие по моточасам 1745 - "lastMotohours": "", ~/~/ Моточасы 1746 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1747 - "kind": "", ~/~/ Вид периодичности по времени 1748 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2084 + "grades": [ ~/~/ Таблицы тарировки 2085 + { 2086 + "input": 0, ~/~/ Вход 2087 + "output": 0 ~/~/ Выход 2088 + } 2089 + ], 2090 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1749 1749 } 2092 + ], 2093 + "showInTooltip": true, ~/~/ Отображение в подсказке 2094 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1750 1750 1751 -(% lang="en-US" style="text-align:left" %) 1752 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2096 +((( 2097 + "color": "string", ~/~/ цвет уведомлений 2098 +))) 1753 1753 2100 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2101 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2102 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2103 + "expr": "string", ~/~/ Выражение 2104 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2105 + "string" 2106 + ], 2107 + "customParams": { ~/~/ Дополнительные настройки 2108 + "additionalProp1": "string", 2109 + "additionalProp2": "string", 2110 + "additionalProp3": "string" 2111 + }, 2112 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2113 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2114 + { 2115 + "from": 0, ~/~/ С какого значения 2116 + "color": "string", ~/~/ Каким цветом 2117 + "text": "string" ~/~/ Текст подписи к этому интервалу 2118 + } 2119 + ] 2120 + } 2121 + ], 2122 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2123 + "customFields": [ ~/~/ Список произвольных полей 2124 + { 2125 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2126 + "name": "string", ~/~/ Наименование произвольного поля 2127 + "value": "string", ~/~/ Значение произвольного поля 2128 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2129 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2130 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2131 + } 2132 + ], 2133 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2134 +} 2135 +))) 2136 + 1754 1754 **Валидация:** 1755 1755 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1756 1756 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1789,18 +1789,15 @@ 1789 1789 1790 1790 (% style="color:#000000" %)Метод запроса: **GET** 1791 1791 1792 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2175 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1793 1793 1794 1794 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1795 1795 1796 1796 (% style="color:#000000" %)Ответ: 1797 1797 1798 -(% style="color:#000000" %){ 1799 - 2181 +(% style="color:#000000" %){(%%) 1800 1800 "deviceTypeId" : "", ~/~/ ID типа устройства 1801 1801 "deviceTypeName" : "" ~/~/ Название типа устройства 1802 - 1803 -(% style="text-align:left" %) 1804 1804 (% style="color:#000000" %)} 1805 1805 1806 1806 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1822,13 +1822,10 @@ 1822 1822 1823 1823 (% style="color:#000000" %)Ответ: 1824 1824 1825 -(% style="color:#000000" %){ 1826 - 2205 +(% style="color:#000000" %){(%%) 1827 1827 "id": "", ~/~/ ID типа датчика 1828 1828 "name": "", ~/~/ Название 1829 1829 "description": "", ~/~/ Описание 1830 - 1831 -(% style="text-align:left" %) 1832 1832 (% style="color:#000000" %)} 1833 1833 1834 1834 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1872,6 +1872,56 @@ 1872 1872 } 1873 1873 ] 1874 1874 2252 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2253 + 2254 +(% class="box infomessage" style="text-align: left;" %) 2255 +((( 2256 +**POST /api/v3/terminalMessages/mapping** 2257 +))) 2258 + 2259 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2260 + 2261 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2262 + 2263 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2264 + 2265 +{ 2266 + "protocolType": 0, 2267 + "params": ["string"] 2268 +} 2269 + 2270 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2271 +|protocolType|ID типа протокола 2272 +|params|((( 2273 +Массив наименований параметров в сообщении 2274 +))) 2275 + 2276 +Ответ: 2277 + 2278 +{ 2279 + "protocolType": 0, 2280 + "mapping": { 2281 + "additionalProp1": { 2282 + "inputType": 0, 2283 + "inputNumber": 0 2284 + }, 2285 + "additionalProp2": { 2286 + "inputType": 0, 2287 + "inputNumber": 0 2288 + } 2289 + } 2290 +} 2291 + 2292 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2293 +|protocolType|Тип протокола 2294 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2295 +|inputNumber|((( 2296 +Номер входа 2297 +))) 2298 + 2299 +(% class="wikigeneratedid" %) 2300 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2301 + 1875 1875 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 1876 1877 1877 (% class="box infomessage" %) ... ... @@ -1896,6 +1896,11 @@ 1896 1896 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 1897 } 1898 1898 2326 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2327 +|vehicleId|ID объекта 2328 +|from|Дата и время начала периода запроса 2329 +|to|Дата и время окончания периода запроса 2330 + 1899 1899 Ответ: 1900 1900 1901 1901 [ ... ... @@ -1902,25 +1902,43 @@ 1902 1902 { 1903 1903 "messages": [ 1904 1904 { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2337 + "deviceTime": "2023-11-29T07:40:44.052Z", 2338 + "serverTime": "2023-11-29T07:40:44.052Z", 2339 + "speed": 0, 2340 + "altitude": 0, 2341 + "latitude": 0, 2342 + "longitude": 0, 2343 + "satellites": 0, 2344 + "course": 0, 2345 + "voltage": 0, 2346 + "parameters": { 1914 1914 "additionalProp1": "string", 1915 1915 "additionalProp2": "string", 1916 1916 "additionalProp3": "string" 1917 1917 }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 2351 + "photoCount": 0, 2352 + "lbsCorrectedCoords": true, 2353 + "protocolType": 0 1919 1919 } 1920 1920 ] 1921 1921 } 1922 1922 ] 1923 1923 2359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2360 +|deviceTime|Время сообщения терминала 2361 +|serverTime|Время когда сообщение поступило на сервер 2362 +|speed|Скорость 2363 +|altitude|Высота над уровнем моря 2364 +|latitude|Широта 2365 +|longitude|Долгота 2366 +|satellites|Кол-во спутников 2367 +|course|Курс 2368 +|voltage|Бортовое напряжение 2369 +|parameters|Список параметров и их значений 2370 +|photoCount|Количество фото 2371 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2372 +|protocolType|ID типа протокола 2373 + 1924 1924 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 1925 1926 1926 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1957,10 +1957,14 @@ 1957 1957 { 1958 1958 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1959 1959 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1960 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1961 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1962 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1963 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2410 + "mileage": 0, ~/~/ Пробег за период, километры 2411 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2412 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2413 + "motohours": 0, ~/~/ Моточасы за период, секунды 2414 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2415 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2416 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2417 + 1964 1964 } 1965 1965 ] 1966 1966 } ... ... @@ -2004,11 +2004,19 @@ 2004 2004 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2005 2005 "fuelConsumption": 0, ~/~/ Расход топлива 2006 2006 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2461 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2462 + 2007 2007 } 2008 2008 ] 2009 2009 } 2010 2010 ] 2011 2011 2468 +(% class="box warningmessage" %) 2469 +((( 2470 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2471 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2472 +))) 2473 + 2012 2012 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2013 2013 2014 2014 (% class="box infomessage" %) ... ... @@ -2043,7 +2043,8 @@ 2043 2043 "model": "string", ~/~/ Модель объекта 2044 2044 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2045 2045 { 2046 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2508 + "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 2509 + 2047 2047 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2048 2048 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2049 2049 "valueFuel": 0, ~/~/ Количество ... ... @@ -2054,6 +2054,96 @@ 2054 2054 } 2055 2055 ] 2056 2056 2520 + 2521 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2522 + 2523 +(% class="box infomessage" %) 2524 +((( 2525 +**POST /api/v3/vehicles/moveStop** 2526 +))) 2527 + 2528 +Метод запроса: **POST** 2529 + 2530 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2531 + 2532 +В заголовках запроса: X-Auth: Токен авторизации 2533 + 2534 + 2535 +Тело запроса: 2536 + 2537 +{ 2538 + "vehicleIds": [ ], ~/~/ Список ID объектов 2539 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2540 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2541 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2542 +} 2543 + 2544 +Ответ: 2545 + 2546 +[ 2547 + { 2548 + "vehicleId": 0, ~/~/ ID объекта 2549 + "vehicleName": "string", ~/~/ Имя объекта 2550 + "moves": [ ~/~/ Событие движения 2551 + { 2552 + "mileage": 0, ~/~/ Пробег, км 2553 + "eventId": 0, ~/~/ Идентификатор события 2554 + "eventName": "string", ~/~/ Название события 2555 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2556 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2557 + "duration": 0 ~/~/ Продолжительность события, секунд 2558 + } 2559 + ], 2560 + "stops": [ ~/~/ События стоянок 2561 + { 2562 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2563 + "eventId": 0, ~/~/ Идентификатор события 2564 + "eventName": "string", ~/~/ Название события 2565 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2566 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2567 + "duration": 0 ~/~/ Продолжительность события, секунд 2568 + } 2569 + ] 2570 + } 2571 +] 2572 + 2573 + 2574 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2575 + 2576 +(% class="box infomessage" %) 2577 +((( 2578 +**POST /api/v3/vehicles/getlastdata** 2579 +))) 2580 + 2581 +Метод запроса: **POST** 2582 + 2583 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2584 + 2585 +В заголовках запроса: X-Auth: Токен авторизации 2586 + 2587 + 2588 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2589 + 2590 +Ответ: 2591 + { 2592 + "vehicleId": 0, ~/~/Идентификатор объекта. 2593 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2594 + "vehicleNumber": "string",~/~/Номер объекта. 2595 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2596 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2597 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2598 + "speed": 0,~/~/Скорость объекта. 2599 + "course": 0,~/~/Курс движения [0;360] 2600 + "latitude": 0,~/~/Широта [-90°;90°]. 2601 + "longitude": 0,~/~/Долгота [-180°;180°]. 2602 + "address": "string",~/~/Адрес. 2603 + "geozones": [ ~/~/Сведения по геозонам. 2604 + { 2605 + "id": 0, 2606 + "name": "string" 2607 + } 2608 + 2609 + 2057 2057 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 2058 2059 2059 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2182,6 +2182,35 @@ 2182 2182 } 2183 2183 ] 2184 2184 2738 + 2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2740 + 2741 +(% class="box successmessage" %) 2742 +((( 2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2744 +))) 2745 + 2746 +(% style="color:#000000" %)Метод запроса: **PUT** 2747 + 2748 +Пример запроса: 2749 + 2750 +((( 2751 +{ 2752 + "id": 0, ~/~/ Идентификатор объекта геозоны 2753 + "name": "string", ~/~/ Наименование объекта геозоны 2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2755 + "description": "string", ~/~/ Описание объекта геозоны 2756 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2757 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2758 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2759 +} 2760 +))) 2761 + 2762 + 2763 +Пример ответа: 2764 + 2765 +200 ~/~/ Success 2766 + 2185 2185 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2186 2186 2187 2187 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2361,6 +2361,32 @@ 2361 2361 2362 2362 Success 2363 2363 2946 + 2947 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2948 + 2949 +(% class="box warningmessage" %) 2950 +((( 2951 +**PUT** /api/v3/notifications/prolongation 2952 +))) 2953 + 2954 +Метод позволяет продлить уведомления. 2955 + 2956 +Метод запроса **PUT** 2957 + 2958 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2959 + 2960 +В заголовках запроса: X-Auth: Токен авторизации. 2961 + 2962 +Тело запроса: 2963 + 2964 +[ 2965 + 2966 +0 2967 + 2968 +] 2969 + 2970 +где 0 идентификатор ids. 2971 + 2364 2364 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2365 2365 2366 2366 (% class="box errormessage" %) ... ... @@ -3406,6 +3406,8 @@ 3406 3406 **PUT /api/v3/Billing/client/balance** 3407 3407 ))) 3408 3408 4017 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4018 + 3409 3409 Тело запроса: 3410 3410 3411 3411 { ... ... @@ -3419,6 +3419,50 @@ 3419 3419 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3420 3420 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3421 3421 4032 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4033 + 4034 +(% class="box warningmessage" %) 4035 +((( 4036 +**PUT /api/v3/billing/client/balance/deposit** 4037 +))) 4038 + 4039 +Создает операцию **Пополнение **с указанной суммой 4040 + 4041 +Тело запроса: 4042 + 4043 +{ 4044 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4045 + "Balance": 0 4046 +} 4047 + 4048 +Ответ: Success 4049 + 4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4051 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4052 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4053 + 4054 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4055 + 4056 +Создает операцию **Списание **с указанной суммой 4057 + 4058 +(% class="box warningmessage" %) 4059 +((( 4060 +**PUT /api/v3/billing/client/balance/withdraw** 4061 +))) 4062 + 4063 +Тело запроса: 4064 + 4065 +{ 4066 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4067 + "Balance": 0 4068 +} 4069 + 4070 +Ответ: Success 4071 + 4072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4073 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4074 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4075 + 3422 3422 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3423 3423 3424 3424 (% class="box warningmessage" %) ... ... @@ -3505,22 +3505,140 @@ 3505 3505 **POST /api/v3/vehicles/import/{agentId}** 3506 3506 ))) 3507 3507 3508 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp ** . В формате**xml**экспортируютсяобъектыизнашейсистемы.4162 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3509 3509 3510 -**agentId** - , указывается в пути запроса.(обязательный)4164 +В пути указывается **agentId** - id клиента. 3511 3511 4166 +**Заголовок** 3512 3512 4168 +**X-Auth: [токен авторизации]** 4169 + 4170 +**Параметры** 4171 + 4172 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4173 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4174 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4175 + 4176 +В теле использовать тип **form-data,** тип значения** file** 4177 + 4178 +**Ключи** 4179 + 4180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4181 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4182 +|csv|В значении передаем файл датчиков, формат **csv** 4183 + 4184 +Ответ: 4185 + 4186 +{ 4187 + "vehicleId": 0, 4188 + "name": "string", 4189 + "errors": ["string"] 4190 +} 4191 + 4192 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4193 +|vehicleId|ID созданного объекта 4194 +|name|Имя созданного объекта 4195 +|errors|Ошибки и их описание 4196 + 3513 3513 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3514 3514 3515 3515 (% class="box infomessage" %) 3516 3516 ((( 3517 -**POST /api/v3/vehicles/import/history/{vehicleId}** 4201 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3518 3518 ))) 3519 3519 3520 3520 (% class="wikigeneratedid" %) 3521 -** vehicleId**-idобъекта.4205 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3522 3522 4207 +(% class="wikigeneratedid" %) 4208 +В пути указывается **vehicleId **- id объекта. 3523 3523 4210 +**Заголовок** 4211 + 4212 +**X-Auth: [токен авторизации]** 4213 + 4214 +В теле использовать тип **form-data.** 4215 + 4216 +Ключи: 4217 + 4218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4219 +|**history**|В значении передавать файл с историей 4220 + 4221 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4222 + 4223 +Ответ: 4224 + 4225 +{ 4226 + "results": [ 4227 + { 4228 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4229 + "vehicleId": 0, 4230 + "errors": [ 4231 + "string" 4232 + ], 4233 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4234 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4235 + "producedCount": 0, 4236 + "msgCount": 0 4237 + } 4238 + ] 4239 +} 4240 + 4241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4242 +|results|Результаты импорта в разрезе ТС 4243 +|vehicleGuid|Guid ТС 4244 +|vehicleId|ID ТС 4245 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4246 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4247 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4248 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4249 +|msgCount|Кол-во обработанных сообщений всего 4250 + 4251 +(% class="wikigeneratedid" %) 4252 +== == 4253 + 4254 +== **Импортировать историю ТС (Асинхронный запрос)** == 4255 + 4256 +(% class="box successmessage" %) 4257 +((( 4258 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4259 +))) 4260 + 4261 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4262 + 4263 +Метод запроса: **POST** 4264 + 4265 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4266 + 4267 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4268 + 4269 + 4270 +Ответ: 4271 + 4272 +{ 4273 + 4274 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4275 + 4276 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4277 + 4278 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4279 + 4280 + "Message": "string", ~/~/ Информация о выполнении запроса 4281 + 4282 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4283 + 4284 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4285 + 4286 + "Data": "string" ~/~/ Данные 4287 + 4288 +} 4289 + 4290 + 4291 +== == 4292 + 4293 +(% class="wikigeneratedid" %) 4294 +== == 4295 + 3524 3524 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3525 3525 3526 3526 (% class="box infomessage" %) ... ... @@ -3528,7 +3528,60 @@ 3528 3528 **GET /api/v3/vehicles/import/history/status** 3529 3529 ))) 3530 3530 4303 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3531 3531 4305 +Ответ: 4306 + 4307 +{ 4308 + "activity": true, 4309 + "progress": 0, 4310 + "message": "string" 4311 +} 4312 + 4313 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4314 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4315 +|progress|Guid ТС 4316 + 4317 +(% class="wikigeneratedid" %) 4318 +== == 4319 + 4320 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4321 + 4322 +(% class="box infomessage" %) 4323 +((( 4324 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4325 +))) 4326 + 4327 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4328 + 4329 +Метод запроса: **GET** 4330 + 4331 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4332 + 4333 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4334 + 4335 + 4336 +Ответ: 4337 + 4338 +{ 4339 + 4340 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4341 + 4342 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4343 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4344 + 4345 + "Message": "string", ~/~/ Информация о выполнении запроса 4346 + 4347 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4348 + 4349 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4350 + 4351 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4352 + 4353 + "Data": "string" ~/~/ Данные 4354 + 4355 +} 4356 + 3532 3532 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3533 3533 3534 3534 (% class="box infomessage" %) ... ... @@ -3598,7 +3598,7 @@ 3598 3598 3599 3599 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3600 3600 3601 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==4426 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3602 3602 3603 3603 (% class="box infomessage" %) 3604 3604 ((( ... ... @@ -3610,64 +3610,67 @@ 3610 3610 Тело запроса: 3611 3611 3612 3612 { 3613 - "vehicleIds": [vehicleId], 3614 - "from": "2023-11-22T09:29:48.051Z", 3615 - "to": "2023-11-22T09:29:48.051Z" 4438 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4439 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4440 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 3616 3616 } 3617 3617 3618 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3619 -|vehicleIds|Массив ID объектов 3620 -|from|Дата начала запроса 3621 -|to|Дата окончания запроса 3622 - 3623 3623 Ответ: 3624 3624 3625 3625 { 3626 - "items": [ 4446 + "items": [ ~/~/ Список в разрезе ТС 3627 3627 { 3628 - "from": "2023-11-22T09:29:48.052Z", 3629 - "to": "2023-11-22T09:29:48.052Z", 3630 - "vehicleId": 0, 3631 - "vehicleName": "string", 3632 - "vehicleModel": "string", 3633 - "penalty": 0, 3634 - "score": 0, 3635 - "totalViolations": 0, 3636 - "violationsByType": { 3637 - "overspeedingViolations": 0, 3638 - "accelerationViolations": 0, 3639 - "brakingViolations": 0, 3640 - "turningViolations": 0, 3641 - "dangerousDrivingViolations": 0, 3642 - "sensorViolations": 0 4448 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4449 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4450 + "vehicleId": 0, ~/~/ ID ТС 4451 + "vehicleName": "string", ~/~/ Название ТС 4452 + "vehicleModel": "string", ~/~/ Модель ТС 4453 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4454 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4455 + "totalViolations": 0, ~/~/ Нарушений всего 4456 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4457 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4458 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4459 + "brakingViolations": 0, ~/~/ Нарушений торможения 4460 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4461 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4462 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3643 3643 }, 3644 - "moveTime": 0, 3645 - "mileage": 0, 3646 - "tripsCount": 0, 3647 - "trips": [ 4464 + 4465 +((( 4466 + 4467 +))) 4468 + 4469 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4470 + "mileage": 0, ~/~/ Пробег, м 4471 + "tripsCount": 0, ~/~/ Кол-во рейсов 4472 + "trips": [ ~/~/ Информация по рейсу 3648 3648 { 3649 - "penalty": 0, 3650 - "score": 0, 3651 - "violationsCount": 0, 3652 - "violationsByType": { 3653 - "overspeedingViolations": 0, 3654 - "accelerationViolations": 0, 3655 - "brakingViolations": 0, 3656 - "turningViolations": 0, 3657 - "dangerousDrivingViolations": 0, 3658 - "sensorViolations": 0 4474 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4475 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4476 + "violationsCount": 0, ~/~/ Всего нарушений 4477 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4478 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4479 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4480 + "brakingViolations": 0, ~/~/ Нарушений торможения 4481 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4482 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4483 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3659 3659 }, 3660 - "moveTime": 0, 3661 - "mileage": 0, 3662 - "motohours": 0, 3663 - "maxSpeed": 0, 3664 - "startAddress": "string", 3665 - "endAddress": "string", 3666 - "drivers": [ 4485 + 4486 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4487 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4488 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4489 + "mileage": 0, ~/~/ Пробег, м 4490 + "motohours": 0, ~/~/ Моточасы, секунды 4491 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4492 + "startAddress": "string", ~/~/ Адрес начала рейса 4493 + "endAddress": "string", ~/~/ Адрес конца рейса 4494 + "drivers": [ ~/~/ Список водителей 3667 3667 { 3668 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3669 - "driverName": "string", 3670 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4496 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4497 + "driverName": "string", ~/~/ФИО водителя 4498 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 3671 3671 } 3672 3672 ] 3673 3673 } ... ... @@ -3676,34 +3676,1747 @@ 3676 3676 ] 3677 3677 } 3678 3678 3679 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3680 -|from|Дата начала запроса 3681 -|to|Дата окончания 3682 -|vehicleId|ID объекта 3683 -|vehicleName|Имя объекта 3684 -|vehicleModel|Модель объекта 3685 -|penalty|Сумма штрафных баллов 3686 -|score|Оценка 3687 -|totalViolations|Суммарное количество нарушений 3688 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3689 -|overspeedingViolations|Превышение скорости 3690 -|accelerationViolations|Ускорение 3691 -|brakingViolations|Торможение 3692 -|turningViolations|Резкий поворот 3693 -|dangerousDrivingViolations|Резкое вождение 3694 -|sensorViolations|Нарушение по датчику 3695 -|moveTime|Время в движении 3696 -|mileage|Пробег 3697 -|tripsCount|Количество рейсов 3698 -|motohours|Моточасы 3699 -|maxSpeed|Максимальная скорость 3700 -|startAddress|Адрес начала рейса 3701 -|endAddress|Адрес окончания рейса 3702 -|drivers|Список водителей, которые были на объекте в течениии рейса 3703 -|driverGuid|Guid водителя 3704 -|driverName|Имя водителя 3705 -|driverRfid|Номер Карты-метки 4507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3706 3706 4509 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4510 + 4511 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4512 + 4513 +(% class="box infomessage" %) 4514 +((( 4515 +**POST /api/v3/fuelcards/transactions** 4516 +))) 4517 + 4518 +Метод запроса: POST 4519 + 4520 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4521 +\\В заголовках запроса: X-Auth: Токен авторизации 4522 + 4523 +Параметры в теле запроса (JSON): 4524 + 4525 +{ 4526 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4527 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4528 + "ids": [ 4529 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4530 + ], 4531 + "timezone": 0 ~/~/ Часовой пояс 4532 +} 4533 + 4534 + 4535 +Ответ: 4536 + { 4537 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4538 + "driver": "string", ~/~/ Водители, привязанные к ТК 4539 + "object": "string", ~/~/ Наименование ТС 4540 + "amount": 0, ~/~/ Количество топлива 4541 + "amountDut": 0, ~/~/ Количество по ДУТ 4542 + "amountDiff": 0, ~/~/ Разница, л 4543 + "amountDiffPerc": 0, ~/~/ Разница, % 4544 + "summa": 0, ~/~/ Стоимость, руб 4545 + "serviceName": "string", ~/~/ Тип топлива 4546 + "price": 0, ~/~/ Цена за литр, руб 4547 + "cardName": "string", ~/~/ Наименование ТК 4548 + "cardNum": "string", ~/~/ Номер ТК 4549 + "operator": "string", ~/~/ Оператор ТК 4550 + "address": "string" ~/~/ Адрес АЗС 4551 + } 4552 + 4553 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4554 + 4555 +(% class="box infomessage" %) 4556 +((( 4557 +**GET /api/v3/fuelcards** 4558 +))) 4559 + 4560 +Метод запроса: GET 4561 + 4562 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4563 + 4564 +Ответ: 4565 + 4566 +[ 4567 + { 4568 + "Name": "string", ~/~/ Определяет наименование карты. 4569 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4570 + "Number": "string", ~/~/ Определяет № карты. 4571 + "Enabled": true, ~/~/ Определяет признак активности карты. 4572 + "Description": "string", ~/~/ Определяет описание карты. 4573 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4574 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4575 + "deleted": true ~/~/ Признак удаления 4576 + } 4577 +] 4578 + 4579 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4580 + 4581 + 4582 +== **Получение полных данных о ретрансляторе** == 4583 + 4584 +(% class="box infomessage" %) 4585 +((( 4586 +**GET ** **/api/v3/retranslations/{id}** 4587 +))) 4588 + 4589 +id - Идентификатор ретранслятора 4590 + 4591 + 4592 +Пример ответа: 4593 + 4594 +{ 4595 +"description": "", ~/~/ Поле описания ретранслятора 4596 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4597 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4598 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4599 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4600 +"objects": [ ~/~/ Объекты для ретрансляции 4601 +{ 4602 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4603 +"name": "", ~/~/ Наименование объекта ретрансляции 4604 +"imei": "", ~/~/ IMEI объекта ретрансляции 4605 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4606 +} 4607 + ], 4608 +"id": "", ~/~/ Идентификатор ретранслятора 4609 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4610 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4611 +} 4612 + 4613 + 4614 +== **Удаление данных ретранслятора** == 4615 + 4616 +(% class="box infomessage" %) 4617 +((( 4618 +**DELETE** **/api/v3/retranslations/{id}** 4619 +))) 4620 + 4621 +id - Идентификатор ретранслятора 4622 + 4623 + 4624 +== **Создание ретранслятора** == 4625 + 4626 +(% class="box infomessage" %) 4627 +((( 4628 +**POST ** **/api/v3/retranslations/{id}** 4629 +))) 4630 + 4631 +Запрос: 4632 + 4633 +{ 4634 +"description": "", ~/~/ Поле описания ретранслятора 4635 +"subscriberId": "", ~/~/ Идентификатор подписчика 4636 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4637 +"address": "", ~/~/ Адрес и порт принимающего сервера 4638 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4639 +"objects": [ ~/~/Объекты для ретрансляции 4640 +{ 4641 +"id": "", ~/~/ Идентификатор ретранслятора 4642 +"imei": "", ~/~/ IMEI объекта ретрансляции 4643 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4644 +} 4645 + ] 4646 +} 4647 + 4648 + 4649 +Ответ: 4650 + 4651 +{ 4652 +"description": "", ~/~/ Поле описания ретранслятора 4653 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4654 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4655 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4656 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4657 +"objects": [ ~/~/ Объекты для ретрансляции 4658 +{ 4659 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4660 +"name": "string", ~/~/ Наименование объекта ретрансляции 4661 +"imei": "", ~/~/ IMEI объекта ретрансляции 4662 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4663 +} 4664 + ], 4665 +"id": "", ~/~/ Идентификатор ретранслятора 4666 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4667 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4668 +} 4669 + 4670 + 4671 +== **Редактирование ретранслятора** == 4672 + 4673 +(% class="box infomessage" %) 4674 +((( 4675 +**PUT** **/api/v3/retranslations** 4676 +))) 4677 + 4678 +Пример запроса: 4679 + 4680 +{ 4681 +"id": "", ~/~/ Идентификатор ретранслятора 4682 +"description": "string", ~/~/ Поле описания ретранслятора 4683 +"subscriberId": "", ~/~/ Идентификатор подписчика 4684 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4685 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4686 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4687 +"objects": ~/~/ Объекты для ретрансляции 4688 +[ 4689 +{ 4690 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4691 +"imei": "", ~/~/ IMEI объекта ретрансляции 4692 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4693 +} 4694 + ] 4695 +} 4696 + 4697 + 4698 +Пример ответа: 4699 + 4700 +{ 4701 +"description": "", ~/~/ Поле описания ретранслятора 4702 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4703 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4704 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4705 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4706 +"objects": [ ~/~/ Объекты для ретрансляции 4707 +{ 4708 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4709 +"name": "string", ~/~/ Наименование объекта ретрансляции 4710 +"imei": "", ~/~/ IMEI объекта ретрансляции 4711 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4712 +} 4713 + ], 4714 +"id": "", ~/~/ Идентификатор ретранслятора 4715 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4716 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4717 +} 4718 + 4719 + 4720 +== **Получение списка ретранслятора клиента** == 4721 + 4722 +(% class="box infomessage" %) 4723 +((( 4724 +**POST /api/v3/retranslations/find** 4725 +))) 4726 + 4727 +Пример запроса: 4728 + 4729 +{ 4730 +"id": "", ~/~/ Идентификатор ретранслятора 4731 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4732 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4733 +} 4734 + 4735 +Ответ: 4736 + 4737 +[ 4738 +{ 4739 +"description": "", ~/~/ Поле описания ретранслятора 4740 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4741 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4742 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4743 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4744 +"id": "", ~/~/ Идентификатор ретранслятора 4745 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4746 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4747 +} 4748 +] 4749 + 4750 + 4751 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4752 + 4753 +== **API для отчета по выгрузке комбайнов** == 4754 + 4755 +(% class="box infomessage" %) 4756 +((( 4757 +**POST /api/v3/Reports/harvesterUnloading** 4758 +))) 4759 + 4760 +Пример запроса: 4761 + 4762 +{ 4763 + "byTime": 0, ~/~/ Объединение событий по времени 4764 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4765 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4766 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4767 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4768 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4769 + 0 4770 + ], 4771 + "from": "", ~/~/ Дата и время начало запроса 4772 + "to": "", ~/~/ Дата и время окончания запроса 4773 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4774 +} 4775 + 4776 +Пример ответа: 4777 + 4778 +[ 4779 + { 4780 + "harvesterName": "", ~/~/Комбайн, номер 4781 + "harvesterId": 0, ~/~/Комбайн, id 4782 +"harvesterModel": "", ~/~/ Модель комбайна 4783 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4784 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4785 + "events": [ ~/~/Список событий в разрезе комбайна 4786 + { 4787 + "driverId": "", ~/~/Идентификатор водителя 4788 + "driverName": "", ~/~/Водитель комбайна, ФИО 4789 + "RFID": "", ~/~/ идентификатор карты-метки 4790 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4791 + "vehicleId": 0, ~/~/идентификатор объекта 4792 + "vehicleName": "string", ~/~/ Имя объекта 4793 + "modelName": "string", ~/~/ Имя модели объекта 4794 + "nearestVehicles": [ ~/~/Объекты рядом 4795 + { 4796 + "vehicleId": 0, ~/~/идентификатор объекта 4797 + "vehicleName": "string" ~/~/ Имя объекта 4798 + } 4799 + ], 4800 + "fields": [ ~/~/Поля, где происходила выгрузка 4801 + { 4802 + "id": 0, ~/~/ идентификатор пользователя 4803 + "name": "string" ~/~/ имя пользователя 4804 + } 4805 + ], 4806 + "event": "string", ~/~/Событие 4807 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4808 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4809 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4810 + "cultureName": "string", ~/~/ название культуры 4811 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4812 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4813 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4814 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4815 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4816 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4817 + "issued": 0, ~/~/Выдано, бункеров 4818 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4819 + "latitude": 0, ~/~/Широта 4820 + "longitude": 0, ~/~/ Долгота 4821 + "litresAway": 0, ~/~/Отдано, л 4822 + "m3Away": 0 ~/~/Отдано, м3 4823 + } 4824 + ] 4825 + } 4826 +] 4827 + 4828 + 4829 +== **Отчет трек-датчики** == 4830 + 4831 +(% class="box infomessage" %) 4832 +((( 4833 +**POST /api/v3/Reports/sensorsWorks** 4834 +))) 4835 + 4836 +**Пример запроса:** 4837 + 4838 +{ 4839 + "vehicleIds": [ ~/~/ Список ID объектов 4840 + 0 4841 + ], 4842 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4843 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4844 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4845 +} 4846 + 4847 +**Пример ответа:** 4848 + 4849 +((( 4850 +{ 4851 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4852 + { 4853 + "vehicleId": 0, ~/~/ Идентификатор ТС 4854 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4855 + { 4856 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4857 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4858 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4859 + "name": "string", ~/~/ Наименование оборудования. 4860 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4861 + "totalMileage": 0, ~/~/ Общий пробег. 4862 + "avgSpeed": 0 ~/~/ Средняя скорость. 4863 + } 4864 + ] 4865 + } 4866 + ] 4867 +} 4868 + 4869 + 4870 +== **Превышение скорости** == 4871 + 4872 +(% class="box infomessage" %) 4873 +((( 4874 +**POST /api/v3/Reports/overSpeedDuration** 4875 +))) 4876 + 4877 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4878 + 4879 +Пример запроса: 4880 + 4881 +((( 4882 +{ 4883 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4884 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4885 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4886 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4887 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4888 +} 4889 +))) 4890 + 4891 +((( 4892 + 4893 +))) 4894 + 4895 +((( 4896 +Пример ответа: 4897 +))) 4898 + 4899 +((( 4900 +((( 4901 +[ 4902 + { 4903 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4904 + "duration": 0, ~/~/ Продолжительность события в секундах 4905 + "maxSpeed": 0, ~/~/ Максимальная скорость 4906 + "speedLimit": 0 ~/~/ Ограничение скорости 4907 + } 4908 +] 4909 +))) 4910 +))) 4911 +))) 4912 + 4913 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4914 + 4915 + 4916 +== **Запрос списка полей** == 4917 + 4918 +(% class="box successmessage" %) 4919 +((( 4920 +**POST /api/v3/agroLands/find** 4921 +))) 4922 + 4923 +Пример запроса: 4924 + 4925 +((( 4926 +((( 4927 +((( 4928 +{ 4929 + "year": 0, ~/~/ Фильтр по году 4930 + "name": "string", ~/~/ Фильтр по названию 4931 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4932 +} 4933 +))) 4934 +))) 4935 + 4936 + 4937 +))) 4938 + 4939 +Пример ответа: 4940 + 4941 +((( 4942 +[ 4943 + { 4944 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4945 + "year": 0, ~/~/ Год поля 4946 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4947 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4948 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4949 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4950 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4951 + "counts": { ~/~/ Счётчики с/х поля 4952 + "fieldOperations": 0, ~/~/ Количество операций на поле 4953 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4954 + "facts": 0 ~/~/ Счётчик факта 4955 + }, 4956 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4957 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4958 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4959 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4960 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4961 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4962 + "planComment": "string", ~/~/ Комментарий к полю 4963 + "productivity": 0, ~/~/ Урожайность. 4964 + "id": 0, ~/~/ Идентификатор объекта геозоны 4965 + "name": "string", ~/~/ Название объекта геозоны 4966 + "type": 0, ~/~/ Тип объекта геозоны 4967 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4968 + "fname": "string", ~/~/ Имя файла 4969 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4970 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4971 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4972 + "description": "string", ~/~/ Описание объекта геозоны 4973 + "area": 0, ~/~/ Площадь, м2 4974 + "perimetr": 0, ~/~/ Периметр, м 4975 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4976 + } 4977 +] 4978 + 4979 + 4980 +== **Создание нового поля ** == 4981 + 4982 +(% class="box successmessage" %) 4983 +((( 4984 +**POST /api/v3/agroLands** 4985 +))) 4986 + 4987 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4988 +X-agent - ID клиента 4989 + 4990 +Пример запроса: 4991 + 4992 +((( 4993 +{ 4994 + "extId": "string", 4995 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4996 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4997 + "display": "string", ~/~/ Настройки отображения 4998 + "year": 0, ~/~/ Год поля 4999 + "name": "string", ~/~/ Наименование 5000 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5001 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5002 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5003 + "planComment": "string", ~/~/ Комментарий к полю 5004 + "cropRotations": [ ~/~/ Данные по севообороту 5005 + { 5006 + "landId": 0, ~/~/ ID поля 5007 + "landName": "string", ~/~/ Название поля 5008 + "year": 0, ~/~/ Год урожая 5009 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5010 + "cultureName": "string", ~/~/ Название культуры 5011 + "productivity": 0, ~/~/ Урожайность 5012 + "area": 0, ~/~/ Площадь поля, Га 5013 + "total": 0, ~/~/ Валовый сбор 5014 + "productivityFact": 0, ~/~/ Фактическая урожайность 5015 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5016 + "totalFact": 0, ~/~/ Фактический валовый сбор 5017 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5018 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5019 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5020 + "isyearplan": true, ~/~/ Годовой план 5021 + "comment": "string" ~/~/ Комментарий 5022 + } 5023 + ] 5024 +} 5025 +))) 5026 + 5027 +((( 5028 + 5029 +))) 5030 + 5031 +Пример ответа: 5032 + 5033 +((( 5034 +((( 5035 +{ 5036 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5037 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5038 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5039 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5040 + "cropRotations": [ ~/~/ Данные по севообороту 5041 + { 5042 + "landId": 0, ~/~/ ID поля 5043 + "landName": "string", ~/~/ Название поля 5044 + "year": 0, ~/~/ Год урожая 5045 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5046 + "cultureName": "string", ~/~/ Название культуры 5047 + "productivity": 0, ~/~/ Урожайность 5048 + "area": 0, ~/~/ Площадь поля, Га. 5049 + "total": 0, ~/~/ Валовый сбор 5050 + "productivityFact": 0, ~/~/ Фактическая урожайность 5051 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5052 + "totalFact": 0, ~/~/ Фактический валовый сбор 5053 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5054 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5055 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5056 + "isyearplan": true, ~/~/ годовой план 5057 + "comment": "string" ~/~/ Комментарий 5058 + } 5059 + ], 5060 + "cropVegetation": [ ~/~/ История вегетации поля 5061 + { 5062 + "values": [ ~/~/ Данные вегетации и состояния посева 5063 + { 5064 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5065 + "ndvi": 0 ~/~/ Индекс вегетации 5066 + } 5067 + ], 5068 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5069 + { 5070 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5071 + "type": "string", ~/~/ Тип 5072 + "pictureid": "string" ~/~/ Идентификатор ресурса 5073 + } 5074 + ], 5075 + "states": [ ~/~/ Ключевые даты развития поля 5076 + { 5077 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5078 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5079 + } 5080 + ] 5081 + } 5082 + ], 5083 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5084 + "counts": { 5085 + "fieldOperations": 0, ~/~/ Количество операций на поле 5086 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5087 + "facts": 0 ~/~/ Счётчик факта 5088 + }, 5089 + "planComment": "string", ~/~/ Комментарий к полю 5090 +))) 5091 + 5092 +((( 5093 + "productivity": 0, ~/~/ Урожайность. 5094 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5095 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5096 + "year": 0, ~/~/ Год поля 5097 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5098 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5099 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5100 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5101 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5102 + "id": 0, ~/~/ Идентификатор объекта геозоны 5103 + "name": "string", ~/~/ Название объекта геозоны 5104 + "type": 0, ~/~/ Тип объекта геозоны 5105 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5106 + "fname": "string", ~/~/ Имя файла 5107 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5108 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5109 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5110 + "description": "string", ~/~/ Описание объекта геозоны 5111 + "area": 0, ~/~/ Площадь, м2 5112 + "perimetr": 0, ~/~/ Периметр, м 5113 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5114 +} 5115 + 5116 + 5117 +))) 5118 +))) 5119 +))) 5120 + 5121 +== **Получение поля по id** == 5122 + 5123 +(% class="box infomessage" %) 5124 +((( 5125 +**GET /api/v3/agroLands/{id}** 5126 +))) 5127 + 5128 +Пример запроса: 5129 +id ~/~/ Идентификатор поля 5130 + 5131 +Пример ответа: 5132 + 5133 +((( 5134 +{ 5135 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5136 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5137 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5138 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5139 + "cropRotations": [ ~/~/ Данные по севообороту 5140 + { 5141 + "landId": 0, ~/~/ ID поля 5142 + "landName": "string", ~/~/ Название поля 5143 + "year": 0, ~/~/ Год урожая 5144 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5145 + "cultureName": "string", ~/~/ Название культуры 5146 + "productivity": 0, ~/~/ Урожайность 5147 + "area": 0, ~/~/ Площадь поля, Га 5148 + "total": 0, ~/~/ Валовый сбор 5149 + "productivityFact": 0, ~/~/ Фактическая урожайность 5150 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5151 + "totalFact": 0, ~/~/ Фактический валовый сбор 5152 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5153 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5154 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5155 + "isyearplan": true, ~/~/ План года 5156 + "comment": "string" ~/~/ Комментарий 5157 + } 5158 + ], 5159 + "cropVegetation": [ ~/~/ История вегетации поля 5160 + { 5161 + "values": [ ~/~/ Данные вегетации и состояния посева 5162 + { 5163 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5164 + "ndvi": 0 ~/~/ Индекс вегетации 5165 + } 5166 + ], 5167 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5168 + { 5169 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5170 + "type": "string", ~/~/ Тип 5171 + "pictureid": "string" ~/~/ Идентификатор ресурса 5172 + } 5173 + ], 5174 + "states": [ ~/~/ Ключевые даты развития поля 5175 + { 5176 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5177 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5178 + } 5179 + ] 5180 + } 5181 + ], 5182 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5183 + "counts": { 5184 + "fieldOperations": 0, ~/~/ Количество операций на поле 5185 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5186 + "facts": 0 ~/~/ Счётчик факта 5187 + }, 5188 + "planComment": "string", ~/~/ Комментарий к полю 5189 + "productivity": 0, ~/~/ Урожайность. 5190 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5191 +))) 5192 + 5193 +((( 5194 +((( 5195 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5196 + "year": 0, ~/~/ Год поля 5197 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5198 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5199 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5200 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5201 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5202 + "id": 0, ~/~/ Идентификатор объекта геозоны 5203 + "name": "string", ~/~/ Название объекта геозоны 5204 + "type": 0, ~/~/ Тип объекта геозоны 5205 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5206 + "fname": "string", ~/~/ Имя файла 5207 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5208 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5209 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5210 + "description": "string", ~/~/ Описание объекта геозоны 5211 + "area": 0, ~/~/ Площадь, м2 5212 + "perimetr": 0, ~/~/ Периметр, м 5213 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5214 +} 5215 +))) 5216 + 5217 + 5218 +== **Удаление существующего поля** == 5219 + 5220 +(% class="box errormessage" %) 5221 +((( 5222 +**DELETE /api/v3/agroLands/{id}** 5223 +))) 5224 + 5225 +Пример запроса: 5226 +id ~/~/ Идентификатор поля 5227 + 5228 +Пример ответа: 5229 + 5230 +((( 5231 +200 ~/~/ Успех 5232 +))) 5233 + 5234 +((( 5235 + 5236 +))) 5237 + 5238 +((( 5239 +((( 5240 +((( 5241 + 5242 +))) 5243 + 5244 +((( 5245 +== **Изменение поля** == 5246 + 5247 +(% class="box infomessage" %) 5248 +((( 5249 +**PUT /api/v3/agroLands** 5250 +))) 5251 + 5252 +Пример запроса: 5253 + 5254 +((( 5255 +((( 5256 +{ 5257 + "id": 0, ~/~/ Идентификатор поля 5258 + "extId": "string", ~/~/ ExtId 5259 + "shape": "string", ~/~/ Форма поля 5260 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5261 + "display": "string", ~/~/ Настройки отображения 5262 + "year": 0, ~/~/ Год поля 5263 + "name": "string", ~/~/ Наименование 5264 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5265 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5266 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5267 + "planComment": "string", ~/~/Комментарий к полю 5268 + "cropRotations": [ ~/~/ Данные по севообороту 5269 + { 5270 + "landId": 0, ~/~/ ID поля 5271 + "landName": "string", ~/~/ Название поля 5272 + "year": 0, ~/~/ Год урожая 5273 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5274 + "cultureName": "string", ~/~/ Название культуры 5275 + "productivity": 0, ~/~/ Урожайность 5276 + "area": 0, ~/~/ Площадь поля, Га. 5277 + "total": 0, ~/~/ Валовый сбор 5278 + "productivityFact": 0, ~/~/ Фактическая урожайность 5279 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5280 + "totalFact": 0, ~/~/ Фактический валовый сбор 5281 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5282 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5283 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5284 + "isyearplan": true, 5285 + "comment": "string" ~/~/ Комментарий 5286 + } 5287 + ], 5288 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5289 +} 5290 +))) 5291 +))) 5292 + 5293 +((( 5294 + 5295 +))) 5296 + 5297 +Пример ответа: 5298 + 5299 +((( 5300 +((( 5301 +((( 5302 +{ 5303 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5304 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5305 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5306 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5307 + "cropRotations": [ ~/~/ Данные по севообороту 5308 + { 5309 + "landId": 0, ~/~/ ID поля 5310 + "landName": "string", ~/~/ Название поля 5311 + "year": 0, ~/~/ Год урожая 5312 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5313 + "cultureName": "string", ~/~/ Название культуры 5314 + "productivity": 0, ~/~/ Урожайность 5315 + "area": 0, ~/~/ Площадь поля, Га 5316 + "total": 0, ~/~/ Валовый сбор 5317 + "productivityFact": 0, ~/~/ Фактическая урожайность 5318 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5319 + "totalFact": 0, ~/~/ Фактический валовый сбор 5320 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5321 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5322 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5323 + "isyearplan": true, ~/~/ 5324 + "comment": "string" ~/~/ Комментарий 5325 + } 5326 + ], 5327 + "cropVegetation": [ ~/~/ История вегетации поля 5328 + { 5329 + "values": [ ~/~/ Данные вегетации и состояния посева 5330 + { 5331 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5332 + "ndvi": 0 ~/~/ Индекс вегетации 5333 + } 5334 + ], 5335 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5336 + { 5337 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5338 + "type": "string", ~/~/ Тип 5339 + "pictureid": "string" ~/~/ Идентификатор ресурса 5340 + } 5341 + ], 5342 + "states": [ ~/~/ Ключевые даты развития поля 5343 + { 5344 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5345 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5346 + } 5347 + ] 5348 + } 5349 + ], 5350 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5351 + "counts": { 5352 + "fieldOperations": 0, ~/~/ Количество операций на поле 5353 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5354 + "facts": 0 ~/~/ Счётчик факта 5355 + }, 5356 + "planComment": "string", ~/~/ Комментарий к полю 5357 + "productivity": 0, ~/~/ Урожайность. 5358 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5359 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5360 + "year": 0, ~/~/ Год поля 5361 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5362 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5363 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5364 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5365 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5366 + "id": 0, ~/~/ Идентификатор объекта геозоны 5367 + "name": "string", ~/~/ Название объекта геозоны 5368 + "type": 0, ~/~/ Тип объекта геозоны 5369 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5370 + "fname": "string", ~/~/ Имя файла 5371 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5372 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5373 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5374 + "description": "string", ~/~/ Описание объекта геозоны 5375 + "area": 0, ~/~/ Площадь, м2 5376 + "perimetr": 0, ~/~/ Периметр, м 5377 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5378 +} 5379 +))) 5380 +))) 5381 +))) 5382 +))) 5383 +))) 5384 + 5385 + 5386 +== **Редактирование года урожая ** == 5387 + 5388 +(% class="box successmessage" %) 5389 +((( 5390 +**POST /api/v3/agroLands/updateOpenCloseYear** 5391 +))) 5392 + 5393 +Пример запроса: 5394 + 5395 +((( 5396 +((( 5397 +{ 5398 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5399 + 0 5400 + ], 5401 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5402 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5403 +} 5404 +))) 5405 + 5406 + 5407 +))) 5408 + 5409 +Пример ответа: 5410 + 5411 +((( 5412 +((( 5413 +{ 5414 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5415 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5416 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5417 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5418 + "cropRotations": [ ~/~/ Данные по севообороту 5419 + { 5420 + "landId": 0, ~/~/ ID поля 5421 + "landName": "string", ~/~/ Название поля 5422 + "year": 0, ~/~/ Год урожая 5423 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5424 + "cultureName": "string", ~/~/ Название культуры 5425 + "productivity": 0, ~/~/ Урожайность 5426 + "area": 0, ~/~/ Площадь поля, Га. 5427 + "total": 0, ~/~/ Валовый сбор 5428 + "productivityFact": 0, ~/~/ Фактическая урожайность 5429 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5430 + "totalFact": 0, ~/~/ Фактический валовый сбор 5431 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5432 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5433 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5434 + "isyearplan": true, ~/~/ 5435 + "comment": "string" ~/~/ Комментарий 5436 + } 5437 + ], 5438 + "cropVegetation": [ ~/~/ История вегетации поля 5439 + { 5440 + "values": [ ~/~/ Данные вегетации и состояния посева 5441 + { 5442 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5443 + "ndvi": 0 ~/~/ Индекс вегетации 5444 + } 5445 + ], 5446 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5447 + { 5448 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5449 + "type": "string", ~/~/ Тип 5450 + "pictureid": "string" ~/~/ Идентификатор ресурса 5451 + } 5452 + ], 5453 + "states": [ ~/~/ Ключевые даты развития поля 5454 + { 5455 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5456 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5457 + } 5458 + ] 5459 + } 5460 + ], 5461 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5462 + "counts": { 5463 + "fieldOperations": 0, ~/~/ Количество операций на поле 5464 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5465 + "facts": 0 ~/~/ Счётчик факта 5466 + }, 5467 + "planComment": "string", ~/~/ Комментарий к полю 5468 + "productivity": 0, ~/~/ Урожайность. 5469 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5470 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5471 + "year": 0, ~/~/ Год поля 5472 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5473 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5474 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5475 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5476 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5477 + "id": 0, ~/~/ Идентификатор объекта геозоны 5478 + "name": "string", ~/~/ Название объекта геозоны 5479 + "type": 0, ~/~/ Тип объекта геозоны 5480 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5481 + "fname": "string", ~/~/ Имя файла 5482 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5483 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5484 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5485 + "description": "string", ~/~/ Описание объекта геозоны 5486 + "area": 0, ~/~/ Площадь, м2 5487 + "perimetr": 0, ~/~/ ериметр, м 5488 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5489 +} 5490 +))) 5491 + 5492 + 5493 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5494 +))) 5495 +))) 5496 +))) 5497 + 5498 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5499 + 5500 + 5501 +(% class="box infomessage" %) 5502 +((( 5503 +**GET api/v3/Vehicles/recyclebin/all** 5504 +))) 5505 + 5506 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5507 + 5508 +Параметр запроса: {parentId} - идентификатор агента 5509 + 5510 +В заголовках запроса: X-Auth: Токен авторизации 5511 + 5512 +Ответ: 5513 + 5514 +[ 5515 + { 5516 + "recordTime": "", ~/~/Время записи 5517 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5518 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5519 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5520 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5521 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5522 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5523 + "items": [ ~/~/ 5524 +nullable: true ~/~/Детали 5525 + { 5526 + "name": "string", ~/~/наименование столбца 5527 + "value": "string" ~/~/содержание столбца 5528 + } 5529 + ] 5530 + }, 5531 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5532 + "string" 5533 + ] 5534 + } 5535 +] 5536 + 5537 + 5538 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5539 + 5540 +(% class="box infomessage" %) 5541 +((( 5542 +**POST api/v3/Vehicles/recyclebin/erase** 5543 +))) 5544 + 5545 +В заголовках запроса: X-Auth: Токен авторизации 5546 + 5547 +Пример запроса: 5548 + 5549 +[ 5550 +0 5551 +] 5552 + 5553 + 5554 +Пример ответа: 5555 + 5556 +[ 5557 +{ 5558 + "recordTime": "", ~/~/Время записи 5559 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5560 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5561 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5562 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5563 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5564 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5565 + "items": [ ~/~/Детали 5566 + { 5567 + "name": "", ~/~/Имя свойства 5568 + "value": "" ~/~/Значение свойства 5569 + } 5570 + ] 5571 + }, 5572 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5573 + "" 5574 + ] 5575 + } 5576 +] 5577 + 5578 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5579 + 5580 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5581 + 5582 +(% class="box infomessage" %) 5583 +((( 5584 +**POST api/v3/Vehicles/recyclebin/restore** 5585 +))) 5586 + 5587 +В заголовках запроса: X-Auth: Токен авторизации 5588 + 5589 +Параметры в теле запроса (JSON): 5590 + 5591 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5592 + 5593 +В заголовках запроса: X-Auth: Токен авторизации 5594 + 5595 + 5596 +Пример запроса: 5597 + 5598 +((( 5599 +[ 5600 +))) 5601 + 5602 +((( 5603 + 0 5604 +))) 5605 + 5606 +((( 5607 +] 5608 +))) 5609 + 5610 + 5611 +Пример ответа: 5612 + 5613 +[ 5614 +{ 5615 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5616 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5617 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5618 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5619 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5620 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5621 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5622 + "items": [ ~/~/Детали 5623 + { 5624 + "name": "string", ~/~/Имя свойства 5625 + "value": "string" ~/~/Значение свойства 5626 + } 5627 + ] 5628 + }, 5629 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5630 + "string" 5631 + ] 5632 + } 5633 +] 5634 + 5635 + 5636 += **Раздел: Журнал заданий ** = 5637 + 5638 + 5639 +== **Создание задания в Журнале заданий** == 5640 + 5641 +(% class="box infomessage" %) 5642 +((( 5643 +**POST /api/v3/vehicletasks** 5644 +))) 5645 + 5646 +Пример запроса: 5647 + 5648 +((( 5649 +{ 5650 + "vehicleId": 0, ~/~/ Идентификатор ТС 5651 + "description": "string", ~/~/ Описание 5652 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5653 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5654 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5655 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5656 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5657 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5658 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5659 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5660 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5661 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5662 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5663 + "cost": { 5664 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5665 + "Name": "string", ~/~/ Наименование 5666 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5667 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5668 + "Norm": 0 ~/~/ Норма внесения 5669 + }, 5670 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5671 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5672 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5673 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5674 + "deleted": true, ~/~/ Признак удаления 5675 + "extId": "string", 5676 + "GeoIds": [ ~/~/ Cвязанные поля 5677 + 0 5678 + ] 5679 +} 5680 +))) 5681 + 5682 + 5683 +Пример ответа: 5684 + 5685 +{ 5686 + "vehicleId": 0, ~/~/ Идентификатор ТС 5687 + "description": "string", ~/~/ Описание 5688 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5689 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5690 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5691 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5692 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5693 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5694 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5695 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5696 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5697 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5698 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5699 + "cost": { 5700 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5701 + "Name": "string", ~/~/ Наименование 5702 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5703 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5704 + "Norm": 0 ~/~/ Норма внесения 5705 + }, 5706 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5707 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5708 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5709 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5710 + "deleted": true, ~/~/ Признак удаления 5711 + "extId": "string", ~/~/ ExtId 5712 + "GeoIds": [ ~/~/ Связанные поля 5713 + 0 5714 + ] 5715 +} 5716 + 5717 + 5718 +== **Редактирование задания в Журнале заданий** == 5719 + 5720 +(% class="box successmessage" %) 5721 +((( 5722 +**PUT /api/v3/vehicletasks** 5723 +))) 5724 + 5725 +Пример запроса: 5726 + 5727 +((( 5728 +{ 5729 + "vehicleId": 0, ~/~/ Идентификатор ТС 5730 + "description": "string", ~/~/ Описание 5731 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5732 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5733 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5734 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5735 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5736 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5737 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5738 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5739 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5740 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5741 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5742 + "cost": { 5743 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5744 + "Name": "string", ~/~/ Наименование 5745 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5746 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5747 + "Norm": 0 ~/~/ Норма внесения 5748 + }, 5749 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5750 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5751 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5752 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5753 + "deleted": true, ~/~/ Признак удаления 5754 + "extId": "string", ~/~/ ExtId 5755 + "GeoIds": [ ~/~/ Связанные поля 5756 + 0 5757 + ] 5758 +} 5759 +))) 5760 + 5761 + 5762 +Пример ответа: 5763 + 5764 +{ 5765 + "vehicleId": 0, ~/~/ Идентификатор ТС 5766 + "description": "string", ~/~/ Описание 5767 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5768 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5769 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5770 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5771 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5772 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5773 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5774 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5775 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5776 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5777 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5778 + "cost": { 5779 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5780 + "Name": "string", ~/~/ Наименование 5781 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5782 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5783 + "Norm": 0 ~/~/ Норма внесения 5784 + }, 5785 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5786 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5787 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5788 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5789 + "deleted": true, ~/~/ Признак удаления 5790 + "extId": "string", ~/~/ ExtId 5791 + "GeoIds": [ ~/~/ Связанные поля 5792 + 0 5793 + ] 5794 +} 5795 + 5796 + 5797 +== **Удаление задания в Журнале заданий** == 5798 + 5799 +(% class="box warningmessage" %) 5800 +((( 5801 +**DELETE /api/v3/vehicletasks** 5802 +))) 5803 + 5804 +Пример запроса: 5805 + 5806 +((( 5807 +[ 5808 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5809 +] 5810 +))) 5811 + 5812 +((( 5813 + 5814 +))) 5815 + 5816 +Пример ответа: 5817 + 5818 +{ 5819 + "vehicleId": 0, ~/~/ Идентификатор ТС 5820 + "description": "string", ~/~/ Описание 5821 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5822 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5823 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5824 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5825 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5826 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5827 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5828 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5829 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5830 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5831 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5832 + "cost": { 5833 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5834 + "Name": "string", ~/~/ Наименование 5835 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5836 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5837 + "Norm": 0 ~/~/ Норма внесения 5838 + }, 5839 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5840 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5841 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5842 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5843 + "deleted": true, ~/~/ Признак удаления 5844 + "extId": "string", ~/~/ ExtId 5845 + "GeoIds": [ ~/~/ Связанные поля 5846 + 0 5847 + ] 5848 +} 5849 + 5850 + 5851 +== **Получение списка Журнала заданий** == 5852 + 5853 +(% class="box infomessage" %) 5854 +((( 5855 +**POST /api/v3/vehicletasks/getbyperiod** 5856 +))) 5857 + 5858 +Пример запроса: 5859 + 5860 +((( 5861 +{ 5862 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5863 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5864 + "TimeZone": 0, ~/~/ Часовой пояс. 5865 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5866 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5867 + ], 5868 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5869 + 0 5870 + ], 5871 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5872 + 0 5873 + ], 5874 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5875 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5876 +} 5877 +))) 5878 + 5879 + 5880 +Пример ответа: 5881 + 5882 +((( 5883 +{ 5884 + "total": 0, ~/~/ Общее количество записей 5885 + "pages": 0, ~/~/ Общее количество страниц 5886 + "currentPage": 0, ~/~/ Текущая страница 5887 + "items": [ ~/~/ Записи 5888 + { 5889 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5890 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5891 + "name": "string", ~/~/ Название задания. 5892 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5893 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5894 + "workKind": "string", ~/~/ Вид работ 5895 + "techOp": "string", ~/~/ Тех. операция 5896 + "trailerModel": "string", ~/~/ Модель агрегата 5897 + "width": "string", ~/~/ Ширина, м 5898 + "speed": "string", ~/~/ Тех. скорость 5899 + "fields": "string", ~/~/ Поля 5900 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5901 + "vehicles": "string", ~/~/ Объект-модель 5902 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5903 + "drivers": "string", ~/~/ Водители 5904 + "tmc": "string", ~/~/ ТМЦ 5905 + "client": "string", ~/~/ Клиент 5906 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5907 + "dep": "string", ~/~/ Подразделение 5908 + "geoIds": [ ~/~/ Связанные поля 5909 + 0 5910 + ] 5911 + } 5912 + ] 5913 +} 5914 +))) 5915 + 5916 + 5917 += **Раздел: Локатор ** = 5918 + 5919 + 5920 +== **Получение списка локаторов, доступных пользователю ** == 5921 + 5922 +(% class="box infomessage" %) 5923 +((( 5924 +**GET /api/v3/locators** 5925 +))) 5926 + 5927 +В заголовках запроса: X-Auth: Токен авторизации 5928 + 5929 + 5930 +Пример ответа: 5931 + 5932 +((( 5933 +[ 5934 + { 5935 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5936 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5937 + "agentName": "string", ~/~/ Наименование агента. 5938 + "isEnabled": true, ~/~/ Активен 5939 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5940 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5941 + "name": "string", ~/~/ Наименование 5942 + "status": 0, ~/~/ 5943 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5944 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5945 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5946 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5947 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5948 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5949 + "url": "string", ~/~/ Ссылка 5950 + "language": 0, ~/~/ Язык. 5951 + "vehiclesCount": 0, ~/~/ Количество объектов. 5952 + "geozonesCount": 0, ~/~/ Количество геозон. 5953 + "fieldsCount": 0 ~/~/ Количество полей. 5954 + } 5955 +] 5956 +))) 5957 + 5958 + 5959 + 5960 +== **Создание локатора** == 5961 + 5962 +(% class="box successmessage" %) 5963 +((( 5964 +**POST /api/v3/locators** 5965 +))) 5966 + 5967 +Пример запроса: 5968 + 5969 +((( 5970 +{ 5971 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5972 + "isEnabled": true, ~/~/ Активность 5973 + "name": "string", ~/~/ Наименование локатора 5974 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5975 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5976 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5977 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5978 + "url": "string", ~/~/ Ссылка 5979 + "language": 0 ~/~/ Язык 5980 +} 5981 +))) 5982 + 5983 + 5984 +Пример ответа: 5985 + 5986 +((( 5987 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5988 +))) 5989 + 5990 + 5991 + 5992 +== **Изменение локатора** == 5993 + 5994 +(% class="box infomessage" %) 5995 +((( 5996 +**PUT /api/v3/locators** 5997 +))) 5998 + 5999 +Пример запроса: 6000 + 6001 +((( 6002 +{ 6003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6004 + "isEnabled": true, ~/~/ Активность 6005 + "name": "string", ~/~/ Наименование 6006 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6007 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6008 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6009 + "autoProlongation": true, ~/~/ Автопродление срока действия 6010 + "url": "string", ~/~/ Ссылка 6011 + "language": 0 ~/~/ Язык 6012 +} 6013 +))) 6014 + 6015 + 6016 +Пример ответа: 6017 + 6018 +200 ~/~/ Success 6019 + 6020 + 6021 +== **Удалить локатор** == 6022 + 6023 +(% class="box warningmessage" %) 6024 +((( 6025 +**DELETE /api/v3/locators** 6026 +))) 6027 + 6028 +Пример запроса: 6029 + 6030 +((( 6031 +[ 6032 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6033 +] 6034 +))) 6035 + 6036 + 6037 + 6038 += **Раздел: Яндекс Маршруты** = 6039 + 6040 + 6041 +== **Возвращение списка маршрутов** == 6042 + 6043 +(% class="box infomessage" %) 6044 +((( 6045 +**GET /api/v3/TransportRoutes** 6046 +))) 6047 + 6048 +Пример запроса: 6049 +Id ~/~/ Идентификатор поля 6050 + 6051 + 6052 +Пример ответа: 6053 + 6054 +((( 6055 +[ 6056 + { 6057 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6058 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6059 + "name": "string", ~/~/ Наименование маршрута. 6060 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6061 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6062 + 0 6063 + ] 6064 + } 6065 +] 6066 +))) 6067 + 6068 + 6069 + 6070 +== **Добавить маршрут** == 6071 + 6072 +(% class="box infomessage" %) 6073 +((( 6074 +**POST /api/v3/TransportRoutes** 6075 +))) 6076 + 6077 +Пример запроса: 6078 +{ 6079 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6080 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6081 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6082 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6083 + 0 6084 + ] 6085 +} 6086 + 6087 + 6088 +Пример ответа: 6089 + 6090 +((( 6091 +{ 6092 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6093 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6094 + "name": "string", ~/~/ Определяет наименование маршрута 6095 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6096 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6097 + 0 6098 + ] 6099 +} 6100 +))) 6101 + 6102 + 6103 +== **Обновление маршрута** == 6104 + 6105 +(% class="box successmessage" %) 6106 +((( 6107 +**PUT /api/v3/TransportRoutes** 6108 +))) 6109 + 6110 +Пример запроса: 6111 + 6112 +((( 6113 +{ 6114 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6115 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6116 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6117 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6118 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6119 + 0 6120 + ] 6121 +} 6122 +))) 6123 + 6124 + 6125 +Пример ответа: 6126 + 6127 +((( 6128 +{ 6129 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6131 + "name": "string", ~/~/ Определяет наименование маршрута 6132 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6133 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6134 + 0 6135 + ] 6136 +} 6137 +))) 6138 + 6139 + 6140 +== **Получить связки маршрутов ТС** == 6141 + 6142 +(% class="box infomessage" %) 6143 +((( 6144 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6145 +))) 6146 + 6147 +Пример запроса: 6148 + 6149 +((( 6150 +[ 6151 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6152 +] 6153 +))) 6154 + 6155 + 6156 +Пример ответа: 6157 + 6158 +((( 6159 +[ 6160 + { 6161 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6162 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6163 + } 6164 +] 6165 +))) 6166 + 6167 + 6168 +== **Удалить маршрут** == 6169 + 6170 +(% class="box warningmessage" %) 6171 +((( 6172 +**DELETE /api/v3/TransportRoutes/{id}** 6173 +))) 6174 + 6175 +Пример запроса: 6176 +Id ~/~/ Идентификатор поля 6177 + 6178 + 6179 +==== ==== 6180 + 6181 += **Раздел: Управление доступа к машинам** = 6182 + 6183 + 6184 +== Получение списка транспортных средств видимых пользователю == 6185 + 6186 +(% class="box infomessage" %) 6187 +((( 6188 +**GET /api/v3/UserVisibleVehicles/{userId}** 6189 +))) 6190 + 6191 +Пример ответа: 6192 + 6193 +((( 6194 +{ 6195 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6196 + 0 6197 + ] 6198 +} 6199 +))) 6200 + 6201 + 6202 + 6203 +== Задает видимость транспортных средств пользователю == 6204 + 6205 +(% class="box infomessage" %) 6206 +((( 6207 +**POST /api/v3/UserVisibleVehicles** 6208 +))) 6209 + 6210 +Пример запроса: 6211 + 6212 +((( 6213 +((( 6214 +{ 6215 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6216 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6217 + 0 6218 + ] 6219 +} 6220 +))) 6221 + 6222 +((( 6223 + 6224 +))) 6225 + 6226 +((( 6227 + 6228 +))) 6229 + 6230 +((( 6231 +Пример ответа : 6232 +))) 6233 + 6234 +((( 6235 + 6236 +))) 6237 + 6238 +((( 6239 +200 ~/~/ Success 6240 +))) 6241 +))) 6242 + 6243 + 6244 + 6245 + 6246 + 6247 + 3707 3707 (% class="box" lang="en-US" style="text-align: center;" %) 3708 3708 ((( 3709 3709 (% 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]] **