Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/08/08 13:28
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,7 +356,7 @@ 356 356 357 357 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 358 358 359 -== (% style="color:#000000; font-size:16px" %)** Редактированиеклиента**(%%) ==393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 360 360 361 361 (% class="box warningmessage" %) 362 362 ((( ... ... @@ -420,9 +420,8 @@ 420 420 [ 421 421 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 422 422 ], 423 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский457 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 424 424 } 425 - 426 426 { 427 427 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 428 428 "lastName": "string", ... ... @@ -436,12 +436,8 @@ 436 436 437 437 (% style="text-align:left" %) 438 438 (% style="color:#000000; font-weight:normal" %)Ответ: 439 - 440 -(% style="text-align:left" %) 441 -(% style="color:#000000; font-weight:normal" %){ 442 - 443 -(% style="text-align:left" %) 444 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "id": "" , ~/~/ ID пользователя 445 445 "lastName": "" , ~/~/ Фамилия , 446 446 "firstName": "" , ~/~/ Имя 447 447 "position": "" , ~/~/ Должность ... ... @@ -458,11 +458,9 @@ 458 458 "kind": "" , ~/~/ тип аутентификации 459 459 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 460 460 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 461 461 462 -(% style="text-align:left" %) 463 -(% style="color:#000000; font-weight:normal" %)} 464 464 465 - 466 466 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 467 467 468 468 (% class="box infomessage" %) ... ... @@ -482,19 +482,16 @@ 482 482 483 483 (% style="color:#000000" %)Параметры в теле запроса (JSON): 484 484 485 -(% style="color:#000000" %){ 486 - 512 +(% style="color:#000000" %){(%%) 487 487 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 488 488 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 489 489 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 490 490 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 491 - 492 492 (% style="color:#000000" %)} 493 493 494 494 (% style="color:#000000" %)Ответ: 495 495 496 496 (% style="color:#000000" %){ (%%) 497 - 498 498 "id": "" , ~/~/ идентификатор пользователя 499 499 "lastName": "" , ~/~/ фамилия 500 500 "firstName": "" , ~/~/ имя ... ... @@ -508,7 +508,6 @@ 508 508 "sessionDuration":"", ~/~/ длительность сессии в минутах 509 509 "status": "1", ~/~/ статус пользователя 510 510 "lastLogged": "", ~/~/ дата/время последней авторизации 511 - 512 512 (% style="color:#000000" %)} 513 513 514 514 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -582,10 +582,8 @@ 582 582 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 583 583 584 584 (% lang="en-US" style="text-align:left" %) 585 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 586 - 587 -(% lang="en-US" style="text-align:left" %) 588 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "id": "" , ~/~/ ID пользователя 589 589 "lastName": "" , ~/~/ фамилия 590 590 "firstName": "" , ~/~/ имя 591 591 "position": "" , ~/~/ должность ... ... @@ -607,9 +607,7 @@ 607 607 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 608 608 }, 609 609 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 610 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 611 - 612 -(% lang="en-US" style="text-align:left" %) 631 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 613 613 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 614 614 615 615 (% lang="en-US" style="text-align:left" %) ... ... @@ -616,10 +616,8 @@ 616 616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 617 617 618 618 (% lang="en-US" style="text-align:left" %) 619 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 620 - 621 -(% lang="en-US" style="text-align:left" %) 622 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "id": "" , ~/~/ идентификатор пользователя 623 623 "lastName": "" , ~/~/ фамилия 624 624 "firstName": "" , ~/~/ имя 625 625 "position": "" , ~/~/ должность ... ... @@ -640,10 +640,8 @@ 640 640 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 641 641 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 642 642 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 660 +} 643 643 644 -(% lang="en-US" style="text-align:left" %) 645 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 646 - 647 647 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 648 648 649 649 (% class="box warningmessage" %) ... ... @@ -663,12 +663,10 @@ 663 663 664 664 (% style="color:#000000" %)Параметры в теле запроса (JSON): 665 665 666 -(% style="color:#000000" %){ 667 - 681 +(% style="color:#000000" %){(%%) 668 668 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 669 669 "description": "" , ~/~/ описание 670 670 "data": "" , ~/~/ данные, связанные со сменой статуса 671 - 672 672 (% style="color:#000000" %)} 673 673 674 674 (% style="text-align:left" %) ... ... @@ -690,7 +690,7 @@ 690 690 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 691 691 692 692 [ 693 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 694 694 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 695 695 ] 696 696 ... ... @@ -753,6 +753,8 @@ 753 753 (% style="text-align:left" %) 754 754 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 755 755 769 += = 770 + 756 756 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 757 757 758 758 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -864,7 +864,7 @@ 864 864 { 865 865 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 866 866 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 867 - "deleted": true,882 + "deleted": false, 868 868 "extId": "string", 869 869 "name": "string", 870 870 "picture": "string", ... ... @@ -883,7 +883,7 @@ 883 883 { 884 884 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 885 885 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 886 - "deleted": true,901 + "deleted": false, 887 887 "extId": "string", 888 888 "name": "string", 889 889 "picture": "string", ... ... @@ -917,7 +917,7 @@ 917 917 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 918 918 ))) 919 919 920 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.935 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 921 921 922 922 (% style="color:#000000" %)Метод запроса: **PUT** 923 923 ... ... @@ -984,7 +984,7 @@ 984 984 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 985 985 ))) 986 986 987 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1002 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 988 988 989 989 (% style="color:#000000" %)Метод запроса: **DELETE** 990 990 ... ... @@ -996,7 +996,7 @@ 996 996 997 997 Ответ: В случае успеха **Success 200** 998 998 999 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1014 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1000 1000 1001 1001 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1002 1002 ... ... @@ -1025,6 +1025,17 @@ 1025 1025 1026 1026 ((( 1027 1027 { 1043 + 1044 +((( 1045 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1046 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1047 +))) 1048 + 1049 +((( 1050 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1051 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1052 +))) 1053 + 1028 1028 "vehicleId": "", ~/~/ ID объекта 1029 1029 "name": "", ~/~/ Имя объекта 1030 1030 "imei": "", ~/~/ IMEI объекта ... ... @@ -1032,19 +1032,15 @@ 1032 1032 "deviceTypeName": "", ~/~/ Название типа устройства 1033 1033 "sim1": "", ~/~/ Номер SIM1 1034 1034 "sim2": "", ~/~/ Номер SIM2 1035 - 1036 1036 "parentId": "", ~/~/ ID клиента-родителя 1037 1037 "parentName": "", ~/~/ Наименование клиента-родителя 1038 1038 "modelId": "", ~/~/ ID модели объекта 1039 1039 "modelName": "", ~/~/ Имя модели объекта 1040 - 1041 1041 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1042 1042 "unitName": "string", ~/~/ Наименование подразделения 1043 1043 "status": 0, ~/~/ Статус объекта 1044 - 1045 1045 "createdAt": "", ~/~/ Дата создания объекта 1046 1046 }, 1047 - 1048 1048 "customFields": [ ~/~/ Произвольные поля 1049 1049 { 1050 1050 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1067,8 +1067,7 @@ 1067 1067 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1068 1068 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1069 1069 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1070 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1071 - 1092 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 1072 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1073 1073 "mileageCoeff": 0, ~/~/ коэффициент пробега 1074 1074 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1098,7 +1098,6 @@ 1098 1098 "retries": 0 ~/~/ Количество попыток 1099 1099 } 1100 1100 ], 1101 - 1102 1102 "sensors": [ ~/~/ Датчики 1103 1103 { 1104 1104 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1125,6 +1125,7 @@ 1125 1125 ], 1126 1126 "showInTooltip": true, ~/~/ Отображать в подсказке 1127 1127 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1148 + "color": "string", ~/~/ Код цвета датчиков 1128 1128 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1129 1129 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1130 1130 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1139,31 +1139,19 @@ 1139 1139 }, 1140 1140 1141 1141 ~/~/ Характерные для произвольного: 1142 - 1143 1143 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1144 - 1145 1145 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1146 - 1147 1147 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1148 - 1149 1149 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1150 - 1151 1151 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1152 - 1153 1153 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1154 - 1155 1155 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1156 - 1157 1157 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1158 - 1159 1159 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1160 - 1161 1161 ~/~/ "ValueOn": "Вкл.", 1162 - 1163 1163 ~/~/ "ValueOff": "Выкл." 1164 1164 "summaryMaxValue": 0 ~/~/ Макс. значение 1165 1165 } 1166 - 1167 1167 "drivers": [ ~/~/ Водители 1168 1168 { 1169 1169 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1172,7 +1172,6 @@ 1172 1172 "isDefault": true ~/~/ По умолчанию 1173 1173 } 1174 1174 ], 1175 - 1176 1176 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1177 1177 { 1178 1178 "id": "", ~/~/ ID задания ... ... @@ -1189,19 +1189,27 @@ 1189 1189 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1190 1190 } 1191 1191 ], 1192 - 1193 - "statusHistory": [ ~/~/ История статусов 1200 +"statusHistory": [ ~/~/ История статусов 1194 1194 { 1195 1195 "status": 0, 1196 1196 "date": "2023-05-22T09:57:39.562Z", 1197 1197 "description": "string", 1198 1198 "additionalInfo": "string" 1199 - } 1200 - ] 1201 1201 1207 +((( 1202 1202 } 1209 + ], 1210 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1211 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1203 1203 ))) 1204 1204 1214 +((( 1215 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1216 +} 1217 + 1218 +))) 1219 +))) 1220 + 1205 1205 (% style="text-align:left" %) 1206 1206 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1207 1207 ... ... @@ -1208,6 +1208,75 @@ 1208 1208 (% style="text-align:left" %) 1209 1209 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1210 1210 1227 + 1228 +== **Отправить команду на терминал** == 1229 + 1230 +(% class="box successmessage" %) 1231 +((( 1232 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1233 +))) 1234 + 1235 +Команда для отправки на тс. 1236 + 1237 +{ 1238 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1239 +"command": "", ~/~/ Текст отправляемой команды 1240 +"retries": "", ~/~/ Количество попыток отправки на терминал 1241 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1242 +} 1243 + 1244 +В ответ получаем cmdid 1245 + 1246 + 1247 +== **Получить ответ на отправленную на ТС команду** == 1248 + 1249 +(% class="box infomessage" %) 1250 +((( 1251 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1252 +))) 1253 + 1254 +Идентификатор команды: cmdId 1255 + 1256 +Запрос от терминала на ответ команды 1257 + 1258 +Пример ответ от терминала: 1259 + 1260 +ID= "" ~/~/ идентификатор объекта 1261 +Soft="" ~/~/ версия софта 1262 +GPS=4 ~/~/ тип трекера 1263 +Time=11:05:43 28.06.24 ~/~/ время запроса 1264 +Lat=45.056221 ~/~/ широта 1265 +Lon=39.035938 ~/~/ долгота 1266 +Speed=0.0 ~/~/ скорость 1267 +Course=181.4 ~/~/направление 1268 + 1269 +((( 1270 +== **Список отправленных объекту команд с ответами** == 1271 + 1272 +(% class="box infomessage" %) 1273 +((( 1274 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1275 +))) 1276 + 1277 +Идентификатор ТС: vehicleId 1278 + 1279 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1280 + 1281 +Пример ответа терминала 1282 + 1283 +[ 1284 +{ 1285 +"id": "", ~/~/ идентификатор пользователя 1286 +"commandText": "", ~/~/Текст команды. 1287 +"templateId": "", ~/~/Идентификатор шаблона 1288 +"updated": "", ~/~/ Время отправки 1289 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1290 +"answer": "", ~/~/ Ответ терминала. 1291 +"status": "" ~/~/ Статус отправки 1292 +} 1293 +] 1294 +))) 1295 + 1211 1211 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1212 1212 1213 1213 (% class="box successmessage" %) ... ... @@ -1227,6 +1227,11 @@ 1227 1227 1228 1228 (% style="color:#000000" %){ 1229 1229 1315 + 1316 +((( 1317 + "vehicleId": 0, ~/~/ ID ТС 1318 +))) 1319 + 1230 1230 "parentId": "" , ~/~/ ID клиента 1231 1231 "name": "" , ~/~/ имя ТС 1232 1232 "imei": "" , ~/~/ IMEI ... ... @@ -1247,7 +1247,6 @@ 1247 1247 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1248 1248 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1249 1249 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1250 - 1251 1251 "mileageCalcMethod": 0, 1252 1252 "mileageCoeff": 0, 1253 1253 "locationByCellId": true, ... ... @@ -1280,7 +1280,6 @@ 1280 1280 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1281 1281 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1282 1282 } 1283 - 1284 1284 "drivers": [ ~/~/ Водители 1285 1285 { 1286 1286 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1295,8 +1295,7 @@ 1295 1295 "retries": 0 1296 1296 } 1297 1297 ], 1298 - 1299 - "sensors": [ ~/~/ Датчики 1386 +"sensors": [ ~/~/ Датчики 1300 1300 { 1301 1301 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1302 1302 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1322,6 +1322,7 @@ 1322 1322 ], 1323 1323 "showInTooltip": true, ~/~/ Отображать в подсказке 1324 1324 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1412 + "color": "string", ~/~/ код цвета датчиков 1325 1325 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1326 1326 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1327 1327 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1334,103 +1334,222 @@ 1334 1334 "additionalProp2": "string", 1335 1335 "additionalProp3": "string" 1336 1336 }, 1337 - 1338 1338 ~/~/ Характерные для произвольного: 1339 - 1340 1340 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1341 - 1342 1342 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1343 - 1344 1344 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1345 - 1346 1346 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1347 - 1348 1348 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1349 - 1350 1350 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1351 - 1352 1352 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1353 - 1354 1354 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1355 - 1356 1356 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1357 - 1358 1358 ~/~/ "ValueOn": "Вкл.", 1359 - 1360 1360 ~/~/ "ValueOff": "Выкл." 1361 - "summaryMaxValue": 0 ~/~/ Макс. значение 1437 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1438 + 1439 +((( 1440 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1441 + { 1442 + "from": 0, ~/~/ С какого значения 1443 + "color": "string", ~/~/ Каким цветом 1444 + "text": "string" ~/~/ Текст подписи к этому интервалу 1445 + } 1446 + ] 1362 1362 } 1363 1363 ], 1449 +))) 1450 + 1451 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1452 + 1453 + 1364 1364 "customFields": [ ~/~/ Произвольные поля 1365 1365 { 1366 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1367 - "name": "string", 1368 - "value": "string", 1369 - "forClient": true, 1370 - "forTooltip": true, 1371 - "forReport": true 1372 - } 1373 - ] 1456 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1457 + "name": "string", ~/~/ Наименование произвольного поля 1458 + "value": "string", ~/~/ Значение произвольного поля 1459 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1460 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1461 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1462 + 1463 +((( 1464 + } 1465 + ], 1466 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1467 +))) 1468 + 1469 +((( 1470 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1374 1374 } 1472 +))) 1375 1375 1474 + 1376 1376 (% style="color:#000000" %)Ответ: 1377 1377 1378 -(% style="color:#000000" %){ 1379 1379 1380 - "vehicleId": "", ~/~/ID ТС 1381 - "parentId": "", ~/~/Guid владельца ТС 1382 - "name": "", ~/~/Имя объекта 1383 - "imei": "", ~/~/IMEI 1384 - "deviceTypeId": "", ~/~/ID типа устройства 1385 - "modelId": "", ~/~/ID модели 1386 - "unitId": "", ~/~/ID подразделения 1387 - "sim1": "", ~/~/SIM1 1388 - "sim2": "", ~/~/SIM2 1389 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1390 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1391 - "counters": { ~/~/Счётчики 1392 - "mileageEnabled": true, 1393 - "motohoursEnabled": true, 1394 - "mileage": "", 1395 - "motohours": 345.0 1396 - }, 1397 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1398 - "id": null, 1399 - "enabled": true, ~/~/флаг включения 1400 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1401 - "login": "", ~/~/ имя учетной записи 1402 - "password": "" ~/~/ пароль учетной записи 1403 - }, 1404 - "inspectionTasks": { ~/~/ задания на ТО 1405 - "id": "", ~/~/ ID задачи 1406 - "enabled": false, ~/~/ Признак включения 1407 - "name": "", ~/~/ Имя задания 1408 - "description": "", ~/~/ Описание задания 1409 - "mileageCondition": "", ~/~/ Условие по пробегу 1410 - "lastMileage": "", ~/~/ Пробег (в метрах) 1411 - "motohoursCondition": "", ~/~/ Условие по моточасам 1412 - "lastMotohours": "", ~/~/ Моточасы 1413 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1414 - "kind": "", ~/~/ Вид периодичности по времени 1415 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1478 +((( 1479 +((( 1480 +((( 1481 +{ 1482 + "vehicleId": 0, ~/~/ ID ТС 1483 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1484 + "name": "string", ~/~/ Имя объекта 1485 + "imei": "string", ~/~/ IMEI 1486 + "deviceTypeId": 0, ~/~/ ID типа устройства 1487 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1488 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1489 + "sim1": "string", ~/~/ SIM1 1490 + "sim2": "string", ~/~/ SIM2 1491 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1492 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1493 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1494 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1495 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1496 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1497 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1498 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1499 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1500 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1501 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1502 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1503 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1504 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1505 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1506 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1507 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1508 + "counters": { ~/~/ Dto для состояний счётчиков 1509 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1510 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1511 + "mileage": 0, ~/~/ Пробег 1512 + "motohours": 0 ~/~/ Моточасы 1513 + }, 1514 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1515 + "id": "string", ~/~/ CMSV6 Идентификатор 1516 + "enabled": true, ~/~/ Признак включения 1517 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1518 + "login": "string", ~/~/ CMSV6 имя учетной записи 1519 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1520 + }, 1521 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1522 + { 1523 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1524 + "enabled": true, ~/~/ Признак включения 1525 + "name": "string", ~/~/ Имя задания 1526 + "description": "string", ~/~/ Описание задания 1527 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1528 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1529 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1530 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1531 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1532 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1533 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1534 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1416 1416 } 1536 + ], 1537 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1538 + { 1539 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1540 + "inputNumber": 0, ~/~/ № входа. 1541 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1542 + "comment": "string", ~/~/ Комментарий 1543 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1544 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1545 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1546 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1547 + } 1548 + ], 1549 + "commandTemplates": [ ~/~/ Список шаблонов команд 1550 + { 1551 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1552 + "name": "string", ~/~/ Название шаблона команд 1553 + "command": "string", ~/~/ Команда на выполнение 1554 + "retries": 0 ~/~/ Лимит попыток отправки 1555 + } 1556 + ], 1557 + "sensors": [ ~/~/ Список датчиков 1558 + { 1559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1560 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1561 + "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 1562 + "name": "string", ~/~/ Имя датчика 1563 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1564 + "inputNumber": 0, ~/~/ Номер входа 1565 + "pseudonym": "string", ~/~/ Псевдоним 1566 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1567 + "isInverted": true, ~/~/ Признак инверсии 1568 + "disabled": true, ~/~/ Датчик не участвует в обработке 1569 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1570 + "gradesTables": [ ~/~/ Тарировка 1571 + { 1572 + "grades": [ ~/~/ Таблицы тарировки 1573 + { 1574 + "input": 0, ~/~/ Вход 1575 + "output": 0 ~/~/ Выход 1576 + } 1577 + ], 1578 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1579 + } 1580 + ], 1581 + "showInTooltip": true, ~/~/ Отображение в подсказке 1582 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1583 + "color": "string", ~/~/ код цвета датчиков 1584 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1585 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1586 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1587 + "expr": "string", ~/~/ Выражение 1588 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1589 + "string" 1590 + ], 1591 + "customParams": { 1592 + "additionalProp1": "string", 1593 + "additionalProp2": "string", 1594 + "additionalProp3": "string" 1595 + }, 1596 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1597 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1598 + { 1599 + "from": 0, ~/~/ С какого значения 1600 + "color": "string", ~/~/ Каким цветом 1601 +))) 1417 1417 1418 -(% style="text-align:left" %) 1419 -(% style="color:#000000" %)} 1603 +((( 1604 + "text": "string" ~/~/ Текст подписи к этому интервалу 1605 + } 1606 + ] 1607 + } 1608 + ], 1609 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1610 + "customFields": [ ~/~/ Список произвольных полей 1611 + { 1612 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1613 + "name": "string", ~/~/ Наименование произвольного поля 1614 + "value": "string", ~/~/ Значение произвольного поля 1615 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1616 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1617 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1618 + } 1619 + ], 1620 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1621 +} 1622 +))) 1623 +))) 1624 +))) 1420 1420 1626 + 1421 1421 **Валидация:** 1422 1422 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1423 1423 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1424 1424 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1425 1425 1426 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1427 1427 1633 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1634 + 1428 1428 (% class="box infomessage" %) 1429 1429 ((( 1430 1430 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1431 1431 ))) 1432 1432 1433 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1640 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1434 1434 1435 1435 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1436 1436 ... ... @@ -1464,9 +1464,12 @@ 1464 1464 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1465 1465 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1466 1466 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1467 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1468 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1469 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1674 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1675 + "unitName": "string", ~/~/ Название подразделения (опционально) 1676 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1677 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1678 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1679 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1470 1470 } 1471 1471 1472 1472 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1473,8 +1473,14 @@ 1473 1473 1474 1474 (% style="color:#000000" %)Ответ: 1475 1475 1476 -(% style="color:#000000" %){ 1686 +(% style="color:#000000" %)[ 1687 +{ 1477 1477 1689 +((( 1690 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1691 +))) 1692 + 1693 +((( 1478 1478 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1479 1479 "name": "" ~/~/ наименование объекта 1480 1480 "imei": "" ~/~/ IMEI объекта ... ... @@ -1500,9 +1500,21 @@ 1500 1500 "forClient": true, ~/~/ право на отображение у клиента 1501 1501 "forTooltip": false, ~/~/ право на отображение в подсказке 1502 1502 "forReport": false ~/~/ право на отображение в отчетах 1503 - }(%%) 1504 -(% style="color:#000000" %)} 1719 +))) 1505 1505 1721 +((( 1722 + } 1723 + ], 1724 + "vehicleGroups": [ ~/~/ Группы ТС 1725 + { 1726 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1727 + "name": "string" ~/~/ Наименование группы ТС 1728 + } 1729 + ] 1730 + } 1731 +] 1732 +))) 1733 + 1506 1506 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1507 1507 1508 1508 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1534,13 +1534,11 @@ 1534 1534 "data": "", ~/~/ Данные 1535 1535 "overwrite": false, ~/~/ Флаг перезаписи 1536 1536 "stage": "", ~/~/ Состояние, может быть null 1537 - 1538 1538 (% style="color:#000000" %)} 1539 1539 1540 1540 (% style="color:#000000" %)Ответ: 1541 1541 1542 -(% style="color:#000000" %){ 1543 - 1769 +(% style="color:#000000" %){(%%) 1544 1544 "status": "", ~/~/ значение статуса 1545 1545 "date": "", ~/~/ Дата смены статуса 1546 1546 "description": "", ~/~/ Описание ... ... @@ -1547,10 +1547,9 @@ 1547 1547 "data": "", ~/~/ Данные 1548 1548 "overwrite": false, ~/~/ Флаг перезаписи 1549 1549 "stage": "", ~/~/ Состояние 1550 - 1551 -(% style="text-align:left" %) 1552 1552 (% style="color:#000000" %) } 1553 1553 1778 + 1554 1554 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1555 1555 1556 1556 (% class="box warningmessage" %) ... ... @@ -1626,9 +1626,19 @@ 1626 1626 1627 1627 "drivers": [ ~/~/ Водители 1628 1628 { 1629 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1630 - "isDefault": true 1631 - } 1854 + 1855 +((( 1856 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1857 + "inputNumber": 0, ~/~/ № входа. 1858 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1859 + "comment": "string", ~/~/ Комментарий. 1860 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1861 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1862 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1863 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1864 +))) 1865 + 1866 + } 1632 1632 ], 1633 1633 "commandTemplates": [ ~/~/ Шаблон команды 1634 1634 { ... ... @@ -1638,8 +1638,7 @@ 1638 1638 "retries": 0 1639 1639 } 1640 1640 ], 1641 - 1642 - "sensors": [ ~/~/ Датчики 1876 +"sensors": [ ~/~/ Датчики 1643 1643 { 1644 1644 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1645 1645 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1665,6 +1665,11 @@ 1665 1665 ], 1666 1666 "showInTooltip": true, ~/~/ Отображать в подсказке 1667 1667 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1902 + 1903 +((( 1904 + "color": "string",** ~/~/ **Цвет датчика 1905 +))) 1906 + 1668 1668 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1669 1669 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1670 1670 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1677,95 +1677,225 @@ 1677 1677 "additionalProp2": "string", 1678 1678 "additionalProp3": "string" 1679 1679 }, 1680 - 1681 1681 ~/~/ Характерные для произвольного: 1682 - 1683 1683 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1684 - 1685 1685 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1686 - 1687 1687 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1688 - 1689 1689 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1690 - 1691 1691 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1692 - 1693 1693 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1694 - 1695 1695 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1696 - 1697 1697 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1698 - 1699 1699 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1700 - 1701 1701 ~/~/ "ValueOn": "Вкл.", 1702 - 1703 1703 ~/~/ "ValueOff": "Выкл." 1704 1704 "summaryMaxValue": 0 ~/~/ Макс. значение 1932 + 1933 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1934 + { 1935 + "from": 0, ~/~/ С какого значения 1936 + "color": "string", ~/~/ Каким цветом 1937 + "text": "string" ~/~/ Текст подписи к этому интервалу 1938 + } 1939 + ] 1705 1705 } 1706 1706 ], 1942 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1943 + 1707 1707 "customFields": [ ~/~/ Произвольные поля 1708 - { 1709 - 1710 - "name": "string", 1711 - "value": "string", 1712 - "forClient": true, 1713 - "forTooltip": true, 1714 - "forReport": true 1945 + { 1946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1947 + "name": "string", ~/~/ Наименование произвольного поля 1948 + "value": "string", ~/~/ Значение произвольного поля 1949 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1950 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1951 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1715 1715 } 1716 - ] 1953 + 1954 +((( 1955 + ], 1956 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1957 +))) 1958 + 1717 1717 } 1718 1718 1961 + 1719 1719 (% style="color:#000000" %)Ответ: 1720 1720 1721 -(% lang="en-US" style="text-align:left" %) 1722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1964 +((( 1965 +{ 1966 + "vehicleId": 0, ~/~/ ID ТС 1967 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1968 + "name": "string", ~/~/ Имя объекта 1969 + "imei": "string", ~/~/ IMEI 1970 + "deviceTypeId": 0, ~/~/ ID типа устройства 1971 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1972 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1973 + "sim1": "string", ~/~/ SIM1 1974 + "sim2": "string", ~/~/ SIM2 1975 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1976 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1977 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1978 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1979 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1980 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1981 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1982 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1983 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1984 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1985 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1986 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1987 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1988 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1989 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1990 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1991 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1992 + "counters": { ~/~/ состояний счётчиков 1993 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1994 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1995 + "mileage": 0, ~/~/ Пробег 1996 + "motohours": 0 ~/~/ Моточасы 1997 + }, 1998 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1999 + "id": "string", ~/~/ CMSV6 Идентификатор 2000 + "enabled": true, ~/~/ Признак включения 2001 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2002 +))) 1723 1723 1724 -(% lang="en-US" style="text-align:left" %) 1725 - "vehicleId": "", ~/~/ ID ТС 1726 - "parentId": "", ~/~/ ID клиента 1727 - "name": "", ~/~/ имя ТС 1728 - "imei": "", ~/~/ IMEI 1729 - "deviceTypeId": "", ~/~/ типа устройства 1730 - "modelId": "", ~/~/ ID модели 1731 - "unitId": "", ~/~/ ID подразделения 1732 - "sim1": "", ~/~/ SIM 1 1733 - "sim2": "", ~/~/ SIM2 1734 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1735 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1736 - "counters": 1737 - { 1738 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1739 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1740 - "mileage": "", ~/~/ пробег 1741 - "motohours": "", ~/~/ моточасы 1742 - } 1743 - "cmsv6Parameters": ~/~/ параметры CMSv6 2004 + 2005 +((( 2006 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2007 + "login": "string", ~/~/ CMSV6 имя учетной записи 2008 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2009 + }, 2010 + "inspectionTasks": [ ~/~/ Задания на ТО 2011 + { 2012 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2013 + "enabled": true, ~/~/ Признак включения 2014 + "name": "string", ~/~/ Имя задания 2015 + "description": "string", ~/~/ Описание задания 2016 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2017 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2018 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2019 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2020 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2021 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2022 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2023 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2024 + } 2025 + ], 2026 + "drivers": [ ~/~/ Список водителей 2027 + { 2028 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2029 + "inputNumber": 0, ~/~/ № входа. 2030 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2031 + "comment": "string", ~/~/ Комментарий. 2032 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2033 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2034 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2035 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2036 + } 2037 + ], 2038 + "commandTemplates": [ ~/~/ Список шаблонов команд 2039 + { 2040 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2041 + "name": "string", ~/~/ Название шаблона команд 2042 + "command": "string", ~/~/ Команда на выполнение 2043 + "retries": 0 ~/~/ Лимит попыток отправки 2044 + } 2045 + ], 2046 + "sensors": [ ~/~/ Список датчиков 2047 + { 2048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2049 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2050 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2051 +))) 2052 + 2053 +((( 2054 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2055 +))) 2056 + 2057 +((( 2058 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2059 +))) 2060 + 2061 +((( 2062 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2063 +))) 2064 + 2065 +((( 2066 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2067 +))) 2068 + 2069 +((( 2070 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2071 + "name": "string", ~/~/ Имя датчика 2072 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2073 +))) 2074 + 2075 +((( 2076 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2077 + "inputNumber": 0, ~/~/ Номер входа 2078 + "pseudonym": "string", ~/~/ Псевдоним 2079 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2080 + "isInverted": true, ~/~/ Признак инверсии 2081 + "disabled": true, ~/~/ Датчик не участвует в обработке 2082 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2083 + "gradesTables": [ ~/~/ Тарировка 1744 1744 { 1745 - "id": ~/~/ идентификатор 1746 - "enabled": true, ~/~/ флаг включения 1747 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1748 - "login": "", ~/~/ имя учетной записи 1749 - "password": "", ~/~/ пароль учетной записи 1750 - } 1751 - "inspectionTasks": ~/~/ задания на ТО 1752 - { 1753 - "id": "", ~/~/ ID задания 1754 - "enabled": false, ~/~/ Признак включения 1755 - "name": "", ~/~/ Имя задания 1756 - "description": "", ~/~/ Описание задания 1757 - "mileageCondition": "", ~/~/ Условие по пробегу 1758 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1759 - "motohoursCondition": "", ~/~/ Условие по моточасам 1760 - "lastMotohours": "", ~/~/ Моточасы 1761 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1762 - "kind": "", ~/~/ Вид периодичности по времени 1763 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2085 + "grades": [ ~/~/ Таблицы тарировки 2086 + { 2087 + "input": 0, ~/~/ Вход 2088 + "output": 0 ~/~/ Выход 2089 + } 2090 + ], 2091 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1764 1764 } 2093 + ], 2094 + "showInTooltip": true, ~/~/ Отображение в подсказке 2095 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1765 1765 1766 -(% lang="en-US" style="text-align:left" %) 1767 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2097 +((( 2098 + "color": "string", ~/~/ цвет уведомлений 2099 +))) 1768 1768 2101 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2102 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2103 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2104 + "expr": "string", ~/~/ Выражение 2105 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2106 + "string" 2107 + ], 2108 + "customParams": { ~/~/ Дополнительные настройки 2109 + "additionalProp1": "string", 2110 + "additionalProp2": "string", 2111 + "additionalProp3": "string" 2112 + }, 2113 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2114 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2115 + { 2116 + "from": 0, ~/~/ С какого значения 2117 + "color": "string", ~/~/ Каким цветом 2118 + "text": "string" ~/~/ Текст подписи к этому интервалу 2119 + } 2120 + ] 2121 + } 2122 + ], 2123 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2124 + "customFields": [ ~/~/ Список произвольных полей 2125 + { 2126 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2127 + "name": "string", ~/~/ Наименование произвольного поля 2128 + "value": "string", ~/~/ Значение произвольного поля 2129 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2130 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2131 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2132 + } 2133 + ], 2134 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2135 +} 2136 +))) 2137 + 1769 1769 **Валидация:** 1770 1770 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1771 1771 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1804,18 +1804,15 @@ 1804 1804 1805 1805 (% style="color:#000000" %)Метод запроса: **GET** 1806 1806 1807 -(% 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]]2176 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1808 1808 1809 1809 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1810 1810 1811 1811 (% style="color:#000000" %)Ответ: 1812 1812 1813 -(% style="color:#000000" %){ 1814 - 2182 +(% style="color:#000000" %){(%%) 1815 1815 "deviceTypeId" : "", ~/~/ ID типа устройства 1816 1816 "deviceTypeName" : "" ~/~/ Название типа устройства 1817 - 1818 -(% style="text-align:left" %) 1819 1819 (% style="color:#000000" %)} 1820 1820 1821 1821 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1837,13 +1837,10 @@ 1837 1837 1838 1838 (% style="color:#000000" %)Ответ: 1839 1839 1840 -(% style="color:#000000" %){ 1841 - 2206 +(% style="color:#000000" %){(%%) 1842 1842 "id": "", ~/~/ ID типа датчика 1843 1843 "name": "", ~/~/ Название 1844 1844 "description": "", ~/~/ Описание 1845 - 1846 -(% style="text-align:left" %) 1847 1847 (% style="color:#000000" %)} 1848 1848 1849 1849 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1887,6 +1887,56 @@ 1887 1887 } 1888 1888 ] 1889 1889 2253 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2254 + 2255 +(% class="box infomessage" style="text-align: left;" %) 2256 +((( 2257 +**POST /api/v3/terminalMessages/mapping** 2258 +))) 2259 + 2260 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2261 + 2262 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2263 + 2264 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2265 + 2266 +{ 2267 + "protocolType": 0, 2268 + "params": ["string"] 2269 +} 2270 + 2271 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2272 +|protocolType|ID типа протокола 2273 +|params|((( 2274 +Массив наименований параметров в сообщении 2275 +))) 2276 + 2277 +Ответ: 2278 + 2279 +{ 2280 + "protocolType": 0, 2281 + "mapping": { 2282 + "additionalProp1": { 2283 + "inputType": 0, 2284 + "inputNumber": 0 2285 + }, 2286 + "additionalProp2": { 2287 + "inputType": 0, 2288 + "inputNumber": 0 2289 + } 2290 + } 2291 +} 2292 + 2293 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2294 +|protocolType|Тип протокола 2295 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2296 +|inputNumber|((( 2297 +Номер входа 2298 +))) 2299 + 2300 +(% class="wikigeneratedid" %) 2301 +Перечень 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/]] 2302 + 1890 1890 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1891 1891 1892 1892 (% class="box infomessage" %) ... ... @@ -1911,6 +1911,11 @@ 1911 1911 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1912 1912 } 1913 1913 2327 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2328 +|vehicleId|ID объекта 2329 +|from|Дата и время начала периода запроса 2330 +|to|Дата и время окончания периода запроса 2331 + 1914 1914 Ответ: 1915 1915 1916 1916 [ ... ... @@ -1917,25 +1917,43 @@ 1917 1917 { 1918 1918 "messages": [ 1919 1919 { 1920 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1921 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1922 - "speed": 0, ~/~/ Скорость, км/ч 1923 - "altitude": 0, ~/~/ Высота, м 1924 - "latitude": 0, ~/~/ Широта [-90°;90°] 1925 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1926 - "satellites": 0, ~/~/ Кол-во спутников 1927 - "voltage": 0, ~/~/ Напряжение 1928 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2338 + "deviceTime": "2023-11-29T07:40:44.052Z", 2339 + "serverTime": "2023-11-29T07:40:44.052Z", 2340 + "speed": 0, 2341 + "altitude": 0, 2342 + "latitude": 0, 2343 + "longitude": 0, 2344 + "satellites": 0, 2345 + "course": 0, 2346 + "voltage": 0, 2347 + "parameters": { 1929 1929 "additionalProp1": "string", 1930 1930 "additionalProp2": "string", 1931 1931 "additionalProp3": "string" 1932 1932 }, 1933 - "photoCount": 0 ~/~/ Кол-во фото 2352 + "photoCount": 0, 2353 + "lbsCorrectedCoords": true, 2354 + "protocolType": 0 1934 1934 } 1935 1935 ] 1936 1936 } 1937 1937 ] 1938 1938 2360 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2361 +|deviceTime|Время сообщения терминала 2362 +|serverTime|Время когда сообщение поступило на сервер 2363 +|speed|Скорость 2364 +|altitude|Высота над уровнем моря 2365 +|latitude|Широта 2366 +|longitude|Долгота 2367 +|satellites|Кол-во спутников 2368 +|course|Курс 2369 +|voltage|Бортовое напряжение 2370 +|parameters|Список параметров и их значений 2371 +|photoCount|Количество фото 2372 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2373 +|protocolType|ID типа протокола 2374 + 1939 1939 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1940 1940 1941 1941 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1955,7 +1955,7 @@ 1955 1955 Тело запроса: 1956 1956 1957 1957 { 1958 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2394 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1959 1959 "vehicleIds": [0], ~/~/ Список ID объектов 1960 1960 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1961 1961 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -1972,10 +1972,14 @@ 1972 1972 { 1973 1973 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1974 1974 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1975 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1976 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1977 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1978 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2411 + "mileage": 0, ~/~/ Пробег за период, километры 2412 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2413 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2414 + "motohours": 0, ~/~/ Моточасы за период, секунды 2415 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2416 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2417 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2418 + 1979 1979 } 1980 1980 ] 1981 1981 } ... ... @@ -1998,7 +1998,7 @@ 1998 1998 Тело запроса: 1999 1999 2000 2000 { 2001 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2441 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2002 2002 "vehicleIds": [0], ~/~/ Список ID объектов 2003 2003 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2004 2004 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2017,13 +2017,23 @@ 2017 2017 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2018 2018 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2019 2019 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2460 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2461 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2020 2020 "fuelConsumption": 0, ~/~/ Расход топлива 2021 2021 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2464 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2465 + 2022 2022 } 2023 2023 ] 2024 2024 } 2025 2025 ] 2026 2026 2471 +(% class="box warningmessage" %) 2472 +((( 2473 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2474 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2475 +))) 2476 + 2027 2027 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2028 2028 2029 2029 (% class="box infomessage" %) ... ... @@ -2058,7 +2058,8 @@ 2058 2058 "model": "string", ~/~/ Модель объекта 2059 2059 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2060 2060 { 2061 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2511 + "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 2512 + 2062 2062 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2063 2063 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2064 2064 "valueFuel": 0, ~/~/ Количество ... ... @@ -2069,6 +2069,120 @@ 2069 2069 } 2070 2070 ] 2071 2071 2523 + 2524 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2525 + 2526 +(% class="box infomessage" %) 2527 +((( 2528 +**POST /api/v3/vehicles/moveStop** 2529 +))) 2530 + 2531 +Метод запроса: **POST** 2532 + 2533 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2534 + 2535 +В заголовках запроса: X-Auth: Токен авторизации 2536 + 2537 + 2538 +Тело запроса: 2539 + 2540 +{ 2541 + "vehicleIds": [ ], ~/~/ Список ID объектов 2542 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2543 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2544 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2545 +} 2546 + 2547 +Ответ: 2548 + 2549 +[ 2550 + { 2551 + "vehicleId": 0, ~/~/ ID объекта 2552 + "vehicleName": "string", ~/~/ Имя объекта 2553 + "moves": [ ~/~/ Событие движения 2554 + { 2555 + "mileage": 0, ~/~/ Пробег, км 2556 + "eventId": 0, ~/~/ Идентификатор события 2557 + "eventName": "string", ~/~/ Название события 2558 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2559 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2560 + "duration": 0 ~/~/ Продолжительность события, секунд 2561 + } 2562 + ], 2563 + "stops": [ ~/~/ События стоянок 2564 + { 2565 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2566 + "eventId": 0, ~/~/ Идентификатор события 2567 + "eventName": "string", ~/~/ Название события 2568 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2569 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2570 + "duration": 0 ~/~/ Продолжительность события, секунд 2571 + } 2572 + ] 2573 + } 2574 +] 2575 + 2576 + 2577 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2578 + 2579 +(% class="box infomessage" %) 2580 +((( 2581 +**POST /api/v3/vehicles/getlastdata** 2582 +))) 2583 + 2584 +Метод запроса: **POST** 2585 + 2586 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2587 + 2588 +В заголовках запроса: X-Auth: Токен авторизации 2589 + 2590 + 2591 +В массиве указываем id объектов через запятую 2592 + 2593 +Ответ: 2594 + 2595 +[ 2596 + { 2597 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2598 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2599 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2600 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2601 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2602 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2603 + "speed": 31, ~/~/ Скорость объекта 2604 + "course": 116, ~/~/ Курс движения [0;360] 2605 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2606 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2607 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2608 + "geozones": [ ~/~/ Сведения по геозонам. 2609 + { 2610 + "id": 10225647, ~/~/ ID Геозоны 2611 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2612 + }, 2613 + { 2614 + "id": 10282875, ~/~/ ID Геозоны 2615 + "name": "Ё2" ~/~/ Наименование геозоны 2616 + }, 2617 + { 2618 + "id": 10226240, ~/~/ ID Геозоны 2619 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2620 + }, 2621 + { 2622 + "id": 9747869, ~/~/ ID Геозоны 2623 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2624 + }, 2625 + { 2626 + "id": 10221123, ~/~/ ID Геозоны 2627 + "name": "53r" ~/~/ Наименование геозоны 2628 + }, 2629 + { 2630 + "id": 10197638, ~/~/ ID Геозоны 2631 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2632 + } 2633 + ] 2634 + } 2635 + 2636 + 2072 2072 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2073 2073 2074 2074 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2197,6 +2197,35 @@ 2197 2197 } 2198 2198 ] 2199 2199 2765 + 2766 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2767 + 2768 +(% class="box successmessage" %) 2769 +((( 2770 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2771 +))) 2772 + 2773 +(% style="color:#000000" %)Метод запроса: **PUT** 2774 + 2775 +Пример запроса: 2776 + 2777 +((( 2778 +{ 2779 + "id": 0, ~/~/ Идентификатор объекта геозоны 2780 + "name": "string", ~/~/ Наименование объекта геозоны 2781 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2782 + "description": "string", ~/~/ Описание объекта геозоны 2783 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2784 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2785 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2786 +} 2787 +))) 2788 + 2789 + 2790 +Пример ответа: 2791 + 2792 +200 ~/~/ Success 2793 + 2200 2200 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2201 2201 2202 2202 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2228,7 +2228,7 @@ 2228 2228 "id": 0, ~/~/ ID уведомления 2229 2229 "name": "string", ~/~/ Название уведомления 2230 2230 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2231 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2825 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2232 2232 "userId": "", ~/~/ Пользователь, создавший уведомление 2233 2233 "parentId": "", ~/~/ Идентификатор клиента 2234 2234 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2235,6 +2235,155 @@ 2235 2235 } 2236 2236 ] 2237 2237 2832 + 2833 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2834 + 2835 +(% class="box infomessage" %) 2836 +((( 2837 +**POST /api/v3/notifications** 2838 +))) 2839 + 2840 +Метод запроса **POST** 2841 + 2842 +(% style="text-align: left;" %) 2843 +(% style="color:#000000" %)Пример запроса 2844 + 2845 +((( 2846 +{ 2847 + "id": 0, ~/~/ ID правила 2848 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2849 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2851 + "name": "string", ~/~/ Имя правила 2852 + "active": true, ~/~/ Активность правила 2853 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2854 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2855 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2856 + ], 2857 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2858 + 0 2859 + ], 2860 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2861 + 0 2862 + ], 2863 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2864 + 0 2865 + ], 2866 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2867 + "additionalProp1": "string", 2868 + "additionalProp2": "string", 2869 + "additionalProp3": "string" 2870 + }, 2871 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2872 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2873 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2874 + ], 2875 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2876 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2877 + "string" 2878 + ], 2879 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2880 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2881 + { 2882 + "id": 0, ~/~/ Идентификатор участника чата. 2883 + "info": "string" ~/~/ Дополнительные сведения. 2884 + } 2885 + ], 2886 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2887 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2888 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2889 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2890 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2891 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2892 + "timezone": 0, ~/~/ часовой пояс 2893 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2894 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2895 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2896 + { 2897 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2898 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2899 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2900 + "additionalProp1": "string", 2901 + "additionalProp2": "string", 2902 + "additionalProp3": "string" 2903 + } 2904 + } 2905 + ] 2906 +} 2907 +))) 2908 + 2909 +((( 2910 + 2911 +))) 2912 + 2913 +((( 2914 + 2915 +))) 2916 + 2917 +Ответ: 2918 + 2919 +{ 2920 + "id": 0, ~/~/ ID правила 2921 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2922 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2923 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2924 + "name": "string", ~/~/ Имя правила 2925 + "active": true, ~/~/ Активность правила 2926 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2927 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2928 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2929 + ], 2930 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2931 + 0 2932 + ], 2933 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2934 + 0 2935 + ], 2936 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2937 + 0 2938 + ], 2939 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2940 + "additionalProp1": "string", 2941 + "additionalProp2": "string", 2942 + "additionalProp3": "string" 2943 + }, 2944 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2945 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2946 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2947 + ], 2948 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2949 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2950 + "string" 2951 + ], 2952 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2953 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2954 + { 2955 + "id": 0, ~/~/ Идентификатор участника чата. 2956 + "info": "string" ~/~/ Дополнительные сведения. 2957 + } 2958 + ], 2959 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2960 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2961 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2962 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2963 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2964 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2965 + "timezone": 0, ~/~/ часовой пояс 2966 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2967 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2968 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2969 + { 2970 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2971 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2972 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2973 + "additionalProp1": "string", 2974 + "additionalProp2": "string", 2975 + "additionalProp3": "string" 2976 + } 2977 + } 2978 + ] 2979 +} 2980 + 2238 2238 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2239 2239 2240 2240 (% class="box infomessage" %) ... ... @@ -2376,6 +2376,32 @@ 2376 2376 2377 2377 Success 2378 2378 3122 + 3123 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3124 + 3125 +(% class="box warningmessage" %) 3126 +((( 3127 +**PUT** /api/v3/notifications/prolongation 3128 +))) 3129 + 3130 +Метод позволяет продлить уведомления. 3131 + 3132 +Метод запроса **PUT** 3133 + 3134 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3135 + 3136 +В заголовках запроса: X-Auth: Токен авторизации. 3137 + 3138 +Тело запроса: 3139 + 3140 +[ 3141 + 3142 +0 3143 + 3144 +] 3145 + 3146 +где 0 идентификатор ids. 3147 + 2379 2379 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2380 2380 2381 2381 (% class="box errormessage" %) ... ... @@ -3426,16 +3426,12 @@ 3426 3426 Тело запроса: 3427 3427 3428 3428 { 3429 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3430 - "Balance": 0 4198 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4199 + "Balance": 0 ~/~/ Значение баланса. 3431 3431 } 3432 3432 3433 3433 Ответ: Success 3434 3434 3435 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3436 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3437 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3438 - 3439 3439 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3440 3440 3441 3441 (% class="box warningmessage" %) ... ... @@ -3447,16 +3447,29 @@ 3447 3447 3448 3448 Тело запроса: 3449 3449 4215 +((( 3450 3450 { 3451 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",3452 - " Balance": 04217 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4218 + "amount": 0 ~/~/ Сумма пополнения баланса 3453 3453 } 4220 +))) 3454 3454 4222 +((( 4223 + 4224 +))) 4225 + 3455 3455 Ответ: Success 3456 3456 3457 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3458 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3459 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4228 +((( 4229 +{ 4230 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4231 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4232 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4233 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4234 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4235 + "Description": "string" ~/~/ Описание корректировки. 4236 +} 4237 +))) 3460 3460 3461 3461 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3462 3462 ... ... @@ -3469,16 +3469,25 @@ 3469 3469 3470 3470 Тело запроса: 3471 3471 4250 +((( 3472 3472 { 3473 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",3474 - " Balance": 04252 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4253 + "amount": 0 ~/~/ Сумма списания с баланса 3475 3475 } 4255 +))) 3476 3476 3477 3477 Ответ: Success 3478 3478 3479 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3480 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3481 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4259 +((( 4260 +{ 4261 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4263 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4264 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4265 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4266 + "Description": "string" ~/~/ Описание корректировки 4267 +} 4268 +))) 3482 3482 3483 3483 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3484 3484 ... ... @@ -3489,28 +3489,35 @@ 3489 3489 3490 3490 Тело запроса: 3491 3491 4279 +((( 3492 3492 { 3493 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3494 - "CalculationType": 0, 3495 - "PermissibleBalance": 0, 3496 - "DefermentDays": 0, 3497 - "SendUiNotifications": true, 3498 - "SendEmailNotifications": true, 3499 - "IsPrivate": true, 4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 3500 3500 } 4288 +))) 3501 3501 4290 +((( 4291 + 4292 +))) 4293 + 3502 3502 Ответ: Success 3503 3503 3504 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3505 -|ClientId|Идентификатор клиента 3506 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3507 -|PermissibleBalance|Допустимый баланс 3508 -|DefermentDays|((( 3509 -Отсрочка, количество дней 4296 +((( 4297 +{ 4298 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4299 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4301 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4302 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4303 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4304 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4305 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4306 +} 3510 3510 ))) 3511 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3512 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3513 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3514 3514 3515 3515 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3516 3516 ... ... @@ -3522,35 +3522,68 @@ 3522 3522 Тело запроса: 3523 3523 3524 3524 { 3525 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3526 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3527 - "Features": [ 4319 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4320 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 3528 3528 { 3529 - "Feature": "string", 3530 - "IsEnabled": true, 3531 - "IsFactual": true, 3532 - "Limit": 0, 3533 - "Price": 0, 3534 - "DebitDate": "2023-10-18T13:26:58.987Z", 3535 - "PeriodValue": 0, 3536 - "PeriodType": 0 4323 + "Feature": "string", ~/~/ Код услуги. 4324 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4325 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4326 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4327 + "Price": 0, ~/~/ Цена за единицу. 4328 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4329 + "PeriodValue": 0, ~/~/ Значение периода. 4330 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 3537 3537 } 3538 3538 ] 3539 3539 } 3540 3540 4335 + 3541 3541 Ответ: Success 3542 3542 3543 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3544 -|ClientId|Идентификатор клиента 3545 -|PlanId|Идентификатор тарифного плана 3546 -|Feature|Код услуги 3547 -|IsEnabled|Признак, определяющий активирована ли услуга 3548 -|IsFactual|Признак, определяющий расчёт по факту 3549 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3550 -|Price|Цена за единицу. 3551 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3552 -|PeriodValue|Значение периода. 3553 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4338 +((( 4339 +{ 4340 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4341 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4342 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4343 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4344 + "Name": "string", ~/~/ Наименование. 4345 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4346 + "Constraint": { ~/~/ Ограничения по тарифу 4347 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4348 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4349 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4350 + }, 4351 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4352 + { 4353 + "Feature": "string", ~/~/Код услуги. 4354 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4355 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4356 + "Price": 0, ~/~/ Цена за единицу. 4357 + "PeriodValue": 0, ~/~/ Значение периода. 4358 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4359 + } 4360 + ], 4361 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4362 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4363 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4364 + }, 4365 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4366 + { 4367 + "Feature": "string", ~/~/ Код услуги. 4368 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4369 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4370 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4371 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4372 + "Price": 0, ~/~/ Цена за единицу. 4373 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4374 + "PeriodValue": 0, ~/~/ Значение периода. 4375 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4376 + "Quantity": 0 ~/~/ Количество использования услуги. 4377 + } 4378 + ] 4379 +} 4380 +))) 3554 3554 3555 3555 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3556 3556 ... ... @@ -3566,7 +3566,7 @@ 3566 3566 **POST /api/v3/vehicles/import/{agentId}** 3567 3567 ))) 3568 3568 3569 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 4396 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3570 3570 3571 3571 В пути указывается **agentId** - id клиента. 3572 3572 ... ... @@ -3578,7 +3578,7 @@ 3578 3578 3579 3579 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3580 3580 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3581 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление4408 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3582 3582 3583 3583 В теле использовать тип **form-data,** тип значения** file** 3584 3584 ... ... @@ -3655,6 +3655,43 @@ 3655 3655 |producedCount|Кол-во успешно отправленных в шину данных сообщений 3656 3656 |msgCount|Кол-во обработанных сообщений всего 3657 3657 4485 +== **Импортировать историю ТС (Асинхронный запрос)** == 4486 + 4487 +(% class="box successmessage" %) 4488 +((( 4489 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4490 +))) 4491 + 4492 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4493 + 4494 +Метод запроса: **POST** 4495 + 4496 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4497 + 4498 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4499 + 4500 + 4501 +Ответ: 4502 + 4503 +{ 4504 + 4505 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4506 + 4507 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4508 + 4509 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4510 + 4511 + "Message": "string", ~/~/ Информация о выполнении запроса 4512 + 4513 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4514 + 4515 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4516 + 4517 + "Data": "string" ~/~/ Данные 4518 + 4519 +} 4520 + 4521 + 3658 3658 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3659 3659 3660 3660 (% class="box infomessage" %) ... ... @@ -3672,10 +3672,59 @@ 3672 3672 "message": "string" 3673 3673 } 3674 3674 3675 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3676 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3677 -|progress|Guid ТС 4539 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4540 +**Параметр** 4541 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4542 +**Описание** 4543 +))) 4544 +|((( 4545 +activity 4546 +)))|((( 4547 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4548 +))) 4549 +|((( 4550 +progress 4551 +)))|((( 4552 +Guid ТС 4553 +))) 3678 3678 4555 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4556 + 4557 +(% class="box infomessage" %) 4558 +((( 4559 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4560 +))) 4561 + 4562 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4563 + 4564 +Метод запроса: **GET** 4565 + 4566 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4567 + 4568 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4569 + 4570 + 4571 +Ответ: 4572 + 4573 +{ 4574 + 4575 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4576 + 4577 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4578 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4579 + 4580 + "Message": "string", ~/~/ Информация о выполнении запроса 4581 + 4582 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4583 + 4584 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4585 + 4586 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4587 + 4588 + "Data": "string" ~/~/ Данные 4589 + 4590 +} 4591 + 3679 3679 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3680 3680 3681 3681 (% class="box infomessage" %) ... ... @@ -3745,7 +3745,7 @@ 3745 3745 3746 3746 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3747 3747 3748 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==4661 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3749 3749 3750 3750 (% class="box infomessage" %) 3751 3751 ((( ... ... @@ -3757,64 +3757,67 @@ 3757 3757 Тело запроса: 3758 3758 3759 3759 { 3760 - "vehicleIds": [vehicleId], 3761 - "from": "2023-11-22T09:29:48.051Z", 3762 - "to": "2023-11-22T09:29:48.051Z" 4673 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4674 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4675 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 3763 3763 } 3764 3764 3765 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3766 -|vehicleIds|Массив ID объектов 3767 -|from|Дата начала запроса 3768 -|to|Дата окончания запроса 3769 - 3770 3770 Ответ: 3771 3771 3772 3772 { 3773 - "items": [ 4681 + "items": [ ~/~/ Список в разрезе ТС 3774 3774 { 3775 - "from": "2023-11-22T09:29:48.052Z", 3776 - "to": "2023-11-22T09:29:48.052Z", 3777 - "vehicleId": 0, 3778 - "vehicleName": "string", 3779 - "vehicleModel": "string", 3780 - "penalty": 0, 3781 - "score": 0, 3782 - "totalViolations": 0, 3783 - "violationsByType": { 3784 - "overspeedingViolations": 0, 3785 - "accelerationViolations": 0, 3786 - "brakingViolations": 0, 3787 - "turningViolations": 0, 3788 - "dangerousDrivingViolations": 0, 3789 - "sensorViolations": 0 4683 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4684 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4685 + "vehicleId": 0, ~/~/ ID ТС 4686 + "vehicleName": "string", ~/~/ Название ТС 4687 + "vehicleModel": "string", ~/~/ Модель ТС 4688 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4689 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4690 + "totalViolations": 0, ~/~/ Нарушений всего 4691 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4692 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4693 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4694 + "brakingViolations": 0, ~/~/ Нарушений торможения 4695 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4696 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4697 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3790 3790 }, 3791 - "moveTime": 0, 3792 - "mileage": 0, 3793 - "tripsCount": 0, 3794 - "trips": [ 4699 + 4700 +((( 4701 + 4702 +))) 4703 + 4704 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4705 + "mileage": 0, ~/~/ Пробег, м 4706 + "tripsCount": 0, ~/~/ Кол-во рейсов 4707 + "trips": [ ~/~/ Информация по рейсу 3795 3795 { 3796 - "penalty": 0, 3797 - "score": 0, 3798 - "violationsCount": 0, 3799 - "violationsByType": { 3800 - "overspeedingViolations": 0, 3801 - "accelerationViolations": 0, 3802 - "brakingViolations": 0, 3803 - "turningViolations": 0, 3804 - "dangerousDrivingViolations": 0, 3805 - "sensorViolations": 0 4709 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4710 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4711 + "violationsCount": 0, ~/~/ Всего нарушений 4712 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4713 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4714 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4715 + "brakingViolations": 0, ~/~/ Нарушений торможения 4716 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4717 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4718 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3806 3806 }, 3807 - "moveTime": 0, 3808 - "mileage": 0, 3809 - "motohours": 0, 3810 - "maxSpeed": 0, 3811 - "startAddress": "string", 3812 - "endAddress": "string", 3813 - "drivers": [ 4720 + 4721 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4722 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4723 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4724 + "mileage": 0, ~/~/ Пробег, м 4725 + "motohours": 0, ~/~/ Моточасы, секунды 4726 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4727 + "startAddress": "string", ~/~/ Адрес начала рейса 4728 + "endAddress": "string", ~/~/ Адрес конца рейса 4729 + "drivers": [ ~/~/ Список водителей 3814 3814 { 3815 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3816 - "driverName": "string", 3817 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4731 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4732 + "driverName": "string", ~/~/ФИО водителя 4733 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 3818 3818 } 3819 3819 ] 3820 3820 } ... ... @@ -3823,34 +3823,1927 @@ 3823 3823 ] 3824 3824 } 3825 3825 3826 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3827 -|from|Дата начала запроса 3828 -|to|Дата окончания 3829 -|vehicleId|ID объекта 3830 -|vehicleName|Имя объекта 3831 -|vehicleModel|Модель объекта 3832 -|penalty|Сумма штрафных баллов 3833 -|score|Оценка 3834 -|totalViolations|Суммарное количество нарушений 3835 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3836 -|overspeedingViolations|Превышение скорости 3837 -|accelerationViolations|Ускорение 3838 -|brakingViolations|Торможение 3839 -|turningViolations|Резкий поворот 3840 -|dangerousDrivingViolations|Резкое вождение 3841 -|sensorViolations|Нарушение по датчику 3842 -|moveTime|Время в движении 3843 -|mileage|Пробег 3844 -|tripsCount|Количество рейсов 3845 -|motohours|Моточасы 3846 -|maxSpeed|Максимальная скорость 3847 -|startAddress|Адрес начала рейса 3848 -|endAddress|Адрес окончания рейса 3849 -|drivers|Список водителей, которые были на объекте в течениии рейса 3850 -|driverGuid|Guid водителя 3851 -|driverName|Имя водителя 3852 -|driverRfid|Номер Карты-метки 4742 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3853 3853 4744 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4745 + 4746 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4747 + 4748 +(% class="box infomessage" %) 4749 +((( 4750 +**POST /api/v3/fuelcards/transactions** 4751 +))) 4752 + 4753 +Метод запроса: POST 4754 + 4755 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4756 +\\В заголовках запроса: X-Auth: Токен авторизации 4757 + 4758 +Параметры в теле запроса (JSON): 4759 + 4760 +{ 4761 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4762 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4763 + "ids": [ 4764 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4765 + ], 4766 + "timezone": 0 ~/~/ Часовой пояс 4767 +} 4768 + 4769 + 4770 +Ответ: 4771 + { 4772 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4773 + "driver": "string", ~/~/ Водители, привязанные к ТК 4774 + "object": "string", ~/~/ Наименование ТС 4775 + "amount": 0, ~/~/ Количество топлива 4776 + "amountDut": 0, ~/~/ Количество по ДУТ 4777 + "amountDiff": 0, ~/~/ Разница, л 4778 + "amountDiffPerc": 0, ~/~/ Разница, % 4779 + "summa": 0, ~/~/ Стоимость, руб 4780 + "serviceName": "string", ~/~/ Тип топлива 4781 + "price": 0, ~/~/ Цена за литр, руб 4782 + "cardName": "string", ~/~/ Наименование ТК 4783 + "cardNum": "string", ~/~/ Номер ТК 4784 + "operator": "string", ~/~/ Оператор ТК 4785 + "address": "string" ~/~/ Адрес АЗС 4786 + } 4787 + 4788 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4789 + 4790 +(% class="box infomessage" %) 4791 +((( 4792 +**GET /api/v3/fuelcards** 4793 +))) 4794 + 4795 +Метод запроса: GET 4796 + 4797 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4798 + 4799 +Ответ: 4800 + 4801 +[ 4802 + { 4803 + "Name": "string", ~/~/ Определяет наименование карты. 4804 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4805 + "Number": "string", ~/~/ Определяет № карты. 4806 + "Enabled": true, ~/~/ Определяет признак активности карты. 4807 + "Description": "string", ~/~/ Определяет описание карты. 4808 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4809 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4810 + "deleted": true ~/~/ Признак удаления 4811 + } 4812 +] 4813 + 4814 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4815 + 4816 + 4817 +== **Получение полных данных о ретрансляторе** == 4818 + 4819 +(% class="box infomessage" %) 4820 +((( 4821 +**GET ** **/api/v3/retranslations/{id}** 4822 +))) 4823 + 4824 +id - Идентификатор ретранслятора 4825 + 4826 + 4827 +Пример ответа: 4828 + 4829 +{ 4830 +"description": "", ~/~/ Поле описания ретранслятора 4831 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4832 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4833 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4834 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4835 +"objects": [ ~/~/ Объекты для ретрансляции 4836 +{ 4837 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4838 +"name": "", ~/~/ Наименование объекта ретрансляции 4839 +"imei": "", ~/~/ IMEI объекта ретрансляции 4840 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4841 +} 4842 + ], 4843 +"id": "", ~/~/ Идентификатор ретранслятора 4844 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4845 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4846 +} 4847 + 4848 + 4849 +== **Удаление данных ретранслятора** == 4850 + 4851 +(% class="box infomessage" %) 4852 +((( 4853 +**DELETE** **/api/v3/retranslations/{id}** 4854 +))) 4855 + 4856 +id - Идентификатор ретранслятора 4857 + 4858 + 4859 +== **Создание ретранслятора** == 4860 + 4861 +(% class="box infomessage" %) 4862 +((( 4863 +**POST ** **/api/v3/retranslations/{id}** 4864 +))) 4865 + 4866 +Запрос: 4867 + 4868 +{ 4869 +"description": "", ~/~/ Поле описания ретранслятора 4870 +"subscriberId": "", ~/~/ Идентификатор подписчика 4871 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4872 +"address": "", ~/~/ Адрес и порт принимающего сервера 4873 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4874 +"objects": [ ~/~/Объекты для ретрансляции 4875 +{ 4876 +"id": "", ~/~/ Идентификатор ретранслятора 4877 +"imei": "", ~/~/ IMEI объекта ретрансляции 4878 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4879 +} 4880 + ] 4881 +} 4882 + 4883 + 4884 +Ответ: 4885 + 4886 +{ 4887 +"description": "", ~/~/ Поле описания ретранслятора 4888 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4889 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4890 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4891 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4892 +"objects": [ ~/~/ Объекты для ретрансляции 4893 +{ 4894 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4895 +"name": "string", ~/~/ Наименование объекта ретрансляции 4896 +"imei": "", ~/~/ IMEI объекта ретрансляции 4897 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4898 +} 4899 + ], 4900 +"id": "", ~/~/ Идентификатор ретранслятора 4901 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4902 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4903 +} 4904 + 4905 + 4906 +== **Редактирование ретранслятора** == 4907 + 4908 +(% class="box infomessage" %) 4909 +((( 4910 +**PUT** **/api/v3/retranslations** 4911 +))) 4912 + 4913 +Пример запроса: 4914 + 4915 +{ 4916 +"id": "", ~/~/ Идентификатор ретранслятора 4917 +"description": "string", ~/~/ Поле описания ретранслятора 4918 +"subscriberId": "", ~/~/ Идентификатор подписчика 4919 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4920 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4921 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4922 +"objects": ~/~/ Объекты для ретрансляции 4923 +[ 4924 +{ 4925 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4926 +"imei": "", ~/~/ IMEI объекта ретрансляции 4927 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4928 +} 4929 + ] 4930 +} 4931 + 4932 + 4933 +Пример ответа: 4934 + 4935 +{ 4936 +"description": "", ~/~/ Поле описания ретранслятора 4937 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4938 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4939 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4940 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4941 +"objects": [ ~/~/ Объекты для ретрансляции 4942 +{ 4943 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4944 +"name": "string", ~/~/ Наименование объекта ретрансляции 4945 +"imei": "", ~/~/ IMEI объекта ретрансляции 4946 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4947 +} 4948 + ], 4949 +"id": "", ~/~/ Идентификатор ретранслятора 4950 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4951 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4952 +} 4953 + 4954 + 4955 +== **Получение списка ретранслятора клиента** == 4956 + 4957 +(% class="box infomessage" %) 4958 +((( 4959 +**POST /api/v3/retranslations/find** 4960 +))) 4961 + 4962 +Пример запроса: 4963 + 4964 +{ 4965 +"id": "", ~/~/ Идентификатор ретранслятора 4966 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4967 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4968 +} 4969 + 4970 +Ответ: 4971 + 4972 +[ 4973 +{ 4974 +"description": "", ~/~/ Поле описания ретранслятора 4975 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4976 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4977 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4978 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4979 +"id": "", ~/~/ Идентификатор ретранслятора 4980 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4981 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4982 +} 4983 +] 4984 + 4985 + 4986 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4987 + 4988 +== **API для отчета по выгрузке комбайнов** == 4989 + 4990 +(% class="box infomessage" %) 4991 +((( 4992 +**POST /api/v3/Reports/harvesterUnloading** 4993 +))) 4994 + 4995 +Пример запроса: 4996 + 4997 +{ 4998 + "byTime": 0, ~/~/ Объединение событий по времени 4999 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5000 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5001 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5002 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 5003 + "vehicleIds": [ ~/~/ Список id объектов для анализа 5004 + 0 5005 + ], 5006 + "from": "", ~/~/ Дата и время начало запроса 5007 + "to": "", ~/~/ Дата и время окончания запроса 5008 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 5009 +} 5010 + 5011 +Пример ответа: 5012 + 5013 +[ 5014 + { 5015 + "harvesterName": "", ~/~/Комбайн, номер 5016 + "harvesterId": 0, ~/~/Комбайн, id 5017 +"harvesterModel": "", ~/~/ Модель комбайна 5018 +"hopperCapacity": 0, ~/~/ Объем бункера м3 5019 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 5020 + "events": [ ~/~/Список событий в разрезе комбайна 5021 + { 5022 + "driverId": "", ~/~/Идентификатор водителя 5023 + "driverName": "", ~/~/Водитель комбайна, ФИО 5024 + "RFID": "", ~/~/ идентификатор карты-метки 5025 + "rfidName": "", ~/~/Водитель комбайна, имя метки 5026 + "vehicleId": 0, ~/~/идентификатор объекта 5027 + "vehicleName": "string", ~/~/ Имя объекта 5028 + "modelName": "string", ~/~/ Имя модели объекта 5029 + "nearestVehicles": [ ~/~/Объекты рядом 5030 + { 5031 + "vehicleId": 0, ~/~/идентификатор объекта 5032 + "vehicleName": "string" ~/~/ Имя объекта 5033 + } 5034 + ], 5035 + "fields": [ ~/~/Поля, где происходила выгрузка 5036 + { 5037 + "id": 0, ~/~/ идентификатор пользователя 5038 + "name": "string" ~/~/ имя пользователя 5039 + } 5040 + ], 5041 + "event": "string", ~/~/Событие 5042 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 5043 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 5044 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 5045 + "cultureName": "string", ~/~/ название культуры 5046 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 5047 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 5048 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 5049 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 5050 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 5051 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 5052 + "issued": 0, ~/~/Выдано, бункеров 5053 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 5054 + "latitude": 0, ~/~/Широта 5055 + "longitude": 0, ~/~/ Долгота 5056 + "litresAway": 0, ~/~/Отдано, л 5057 + "m3Away": 0 ~/~/Отдано, м3 5058 + } 5059 + ] 5060 + } 5061 +] 5062 + 5063 + 5064 +== **Отчет трек-датчики** == 5065 + 5066 +(% class="box infomessage" %) 5067 +((( 5068 +**POST /api/v3/Reports/sensorsWorks** 5069 +))) 5070 + 5071 +**Пример запроса:** 5072 + 5073 +{ 5074 + "vehicleIds": [ ~/~/ Список ID объектов 5075 + 0 5076 + ], 5077 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5078 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5079 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5080 +} 5081 + 5082 +**Пример ответа:** 5083 + 5084 +((( 5085 +{ 5086 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5087 + { 5088 + "vehicleId": 0, ~/~/ Идентификатор ТС 5089 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5090 + { 5091 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5092 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5093 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5094 + "name": "string", ~/~/ Наименование оборудования. 5095 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5096 + "totalMileage": 0, ~/~/ Общий пробег. 5097 + "avgSpeed": 0 ~/~/ Средняя скорость. 5098 + } 5099 + ] 5100 + } 5101 + ] 5102 +} 5103 + 5104 + 5105 +== **Превышение скорости** == 5106 + 5107 +(% class="box infomessage" %) 5108 +((( 5109 +**POST /api/v3/Reports/overSpeedDuration** 5110 +))) 5111 + 5112 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5113 + 5114 +Пример запроса: 5115 + 5116 +((( 5117 +{ 5118 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5119 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5120 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5121 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5122 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5123 +} 5124 +))) 5125 + 5126 +((( 5127 + 5128 +))) 5129 + 5130 +((( 5131 +Пример ответа: 5132 +))) 5133 + 5134 +((( 5135 +((( 5136 +[ 5137 + { 5138 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5139 + "duration": 0, ~/~/ Продолжительность события в секундах 5140 + "maxSpeed": 0, ~/~/ Максимальная скорость 5141 + "speedLimit": 0 ~/~/ Ограничение скорости 5142 + } 5143 +] 5144 +))) 5145 +))) 5146 +))) 5147 + 5148 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5149 + 5150 + 5151 +== **Запрос списка полей** == 5152 + 5153 +(% class="box successmessage" %) 5154 +((( 5155 +**POST /api/v3/agroLands/find** 5156 +))) 5157 + 5158 +Пример запроса: 5159 + 5160 +((( 5161 +((( 5162 +((( 5163 +{ 5164 + "year": 0, ~/~/ Фильтр по году 5165 + "name": "string", ~/~/ Фильтр по названию 5166 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5167 +} 5168 +))) 5169 +))) 5170 + 5171 + 5172 +))) 5173 + 5174 +Пример ответа: 5175 + 5176 +((( 5177 +[ 5178 + { 5179 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5180 + "year": 0, ~/~/ Год поля 5181 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5182 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5183 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5184 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5185 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5186 + "counts": { ~/~/ Счётчики с/х поля 5187 + "fieldOperations": 0, ~/~/ Количество операций на поле 5188 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5189 + "facts": 0 ~/~/ Счётчик факта 5190 + }, 5191 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5192 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5193 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5194 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5195 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5196 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5197 + "planComment": "string", ~/~/ Комментарий к полю 5198 + "productivity": 0, ~/~/ Урожайность. 5199 + "id": 0, ~/~/ Идентификатор объекта геозоны 5200 + "name": "string", ~/~/ Название объекта геозоны 5201 + "type": 0, ~/~/ Тип объекта геозоны 5202 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5203 + "fname": "string", ~/~/ Имя файла 5204 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5205 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5206 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5207 + "description": "string", ~/~/ Описание объекта геозоны 5208 + "area": 0, ~/~/ Площадь, м2 5209 + "perimetr": 0, ~/~/ Периметр, м 5210 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5211 + } 5212 +] 5213 + 5214 + 5215 +== **Создание нового поля ** == 5216 + 5217 +(% class="box successmessage" %) 5218 +((( 5219 +**POST /api/v3/agroLands** 5220 +))) 5221 + 5222 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5223 +X-agent - ID клиента 5224 + 5225 +Пример запроса: 5226 + 5227 +((( 5228 +{ 5229 + "extId": "string", 5230 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5231 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5232 + "display": "string", ~/~/ Настройки отображения 5233 + "year": 0, ~/~/ Год поля 5234 + "name": "string", ~/~/ Наименование 5235 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5236 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5237 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5238 + "planComment": "string", ~/~/ Комментарий к полю 5239 + "cropRotations": [ ~/~/ Данные по севообороту 5240 + { 5241 + "landId": 0, ~/~/ ID поля 5242 + "landName": "string", ~/~/ Название поля 5243 + "year": 0, ~/~/ Год урожая 5244 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5245 + "cultureName": "string", ~/~/ Название культуры 5246 + "productivity": 0, ~/~/ Урожайность 5247 + "area": 0, ~/~/ Площадь поля, Га 5248 + "total": 0, ~/~/ Валовый сбор 5249 + "productivityFact": 0, ~/~/ Фактическая урожайность 5250 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5251 + "totalFact": 0, ~/~/ Фактический валовый сбор 5252 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5253 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5254 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5255 + "isyearplan": true, ~/~/ Годовой план 5256 + "comment": "string" ~/~/ Комментарий 5257 + } 5258 + ] 5259 +} 5260 +))) 5261 + 5262 +((( 5263 + 5264 +))) 5265 + 5266 +Пример ответа: 5267 + 5268 +((( 5269 +((( 5270 +{ 5271 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5272 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5273 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5274 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5275 + "cropRotations": [ ~/~/ Данные по севообороту 5276 + { 5277 + "landId": 0, ~/~/ ID поля 5278 + "landName": "string", ~/~/ Название поля 5279 + "year": 0, ~/~/ Год урожая 5280 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5281 + "cultureName": "string", ~/~/ Название культуры 5282 + "productivity": 0, ~/~/ Урожайность 5283 + "area": 0, ~/~/ Площадь поля, Га. 5284 + "total": 0, ~/~/ Валовый сбор 5285 + "productivityFact": 0, ~/~/ Фактическая урожайность 5286 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5287 + "totalFact": 0, ~/~/ Фактический валовый сбор 5288 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5289 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5290 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5291 + "isyearplan": true, ~/~/ годовой план 5292 + "comment": "string" ~/~/ Комментарий 5293 + } 5294 + ], 5295 + "cropVegetation": [ ~/~/ История вегетации поля 5296 + { 5297 + "values": [ ~/~/ Данные вегетации и состояния посева 5298 + { 5299 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5300 + "ndvi": 0 ~/~/ Индекс вегетации 5301 + } 5302 + ], 5303 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5304 + { 5305 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5306 + "type": "string", ~/~/ Тип 5307 + "pictureid": "string" ~/~/ Идентификатор ресурса 5308 + } 5309 + ], 5310 + "states": [ ~/~/ Ключевые даты развития поля 5311 + { 5312 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5313 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5314 + } 5315 + ] 5316 + } 5317 + ], 5318 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5319 + "counts": { 5320 + "fieldOperations": 0, ~/~/ Количество операций на поле 5321 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5322 + "facts": 0 ~/~/ Счётчик факта 5323 + }, 5324 + "planComment": "string", ~/~/ Комментарий к полю 5325 +))) 5326 + 5327 +((( 5328 + "productivity": 0, ~/~/ Урожайность. 5329 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5330 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5331 + "year": 0, ~/~/ Год поля 5332 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5333 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5334 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5335 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5336 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5337 + "id": 0, ~/~/ Идентификатор объекта геозоны 5338 + "name": "string", ~/~/ Название объекта геозоны 5339 + "type": 0, ~/~/ Тип объекта геозоны 5340 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5341 + "fname": "string", ~/~/ Имя файла 5342 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5343 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5344 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5345 + "description": "string", ~/~/ Описание объекта геозоны 5346 + "area": 0, ~/~/ Площадь, м2 5347 + "perimetr": 0, ~/~/ Периметр, м 5348 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5349 +} 5350 + 5351 + 5352 +))) 5353 +))) 5354 +))) 5355 + 5356 +== **Получение поля по id** == 5357 + 5358 +(% class="box infomessage" %) 5359 +((( 5360 +**GET /api/v3/agroLands/{id}** 5361 +))) 5362 + 5363 +Пример запроса: 5364 +id ~/~/ Идентификатор поля 5365 + 5366 +Пример ответа: 5367 + 5368 +((( 5369 +{ 5370 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5371 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5372 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5373 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5374 + "cropRotations": [ ~/~/ Данные по севообороту 5375 + { 5376 + "landId": 0, ~/~/ ID поля 5377 + "landName": "string", ~/~/ Название поля 5378 + "year": 0, ~/~/ Год урожая 5379 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5380 + "cultureName": "string", ~/~/ Название культуры 5381 + "productivity": 0, ~/~/ Урожайность 5382 + "area": 0, ~/~/ Площадь поля, Га 5383 + "total": 0, ~/~/ Валовый сбор 5384 + "productivityFact": 0, ~/~/ Фактическая урожайность 5385 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5386 + "totalFact": 0, ~/~/ Фактический валовый сбор 5387 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5388 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5389 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5390 + "isyearplan": true, ~/~/ План года 5391 + "comment": "string" ~/~/ Комментарий 5392 + } 5393 + ], 5394 + "cropVegetation": [ ~/~/ История вегетации поля 5395 + { 5396 + "values": [ ~/~/ Данные вегетации и состояния посева 5397 + { 5398 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5399 + "ndvi": 0 ~/~/ Индекс вегетации 5400 + } 5401 + ], 5402 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5403 + { 5404 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5405 + "type": "string", ~/~/ Тип 5406 + "pictureid": "string" ~/~/ Идентификатор ресурса 5407 + } 5408 + ], 5409 + "states": [ ~/~/ Ключевые даты развития поля 5410 + { 5411 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5412 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5413 + } 5414 + ] 5415 + } 5416 + ], 5417 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5418 + "counts": { 5419 + "fieldOperations": 0, ~/~/ Количество операций на поле 5420 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5421 + "facts": 0 ~/~/ Счётчик факта 5422 + }, 5423 + "planComment": "string", ~/~/ Комментарий к полю 5424 + "productivity": 0, ~/~/ Урожайность. 5425 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5426 +))) 5427 + 5428 +((( 5429 +((( 5430 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5431 + "year": 0, ~/~/ Год поля 5432 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5433 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5434 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5435 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5436 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5437 + "id": 0, ~/~/ Идентификатор объекта геозоны 5438 + "name": "string", ~/~/ Название объекта геозоны 5439 + "type": 0, ~/~/ Тип объекта геозоны 5440 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5441 + "fname": "string", ~/~/ Имя файла 5442 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5443 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5444 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5445 + "description": "string", ~/~/ Описание объекта геозоны 5446 + "area": 0, ~/~/ Площадь, м2 5447 + "perimetr": 0, ~/~/ Периметр, м 5448 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5449 +} 5450 +))) 5451 + 5452 + 5453 + 5454 +((( 5455 + 5456 +))) 5457 + 5458 +((( 5459 +((( 5460 +((( 5461 +== **Изменение поля** == 5462 + 5463 +(% class="box infomessage" %) 5464 +((( 5465 +**PUT /api/v3/agroLands** 5466 +))) 5467 + 5468 +Пример запроса: 5469 + 5470 +((( 5471 +((( 5472 +{ 5473 + "id": 0, ~/~/ Идентификатор поля 5474 + "extId": "string", ~/~/ ExtId 5475 + "shape": "string", ~/~/ Форма поля 5476 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5477 + "display": "string", ~/~/ Настройки отображения 5478 + "year": 0, ~/~/ Год поля 5479 + "name": "string", ~/~/ Наименование 5480 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5481 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5482 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5483 + "planComment": "string", ~/~/Комментарий к полю 5484 + "cropRotations": [ ~/~/ Данные по севообороту 5485 + { 5486 + "landId": 0, ~/~/ ID поля 5487 + "landName": "string", ~/~/ Название поля 5488 + "year": 0, ~/~/ Год урожая 5489 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5490 + "cultureName": "string", ~/~/ Название культуры 5491 + "productivity": 0, ~/~/ Урожайность 5492 + "area": 0, ~/~/ Площадь поля, Га. 5493 + "total": 0, ~/~/ Валовый сбор 5494 + "productivityFact": 0, ~/~/ Фактическая урожайность 5495 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5496 + "totalFact": 0, ~/~/ Фактический валовый сбор 5497 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5498 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5499 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5500 + "isyearplan": true, 5501 + "comment": "string" ~/~/ Комментарий 5502 + } 5503 + ], 5504 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5505 +} 5506 +))) 5507 +))) 5508 + 5509 +((( 5510 + 5511 +))) 5512 + 5513 +Пример ответа: 5514 + 5515 +((( 5516 +((( 5517 +((( 5518 +{ 5519 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5520 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5521 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5522 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5523 + "cropRotations": [ ~/~/ Данные по севообороту 5524 + { 5525 + "landId": 0, ~/~/ ID поля 5526 + "landName": "string", ~/~/ Название поля 5527 + "year": 0, ~/~/ Год урожая 5528 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5529 + "cultureName": "string", ~/~/ Название культуры 5530 + "productivity": 0, ~/~/ Урожайность 5531 + "area": 0, ~/~/ Площадь поля, Га 5532 + "total": 0, ~/~/ Валовый сбор 5533 + "productivityFact": 0, ~/~/ Фактическая урожайность 5534 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5535 + "totalFact": 0, ~/~/ Фактический валовый сбор 5536 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5537 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5538 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5539 + "isyearplan": true, ~/~/ 5540 + "comment": "string" ~/~/ Комментарий 5541 + } 5542 + ], 5543 + "cropVegetation": [ ~/~/ История вегетации поля 5544 + { 5545 + "values": [ ~/~/ Данные вегетации и состояния посева 5546 + { 5547 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5548 + "ndvi": 0 ~/~/ Индекс вегетации 5549 + } 5550 + ], 5551 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5552 + { 5553 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5554 + "type": "string", ~/~/ Тип 5555 + "pictureid": "string" ~/~/ Идентификатор ресурса 5556 + } 5557 + ], 5558 + "states": [ ~/~/ Ключевые даты развития поля 5559 + { 5560 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5561 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5562 + } 5563 + ] 5564 + } 5565 + ], 5566 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5567 + "counts": { 5568 + "fieldOperations": 0, ~/~/ Количество операций на поле 5569 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5570 + "facts": 0 ~/~/ Счётчик факта 5571 + }, 5572 + "planComment": "string", ~/~/ Комментарий к полю 5573 + "productivity": 0, ~/~/ Урожайность. 5574 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5575 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5576 + "year": 0, ~/~/ Год поля 5577 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5578 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5579 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5580 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5581 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5582 + "id": 0, ~/~/ Идентификатор объекта геозоны 5583 + "name": "string", ~/~/ Название объекта геозоны 5584 + "type": 0, ~/~/ Тип объекта геозоны 5585 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5586 + "fname": "string", ~/~/ Имя файла 5587 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5588 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5589 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5590 + "description": "string", ~/~/ Описание объекта геозоны 5591 + "area": 0, ~/~/ Площадь, м2 5592 + "perimetr": 0, ~/~/ Периметр, м 5593 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5594 +} 5595 +))) 5596 +))) 5597 +))) 5598 +))) 5599 +))) 5600 + 5601 + 5602 +== **Редактирование года урожая ** == 5603 + 5604 +(% class="box successmessage" %) 5605 +((( 5606 +**POST /api/v3/agroLands/updateOpenCloseYear** 5607 +))) 5608 + 5609 +Пример запроса: 5610 + 5611 +((( 5612 +((( 5613 +{ 5614 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5615 + 0 5616 + ], 5617 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5618 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5619 +} 5620 +))) 5621 + 5622 + 5623 +))) 5624 + 5625 +Пример ответа: 5626 + 5627 +((( 5628 +((( 5629 +{ 5630 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5631 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5632 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5633 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5634 + "cropRotations": [ ~/~/ Данные по севообороту 5635 + { 5636 + "landId": 0, ~/~/ ID поля 5637 + "landName": "string", ~/~/ Название поля 5638 + "year": 0, ~/~/ Год урожая 5639 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5640 + "cultureName": "string", ~/~/ Название культуры 5641 + "productivity": 0, ~/~/ Урожайность 5642 + "area": 0, ~/~/ Площадь поля, Га. 5643 + "total": 0, ~/~/ Валовый сбор 5644 + "productivityFact": 0, ~/~/ Фактическая урожайность 5645 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5646 + "totalFact": 0, ~/~/ Фактический валовый сбор 5647 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5648 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5649 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5650 + "isyearplan": true, ~/~/ 5651 + "comment": "string" ~/~/ Комментарий 5652 + } 5653 + ], 5654 + "cropVegetation": [ ~/~/ История вегетации поля 5655 + { 5656 + "values": [ ~/~/ Данные вегетации и состояния посева 5657 + { 5658 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5659 + "ndvi": 0 ~/~/ Индекс вегетации 5660 + } 5661 + ], 5662 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5663 + { 5664 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5665 + "type": "string", ~/~/ Тип 5666 + "pictureid": "string" ~/~/ Идентификатор ресурса 5667 + } 5668 + ], 5669 + "states": [ ~/~/ Ключевые даты развития поля 5670 + { 5671 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5672 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5673 + } 5674 + ] 5675 + } 5676 + ], 5677 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5678 + "counts": { 5679 + "fieldOperations": 0, ~/~/ Количество операций на поле 5680 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5681 + "facts": 0 ~/~/ Счётчик факта 5682 + }, 5683 + "planComment": "string", ~/~/ Комментарий к полю 5684 + "productivity": 0, ~/~/ Урожайность. 5685 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5686 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5687 + "year": 0, ~/~/ Год поля 5688 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5689 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5690 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5691 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5692 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5693 + "id": 0, ~/~/ Идентификатор объекта геозоны 5694 + "name": "string", ~/~/ Название объекта геозоны 5695 + "type": 0, ~/~/ Тип объекта геозоны 5696 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5697 + "fname": "string", ~/~/ Имя файла 5698 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5699 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5700 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5701 + "description": "string", ~/~/ Описание объекта геозоны 5702 + "area": 0, ~/~/ Площадь, м2 5703 + "perimetr": 0, ~/~/ ериметр, м 5704 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5705 +} 5706 +))) 5707 + 5708 + 5709 +== **Удаление существующего поля** == 5710 + 5711 +(% class="box errormessage" %) 5712 +((( 5713 +**DELETE /api/v3/agroLands/{id}** 5714 +))) 5715 + 5716 +Пример запроса: 5717 +id ~/~/ Идентификатор поля 5718 + 5719 +Пример ответа: 5720 + 5721 +((( 5722 +200 ~/~/ Успех 5723 + 5724 + 5725 +))) 5726 + 5727 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5728 +))) 5729 +))) 5730 +))) 5731 + 5732 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5733 + 5734 + 5735 +(% class="box infomessage" %) 5736 +((( 5737 +**GET api/v3/Vehicles/recyclebin/all** 5738 +))) 5739 + 5740 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5741 + 5742 +Параметр запроса: {parentId} - идентификатор агента 5743 + 5744 +В заголовках запроса: X-Auth: Токен авторизации 5745 + 5746 +Ответ: 5747 + 5748 +[ 5749 + { 5750 + "recordTime": "", ~/~/Время записи 5751 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5752 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5753 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5754 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5755 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5756 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5757 + "items": [ ~/~/ 5758 +nullable: true ~/~/Детали 5759 + { 5760 + "name": "string", ~/~/наименование столбца 5761 + "value": "string" ~/~/содержание столбца 5762 + } 5763 + ] 5764 + }, 5765 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5766 + "string" 5767 + ] 5768 + } 5769 +] 5770 + 5771 + 5772 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5773 + 5774 +(% class="box infomessage" %) 5775 +((( 5776 +**POST api/v3/Vehicles/recyclebin/erase** 5777 +))) 5778 + 5779 +В заголовках запроса: X-Auth: Токен авторизации 5780 + 5781 +Пример запроса: 5782 + 5783 +[ 5784 +0 5785 +] 5786 + 5787 + 5788 +Пример ответа: 5789 + 5790 +[ 5791 +{ 5792 + "recordTime": "", ~/~/Время записи 5793 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5794 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5795 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5796 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5797 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5798 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5799 + "items": [ ~/~/Детали 5800 + { 5801 + "name": "", ~/~/Имя свойства 5802 + "value": "" ~/~/Значение свойства 5803 + } 5804 + ] 5805 + }, 5806 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5807 + "" 5808 + ] 5809 + } 5810 +] 5811 + 5812 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5813 + 5814 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5815 + 5816 +(% class="box infomessage" %) 5817 +((( 5818 +**POST api/v3/Vehicles/recyclebin/restore** 5819 +))) 5820 + 5821 +В заголовках запроса: X-Auth: Токен авторизации 5822 + 5823 +Параметры в теле запроса (JSON): 5824 + 5825 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5826 + 5827 +В заголовках запроса: X-Auth: Токен авторизации 5828 + 5829 + 5830 +Пример запроса: 5831 + 5832 +((( 5833 +[ 5834 +))) 5835 + 5836 +((( 5837 + 0 5838 +))) 5839 + 5840 +((( 5841 +] 5842 +))) 5843 + 5844 + 5845 +Пример ответа: 5846 + 5847 +[ 5848 +{ 5849 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5850 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5852 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5853 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5854 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5855 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5856 + "items": [ ~/~/Детали 5857 + { 5858 + "name": "string", ~/~/Имя свойства 5859 + "value": "string" ~/~/Значение свойства 5860 + } 5861 + ] 5862 + }, 5863 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5864 + "string" 5865 + ] 5866 + } 5867 +] 5868 + 5869 + 5870 += **Раздел: Журнал заданий ** = 5871 + 5872 + 5873 +== **Создание задания в Журнале заданий** == 5874 + 5875 +(% class="box infomessage" %) 5876 +((( 5877 +**POST /api/v3/vehicletasks** 5878 +))) 5879 + 5880 +Пример запроса: 5881 + 5882 +((( 5883 +{ 5884 + "vehicleId": 0, ~/~/ Идентификатор ТС 5885 + "description": "string", ~/~/ Описание 5886 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5887 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5888 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5889 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5890 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5891 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5892 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5893 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5894 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5895 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5896 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5897 + "cost": { 5898 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5899 + "Name": "string", ~/~/ Наименование 5900 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5901 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5902 + "Norm": 0 ~/~/ Норма внесения 5903 + }, 5904 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5905 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5906 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5907 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5908 + "deleted": true, ~/~/ Признак удаления 5909 + "extId": "string", 5910 + "GeoIds": [ ~/~/ Cвязанные поля 5911 + 0 5912 + ] 5913 +} 5914 +))) 5915 + 5916 + 5917 +Пример ответа: 5918 + 5919 +{ 5920 + "vehicleId": 0, ~/~/ Идентификатор ТС 5921 + "description": "string", ~/~/ Описание 5922 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5923 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5924 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5925 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5926 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5927 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5928 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5929 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5930 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5931 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5932 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5933 + "cost": { 5934 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5935 + "Name": "string", ~/~/ Наименование 5936 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5937 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5938 + "Norm": 0 ~/~/ Норма внесения 5939 + }, 5940 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5941 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5942 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5943 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5944 + "deleted": true, ~/~/ Признак удаления 5945 + "extId": "string", ~/~/ ExtId 5946 + "GeoIds": [ ~/~/ Связанные поля 5947 + 0 5948 + ] 5949 +} 5950 + 5951 + 5952 +== **Редактирование задания в Журнале заданий** == 5953 + 5954 +(% class="box successmessage" %) 5955 +((( 5956 +**PUT /api/v3/vehicletasks** 5957 +))) 5958 + 5959 +Пример запроса: 5960 + 5961 +((( 5962 +{ 5963 + "vehicleId": 0, ~/~/ Идентификатор ТС 5964 + "description": "string", ~/~/ Описание 5965 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5966 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5967 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5968 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5969 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5970 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5971 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5972 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5973 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5974 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5975 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5976 + "cost": { 5977 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5978 + "Name": "string", ~/~/ Наименование 5979 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5980 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5981 + "Norm": 0 ~/~/ Норма внесения 5982 + }, 5983 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5984 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5985 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5986 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5987 + "deleted": true, ~/~/ Признак удаления 5988 + "extId": "string", ~/~/ ExtId 5989 + "GeoIds": [ ~/~/ Связанные поля 5990 + 0 5991 + ] 5992 +} 5993 +))) 5994 + 5995 + 5996 +Пример ответа: 5997 + 5998 +{ 5999 + "vehicleId": 0, ~/~/ Идентификатор ТС 6000 + "description": "string", ~/~/ Описание 6001 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6002 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6003 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6004 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6005 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6006 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6007 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6008 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6009 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6010 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6011 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6012 + "cost": { 6013 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6014 + "Name": "string", ~/~/ Наименование 6015 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6016 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6017 + "Norm": 0 ~/~/ Норма внесения 6018 + }, 6019 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6020 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6021 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6022 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6023 + "deleted": true, ~/~/ Признак удаления 6024 + "extId": "string", ~/~/ ExtId 6025 + "GeoIds": [ ~/~/ Связанные поля 6026 + 0 6027 + ] 6028 +} 6029 + 6030 + 6031 +== **Удаление задания в Журнале заданий** == 6032 + 6033 +(% class="box warningmessage" %) 6034 +((( 6035 +**DELETE /api/v3/vehicletasks** 6036 +))) 6037 + 6038 +Пример запроса: 6039 + 6040 +((( 6041 +[ 6042 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6043 +] 6044 +))) 6045 + 6046 +((( 6047 + 6048 +))) 6049 + 6050 +Пример ответа: 6051 + 6052 +{ 6053 + "vehicleId": 0, ~/~/ Идентификатор ТС 6054 + "description": "string", ~/~/ Описание 6055 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6056 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6057 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6058 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6059 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6060 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6061 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6062 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6063 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6064 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6065 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6066 + "cost": { 6067 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6068 + "Name": "string", ~/~/ Наименование 6069 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6070 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6071 + "Norm": 0 ~/~/ Норма внесения 6072 + }, 6073 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6074 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6075 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6076 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6077 + "deleted": true, ~/~/ Признак удаления 6078 + "extId": "string", ~/~/ ExtId 6079 + "GeoIds": [ ~/~/ Связанные поля 6080 + 0 6081 + ] 6082 +} 6083 + 6084 + 6085 +== **Получение списка Журнала заданий** == 6086 + 6087 +(% class="box infomessage" %) 6088 +((( 6089 +**POST /api/v3/vehicletasks/getbyperiod** 6090 +))) 6091 + 6092 +Пример запроса: 6093 + 6094 +((( 6095 +{ 6096 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6097 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6098 + "TimeZone": 0, ~/~/ Часовой пояс. 6099 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6100 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6101 + ], 6102 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6103 + 0 6104 + ], 6105 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6106 + 0 6107 + ], 6108 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6109 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6110 +} 6111 +))) 6112 + 6113 + 6114 +Пример ответа: 6115 + 6116 +((( 6117 +{ 6118 + "total": 0, ~/~/ Общее количество записей 6119 + "pages": 0, ~/~/ Общее количество страниц 6120 + "currentPage": 0, ~/~/ Текущая страница 6121 + "items": [ ~/~/ Записи 6122 + { 6123 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6124 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6125 + "name": "string", ~/~/ Название задания. 6126 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6127 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6128 + "workKind": "string", ~/~/ Вид работ 6129 + "techOp": "string", ~/~/ Тех. операция 6130 + "trailerModel": "string", ~/~/ Модель агрегата 6131 + "width": "string", ~/~/ Ширина, м 6132 + "speed": "string", ~/~/ Тех. скорость 6133 + "fields": "string", ~/~/ Поля 6134 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6135 + "vehicles": "string", ~/~/ Объект-модель 6136 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6137 + "drivers": "string", ~/~/ Водители 6138 + "tmc": "string", ~/~/ ТМЦ 6139 + "client": "string", ~/~/ Клиент 6140 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6141 + "dep": "string", ~/~/ Подразделение 6142 + "geoIds": [ ~/~/ Связанные поля 6143 + 0 6144 + ] 6145 + } 6146 + ] 6147 +} 6148 +))) 6149 + 6150 + 6151 += **Раздел: Роли** = 6152 + 6153 +== **Получение списка клиентских и системных ролей пользователя ** == 6154 + 6155 +(% class="box successmessage" %) 6156 +((( 6157 +**POST /api/v3/groups/find** 6158 +))) 6159 + 6160 +Пример запроса: 6161 + 6162 +((( 6163 +{ 6164 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6165 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6166 +} 6167 +))) 6168 + 6169 +((( 6170 + 6171 +))) 6172 + 6173 +((( 6174 +Пример ответа: 6175 +))) 6176 + 6177 +((( 6178 +((( 6179 +{ 6180 + "groups": [ ~/~/ Системные роли пользователя 6181 + { 6182 + "code": "string", ~/~/ Код роли. 6183 + "name": "string", ~/~/ Имя 6184 + "shortName": "string" ~/~/ Короткое имя 6185 + } 6186 + ], 6187 + "customGroups": [ ~/~/ Системные роли пользователя 6188 + { 6189 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6190 + "name": "string", ~/~/ Наименование 6191 + "shortName": "string", ~/~/ Короткое наименование 6192 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6193 + } 6194 + ] 6195 +} 6196 +))) 6197 +))) 6198 + 6199 +((( 6200 + 6201 +))) 6202 + 6203 +((( 6204 + 6205 +))) 6206 + 6207 += **Раздел: Локатор ** = 6208 + 6209 + 6210 +== **Получение данных по локатору** == 6211 + 6212 +(% class="box infomessage" %) 6213 +((( 6214 +**GET /api/v3/locators/{locatorId}** 6215 +))) 6216 + 6217 +В запросе указывается locatorid - идентификатор локатора 6218 + 6219 + 6220 +Пример ответа: 6221 + 6222 +((( 6223 +((( 6224 +{ 6225 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6226 + 0 6227 + ], 6228 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6229 + 0 6230 + ], 6231 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6232 + 0 6233 + ], 6234 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6235 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6236 + "agentName": "string", ~/~/ Наименование агента. 6237 + "isEnabled": true, ~/~/ Активность 6238 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6239 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6240 + "name": "string", ~/~/ Наименование. 6241 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6242 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6243 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6244 + "validity": 0, ~/~/ Значение срока действия 6245 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6246 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6247 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6248 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6249 + "url": "string", ~/~/ Ссылка 6250 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6251 + 6252 + "showVehicleName": true, ~/~/ Наименование объекта 6253 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6254 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6255 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6256 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6257 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6258 + 6259 + 1 6260 + 6261 + ] 6262 +} 6263 +))) 6264 +))) 6265 + 6266 + 6267 +((( 6268 +((( 6269 + 6270 +))) 6271 +))) 6272 + 6273 + 6274 +== **Создание локатора** == 6275 + 6276 +(% class="box successmessage" %) 6277 +((( 6278 +**POST /api/v3/locators** 6279 +))) 6280 + 6281 +Пример запроса: 6282 + 6283 +((( 6284 +{ 6285 + "isEnabled": true, ~/~/ Активность 6286 + "name": "string", ~/~/ Наименование локатора 6287 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6288 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6289 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6290 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6291 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6292 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6293 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6294 + 0 6295 + ], 6296 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6297 + 0 6298 + ], 6299 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6300 + 0 6301 + ], 6302 + 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6305 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6306 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6307 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6308 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6309 + 6310 + 1 6311 + 6312 + ] 6313 +} 6314 +))) 6315 + 6316 + 6317 +Пример ответа: 6318 + 6319 +((( 6320 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6321 +))) 6322 + 6323 + 6324 +== **Выводит список локаторов ** == 6325 + 6326 +(% class="box successmessage" %) 6327 +((( 6328 +**POST /api/v3/locators/find** 6329 +))) 6330 + 6331 +Пример запроса: 6332 + 6333 +((( 6334 +{ 6335 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6336 +} 6337 +))) 6338 + 6339 +((( 6340 + 6341 +))) 6342 + 6343 +((( 6344 + 6345 +))) 6346 + 6347 + 6348 +Пример ответа: 6349 + 6350 +((( 6351 +[ 6352 + { 6353 + "vehiclesCount": 0, ~/~/ Количество объектов. 6354 + "geozonesCount": 0, ~/~/ Количество геозон. 6355 + "fieldsCount": 0, ~/~/ Количество полей. 6356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6357 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6358 + "agentName": "string", ~/~/ Наименование агента. 6359 + "isEnabled": true, ~/~/ Активность локатора 6360 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6361 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6362 + "name": "string", ~/~/ Наименование локатора 6363 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6364 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6365 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6366 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6367 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6368 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6369 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6370 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6371 + "url": "string", ~/~/ ссылка на локатор 6372 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6373 + "showVehicleName": true, ~/~/ Наименование объекта 6374 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6375 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6376 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6377 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6378 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6379 + 6380 + 0 6381 + ] 6382 + } 6383 +] 6384 +))) 6385 + 6386 + 6387 + 6388 +== **Изменение локатора** == 6389 + 6390 +(% class="box infomessage" %) 6391 +((( 6392 +**PUT /api/v3/locators** 6393 +))) 6394 + 6395 +Пример запроса: 6396 + 6397 +((( 6398 +{ 6399 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6400 + "isEnabled": true, ~/~/ Активность 6401 + "name": "string", ~/~/ Наименование 6402 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6403 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6404 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6405 + "autoProlongation": true, ~/~/ Автопродление срока действия 6406 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6407 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6408 + 0 6409 + ], 6410 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6411 + 0 6412 + ], 6413 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6414 + 0 6415 + ], 6416 + "showVehicleName": true, ~/~/ Наименование объекта 6417 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6418 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6419 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6420 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6421 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6422 + 6423 + 0 6424 + 6425 + ] 6426 +} 6427 + 6428 + 6429 +))) 6430 + 6431 +Пример ответа: 6432 + 6433 +200 ~/~/ Success 6434 + 6435 + 6436 +== **Удалить локатор** == 6437 + 6438 +(% class="box warningmessage" %) 6439 +((( 6440 +**DELETE /api/v3/locators** 6441 +))) 6442 + 6443 +Пример запроса: 6444 + 6445 +((( 6446 +[ 6447 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6448 +] 6449 +))) 6450 + 6451 + 6452 + 6453 += **Раздел: Яндекс Маршруты** = 6454 + 6455 + 6456 +== **Возвращение списка маршрутов** == 6457 + 6458 +(% class="box infomessage" %) 6459 +((( 6460 +**GET /api/v3/TransportRoutes** 6461 +))) 6462 + 6463 +Пример запроса: 6464 +Id ~/~/ Идентификатор поля 6465 + 6466 + 6467 +Пример ответа: 6468 + 6469 +((( 6470 +[ 6471 + { 6472 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6473 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6474 + "name": "string", ~/~/ Наименование маршрута. 6475 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6476 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6477 + 0 6478 + ] 6479 + } 6480 +] 6481 +))) 6482 + 6483 + 6484 + 6485 +== **Добавить маршрут** == 6486 + 6487 +(% class="box infomessage" %) 6488 +((( 6489 +**POST /api/v3/TransportRoutes** 6490 +))) 6491 + 6492 +Пример запроса: 6493 +{ 6494 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6495 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6496 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6497 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6498 + 0 6499 + ] 6500 +} 6501 + 6502 + 6503 +Пример ответа: 6504 + 6505 +((( 6506 +{ 6507 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6508 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6509 + "name": "string", ~/~/ Определяет наименование маршрута 6510 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6511 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6512 + 0 6513 + ] 6514 +} 6515 +))) 6516 + 6517 + 6518 +== **Обновление маршрута** == 6519 + 6520 +(% class="box successmessage" %) 6521 +((( 6522 +**PUT /api/v3/TransportRoutes** 6523 +))) 6524 + 6525 +Пример запроса: 6526 + 6527 +((( 6528 +{ 6529 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6530 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6531 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6532 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6533 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6534 + 0 6535 + ] 6536 +} 6537 +))) 6538 + 6539 + 6540 +Пример ответа: 6541 + 6542 +((( 6543 +{ 6544 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6545 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6546 + "name": "string", ~/~/ Определяет наименование маршрута 6547 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6548 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6549 + 0 6550 + ] 6551 +} 6552 +))) 6553 + 6554 + 6555 +== **Получить связки маршрутов ТС** == 6556 + 6557 +(% class="box infomessage" %) 6558 +((( 6559 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6560 +))) 6561 + 6562 +Пример запроса: 6563 + 6564 +((( 6565 +[ 6566 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6567 +] 6568 +))) 6569 + 6570 + 6571 +Пример ответа: 6572 + 6573 +((( 6574 +[ 6575 + { 6576 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6577 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6578 + } 6579 +] 6580 +))) 6581 + 6582 + 6583 +== **Удалить маршрут** == 6584 + 6585 +(% class="box warningmessage" %) 6586 +((( 6587 +**DELETE /api/v3/TransportRoutes/{id}** 6588 +))) 6589 + 6590 +Пример запроса: 6591 +Id ~/~/ Идентификатор поля 6592 + 6593 + 6594 + 6595 += **Раздел: Управление доступа к машинам** = 6596 + 6597 + 6598 +== Получение списка транспортных средств видимых пользователю == 6599 + 6600 +(% class="box infomessage" %) 6601 +((( 6602 +**GET /api/v3/UserVisibleVehicles/{userId}** 6603 +))) 6604 + 6605 +Пример ответа: 6606 + 6607 +((( 6608 +{ 6609 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6610 + 0 6611 + ] 6612 +} 6613 +))) 6614 + 6615 + 6616 + 6617 +== Задает видимость транспортных средств пользователю == 6618 + 6619 +(% class="box infomessage" %) 6620 +((( 6621 +**POST /api/v3/UserVisibleVehicles** 6622 +))) 6623 + 6624 +Пример запроса: 6625 + 6626 +((( 6627 +((( 6628 +{ 6629 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6630 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6631 + 0 6632 + ] 6633 +} 6634 +))) 6635 + 6636 +((( 6637 + 6638 +))) 6639 + 6640 +((( 6641 + 6642 +))) 6643 + 6644 +((( 6645 +Пример ответа : 6646 +))) 6647 + 6648 +((( 6649 + 6650 +))) 6651 + 6652 +((( 6653 +200 ~/~/ Success 6654 +))) 6655 +))) 6656 + 6657 + 6658 +== == 6659 + 6660 + 6661 + 6662 + 3854 3854 (% class="box" lang="en-US" style="text-align: center;" %) 3855 3855 ((( 3856 3856 (% 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]] **