Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/16 11:13
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 { ... ... @@ -253,28 +253,6 @@ 253 253 "bankKS": "string" ~/~/ корр. счёт 254 254 } 255 255 256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 277 - 278 278 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 279 279 280 280 (% class="box warningmessage" %) ... ... @@ -356,6 +356,21 @@ 356 356 357 357 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 358 358 371 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 372 + 373 +(% class="box warningmessage" %) 374 +((( 375 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 376 +))) 377 + 378 +Метод позволяет изменить статус клиента, указанного в запросе. 379 + 380 +В пути указывается GUID клиента и статус клиента. 381 + 382 +**status **- значение 0 - заблокирован, 1 - активен. 383 + 384 +Ответ: Code 204 385 + 359 359 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 360 360 361 361 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -405,9 +405,8 @@ 405 405 [ 406 406 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 407 407 ], 408 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 409 409 } 410 - 411 411 { 412 412 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 413 413 "lastName": "string", ... ... @@ -421,12 +421,8 @@ 421 421 422 422 (% style="text-align:left" %) 423 423 (% style="color:#000000; font-weight:normal" %)Ответ: 424 - 425 -(% style="text-align:left" %) 426 -(% style="color:#000000; font-weight:normal" %){ 427 - 428 -(% style="text-align:left" %) 429 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 450 +{ 451 + "id": "" , ~/~/ ID пользователя 430 430 "lastName": "" , ~/~/ Фамилия , 431 431 "firstName": "" , ~/~/ Имя 432 432 "position": "" , ~/~/ Должность ... ... @@ -443,11 +443,9 @@ 443 443 "kind": "" , ~/~/ тип аутентификации 444 444 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 445 445 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 468 +} 446 446 447 -(% style="text-align:left" %) 448 -(% style="color:#000000; font-weight:normal" %)} 449 449 450 - 451 451 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 452 452 453 453 (% class="box infomessage" %) ... ... @@ -467,19 +467,16 @@ 467 467 468 468 (% style="color:#000000" %)Параметры в теле запроса (JSON): 469 469 470 -(% style="color:#000000" %){ 471 - 490 +(% style="color:#000000" %){(%%) 472 472 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 473 473 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 474 474 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 475 475 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 476 - 477 477 (% style="color:#000000" %)} 478 478 479 479 (% style="color:#000000" %)Ответ: 480 480 481 481 (% style="color:#000000" %){ (%%) 482 - 483 483 "id": "" , ~/~/ идентификатор пользователя 484 484 "lastName": "" , ~/~/ фамилия 485 485 "firstName": "" , ~/~/ имя ... ... @@ -493,7 +493,6 @@ 493 493 "sessionDuration":"", ~/~/ длительность сессии в минутах 494 494 "status": "1", ~/~/ статус пользователя 495 495 "lastLogged": "", ~/~/ дата/время последней авторизации 496 - 497 497 (% style="color:#000000" %)} 498 498 499 499 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -567,10 +567,8 @@ 567 567 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 568 569 569 (% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - 572 -(% lang="en-US" style="text-align:left" %) 573 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 + "id": "" , ~/~/ ID пользователя 574 574 "lastName": "" , ~/~/ фамилия 575 575 "firstName": "" , ~/~/ имя 576 576 "position": "" , ~/~/ должность ... ... @@ -592,9 +592,7 @@ 592 592 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 593 593 }, 594 594 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 595 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 596 - 597 -(% lang="en-US" style="text-align:left" %) 609 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 598 598 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 599 599 600 600 (% lang="en-US" style="text-align:left" %) ... ... @@ -601,10 +601,8 @@ 601 601 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 602 602 603 603 (% lang="en-US" style="text-align:left" %) 604 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 605 - 606 -(% lang="en-US" style="text-align:left" %) 607 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 616 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 617 + "id": "" , ~/~/ идентификатор пользователя 608 608 "lastName": "" , ~/~/ фамилия 609 609 "firstName": "" , ~/~/ имя 610 610 "position": "" , ~/~/ должность ... ... @@ -625,10 +625,8 @@ 625 625 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 626 626 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 627 627 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 638 +} 628 628 629 -(% lang="en-US" style="text-align:left" %) 630 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 631 - 632 632 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 633 633 634 634 (% class="box warningmessage" %) ... ... @@ -648,12 +648,10 @@ 648 648 649 649 (% style="color:#000000" %)Параметры в теле запроса (JSON): 650 650 651 -(% style="color:#000000" %){ 652 - 659 +(% style="color:#000000" %){(%%) 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 656 - 657 657 (% style="color:#000000" %)} 658 658 659 659 (% style="text-align:left" %) ... ... @@ -675,7 +675,7 @@ 675 675 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 676 676 677 677 [ 678 - 684 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 679 679 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 680 680 ] 681 681 ... ... @@ -738,6 +738,11 @@ 738 738 (% style="text-align:left" %) 739 739 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 740 740 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 751 + 741 741 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 742 742 743 743 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -849,7 +849,7 @@ 849 849 { 850 850 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 851 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 852 - "deleted": true,863 + "deleted": false, 853 853 "extId": "string", 854 854 "name": "string", 855 855 "picture": "string", ... ... @@ -868,7 +868,7 @@ 868 868 { 869 869 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 870 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 871 - "deleted": true,882 + "deleted": false, 872 872 "extId": "string", 873 873 "name": "string", 874 874 "picture": "string", ... ... @@ -902,7 +902,7 @@ 902 902 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 903 903 ))) 904 904 905 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 906 906 907 907 (% style="color:#000000" %)Метод запроса: **PUT** 908 908 ... ... @@ -969,7 +969,7 @@ 969 969 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 970 970 ))) 971 971 972 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 973 973 974 974 (% style="color:#000000" %)Метод запроса: **DELETE** 975 975 ... ... @@ -981,7 +981,7 @@ 981 981 982 982 Ответ: В случае успеха **Success 200** 983 983 984 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 985 985 986 986 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 987 987 ... ... @@ -1010,6 +1010,17 @@ 1010 1010 1011 1011 ((( 1012 1012 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 1013 1013 "vehicleId": "", ~/~/ ID объекта 1014 1014 "name": "", ~/~/ Имя объекта 1015 1015 "imei": "", ~/~/ IMEI объекта ... ... @@ -1017,19 +1017,15 @@ 1017 1017 "deviceTypeName": "", ~/~/ Название типа устройства 1018 1018 "sim1": "", ~/~/ Номер SIM1 1019 1019 "sim2": "", ~/~/ Номер SIM2 1020 - 1021 1021 "parentId": "", ~/~/ ID клиента-родителя 1022 1022 "parentName": "", ~/~/ Наименование клиента-родителя 1023 1023 "modelId": "", ~/~/ ID модели объекта 1024 1024 "modelName": "", ~/~/ Имя модели объекта 1025 - 1026 1026 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1027 1027 "unitName": "string", ~/~/ Наименование подразделения 1028 1028 "status": 0, ~/~/ Статус объекта 1029 - 1030 1030 "createdAt": "", ~/~/ Дата создания объекта 1031 1031 }, 1032 - 1033 1033 "customFields": [ ~/~/ Произвольные поля 1034 1034 { 1035 1035 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1052,8 +1052,7 @@ 1052 1052 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1053 1053 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1054 1054 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1055 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1056 - 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1057 1057 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1058 1058 "mileageCoeff": 0, ~/~/ коэффициент пробега 1059 1059 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1083,7 +1083,6 @@ 1083 1083 "retries": 0 ~/~/ Количество попыток 1084 1084 } 1085 1085 ], 1086 - 1087 1087 "sensors": [ ~/~/ Датчики 1088 1088 { 1089 1089 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1110,6 +1110,7 @@ 1110 1110 ], 1111 1111 "showInTooltip": true, ~/~/ Отображать в подсказке 1112 1112 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 1113 1113 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1114 1114 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1115 1115 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1124,31 +1124,19 @@ 1124 1124 }, 1125 1125 1126 1126 ~/~/ Характерные для произвольного: 1127 - 1128 1128 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1129 - 1130 1130 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1131 - 1132 1132 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1133 - 1134 1134 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1135 - 1136 1136 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1137 - 1138 1138 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1139 - 1140 1140 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1141 - 1142 1142 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1143 - 1144 1144 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1145 - 1146 1146 ~/~/ "ValueOn": "Вкл.", 1147 - 1148 1148 ~/~/ "ValueOff": "Выкл." 1149 1149 "summaryMaxValue": 0 ~/~/ Макс. значение 1150 1150 } 1151 - 1152 1152 "drivers": [ ~/~/ Водители 1153 1153 { 1154 1154 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1157,7 +1157,6 @@ 1157 1157 "isDefault": true ~/~/ По умолчанию 1158 1158 } 1159 1159 ], 1160 - 1161 1161 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1162 1162 { 1163 1163 "id": "", ~/~/ ID задания ... ... @@ -1174,19 +1174,27 @@ 1174 1174 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1175 1175 } 1176 1176 ], 1177 - 1178 - "statusHistory": [ ~/~/ История статусов 1181 +"statusHistory": [ ~/~/ История статусов 1179 1179 { 1180 1180 "status": 0, 1181 1181 "date": "2023-05-22T09:57:39.562Z", 1182 1182 "description": "string", 1183 1183 "additionalInfo": "string" 1184 - } 1185 - ] 1186 1186 1188 +((( 1187 1187 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1188 1188 ))) 1189 1189 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 1190 1190 (% style="text-align:left" %) 1191 1191 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1192 1192 ... ... @@ -1193,6 +1193,75 @@ 1193 1193 (% style="text-align:left" %) 1194 1194 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1195 1195 1208 + 1209 +== **Отправить команду на терминал** == 1210 + 1211 +(% class="box successmessage" %) 1212 +((( 1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1214 +))) 1215 + 1216 +Команда для отправки на тс. 1217 + 1218 +{ 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1223 +} 1224 + 1225 +В ответ получаем cmdid 1226 + 1227 + 1228 +== **Получить ответ на отправленную на ТС команду** == 1229 + 1230 +(% class="box infomessage" %) 1231 +((( 1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1233 +))) 1234 + 1235 +Идентификатор команды: cmdId 1236 + 1237 +Запрос от терминала на ответ команды 1238 + 1239 +Пример ответ от терминала: 1240 + 1241 +ID= "" ~/~/ идентификатор объекта 1242 +Soft="" ~/~/ версия софта 1243 +GPS=4 ~/~/ тип трекера 1244 +Time=11:05:43 28.06.24 ~/~/ время запроса 1245 +Lat=45.056221 ~/~/ широта 1246 +Lon=39.035938 ~/~/ долгота 1247 +Speed=0.0 ~/~/ скорость 1248 +Course=181.4 ~/~/направление 1249 + 1250 +((( 1251 +== **Список отправленных объекту команд с ответами** == 1252 + 1253 +(% class="box infomessage" %) 1254 +((( 1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1256 +))) 1257 + 1258 +Идентификатор ТС: vehicleId 1259 + 1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1261 + 1262 +Пример ответа терминала 1263 + 1264 +[ 1265 +{ 1266 +"id": "", ~/~/ идентификатор пользователя 1267 +"commandText": "", ~/~/Текст команды. 1268 +"templateId": "", ~/~/Идентификатор шаблона 1269 +"updated": "", ~/~/ Время отправки 1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1271 +"answer": "", ~/~/ Ответ терминала. 1272 +"status": "" ~/~/ Статус отправки 1273 +} 1274 +] 1275 +))) 1276 + 1196 1196 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1197 1197 1198 1198 (% class="box successmessage" %) ... ... @@ -1212,6 +1212,11 @@ 1212 1212 1213 1213 (% style="color:#000000" %){ 1214 1214 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 1215 1215 "parentId": "" , ~/~/ ID клиента 1216 1216 "name": "" , ~/~/ имя ТС 1217 1217 "imei": "" , ~/~/ IMEI ... ... @@ -1232,7 +1232,6 @@ 1232 1232 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1233 1233 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1234 1234 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1235 - 1236 1236 "mileageCalcMethod": 0, 1237 1237 "mileageCoeff": 0, 1238 1238 "locationByCellId": true, ... ... @@ -1265,7 +1265,6 @@ 1265 1265 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1266 1266 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1267 1267 } 1268 - 1269 1269 "drivers": [ ~/~/ Водители 1270 1270 { 1271 1271 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1280,8 +1280,7 @@ 1280 1280 "retries": 0 1281 1281 } 1282 1282 ], 1283 - 1284 - "sensors": [ ~/~/ Датчики 1367 +"sensors": [ ~/~/ Датчики 1285 1285 { 1286 1286 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1287 1287 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1307,6 +1307,7 @@ 1307 1307 ], 1308 1308 "showInTooltip": true, ~/~/ Отображать в подсказке 1309 1309 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1310 1310 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1311 1311 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1312 1312 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1319,103 +1319,222 @@ 1319 1319 "additionalProp2": "string", 1320 1320 "additionalProp3": "string" 1321 1321 }, 1322 - 1323 1323 ~/~/ Характерные для произвольного: 1324 - 1325 1325 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1326 - 1327 1327 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1328 - 1329 1329 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1330 - 1331 1331 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1332 - 1333 1333 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1334 - 1335 1335 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1336 - 1337 1337 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1338 - 1339 1339 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1340 - 1341 1341 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1342 - 1343 1343 ~/~/ "ValueOn": "Вкл.", 1344 - 1345 1345 ~/~/ "ValueOff": "Выкл." 1346 - "summaryMaxValue": 0 ~/~/ Макс. значение 1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1419 + 1420 +((( 1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1422 + { 1423 + "from": 0, ~/~/ С какого значения 1424 + "color": "string", ~/~/ Каким цветом 1425 + "text": "string" ~/~/ Текст подписи к этому интервалу 1426 + } 1427 + ] 1347 1347 } 1348 1348 ], 1430 +))) 1431 + 1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1433 + 1434 + 1349 1349 "customFields": [ ~/~/ Произвольные поля 1350 1350 { 1351 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1352 - "name": "string", 1353 - "value": "string", 1354 - "forClient": true, 1355 - "forTooltip": true, 1356 - "forReport": true 1357 - } 1358 - ] 1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1438 + "name": "string", ~/~/ Наименование произвольного поля 1439 + "value": "string", ~/~/ Значение произвольного поля 1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1359 1359 } 1453 +))) 1360 1360 1455 + 1361 1361 (% style="color:#000000" %)Ответ: 1362 1362 1363 -(% style="color:#000000" %){ 1364 1364 1365 - "vehicleId": "", ~/~/ID ТС 1366 - "parentId": "", ~/~/Guid владельца ТС 1367 - "name": "", ~/~/Имя объекта 1368 - "imei": "", ~/~/IMEI 1369 - "deviceTypeId": "", ~/~/ID типа устройства 1370 - "modelId": "", ~/~/ID модели 1371 - "unitId": "", ~/~/ID подразделения 1372 - "sim1": "", ~/~/SIM1 1373 - "sim2": "", ~/~/SIM2 1374 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1375 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1376 - "counters": { ~/~/Счётчики 1377 - "mileageEnabled": true, 1378 - "motohoursEnabled": true, 1379 - "mileage": "", 1380 - "motohours": 345.0 1381 - }, 1382 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1383 - "id": null, 1384 - "enabled": true, ~/~/флаг включения 1385 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1386 - "login": "", ~/~/ имя учетной записи 1387 - "password": "" ~/~/ пароль учетной записи 1388 - }, 1389 - "inspectionTasks": { ~/~/ задания на ТО 1390 - "id": "", ~/~/ ID задачи 1391 - "enabled": false, ~/~/ Признак включения 1392 - "name": "", ~/~/ Имя задания 1393 - "description": "", ~/~/ Описание задания 1394 - "mileageCondition": "", ~/~/ Условие по пробегу 1395 - "lastMileage": "", ~/~/ Пробег (в метрах) 1396 - "motohoursCondition": "", ~/~/ Условие по моточасам 1397 - "lastMotohours": "", ~/~/ Моточасы 1398 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1399 - "kind": "", ~/~/ Вид периодичности по времени 1400 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1459 +((( 1460 +((( 1461 +((( 1462 +{ 1463 + "vehicleId": 0, ~/~/ ID ТС 1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1465 + "name": "string", ~/~/ Имя объекта 1466 + "imei": "string", ~/~/ IMEI 1467 + "deviceTypeId": 0, ~/~/ ID типа устройства 1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1470 + "sim1": "string", ~/~/ SIM1 1471 + "sim2": "string", ~/~/ SIM2 1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1474 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1489 + "counters": { ~/~/ Dto для состояний счётчиков 1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1492 + "mileage": 0, ~/~/ Пробег 1493 + "motohours": 0 ~/~/ Моточасы 1494 + }, 1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1496 + "id": "string", ~/~/ CMSV6 Идентификатор 1497 + "enabled": true, ~/~/ Признак включения 1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1499 + "login": "string", ~/~/ CMSV6 имя учетной записи 1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1501 + }, 1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1503 + { 1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1505 + "enabled": true, ~/~/ Признак включения 1506 + "name": "string", ~/~/ Имя задания 1507 + "description": "string", ~/~/ Описание задания 1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1401 1401 } 1517 + ], 1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1519 + { 1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1521 + "inputNumber": 0, ~/~/ № входа. 1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1523 + "comment": "string", ~/~/ Комментарий 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1528 + } 1529 + ], 1530 + "commandTemplates": [ ~/~/ Список шаблонов команд 1531 + { 1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1533 + "name": "string", ~/~/ Название шаблона команд 1534 + "command": "string", ~/~/ Команда на выполнение 1535 + "retries": 0 ~/~/ Лимит попыток отправки 1536 + } 1537 + ], 1538 + "sensors": [ ~/~/ Список датчиков 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1542 + "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 1543 + "name": "string", ~/~/ Имя датчика 1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1545 + "inputNumber": 0, ~/~/ Номер входа 1546 + "pseudonym": "string", ~/~/ Псевдоним 1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1548 + "isInverted": true, ~/~/ Признак инверсии 1549 + "disabled": true, ~/~/ Датчик не участвует в обработке 1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1551 + "gradesTables": [ ~/~/ Тарировка 1552 + { 1553 + "grades": [ ~/~/ Таблицы тарировки 1554 + { 1555 + "input": 0, ~/~/ Вход 1556 + "output": 0 ~/~/ Выход 1557 + } 1558 + ], 1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1560 + } 1561 + ], 1562 + "showInTooltip": true, ~/~/ Отображение в подсказке 1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1567 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1568 + "expr": "string", ~/~/ Выражение 1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1570 + "string" 1571 + ], 1572 + "customParams": { 1573 + "additionalProp1": "string", 1574 + "additionalProp2": "string", 1575 + "additionalProp3": "string" 1576 + }, 1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1578 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1579 + { 1580 + "from": 0, ~/~/ С какого значения 1581 + "color": "string", ~/~/ Каким цветом 1582 +))) 1402 1402 1403 -(% style="text-align:left" %) 1404 -(% style="color:#000000" %)} 1584 +((( 1585 + "text": "string" ~/~/ Текст подписи к этому интервалу 1586 + } 1587 + ] 1588 + } 1589 + ], 1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1591 + "customFields": [ ~/~/ Список произвольных полей 1592 + { 1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1594 + "name": "string", ~/~/ Наименование произвольного поля 1595 + "value": "string", ~/~/ Значение произвольного поля 1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1599 + } 1600 + ], 1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1602 +} 1603 +))) 1604 +))) 1605 +))) 1405 1405 1607 + 1406 1406 **Валидация:** 1407 1407 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1408 1408 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1409 1409 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1410 1410 1411 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1412 1412 1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1615 + 1413 1413 (% class="box infomessage" %) 1414 1414 ((( 1415 1415 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 1416 ))) 1417 1417 1418 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1621 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1419 1419 1420 1420 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1421 1421 ... ... @@ -1449,9 +1449,12 @@ 1449 1449 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1450 1450 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1451 1451 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1452 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1453 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1454 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1655 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1656 + "unitName": "string", ~/~/ Название подразделения (опционально) 1657 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1658 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1659 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1455 1455 } 1456 1456 1457 1457 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1458,8 +1458,14 @@ 1458 1458 1459 1459 (% style="color:#000000" %)Ответ: 1460 1460 1461 -(% style="color:#000000" %){ 1667 +(% style="color:#000000" %)[ 1668 +{ 1462 1462 1670 +((( 1671 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1672 +))) 1673 + 1674 +((( 1463 1463 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1464 1464 "name": "" ~/~/ наименование объекта 1465 1465 "imei": "" ~/~/ IMEI объекта ... ... @@ -1485,9 +1485,21 @@ 1485 1485 "forClient": true, ~/~/ право на отображение у клиента 1486 1486 "forTooltip": false, ~/~/ право на отображение в подсказке 1487 1487 "forReport": false ~/~/ право на отображение в отчетах 1488 - }(%%) 1489 -(% style="color:#000000" %)} 1700 +))) 1490 1490 1702 +((( 1703 + } 1704 + ], 1705 + "vehicleGroups": [ ~/~/ Группы ТС 1706 + { 1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1708 + "name": "string" ~/~/ Наименование группы ТС 1709 + } 1710 + ] 1711 + } 1712 +] 1713 +))) 1714 + 1491 1491 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1492 1492 1493 1493 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1519,13 +1519,11 @@ 1519 1519 "data": "", ~/~/ Данные 1520 1520 "overwrite": false, ~/~/ Флаг перезаписи 1521 1521 "stage": "", ~/~/ Состояние, может быть null 1522 - 1523 1523 (% style="color:#000000" %)} 1524 1524 1525 1525 (% style="color:#000000" %)Ответ: 1526 1526 1527 -(% style="color:#000000" %){ 1528 - 1750 +(% style="color:#000000" %){(%%) 1529 1529 "status": "", ~/~/ значение статуса 1530 1530 "date": "", ~/~/ Дата смены статуса 1531 1531 "description": "", ~/~/ Описание ... ... @@ -1532,10 +1532,9 @@ 1532 1532 "data": "", ~/~/ Данные 1533 1533 "overwrite": false, ~/~/ Флаг перезаписи 1534 1534 "stage": "", ~/~/ Состояние 1535 - 1536 -(% style="text-align:left" %) 1537 1537 (% style="color:#000000" %) } 1538 1538 1759 + 1539 1539 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1540 1540 1541 1541 (% class="box warningmessage" %) ... ... @@ -1611,9 +1611,19 @@ 1611 1611 1612 1612 "drivers": [ ~/~/ Водители 1613 1613 { 1614 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1615 - "isDefault": true 1616 - } 1835 + 1836 +((( 1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1838 + "inputNumber": 0, ~/~/ № входа. 1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1840 + "comment": "string", ~/~/ Комментарий. 1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1845 +))) 1846 + 1847 + } 1617 1617 ], 1618 1618 "commandTemplates": [ ~/~/ Шаблон команды 1619 1619 { ... ... @@ -1623,8 +1623,7 @@ 1623 1623 "retries": 0 1624 1624 } 1625 1625 ], 1626 - 1627 - "sensors": [ ~/~/ Датчики 1857 +"sensors": [ ~/~/ Датчики 1628 1628 { 1629 1629 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1630 1630 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1650,6 +1650,11 @@ 1650 1650 ], 1651 1651 "showInTooltip": true, ~/~/ Отображать в подсказке 1652 1652 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1883 + 1884 +((( 1885 + "color": "string",** ~/~/ **Цвет датчика 1886 +))) 1887 + 1653 1653 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1654 1654 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1655 1655 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1662,95 +1662,225 @@ 1662 1662 "additionalProp2": "string", 1663 1663 "additionalProp3": "string" 1664 1664 }, 1665 - 1666 1666 ~/~/ Характерные для произвольного: 1667 - 1668 1668 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1669 - 1670 1670 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1671 - 1672 1672 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1673 - 1674 1674 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1675 - 1676 1676 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1677 - 1678 1678 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1679 - 1680 1680 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1681 - 1682 1682 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1683 - 1684 1684 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1685 - 1686 1686 ~/~/ "ValueOn": "Вкл.", 1687 - 1688 1688 ~/~/ "ValueOff": "Выкл." 1689 1689 "summaryMaxValue": 0 ~/~/ Макс. значение 1913 + 1914 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1915 + { 1916 + "from": 0, ~/~/ С какого значения 1917 + "color": "string", ~/~/ Каким цветом 1918 + "text": "string" ~/~/ Текст подписи к этому интервалу 1919 + } 1920 + ] 1690 1690 } 1691 1691 ], 1923 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1924 + 1692 1692 "customFields": [ ~/~/ Произвольные поля 1693 - { 1694 - 1695 - "name": "string", 1696 - "value": "string", 1697 - "forClient": true, 1698 - "forTooltip": true, 1699 - "forReport": true 1926 + { 1927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1928 + "name": "string", ~/~/ Наименование произвольного поля 1929 + "value": "string", ~/~/ Значение произвольного поля 1930 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1931 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1932 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1700 1700 } 1701 - ] 1934 + 1935 +((( 1936 + ], 1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1938 +))) 1939 + 1702 1702 } 1703 1703 1942 + 1704 1704 (% style="color:#000000" %)Ответ: 1705 1705 1706 -(% lang="en-US" style="text-align:left" %) 1707 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1945 +((( 1946 +{ 1947 + "vehicleId": 0, ~/~/ ID ТС 1948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1949 + "name": "string", ~/~/ Имя объекта 1950 + "imei": "string", ~/~/ IMEI 1951 + "deviceTypeId": 0, ~/~/ ID типа устройства 1952 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1954 + "sim1": "string", ~/~/ SIM1 1955 + "sim2": "string", ~/~/ SIM2 1956 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1957 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1958 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1959 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1960 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1961 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1962 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1963 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1964 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1965 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1966 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1967 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1968 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1969 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1970 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1971 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1972 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1973 + "counters": { ~/~/ состояний счётчиков 1974 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1975 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1976 + "mileage": 0, ~/~/ Пробег 1977 + "motohours": 0 ~/~/ Моточасы 1978 + }, 1979 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1980 + "id": "string", ~/~/ CMSV6 Идентификатор 1981 + "enabled": true, ~/~/ Признак включения 1982 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1983 +))) 1708 1708 1709 -(% lang="en-US" style="text-align:left" %) 1710 - "vehicleId": "", ~/~/ ID ТС 1711 - "parentId": "", ~/~/ ID клиента 1712 - "name": "", ~/~/ имя ТС 1713 - "imei": "", ~/~/ IMEI 1714 - "deviceTypeId": "", ~/~/ типа устройства 1715 - "modelId": "", ~/~/ ID модели 1716 - "unitId": "", ~/~/ ID подразделения 1717 - "sim1": "", ~/~/ SIM 1 1718 - "sim2": "", ~/~/ SIM2 1719 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1720 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1721 - "counters": 1722 - { 1723 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1724 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1725 - "mileage": "", ~/~/ пробег 1726 - "motohours": "", ~/~/ моточасы 1727 - } 1728 - "cmsv6Parameters": ~/~/ параметры CMSv6 1985 + 1986 +((( 1987 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1988 + "login": "string", ~/~/ CMSV6 имя учетной записи 1989 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1990 + }, 1991 + "inspectionTasks": [ ~/~/ Задания на ТО 1992 + { 1993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1994 + "enabled": true, ~/~/ Признак включения 1995 + "name": "string", ~/~/ Имя задания 1996 + "description": "string", ~/~/ Описание задания 1997 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1998 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1999 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2000 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2001 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2002 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2003 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2004 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2005 + } 2006 + ], 2007 + "drivers": [ ~/~/ Список водителей 2008 + { 2009 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2010 + "inputNumber": 0, ~/~/ № входа. 2011 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2012 + "comment": "string", ~/~/ Комментарий. 2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2014 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2015 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2016 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2017 + } 2018 + ], 2019 + "commandTemplates": [ ~/~/ Список шаблонов команд 2020 + { 2021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2022 + "name": "string", ~/~/ Название шаблона команд 2023 + "command": "string", ~/~/ Команда на выполнение 2024 + "retries": 0 ~/~/ Лимит попыток отправки 2025 + } 2026 + ], 2027 + "sensors": [ ~/~/ Список датчиков 2028 + { 2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2030 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2031 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2032 +))) 2033 + 2034 +((( 2035 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2036 +))) 2037 + 2038 +((( 2039 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2040 +))) 2041 + 2042 +((( 2043 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2044 +))) 2045 + 2046 +((( 2047 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2048 +))) 2049 + 2050 +((( 2051 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2052 + "name": "string", ~/~/ Имя датчика 2053 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2058 + "inputNumber": 0, ~/~/ Номер входа 2059 + "pseudonym": "string", ~/~/ Псевдоним 2060 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2061 + "isInverted": true, ~/~/ Признак инверсии 2062 + "disabled": true, ~/~/ Датчик не участвует в обработке 2063 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2064 + "gradesTables": [ ~/~/ Тарировка 1729 1729 { 1730 - "id": ~/~/ идентификатор 1731 - "enabled": true, ~/~/ флаг включения 1732 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1733 - "login": "", ~/~/ имя учетной записи 1734 - "password": "", ~/~/ пароль учетной записи 1735 - } 1736 - "inspectionTasks": ~/~/ задания на ТО 1737 - { 1738 - "id": "", ~/~/ ID задания 1739 - "enabled": false, ~/~/ Признак включения 1740 - "name": "", ~/~/ Имя задания 1741 - "description": "", ~/~/ Описание задания 1742 - "mileageCondition": "", ~/~/ Условие по пробегу 1743 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1744 - "motohoursCondition": "", ~/~/ Условие по моточасам 1745 - "lastMotohours": "", ~/~/ Моточасы 1746 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1747 - "kind": "", ~/~/ Вид периодичности по времени 1748 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2066 + "grades": [ ~/~/ Таблицы тарировки 2067 + { 2068 + "input": 0, ~/~/ Вход 2069 + "output": 0 ~/~/ Выход 2070 + } 2071 + ], 2072 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1749 1749 } 2074 + ], 2075 + "showInTooltip": true, ~/~/ Отображение в подсказке 2076 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1750 1750 1751 -(% lang="en-US" style="text-align:left" %) 1752 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2078 +((( 2079 + "color": "string", ~/~/ цвет уведомлений 2080 +))) 1753 1753 2082 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2083 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2084 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2085 + "expr": "string", ~/~/ Выражение 2086 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2087 + "string" 2088 + ], 2089 + "customParams": { ~/~/ Дополнительные настройки 2090 + "additionalProp1": "string", 2091 + "additionalProp2": "string", 2092 + "additionalProp3": "string" 2093 + }, 2094 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2095 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2096 + { 2097 + "from": 0, ~/~/ С какого значения 2098 + "color": "string", ~/~/ Каким цветом 2099 + "text": "string" ~/~/ Текст подписи к этому интервалу 2100 + } 2101 + ] 2102 + } 2103 + ], 2104 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2105 + "customFields": [ ~/~/ Список произвольных полей 2106 + { 2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2108 + "name": "string", ~/~/ Наименование произвольного поля 2109 + "value": "string", ~/~/ Значение произвольного поля 2110 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2111 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2112 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2113 + } 2114 + ], 2115 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2116 +} 2117 +))) 2118 + 1754 1754 **Валидация:** 1755 1755 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1756 1756 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1789,18 +1789,15 @@ 1789 1789 1790 1790 (% style="color:#000000" %)Метод запроса: **GET** 1791 1791 1792 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2157 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1793 1793 1794 1794 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1795 1795 1796 1796 (% style="color:#000000" %)Ответ: 1797 1797 1798 -(% style="color:#000000" %){ 1799 - 2163 +(% style="color:#000000" %){(%%) 1800 1800 "deviceTypeId" : "", ~/~/ ID типа устройства 1801 1801 "deviceTypeName" : "" ~/~/ Название типа устройства 1802 - 1803 -(% style="text-align:left" %) 1804 1804 (% style="color:#000000" %)} 1805 1805 1806 1806 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1822,13 +1822,10 @@ 1822 1822 1823 1823 (% style="color:#000000" %)Ответ: 1824 1824 1825 -(% style="color:#000000" %){ 1826 - 2187 +(% style="color:#000000" %){(%%) 1827 1827 "id": "", ~/~/ ID типа датчика 1828 1828 "name": "", ~/~/ Название 1829 1829 "description": "", ~/~/ Описание 1830 - 1831 -(% style="text-align:left" %) 1832 1832 (% style="color:#000000" %)} 1833 1833 1834 1834 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1872,6 +1872,56 @@ 1872 1872 } 1873 1873 ] 1874 1874 2234 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2235 + 2236 +(% class="box infomessage" style="text-align: left;" %) 2237 +((( 2238 +**POST /api/v3/terminalMessages/mapping** 2239 +))) 2240 + 2241 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2242 + 2243 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2244 + 2245 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2246 + 2247 +{ 2248 + "protocolType": 0, 2249 + "params": ["string"] 2250 +} 2251 + 2252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2253 +|protocolType|ID типа протокола 2254 +|params|((( 2255 +Массив наименований параметров в сообщении 2256 +))) 2257 + 2258 +Ответ: 2259 + 2260 +{ 2261 + "protocolType": 0, 2262 + "mapping": { 2263 + "additionalProp1": { 2264 + "inputType": 0, 2265 + "inputNumber": 0 2266 + }, 2267 + "additionalProp2": { 2268 + "inputType": 0, 2269 + "inputNumber": 0 2270 + } 2271 + } 2272 +} 2273 + 2274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2275 +|protocolType|Тип протокола 2276 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2277 +|inputNumber|((( 2278 +Номер входа 2279 +))) 2280 + 2281 +(% class="wikigeneratedid" %) 2282 +Перечень 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/]] 2283 + 1875 1875 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 1876 1877 1877 (% class="box infomessage" %) ... ... @@ -1896,6 +1896,11 @@ 1896 1896 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 1897 } 1898 1898 2308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2309 +|vehicleId|ID объекта 2310 +|from|Дата и время начала периода запроса 2311 +|to|Дата и время окончания периода запроса 2312 + 1899 1899 Ответ: 1900 1900 1901 1901 [ ... ... @@ -1902,25 +1902,43 @@ 1902 1902 { 1903 1903 "messages": [ 1904 1904 { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2319 + "deviceTime": "2023-11-29T07:40:44.052Z", 2320 + "serverTime": "2023-11-29T07:40:44.052Z", 2321 + "speed": 0, 2322 + "altitude": 0, 2323 + "latitude": 0, 2324 + "longitude": 0, 2325 + "satellites": 0, 2326 + "course": 0, 2327 + "voltage": 0, 2328 + "parameters": { 1914 1914 "additionalProp1": "string", 1915 1915 "additionalProp2": "string", 1916 1916 "additionalProp3": "string" 1917 1917 }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 2333 + "photoCount": 0, 2334 + "lbsCorrectedCoords": true, 2335 + "protocolType": 0 1919 1919 } 1920 1920 ] 1921 1921 } 1922 1922 ] 1923 1923 2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2342 +|deviceTime|Время сообщения терминала 2343 +|serverTime|Время когда сообщение поступило на сервер 2344 +|speed|Скорость 2345 +|altitude|Высота над уровнем моря 2346 +|latitude|Широта 2347 +|longitude|Долгота 2348 +|satellites|Кол-во спутников 2349 +|course|Курс 2350 +|voltage|Бортовое напряжение 2351 +|parameters|Список параметров и их значений 2352 +|photoCount|Количество фото 2353 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2354 +|protocolType|ID типа протокола 2355 + 1924 1924 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 1925 1926 1926 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1940,7 +1940,7 @@ 1940 1940 Тело запроса: 1941 1941 1942 1942 { 1943 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1944 1944 "vehicleIds": [0], ~/~/ Список ID объектов 1945 1945 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1946 1946 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -1957,10 +1957,14 @@ 1957 1957 { 1958 1958 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1959 1959 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1960 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1961 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1962 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1963 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2392 + "mileage": 0, ~/~/ Пробег за период, километры 2393 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2394 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2395 + "motohours": 0, ~/~/ Моточасы за период, секунды 2396 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2397 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2398 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2399 + 1964 1964 } 1965 1965 ] 1966 1966 } ... ... @@ -1983,7 +1983,7 @@ 1983 1983 Тело запроса: 1984 1984 1985 1985 { 1986 - "sampling": 0, ~/~/ Частота дискретизации всекундах, минимум 60 секунд.Весь периодразбивает на подпериоды с указанной частотой.2422 + "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой) 1987 1987 "vehicleIds": [0], ~/~/ Список ID объектов 1988 1988 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1989 1989 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2002,13 +2002,23 @@ 2002 2002 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2003 2003 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2004 2004 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2005 2005 "fuelConsumption": 0, ~/~/ Расход топлива 2006 2006 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2446 + 2007 2007 } 2008 2008 ] 2009 2009 } 2010 2010 ] 2011 2011 2452 +(% class="box warningmessage" %) 2453 +((( 2454 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2455 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2456 +))) 2457 + 2012 2012 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2013 2013 2014 2014 (% class="box infomessage" %) ... ... @@ -2043,7 +2043,8 @@ 2043 2043 "model": "string", ~/~/ Модель объекта 2044 2044 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2045 2045 { 2046 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2492 + "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 2493 + 2047 2047 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2048 2048 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2049 2049 "valueFuel": 0, ~/~/ Количество ... ... @@ -2054,6 +2054,120 @@ 2054 2054 } 2055 2055 ] 2056 2056 2504 + 2505 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2506 + 2507 +(% class="box infomessage" %) 2508 +((( 2509 +**POST /api/v3/vehicles/moveStop** 2510 +))) 2511 + 2512 +Метод запроса: **POST** 2513 + 2514 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2515 + 2516 +В заголовках запроса: X-Auth: Токен авторизации 2517 + 2518 + 2519 +Тело запроса: 2520 + 2521 +{ 2522 + "vehicleIds": [ ], ~/~/ Список ID объектов 2523 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2524 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2525 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2526 +} 2527 + 2528 +Ответ: 2529 + 2530 +[ 2531 + { 2532 + "vehicleId": 0, ~/~/ ID объекта 2533 + "vehicleName": "string", ~/~/ Имя объекта 2534 + "moves": [ ~/~/ Событие движения 2535 + { 2536 + "mileage": 0, ~/~/ Пробег, км 2537 + "eventId": 0, ~/~/ Идентификатор события 2538 + "eventName": "string", ~/~/ Название события 2539 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2540 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2541 + "duration": 0 ~/~/ Продолжительность события, секунд 2542 + } 2543 + ], 2544 + "stops": [ ~/~/ События стоянок 2545 + { 2546 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2547 + "eventId": 0, ~/~/ Идентификатор события 2548 + "eventName": "string", ~/~/ Название события 2549 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2550 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2551 + "duration": 0 ~/~/ Продолжительность события, секунд 2552 + } 2553 + ] 2554 + } 2555 +] 2556 + 2557 + 2558 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2559 + 2560 +(% class="box infomessage" %) 2561 +((( 2562 +**POST /api/v3/vehicles/getlastdata** 2563 +))) 2564 + 2565 +Метод запроса: **POST** 2566 + 2567 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2568 + 2569 +В заголовках запроса: X-Auth: Токен авторизации 2570 + 2571 + 2572 +В массиве указываем id объектов через запятую 2573 + 2574 +Ответ: 2575 + 2576 +[ 2577 + { 2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2584 + "speed": 31, ~/~/ Скорость объекта 2585 + "course": 116, ~/~/ Курс движения [0;360] 2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2589 + "geozones": [ ~/~/ Сведения по геозонам. 2590 + { 2591 + "id": 10225647, ~/~/ ID Геозоны 2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2593 + }, 2594 + { 2595 + "id": 10282875, ~/~/ ID Геозоны 2596 + "name": "Ё2" ~/~/ Наименование геозоны 2597 + }, 2598 + { 2599 + "id": 10226240, ~/~/ ID Геозоны 2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2601 + }, 2602 + { 2603 + "id": 9747869, ~/~/ ID Геозоны 2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2605 + }, 2606 + { 2607 + "id": 10221123, ~/~/ ID Геозоны 2608 + "name": "53r" ~/~/ Наименование геозоны 2609 + }, 2610 + { 2611 + "id": 10197638, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2613 + } 2614 + ] 2615 + } 2616 + 2617 + 2057 2057 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 2058 2059 2059 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2076,7 +2076,7 @@ 2076 2076 2077 2077 (% style="text-align:left" %) 2078 2078 { 2079 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2640 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные 2080 2080 } 2081 2081 2082 2082 (% style="text-align:left" %) ... ... @@ -2087,9 +2087,9 @@ 2087 2087 "id": 0, ~/~/ Идентификатор объекта геозоны 2088 2088 "name": "string", ~/~/ Название объекта геозоны 2089 2089 "type": 0, ~/~/ Тип объекта геозоны 2651 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2090 2090 "fname": "string", ~/~/ Имя файла 2091 2091 "parentId": "string", ~/~/ Идентификатор клиента 2092 - "radius": 0, ~/~/ Радиус геообъекта 2093 2093 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2094 2094 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2095 2095 "description": "string", ~/~/ Описание ... ... @@ -2182,6 +2182,40 @@ 2182 2182 } 2183 2183 ] 2184 2184 2746 + 2747 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2748 + 2749 +(% class="box successmessage" %) 2750 +((( 2751 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2752 +))) 2753 + 2754 +(% style="color:#000000" %)Метод запроса: **PUT** 2755 + 2756 +Пример запроса: 2757 + 2758 +((( 2759 +{ 2760 + "id": 0, ~/~/ Идентификатор объекта геозоны 2761 + "name": "string", ~/~/ Наименование объекта геозоны 2762 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2763 + "description": "string", ~/~/ Описание объекта геозоны 2764 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2765 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2766 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2767 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2768 + "radius": 0, ~/~/ Радиус геозоны 2769 + "shape": "string", ~/~/ Координаты геозоны 2770 + "shape_format": "string" ~/~/ Формат xml,json 2771 + 2772 +} 2773 +))) 2774 + 2775 + 2776 +Пример ответа: 2777 + 2778 +200 ~/~/ Success 2779 + 2185 2185 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2186 2186 2187 2187 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2213,7 +2213,7 @@ 2213 2213 "id": 0, ~/~/ ID уведомления 2214 2214 "name": "string", ~/~/ Название уведомления 2215 2215 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2216 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2811 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2217 2217 "userId": "", ~/~/ Пользователь, создавший уведомление 2218 2218 "parentId": "", ~/~/ Идентификатор клиента 2219 2219 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2220,6 +2220,155 @@ 2220 2220 } 2221 2221 ] 2222 2222 2818 + 2819 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2820 + 2821 +(% class="box infomessage" %) 2822 +((( 2823 +**POST /api/v3/notifications** 2824 +))) 2825 + 2826 +Метод запроса **POST** 2827 + 2828 +(% style="text-align: left;" %) 2829 +(% style="color:#000000" %)Пример запроса 2830 + 2831 +((( 2832 +{ 2833 + "id": 0, ~/~/ ID правила 2834 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2835 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2836 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2837 + "name": "string", ~/~/ Имя правила 2838 + "active": true, ~/~/ Активность правила 2839 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2840 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2841 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2842 + ], 2843 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2844 + 0 2845 + ], 2846 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2847 + 0 2848 + ], 2849 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2850 + 0 2851 + ], 2852 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2853 + "additionalProp1": "string", 2854 + "additionalProp2": "string", 2855 + "additionalProp3": "string" 2856 + }, 2857 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2858 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2859 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2860 + ], 2861 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2862 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2863 + "string" 2864 + ], 2865 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2866 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2867 + { 2868 + "id": 0, ~/~/ Идентификатор участника чата. 2869 + "info": "string" ~/~/ Дополнительные сведения. 2870 + } 2871 + ], 2872 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2873 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2874 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2875 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2876 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2877 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2878 + "timezone": 0, ~/~/ часовой пояс 2879 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2880 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2881 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2882 + { 2883 + "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 - Срок действия правила истек 2884 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2885 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2886 + "additionalProp1": "string", 2887 + "additionalProp2": "string", 2888 + "additionalProp3": "string" 2889 + } 2890 + } 2891 + ] 2892 +} 2893 +))) 2894 + 2895 +((( 2896 + 2897 +))) 2898 + 2899 +((( 2900 + 2901 +))) 2902 + 2903 +Ответ: 2904 + 2905 +{ 2906 + "id": 0, ~/~/ ID правила 2907 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2908 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2909 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2910 + "name": "string", ~/~/ Имя правила 2911 + "active": true, ~/~/ Активность правила 2912 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2913 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2914 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2915 + ], 2916 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2917 + 0 2918 + ], 2919 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2920 + 0 2921 + ], 2922 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2923 + 0 2924 + ], 2925 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2926 + "additionalProp1": "string", 2927 + "additionalProp2": "string", 2928 + "additionalProp3": "string" 2929 + }, 2930 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2931 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2932 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2933 + ], 2934 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2935 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2936 + "string" 2937 + ], 2938 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2939 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2940 + { 2941 + "id": 0, ~/~/ Идентификатор участника чата. 2942 + "info": "string" ~/~/ Дополнительные сведения. 2943 + } 2944 + ], 2945 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2946 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2947 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2948 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2949 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2950 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2951 + "timezone": 0, ~/~/ часовой пояс 2952 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2953 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2954 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2955 + { 2956 + "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 - Срок действия правила истек 2957 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2958 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2959 + "additionalProp1": "string", 2960 + "additionalProp2": "string", 2961 + "additionalProp3": "string" 2962 + } 2963 + } 2964 + ] 2965 +} 2966 + 2223 2223 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2224 2224 2225 2225 (% class="box infomessage" %) ... ... @@ -2361,6 +2361,32 @@ 2361 2361 2362 2362 Success 2363 2363 3108 + 3109 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3110 + 3111 +(% class="box warningmessage" %) 3112 +((( 3113 +**PUT** /api/v3/notifications/prolongation 3114 +))) 3115 + 3116 +Метод позволяет продлить уведомления. 3117 + 3118 +Метод запроса **PUT** 3119 + 3120 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3121 + 3122 +В заголовках запроса: X-Auth: Токен авторизации. 3123 + 3124 +Тело запроса: 3125 + 3126 +[ 3127 + 3128 +0 3129 + 3130 +] 3131 + 3132 +где 0 идентификатор ids. 3133 + 2364 2364 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2365 2365 2366 2366 (% class="box errormessage" %) ... ... @@ -3050,13 +3050,19 @@ 3050 3050 { 3051 3051 "name": "string", 3052 3052 "number": 0, 3053 - "period": 0, ~/~/ Частота трансляции радиометки3823 + "period": 0, 3054 3054 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 3055 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3056 - "deleted": true 3057 3057 } 3058 3058 ] 3059 3059 3829 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3830 +|parentId|ID клиента 3831 +|name|Название карты-метки 3832 +|number|Номер 3833 +|period|Период запросов в секундах (работает только для агрегатов) 3834 +|id|ID карты-метки 3835 + 3060 3060 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3061 3061 3062 3062 (% class="box infomessage" %) ... ... @@ -3072,13 +3072,19 @@ 3072 3072 { 3073 3073 "name": "string", 3074 3074 "number": 0, 3075 - "period": 0, ~/~/ Частота трансляции радиометки3851 + "period": 0, 3076 3076 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3077 3077 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3078 - "deleted": true 3079 3079 } 3080 3080 ] 3081 3081 3857 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3858 +|name|Название карты-метки 3859 +|number|Номер 3860 +|period|Период запросов в секундах (работает только для агрегатов) 3861 +|id|ID карты-метки 3862 +|parentId|ID клиента 3863 + 3082 3082 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3083 3083 3084 3084 (% class="box successmessage" %) ... ... @@ -3093,7 +3093,6 @@ 3093 3093 "number": 0, 3094 3094 "period": 0, 3095 3095 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3096 - "deleted": true 3097 3097 } 3098 3098 3099 3099 Ответ: ... ... @@ -3104,9 +3104,15 @@ 3104 3104 "period": 0, 3105 3105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3106 3106 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3107 - "deleted": true 3108 3108 } 3109 3109 3890 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3891 +|name|Название карты-метки 3892 +|number|Номер 3893 +|period|Период запросов в секундах (работает только для агрегатов) 3894 +|id|ID карты-метки 3895 +|parentId|ID клиента 3896 + 3110 3110 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3111 3111 3112 3112 (% class="box warningmessage" %) ... ... @@ -3122,7 +3122,6 @@ 3122 3122 "period": 0, 3123 3123 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3124 3124 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3125 - "deleted": true 3126 3126 } 3127 3127 3128 3128 Ответ: ... ... @@ -3133,9 +3133,15 @@ 3133 3133 "period": 0, 3134 3134 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3135 3135 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3136 - "deleted": true 3137 3137 } 3138 3138 3924 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3925 +|name|Название карты-метки 3926 +|number|Номер 3927 +|period|Период запросов в секундах (работает только для агрегатов) 3928 +|id|ID карты-метки 3929 +|parentId|ID клиента 3930 + 3139 3139 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3140 3140 3141 3141 (% class="box errormessage" %) ... ... @@ -3384,19 +3384,83 @@ 3384 3384 **PUT /api/v3/Billing/client/balance** 3385 3385 ))) 3386 3386 4179 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4180 + 3387 3387 Тело запроса: 3388 3388 3389 3389 { 3390 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3391 - "Balance": 0 4184 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4185 + "Balance": 0 ~/~/ Значение баланса. 3392 3392 } 3393 3393 3394 3394 Ответ: Success 3395 3395 3396 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3397 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3398 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4190 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3399 3399 4192 +(% class="box warningmessage" %) 4193 +((( 4194 +**PUT /api/v3/billing/client/balance/deposit** 4195 +))) 4196 + 4197 +Создает операцию **Пополнение **с указанной суммой 4198 + 4199 +Тело запроса: 4200 + 4201 +((( 4202 +{ 4203 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4204 + "amount": 0 ~/~/ Сумма пополнения баланса 4205 +} 4206 +))) 4207 + 4208 +((( 4209 + 4210 +))) 4211 + 4212 +Ответ: Success 4213 + 4214 +((( 4215 +{ 4216 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4217 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4218 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4219 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4220 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4221 + "Description": "string" ~/~/ Описание корректировки. 4222 +} 4223 +))) 4224 + 4225 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4226 + 4227 +Создает операцию **Списание **с указанной суммой 4228 + 4229 +(% class="box warningmessage" %) 4230 +((( 4231 +**PUT /api/v3/billing/client/balance/withdraw** 4232 +))) 4233 + 4234 +Тело запроса: 4235 + 4236 +((( 4237 +{ 4238 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4239 + "amount": 0 ~/~/ Сумма списания с баланса 4240 +} 4241 +))) 4242 + 4243 +Ответ: Success 4244 + 4245 +((( 4246 +{ 4247 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4248 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4249 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4250 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4251 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4252 + "Description": "string" ~/~/ Описание корректировки 4253 +} 4254 +))) 4255 + 3400 3400 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3401 3401 3402 3402 (% class="box warningmessage" %) ... ... @@ -3406,28 +3406,35 @@ 3406 3406 3407 3407 Тело запроса: 3408 3408 4265 +((( 3409 3409 { 3410 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3411 - "CalculationType": 0, 3412 - "PermissibleBalance": 0, 3413 - "DefermentDays": 0, 3414 - "SendUiNotifications": true, 3415 - "SendEmailNotifications": true, 3416 - "IsPrivate": true, 4267 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4268 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4269 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4270 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4271 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4272 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 3417 3417 } 4274 +))) 3418 3418 4276 +((( 4277 + 4278 +))) 4279 + 3419 3419 Ответ: Success 3420 3420 3421 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3422 -|ClientId|Идентификатор клиента 3423 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3424 -|PermissibleBalance|Допустимый баланс 3425 -|DefermentDays|((( 3426 -Отсрочка, количество дней 4282 +((( 4283 +{ 4284 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4285 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4286 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4287 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4288 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4289 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4290 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4291 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4292 +} 3427 3427 ))) 3428 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3429 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3430 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3431 3431 3432 3432 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3433 3433 ... ... @@ -3439,38 +3439,296 @@ 3439 3439 Тело запроса: 3440 3440 3441 3441 { 3442 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3443 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3444 - "Features": [ 4305 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4306 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4307 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 3445 3445 { 3446 - "Feature": "string", 3447 - "IsEnabled": true, 3448 - "IsFactual": true, 3449 - "Limit": 0, 3450 - "Price": 0, 3451 - "DebitDate": "2023-10-18T13:26:58.987Z", 3452 - "PeriodValue": 0, 3453 - "PeriodType": 0 4309 + "Feature": "string", ~/~/ Код услуги. 4310 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4311 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4312 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4313 + "Price": 0, ~/~/ Цена за единицу. 4314 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4315 + "PeriodValue": 0, ~/~/ Значение периода. 4316 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 3454 3454 } 3455 3455 ] 3456 3456 } 3457 3457 4321 + 3458 3458 Ответ: Success 3459 3459 3460 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3461 -|ClientId|Идентификатор клиента 3462 -|PlanId|Идентификатор тарифного плана 3463 -|Feature|Код услуги 3464 -|IsEnabled|Признак, определяющий активирована ли услуга 3465 -|IsFactual|Признак, определяющий расчёт по факту 3466 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3467 -|Price|Цена за единицу. 3468 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3469 -|PeriodValue|Значение периода. 3470 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4324 +((( 4325 +{ 4326 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4327 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4328 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4329 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4330 + "Name": "string", ~/~/ Наименование. 4331 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4332 + "Constraint": { ~/~/ Ограничения по тарифу 4333 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4334 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4335 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4336 + }, 4337 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4338 + { 4339 + "Feature": "string", ~/~/Код услуги. 4340 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4341 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4342 + "Price": 0, ~/~/ Цена за единицу. 4343 + "PeriodValue": 0, ~/~/ Значение периода. 4344 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4345 + } 4346 + ], 4347 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4348 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4349 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4350 + }, 4351 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4352 + { 4353 + "Feature": "string", ~/~/ Код услуги. 4354 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4355 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4356 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4357 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4358 + "Price": 0, ~/~/ Цена за единицу. 4359 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4360 + "PeriodValue": 0, ~/~/ Значение периода. 4361 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4362 + "Quantity": 0 ~/~/ Количество использования услуги. 4363 + } 4364 + ] 4365 +} 4366 +))) 3471 3471 3472 3472 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3473 3473 4370 +(% class="box warningmessage" %) 4371 +((( 4372 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4373 +))) 4374 + 4375 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4376 + 4377 +(% class="box infomessage" %) 4378 +((( 4379 +**POST /api/v3/vehicles/import/{agentId}** 4380 +))) 4381 + 4382 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4383 + 4384 +В пути указывается **agentId** - id клиента. 4385 + 4386 +**Заголовок** 4387 + 4388 +**X-Auth: [токен авторизации]** 4389 + 4390 +**Параметры** 4391 + 4392 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4393 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4394 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4395 + 4396 +В теле использовать тип **form-data,** тип значения** file** 4397 + 4398 +**Ключи** 4399 + 4400 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4401 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4402 +|csv|В значении передаем файл датчиков, формат **csv** 4403 + 4404 +Ответ: 4405 + 4406 +{ 4407 + "vehicleId": 0, 4408 + "name": "string", 4409 + "errors": ["string"] 4410 +} 4411 + 4412 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4413 +|vehicleId|ID созданного объекта 4414 +|name|Имя созданного объекта 4415 +|errors|Ошибки и их описание 4416 + 4417 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4418 + 4419 +(% class="box infomessage" %) 4420 +((( 4421 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4422 +))) 4423 + 4424 +(% class="wikigeneratedid" %) 4425 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4426 + 4427 +(% class="wikigeneratedid" %) 4428 +В пути указывается **vehicleId **- id объекта. 4429 + 4430 +**Заголовок** 4431 + 4432 +**X-Auth: [токен авторизации]** 4433 + 4434 +В теле использовать тип **form-data.** 4435 + 4436 +Ключи: 4437 + 4438 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4439 +|**history**|В значении передавать файл с историей 4440 + 4441 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4442 + 4443 +Ответ: 4444 + 4445 +{ 4446 + "results": [ 4447 + { 4448 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4449 + "vehicleId": 0, 4450 + "errors": [ 4451 + "string" 4452 + ], 4453 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4454 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4455 + "producedCount": 0, 4456 + "msgCount": 0 4457 + } 4458 + ] 4459 +} 4460 + 4461 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4462 +|results|Результаты импорта в разрезе ТС 4463 +|vehicleGuid|Guid ТС 4464 +|vehicleId|ID ТС 4465 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4466 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4467 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4468 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4469 +|msgCount|Кол-во обработанных сообщений всего 4470 + 4471 +== **Импортировать историю ТС (Асинхронный запрос)** == 4472 + 4473 +(% class="box successmessage" %) 4474 +((( 4475 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4476 +))) 4477 + 4478 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4479 + 4480 +Метод запроса: **POST** 4481 + 4482 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4483 + 4484 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4485 + 4486 + 4487 +Ответ: 4488 + 4489 +{ 4490 + 4491 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4492 + 4493 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4494 + 4495 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4496 + 4497 + "Message": "string", ~/~/ Информация о выполнении запроса 4498 + 4499 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4500 + 4501 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4502 + 4503 + "Data": "string" ~/~/ Данные 4504 + 4505 +} 4506 + 4507 + 4508 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4509 + 4510 +(% class="box infomessage" %) 4511 +((( 4512 +**GET /api/v3/vehicles/import/history/status** 4513 +))) 4514 + 4515 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4516 + 4517 +Ответ: 4518 + 4519 +{ 4520 + "activity": true, 4521 + "progress": 0, 4522 + "message": "string" 4523 +} 4524 + 4525 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4526 +**Параметр** 4527 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4528 +**Описание** 4529 +))) 4530 +|((( 4531 +activity 4532 +)))|((( 4533 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4534 +))) 4535 +|((( 4536 +progress 4537 +)))|((( 4538 +Guid ТС 4539 +))) 4540 + 4541 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4542 + 4543 +(% class="box infomessage" %) 4544 +((( 4545 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4546 +))) 4547 + 4548 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4549 + 4550 +Метод запроса: **GET** 4551 + 4552 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4553 + 4554 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4555 + 4556 + 4557 +Ответ: 4558 + 4559 +{ 4560 + 4561 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4562 + 4563 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4564 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4565 + 4566 + "Message": "string", ~/~/ Информация о выполнении запроса 4567 + 4568 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4569 + 4570 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4571 + 4572 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4573 + 4574 + "Data": "string" ~/~/ Данные 4575 + 4576 +} 4577 + 4578 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4579 + 4580 +(% class="box infomessage" %) 4581 +((( 4582 +**POST /api/v3/vehicles/export** 4583 +))) 4584 + 4585 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4586 + 4587 +Тело запроса: 4588 + 4589 +[ 4590 + id 4591 +] 4592 + 4593 +Ответ: Success 200, получаете файлы с настройками. 4594 + 3474 3474 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3475 3475 3476 3476 (% class="box infomessage" %) ... ... @@ -3521,24 +3521,2063 @@ 3521 3521 |progress|Прогресс экспорта, от 0 до 100% 3522 3522 |message|Текст описывающий статус 3523 3523 3524 -= =(% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==4645 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3525 3525 4647 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4648 + 3526 3526 (% class="box infomessage" %) 3527 3527 ((( 3528 -**POST /api/v3/v ehicles/export**4651 +**POST /api/v3/EcoDriving/rating** 3529 3529 ))) 3530 3530 3531 - Запрос позволяетэкспортироватьфайлыснастройками объектов. Взапросе передается массивidобъектов.4654 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3532 3532 3533 3533 Тело запроса: 3534 3534 4658 +{ 4659 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4660 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4661 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4662 +} 4663 + 4664 +Ответ: 4665 + 4666 +{ 4667 + "items": [ ~/~/ Список в разрезе ТС 4668 + { 4669 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4670 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4671 + "vehicleId": 0, ~/~/ ID ТС 4672 + "vehicleName": "string", ~/~/ Название ТС 4673 + "vehicleModel": "string", ~/~/ Модель ТС 4674 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4675 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4676 + "totalViolations": 0, ~/~/ Нарушений всего 4677 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4678 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4679 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4680 + "brakingViolations": 0, ~/~/ Нарушений торможения 4681 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4682 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4683 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4684 + }, 4685 + 4686 +((( 4687 + 4688 +))) 4689 + 4690 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4691 + "mileage": 0, ~/~/ Пробег, м 4692 + "tripsCount": 0, ~/~/ Кол-во рейсов 4693 + "trips": [ ~/~/ Информация по рейсу 4694 + { 4695 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4696 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4697 + "violationsCount": 0, ~/~/ Всего нарушений 4698 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4699 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4700 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4701 + "brakingViolations": 0, ~/~/ Нарушений торможения 4702 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4703 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4704 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4705 + }, 4706 + 4707 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4708 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4709 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4710 + "mileage": 0, ~/~/ Пробег, м 4711 + "motohours": 0, ~/~/ Моточасы, секунды 4712 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4713 + "startAddress": "string", ~/~/ Адрес начала рейса 4714 + "endAddress": "string", ~/~/ Адрес конца рейса 4715 + "drivers": [ ~/~/ Список водителей 4716 + { 4717 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4718 + "driverName": "string", ~/~/ФИО водителя 4719 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4720 + } 4721 + ] 4722 + } 4723 + ] 4724 + } 4725 + ] 4726 +} 4727 + 4728 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4729 + 4730 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4731 + 4732 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4733 + 4734 +(% class="box infomessage" %) 4735 +((( 4736 +**POST /api/v3/fuelcards/transactions** 4737 +))) 4738 + 4739 +Метод запроса: POST 4740 + 4741 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4742 +\\В заголовках запроса: X-Auth: Токен авторизации 4743 + 4744 +Параметры в теле запроса (JSON): 4745 + 4746 +{ 4747 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4748 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4749 + "ids": [ 4750 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4751 + ], 4752 + "timezone": 0 ~/~/ Часовой пояс 4753 +} 4754 + 4755 + 4756 +Ответ: 4757 + { 4758 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4759 + "driver": "string", ~/~/ Водители, привязанные к ТК 4760 + "object": "string", ~/~/ Наименование ТС 4761 + "amount": 0, ~/~/ Количество топлива 4762 + "amountDut": 0, ~/~/ Количество по ДУТ 4763 + "amountDiff": 0, ~/~/ Разница, л 4764 + "amountDiffPerc": 0, ~/~/ Разница, % 4765 + "summa": 0, ~/~/ Стоимость, руб 4766 + "serviceName": "string", ~/~/ Тип топлива 4767 + "price": 0, ~/~/ Цена за литр, руб 4768 + "cardName": "string", ~/~/ Наименование ТК 4769 + "cardNum": "string", ~/~/ Номер ТК 4770 + "operator": "string", ~/~/ Оператор ТК 4771 + "address": "string" ~/~/ Адрес АЗС 4772 + } 4773 + 4774 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4775 + 4776 +(% class="box infomessage" %) 4777 +((( 4778 +**GET /api/v3/fuelcards** 4779 +))) 4780 + 4781 +Метод запроса: GET 4782 + 4783 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4784 + 4785 +Ответ: 4786 + 3535 3535 [ 3536 - id 4788 + { 4789 + "Name": "string", ~/~/ Определяет наименование карты. 4790 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4791 + "Number": "string", ~/~/ Определяет № карты. 4792 + "Enabled": true, ~/~/ Определяет признак активности карты. 4793 + "Description": "string", ~/~/ Определяет описание карты. 4794 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4795 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4796 + "deleted": true ~/~/ Признак удаления 4797 + } 3537 3537 ] 3538 3538 3539 - Ответ: Success200,получаетефайлыснастройками.4800 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 3540 3540 3541 3541 4803 +== **Получение полных данных о ретрансляторе** == 4804 + 4805 +(% class="box infomessage" %) 4806 +((( 4807 +**GET ** **/api/v3/retranslations/{id}** 4808 +))) 4809 + 4810 +id - Идентификатор ретранслятора 4811 + 4812 + 4813 +Пример ответа: 4814 + 4815 +{ 4816 +"description": "", ~/~/ Поле описания ретранслятора 4817 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4818 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4819 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4820 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4821 +"objects": [ ~/~/ Объекты для ретрансляции 4822 +{ 4823 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4824 +"name": "", ~/~/ Наименование объекта ретрансляции 4825 +"imei": "", ~/~/ IMEI объекта ретрансляции 4826 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4827 +} 4828 + ], 4829 +"id": "", ~/~/ Идентификатор ретранслятора 4830 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4831 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4832 +} 4833 + 4834 + 4835 +== **Удаление данных ретранслятора** == 4836 + 4837 +(% class="box infomessage" %) 4838 +((( 4839 +**DELETE** **/api/v3/retranslations/{id}** 4840 +))) 4841 + 4842 +id - Идентификатор ретранслятора 4843 + 4844 + 4845 +== **Создание ретранслятора** == 4846 + 4847 +(% class="box infomessage" %) 4848 +((( 4849 +**POST ** **/api/v3/retranslations/{id}** 4850 +))) 4851 + 4852 +Запрос: 4853 + 4854 +{ 4855 +"description": "", ~/~/ Поле описания ретранслятора 4856 +"subscriberId": "", ~/~/ Идентификатор подписчика 4857 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4858 +"address": "", ~/~/ Адрес и порт принимающего сервера 4859 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4860 +"objects": [ ~/~/Объекты для ретрансляции 4861 +{ 4862 +"id": "", ~/~/ Идентификатор ретранслятора 4863 +"imei": "", ~/~/ IMEI объекта ретрансляции 4864 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4865 +} 4866 + ] 4867 +} 4868 + 4869 + 4870 +Ответ: 4871 + 4872 +{ 4873 +"description": "", ~/~/ Поле описания ретранслятора 4874 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4875 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4876 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4877 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4878 +"objects": [ ~/~/ Объекты для ретрансляции 4879 +{ 4880 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4881 +"name": "string", ~/~/ Наименование объекта ретрансляции 4882 +"imei": "", ~/~/ IMEI объекта ретрансляции 4883 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4884 +} 4885 + ], 4886 +"id": "", ~/~/ Идентификатор ретранслятора 4887 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4888 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4889 +} 4890 + 4891 + 4892 +== **Редактирование ретранслятора** == 4893 + 4894 +(% class="box infomessage" %) 4895 +((( 4896 +**PUT** **/api/v3/retranslations** 4897 +))) 4898 + 4899 +Пример запроса: 4900 + 4901 +{ 4902 +"id": "", ~/~/ Идентификатор ретранслятора 4903 +"description": "string", ~/~/ Поле описания ретранслятора 4904 +"subscriberId": "", ~/~/ Идентификатор подписчика 4905 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4906 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4907 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4908 +"objects": ~/~/ Объекты для ретрансляции 4909 +[ 4910 +{ 4911 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4912 +"imei": "", ~/~/ IMEI объекта ретрансляции 4913 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4914 +} 4915 + ] 4916 +} 4917 + 4918 + 4919 +Пример ответа: 4920 + 4921 +{ 4922 +"description": "", ~/~/ Поле описания ретранслятора 4923 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4924 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4925 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4926 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4927 +"objects": [ ~/~/ Объекты для ретрансляции 4928 +{ 4929 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4930 +"name": "string", ~/~/ Наименование объекта ретрансляции 4931 +"imei": "", ~/~/ IMEI объекта ретрансляции 4932 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4933 +} 4934 + ], 4935 +"id": "", ~/~/ Идентификатор ретранслятора 4936 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4937 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4938 +} 4939 + 4940 + 4941 +== **Получение списка ретранслятора клиента** == 4942 + 4943 +(% class="box infomessage" %) 4944 +((( 4945 +**POST /api/v3/retranslations/find** 4946 +))) 4947 + 4948 +Пример запроса: 4949 + 4950 +{ 4951 +"id": "", ~/~/ Идентификатор ретранслятора 4952 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4953 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4954 +} 4955 + 4956 +Ответ: 4957 + 4958 +[ 4959 +{ 4960 +"description": "", ~/~/ Поле описания ретранслятора 4961 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4962 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4963 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4964 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4965 +"id": "", ~/~/ Идентификатор ретранслятора 4966 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4967 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4968 +} 4969 +] 4970 + 4971 + 4972 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4973 + 4974 +== **API для отчета по выгрузке комбайнов** == 4975 + 4976 +(% class="box infomessage" %) 4977 +((( 4978 +**POST /api/v3/Reports/harvesterUnloading** 4979 +))) 4980 + 4981 +Пример запроса: 4982 + 4983 +{ 4984 + "byTime": 0, ~/~/ Объединение событий по времени 4985 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4986 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4987 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4988 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4989 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4990 + 0 4991 + ], 4992 + "from": "", ~/~/ Дата и время начало запроса 4993 + "to": "", ~/~/ Дата и время окончания запроса 4994 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4995 +} 4996 + 4997 +Пример ответа: 4998 + 4999 +[ 5000 + { 5001 + "harvesterName": "", ~/~/Комбайн, номер 5002 + "harvesterId": 0, ~/~/Комбайн, id 5003 +"harvesterModel": "", ~/~/ Модель комбайна 5004 +"hopperCapacity": 0, ~/~/ Объем бункера м3 5005 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 5006 + "events": [ ~/~/Список событий в разрезе комбайна 5007 + { 5008 + "driverId": "", ~/~/Идентификатор водителя 5009 + "driverName": "", ~/~/Водитель комбайна, ФИО 5010 + "RFID": "", ~/~/ идентификатор карты-метки 5011 + "rfidName": "", ~/~/Водитель комбайна, имя метки 5012 + "vehicleId": 0, ~/~/идентификатор объекта 5013 + "vehicleName": "string", ~/~/ Имя объекта 5014 + "modelName": "string", ~/~/ Имя модели объекта 5015 + "nearestVehicles": [ ~/~/Объекты рядом 5016 + { 5017 + "vehicleId": 0, ~/~/идентификатор объекта 5018 + "vehicleName": "string" ~/~/ Имя объекта 5019 + } 5020 + ], 5021 + "fields": [ ~/~/Поля, где происходила выгрузка 5022 + { 5023 + "id": 0, ~/~/ идентификатор пользователя 5024 + "name": "string" ~/~/ имя пользователя 5025 + } 5026 + ], 5027 + "event": "string", ~/~/Событие 5028 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 5029 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 5030 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 5031 + "cultureName": "string", ~/~/ название культуры 5032 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 5033 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 5034 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 5035 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 5036 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 5037 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 5038 + "issued": 0, ~/~/Выдано, бункеров 5039 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 5040 + "latitude": 0, ~/~/Широта 5041 + "longitude": 0, ~/~/ Долгота 5042 + "litresAway": 0, ~/~/Отдано, л 5043 + "m3Away": 0 ~/~/Отдано, м3 5044 + } 5045 + ] 5046 + } 5047 +] 5048 + 5049 + 5050 +== **Отчет трек-датчики** == 5051 + 5052 +(% class="box infomessage" %) 5053 +((( 5054 +**POST /api/v3/Reports/sensorsWorks** 5055 +))) 5056 + 5057 +**Пример запроса:** 5058 + 5059 +{ 5060 + "vehicleIds": [ ~/~/ Список ID объектов 5061 + 0 5062 + ], 5063 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5064 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5065 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5066 +} 5067 + 5068 +**Пример ответа:** 5069 + 5070 +((( 5071 +{ 5072 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5073 + { 5074 + "vehicleId": 0, ~/~/ Идентификатор ТС 5075 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5076 + { 5077 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5078 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5079 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5080 + "name": "string", ~/~/ Наименование оборудования. 5081 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5082 + "totalMileage": 0, ~/~/ Общий пробег. 5083 + "avgSpeed": 0 ~/~/ Средняя скорость. 5084 + } 5085 + ] 5086 + } 5087 + ] 5088 +} 5089 + 5090 + 5091 +== **Превышение скорости** == 5092 + 5093 +(% class="box infomessage" %) 5094 +((( 5095 +**POST /api/v3/Reports/overSpeedDuration** 5096 +))) 5097 + 5098 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5099 + 5100 +Пример запроса: 5101 + 5102 +((( 5103 +{ 5104 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5105 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5106 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5107 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5108 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5109 +} 5110 +))) 5111 + 5112 +((( 5113 + 5114 +))) 5115 + 5116 +((( 5117 +Пример ответа: 5118 +))) 5119 + 5120 +((( 5121 +((( 5122 +[ 5123 + { 5124 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5125 + "duration": 0, ~/~/ Продолжительность события в секундах 5126 + "maxSpeed": 0, ~/~/ Максимальная скорость 5127 + "speedLimit": 0 ~/~/ Ограничение скорости 5128 + } 5129 +] 5130 +))) 5131 +))) 5132 +))) 5133 + 5134 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5135 + 5136 + 5137 +== **Запрос списка полей** == 5138 + 5139 +(% class="box successmessage" %) 5140 +((( 5141 +**POST /api/v3/agroLands/find** 5142 +))) 5143 + 5144 +Пример запроса: 5145 + 5146 +((( 5147 +((( 5148 +((( 5149 +{ 5150 + "year": 0, ~/~/ Фильтр по году 5151 + "name": "string", ~/~/ Фильтр по названию 5152 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5153 +} 5154 +))) 5155 +))) 5156 + 5157 + 5158 +))) 5159 + 5160 +Пример ответа: 5161 + 5162 +((( 5163 +[ 5164 + { 5165 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5166 + "year": 0, ~/~/ Год поля 5167 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5168 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5169 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5170 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5171 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5172 + "counts": { ~/~/ Счётчики с/х поля 5173 + "fieldOperations": 0, ~/~/ Количество операций на поле 5174 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5175 + "facts": 0 ~/~/ Счётчик факта 5176 + }, 5177 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5178 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5179 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5180 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5181 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5182 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5183 + "planComment": "string", ~/~/ Комментарий к полю 5184 + "productivity": 0, ~/~/ Урожайность. 5185 + "id": 0, ~/~/ Идентификатор объекта геозоны 5186 + "name": "string", ~/~/ Название объекта геозоны 5187 + "type": 0, ~/~/ Тип объекта геозоны 5188 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5189 + "fname": "string", ~/~/ Имя файла 5190 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5191 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5192 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5193 + "description": "string", ~/~/ Описание объекта геозоны 5194 + "area": 0, ~/~/ Площадь, м2 5195 + "perimetr": 0, ~/~/ Периметр, м 5196 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5197 + } 5198 +] 5199 + 5200 + 5201 +== **Создание нового поля ** == 5202 + 5203 +(% class="box successmessage" %) 5204 +((( 5205 +**POST /api/v3/agroLands** 5206 +))) 5207 + 5208 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5209 +X-agent - ID клиента 5210 + 5211 +Пример запроса: 5212 + 5213 +((( 5214 +{ 5215 + "extId": "string", 5216 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5217 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5218 + "display": "string", ~/~/ Настройки отображения 5219 + "year": 0, ~/~/ Год поля 5220 + "name": "string", ~/~/ Наименование 5221 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5222 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5223 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5224 + "planComment": "string", ~/~/ Комментарий к полю 5225 + "cropRotations": [ ~/~/ Данные по севообороту 5226 + { 5227 + "landId": 0, ~/~/ ID поля 5228 + "landName": "string", ~/~/ Название поля 5229 + "year": 0, ~/~/ Год урожая 5230 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5231 + "cultureName": "string", ~/~/ Название культуры 5232 + "productivity": 0, ~/~/ Урожайность 5233 + "area": 0, ~/~/ Площадь поля, Га 5234 + "total": 0, ~/~/ Валовый сбор 5235 + "productivityFact": 0, ~/~/ Фактическая урожайность 5236 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5237 + "totalFact": 0, ~/~/ Фактический валовый сбор 5238 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5239 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5240 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5241 + "isyearplan": true, ~/~/ Годовой план 5242 + "comment": "string" ~/~/ Комментарий 5243 + } 5244 + ] 5245 +} 5246 +))) 5247 + 5248 +((( 5249 + 5250 +))) 5251 + 5252 +Пример ответа: 5253 + 5254 +((( 5255 +((( 5256 +{ 5257 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5258 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5259 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5260 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5261 + "cropRotations": [ ~/~/ Данные по севообороту 5262 + { 5263 + "landId": 0, ~/~/ ID поля 5264 + "landName": "string", ~/~/ Название поля 5265 + "year": 0, ~/~/ Год урожая 5266 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5267 + "cultureName": "string", ~/~/ Название культуры 5268 + "productivity": 0, ~/~/ Урожайность 5269 + "area": 0, ~/~/ Площадь поля, Га. 5270 + "total": 0, ~/~/ Валовый сбор 5271 + "productivityFact": 0, ~/~/ Фактическая урожайность 5272 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5273 + "totalFact": 0, ~/~/ Фактический валовый сбор 5274 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5275 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5276 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5277 + "isyearplan": true, ~/~/ годовой план 5278 + "comment": "string" ~/~/ Комментарий 5279 + } 5280 + ], 5281 + "cropVegetation": [ ~/~/ История вегетации поля 5282 + { 5283 + "values": [ ~/~/ Данные вегетации и состояния посева 5284 + { 5285 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5286 + "ndvi": 0 ~/~/ Индекс вегетации 5287 + } 5288 + ], 5289 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5290 + { 5291 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5292 + "type": "string", ~/~/ Тип 5293 + "pictureid": "string" ~/~/ Идентификатор ресурса 5294 + } 5295 + ], 5296 + "states": [ ~/~/ Ключевые даты развития поля 5297 + { 5298 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5299 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5300 + } 5301 + ] 5302 + } 5303 + ], 5304 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5305 + "counts": { 5306 + "fieldOperations": 0, ~/~/ Количество операций на поле 5307 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5308 + "facts": 0 ~/~/ Счётчик факта 5309 + }, 5310 + "planComment": "string", ~/~/ Комментарий к полю 5311 +))) 5312 + 5313 +((( 5314 + "productivity": 0, ~/~/ Урожайность. 5315 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5316 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5317 + "year": 0, ~/~/ Год поля 5318 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5319 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5320 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5321 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5322 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5323 + "id": 0, ~/~/ Идентификатор объекта геозоны 5324 + "name": "string", ~/~/ Название объекта геозоны 5325 + "type": 0, ~/~/ Тип объекта геозоны 5326 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5327 + "fname": "string", ~/~/ Имя файла 5328 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5329 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5330 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5331 + "description": "string", ~/~/ Описание объекта геозоны 5332 + "area": 0, ~/~/ Площадь, м2 5333 + "perimetr": 0, ~/~/ Периметр, м 5334 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5335 +} 5336 + 5337 + 5338 +))) 5339 +))) 5340 +))) 5341 + 5342 +== **Получение поля по id** == 5343 + 5344 +(% class="box infomessage" %) 5345 +((( 5346 +**GET /api/v3/agroLands/{id}** 5347 +))) 5348 + 5349 +Пример запроса: 5350 +id ~/~/ Идентификатор поля 5351 + 5352 +Пример ответа: 5353 + 5354 +((( 5355 +{ 5356 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5357 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5358 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5359 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5360 + "cropRotations": [ ~/~/ Данные по севообороту 5361 + { 5362 + "landId": 0, ~/~/ ID поля 5363 + "landName": "string", ~/~/ Название поля 5364 + "year": 0, ~/~/ Год урожая 5365 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5366 + "cultureName": "string", ~/~/ Название культуры 5367 + "productivity": 0, ~/~/ Урожайность 5368 + "area": 0, ~/~/ Площадь поля, Га 5369 + "total": 0, ~/~/ Валовый сбор 5370 + "productivityFact": 0, ~/~/ Фактическая урожайность 5371 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5372 + "totalFact": 0, ~/~/ Фактический валовый сбор 5373 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5374 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5375 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5376 + "isyearplan": true, ~/~/ План года 5377 + "comment": "string" ~/~/ Комментарий 5378 + } 5379 + ], 5380 + "cropVegetation": [ ~/~/ История вегетации поля 5381 + { 5382 + "values": [ ~/~/ Данные вегетации и состояния посева 5383 + { 5384 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5385 + "ndvi": 0 ~/~/ Индекс вегетации 5386 + } 5387 + ], 5388 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5389 + { 5390 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5391 + "type": "string", ~/~/ Тип 5392 + "pictureid": "string" ~/~/ Идентификатор ресурса 5393 + } 5394 + ], 5395 + "states": [ ~/~/ Ключевые даты развития поля 5396 + { 5397 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5398 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5399 + } 5400 + ] 5401 + } 5402 + ], 5403 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5404 + "counts": { 5405 + "fieldOperations": 0, ~/~/ Количество операций на поле 5406 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5407 + "facts": 0 ~/~/ Счётчик факта 5408 + }, 5409 + "planComment": "string", ~/~/ Комментарий к полю 5410 + "productivity": 0, ~/~/ Урожайность. 5411 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5412 +))) 5413 + 5414 +((( 5415 +((( 5416 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5417 + "year": 0, ~/~/ Год поля 5418 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5419 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5420 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5421 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5422 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5423 + "id": 0, ~/~/ Идентификатор объекта геозоны 5424 + "name": "string", ~/~/ Название объекта геозоны 5425 + "type": 0, ~/~/ Тип объекта геозоны 5426 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5427 + "fname": "string", ~/~/ Имя файла 5428 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5429 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5430 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5431 + "description": "string", ~/~/ Описание объекта геозоны 5432 + "area": 0, ~/~/ Площадь, м2 5433 + "perimetr": 0, ~/~/ Периметр, м 5434 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5435 +} 5436 +))) 5437 + 5438 + 5439 +((( 5440 +((( 5441 +((( 5442 +== **Изменение поля** == 5443 + 5444 +(% class="box infomessage" %) 5445 +((( 5446 +**PUT /api/v3/agroLands** 5447 +))) 5448 + 5449 +Пример запроса: 5450 + 5451 +((( 5452 +((( 5453 +{ 5454 + "id": 0, ~/~/ Идентификатор поля 5455 + "extId": "string", ~/~/ ExtId 5456 + "shape": "string", ~/~/ Форма поля 5457 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5458 + "display": "string", ~/~/ Настройки отображения 5459 + "year": 0, ~/~/ Год поля 5460 + "name": "string", ~/~/ Наименование 5461 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5462 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5463 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5464 + "planComment": "string", ~/~/Комментарий к полю 5465 + "cropRotations": [ ~/~/ Данные по севообороту 5466 + { 5467 + "landId": 0, ~/~/ ID поля 5468 + "landName": "string", ~/~/ Название поля 5469 + "year": 0, ~/~/ Год урожая 5470 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5471 + "cultureName": "string", ~/~/ Название культуры 5472 + "productivity": 0, ~/~/ Урожайность 5473 + "area": 0, ~/~/ Площадь поля, Га. 5474 + "total": 0, ~/~/ Валовый сбор 5475 + "productivityFact": 0, ~/~/ Фактическая урожайность 5476 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5477 + "totalFact": 0, ~/~/ Фактический валовый сбор 5478 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5479 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5480 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5481 + "isyearplan": true, 5482 + "comment": "string" ~/~/ Комментарий 5483 + } 5484 + ], 5485 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5486 +} 5487 +))) 5488 +))) 5489 + 5490 +((( 5491 + 5492 +))) 5493 + 5494 +Пример ответа: 5495 + 5496 +((( 5497 +((( 5498 +((( 5499 +{ 5500 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5501 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5502 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5503 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5504 + "cropRotations": [ ~/~/ Данные по севообороту 5505 + { 5506 + "landId": 0, ~/~/ ID поля 5507 + "landName": "string", ~/~/ Название поля 5508 + "year": 0, ~/~/ Год урожая 5509 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5510 + "cultureName": "string", ~/~/ Название культуры 5511 + "productivity": 0, ~/~/ Урожайность 5512 + "area": 0, ~/~/ Площадь поля, Га 5513 + "total": 0, ~/~/ Валовый сбор 5514 + "productivityFact": 0, ~/~/ Фактическая урожайность 5515 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5516 + "totalFact": 0, ~/~/ Фактический валовый сбор 5517 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5518 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5519 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5520 + "isyearplan": true, ~/~/ 5521 + "comment": "string" ~/~/ Комментарий 5522 + } 5523 + ], 5524 + "cropVegetation": [ ~/~/ История вегетации поля 5525 + { 5526 + "values": [ ~/~/ Данные вегетации и состояния посева 5527 + { 5528 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5529 + "ndvi": 0 ~/~/ Индекс вегетации 5530 + } 5531 + ], 5532 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5533 + { 5534 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5535 + "type": "string", ~/~/ Тип 5536 + "pictureid": "string" ~/~/ Идентификатор ресурса 5537 + } 5538 + ], 5539 + "states": [ ~/~/ Ключевые даты развития поля 5540 + { 5541 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5542 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5543 + } 5544 + ] 5545 + } 5546 + ], 5547 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5548 + "counts": { 5549 + "fieldOperations": 0, ~/~/ Количество операций на поле 5550 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5551 + "facts": 0 ~/~/ Счётчик факта 5552 + }, 5553 + "planComment": "string", ~/~/ Комментарий к полю 5554 + "productivity": 0, ~/~/ Урожайность. 5555 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5556 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5557 + "year": 0, ~/~/ Год поля 5558 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5559 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5560 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5561 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5562 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5563 + "id": 0, ~/~/ Идентификатор объекта геозоны 5564 + "name": "string", ~/~/ Название объекта геозоны 5565 + "type": 0, ~/~/ Тип объекта геозоны 5566 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5567 + "fname": "string", ~/~/ Имя файла 5568 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5569 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5570 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5571 + "description": "string", ~/~/ Описание объекта геозоны 5572 + "area": 0, ~/~/ Площадь, м2 5573 + "perimetr": 0, ~/~/ Периметр, м 5574 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5575 +} 5576 +))) 5577 +))) 5578 +))) 5579 +))) 5580 +))) 5581 + 5582 + 5583 +== **Редактирование года урожая ** == 5584 + 5585 +(% class="box successmessage" %) 5586 +((( 5587 +**POST /api/v3/agroLands/updateOpenCloseYear** 5588 +))) 5589 + 5590 +Пример запроса: 5591 + 5592 +((( 5593 +((( 5594 +{ 5595 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5596 + 0 5597 + ], 5598 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5599 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5600 +} 5601 +))) 5602 + 5603 + 5604 +))) 5605 + 5606 +Пример ответа: 5607 + 5608 +((( 5609 +((( 5610 +{ 5611 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5612 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5613 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5614 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5615 + "cropRotations": [ ~/~/ Данные по севообороту 5616 + { 5617 + "landId": 0, ~/~/ ID поля 5618 + "landName": "string", ~/~/ Название поля 5619 + "year": 0, ~/~/ Год урожая 5620 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5621 + "cultureName": "string", ~/~/ Название культуры 5622 + "productivity": 0, ~/~/ Урожайность 5623 + "area": 0, ~/~/ Площадь поля, Га. 5624 + "total": 0, ~/~/ Валовый сбор 5625 + "productivityFact": 0, ~/~/ Фактическая урожайность 5626 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5627 + "totalFact": 0, ~/~/ Фактический валовый сбор 5628 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5629 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5630 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5631 + "isyearplan": true, ~/~/ 5632 + "comment": "string" ~/~/ Комментарий 5633 + } 5634 + ], 5635 + "cropVegetation": [ ~/~/ История вегетации поля 5636 + { 5637 + "values": [ ~/~/ Данные вегетации и состояния посева 5638 + { 5639 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5640 + "ndvi": 0 ~/~/ Индекс вегетации 5641 + } 5642 + ], 5643 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5644 + { 5645 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5646 + "type": "string", ~/~/ Тип 5647 + "pictureid": "string" ~/~/ Идентификатор ресурса 5648 + } 5649 + ], 5650 + "states": [ ~/~/ Ключевые даты развития поля 5651 + { 5652 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5653 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5654 + } 5655 + ] 5656 + } 5657 + ], 5658 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5659 + "counts": { 5660 + "fieldOperations": 0, ~/~/ Количество операций на поле 5661 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5662 + "facts": 0 ~/~/ Счётчик факта 5663 + }, 5664 + "planComment": "string", ~/~/ Комментарий к полю 5665 + "productivity": 0, ~/~/ Урожайность. 5666 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5667 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5668 + "year": 0, ~/~/ Год поля 5669 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5670 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5671 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5672 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5673 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5674 + "id": 0, ~/~/ Идентификатор объекта геозоны 5675 + "name": "string", ~/~/ Название объекта геозоны 5676 + "type": 0, ~/~/ Тип объекта геозоны 5677 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5678 + "fname": "string", ~/~/ Имя файла 5679 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5680 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5681 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5682 + "description": "string", ~/~/ Описание объекта геозоны 5683 + "area": 0, ~/~/ Площадь, м2 5684 + "perimetr": 0, ~/~/ ериметр, м 5685 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5686 +} 5687 + 5688 + 5689 +== **Какие поля посещал объект** == 5690 + 5691 +(% class="box successmessage" %) 5692 +((( 5693 +**POST /api/v3/agroLands/visitingByVehicle** 5694 +))) 5695 + 5696 +Пример запроса: 5697 + 5698 +{ 5699 + "vehicleId": 0, ~/~/ id объекта 5700 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5701 + "byTime": 0, ~/~/ Объединение событий по времени 5702 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5703 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5704 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5705 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5706 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5707 +} 5708 + 5709 +Пример ответа: 5710 + 5711 +[ 5712 + { 5713 + "fieldId": 0, ~/~/ id объекта 5714 + "vehicleName": "string", ~/~/ Наименование объекта 5715 + "fieldName": "string", ~/~/ Наименование поля 5716 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5717 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5718 + "vehicleId": 0, ~/~/ Идентификатор ТС 5719 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5720 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5721 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5722 + "mileage": 0 ~/~/ Пробег 5723 + } 5724 +] 5725 +))) 5726 + 5727 + 5728 +== **Посещение поля объектами ** == 5729 + 5730 +(% class="box successmessage" %) 5731 +((( 5732 +**POST /api/v3/agroLands/visitingByField** 5733 +))) 5734 + 5735 +Пример запроса: 5736 +{ 5737 + "fieldId": 0, ~/~/ ID поля 5738 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5739 + "byTime": 0, ~/~/ Объединение событий по времени 5740 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5741 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5742 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5743 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5744 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5745 +} 5746 + 5747 +Пример ответа: 5748 + 5749 +[ 5750 + { 5751 + "fieldId": 0, ~/~/ ID поля 5752 + "vehicleName": "string", ~/~/ Наименование объекта 5753 + "fieldName": "string", ~/~/ Имя поля 5754 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5755 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5756 + "vehicleId": 0, ~/~/ Идентификатор ТС 5757 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5758 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5759 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5760 + "mileage": 0 ~/~/ Пробег 5761 + } 5762 +] 5763 + 5764 + 5765 +== **Удаление существующего поля** == 5766 + 5767 +(% class="box errormessage" %) 5768 +((( 5769 +**DELETE /api/v3/agroLands/{id}** 5770 +))) 5771 + 5772 +Пример запроса: 5773 +id ~/~/ Идентификатор поля 5774 + 5775 +Пример ответа: 5776 + 5777 +((( 5778 +200 ~/~/ Успех 5779 + 5780 + 5781 +))) 5782 + 5783 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5784 +))) 5785 +))) 5786 +))) 5787 + 5788 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5789 + 5790 + 5791 +(% class="box infomessage" %) 5792 +((( 5793 +**GET api/v3/Vehicles/recyclebin/all** 5794 +))) 5795 + 5796 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5797 + 5798 +Параметр запроса: {parentId} - идентификатор агента 5799 + 5800 +В заголовках запроса: X-Auth: Токен авторизации 5801 + 5802 +Ответ: 5803 + 5804 +[ 5805 + { 5806 + "recordTime": "", ~/~/Время записи 5807 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5808 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5809 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5810 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5811 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5812 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5813 + "items": [ ~/~/ 5814 +nullable: true ~/~/Детали 5815 + { 5816 + "name": "string", ~/~/наименование столбца 5817 + "value": "string" ~/~/содержание столбца 5818 + } 5819 + ] 5820 + }, 5821 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5822 + "string" 5823 + ] 5824 + } 5825 +] 5826 + 5827 + 5828 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5829 + 5830 +(% class="box infomessage" %) 5831 +((( 5832 +**POST api/v3/Vehicles/recyclebin/erase** 5833 +))) 5834 + 5835 +В заголовках запроса: X-Auth: Токен авторизации 5836 + 5837 +Пример запроса: 5838 + 5839 +[ 5840 +0 5841 +] 5842 + 5843 + 5844 +Пример ответа: 5845 + 5846 +[ 5847 +{ 5848 + "recordTime": "", ~/~/Время записи 5849 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5850 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5851 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5852 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5853 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5854 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5855 + "items": [ ~/~/Детали 5856 + { 5857 + "name": "", ~/~/Имя свойства 5858 + "value": "" ~/~/Значение свойства 5859 + } 5860 + ] 5861 + }, 5862 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5863 + "" 5864 + ] 5865 + } 5866 +] 5867 + 5868 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5869 + 5870 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5871 + 5872 +(% class="box infomessage" %) 5873 +((( 5874 +**POST api/v3/Vehicles/recyclebin/restore** 5875 +))) 5876 + 5877 +В заголовках запроса: X-Auth: Токен авторизации 5878 + 5879 +Параметры в теле запроса (JSON): 5880 + 5881 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5882 + 5883 +В заголовках запроса: X-Auth: Токен авторизации 5884 + 5885 + 5886 +Пример запроса: 5887 + 5888 +((( 5889 +[ 5890 +))) 5891 + 5892 +((( 5893 + 0 5894 +))) 5895 + 5896 +((( 5897 +] 5898 +))) 5899 + 5900 + 5901 +Пример ответа: 5902 + 5903 +[ 5904 +{ 5905 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5906 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5907 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5908 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5909 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5910 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5911 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5912 + "items": [ ~/~/Детали 5913 + { 5914 + "name": "string", ~/~/Имя свойства 5915 + "value": "string" ~/~/Значение свойства 5916 + } 5917 + ] 5918 + }, 5919 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5920 + "string" 5921 + ] 5922 + } 5923 +] 5924 + 5925 + 5926 += **Раздел: Журнал заданий ** = 5927 + 5928 + 5929 +== **Создание задания в Журнале заданий** == 5930 + 5931 +(% class="box infomessage" %) 5932 +((( 5933 +**POST /api/v3/vehicletasks** 5934 +))) 5935 + 5936 +Пример запроса: 5937 + 5938 +((( 5939 +{ 5940 + "vehicleId": 0, ~/~/ Идентификатор ТС 5941 + "description": "string", ~/~/ Описание 5942 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5943 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5944 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5945 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5946 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5947 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5948 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5949 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5950 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5951 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5952 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5953 + "cost": { 5954 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5955 + "Name": "string", ~/~/ Наименование 5956 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5957 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5958 + "Norm": 0 ~/~/ Норма внесения 5959 + }, 5960 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5961 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5962 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5963 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5964 + "deleted": true, ~/~/ Признак удаления 5965 + "extId": "string", 5966 + "GeoIds": [ ~/~/ Cвязанные поля 5967 + 0 5968 + ] 5969 +} 5970 +))) 5971 + 5972 + 5973 +Пример ответа: 5974 + 5975 +{ 5976 + "vehicleId": 0, ~/~/ Идентификатор ТС 5977 + "description": "string", ~/~/ Описание 5978 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5979 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5980 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5981 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5982 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5983 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5984 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5985 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5986 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5987 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5988 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5989 + "cost": { 5990 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5991 + "Name": "string", ~/~/ Наименование 5992 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5993 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5994 + "Norm": 0 ~/~/ Норма внесения 5995 + }, 5996 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5997 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5998 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5999 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6000 + "deleted": true, ~/~/ Признак удаления 6001 + "extId": "string", ~/~/ ExtId 6002 + "GeoIds": [ ~/~/ Связанные поля 6003 + 0 6004 + ] 6005 +} 6006 + 6007 + 6008 +== **Редактирование задания в Журнале заданий** == 6009 + 6010 +(% class="box successmessage" %) 6011 +((( 6012 +**PUT /api/v3/vehicletasks** 6013 +))) 6014 + 6015 +Пример запроса: 6016 + 6017 +((( 6018 +{ 6019 + "vehicleId": 0, ~/~/ Идентификатор ТС 6020 + "description": "string", ~/~/ Описание 6021 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6022 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6023 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 6024 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 6025 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6026 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6027 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6028 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6029 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6030 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6031 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6032 + "cost": { 6033 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6034 + "Name": "string", ~/~/ Наименование 6035 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6036 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6037 + "Norm": 0 ~/~/ Норма внесения 6038 + }, 6039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6040 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6041 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 6042 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 6043 + "deleted": true, ~/~/ Признак удаления 6044 + "extId": "string", ~/~/ ExtId 6045 + "GeoIds": [ ~/~/ Связанные поля 6046 + 0 6047 + ] 6048 +} 6049 +))) 6050 + 6051 + 6052 +Пример ответа: 6053 + 6054 +{ 6055 + "vehicleId": 0, ~/~/ Идентификатор ТС 6056 + "description": "string", ~/~/ Описание 6057 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6058 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6059 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6060 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6061 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6062 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6063 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6064 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6065 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6066 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6067 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6068 + "cost": { 6069 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6070 + "Name": "string", ~/~/ Наименование 6071 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6072 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6073 + "Norm": 0 ~/~/ Норма внесения 6074 + }, 6075 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6076 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6077 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6078 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6079 + "deleted": true, ~/~/ Признак удаления 6080 + "extId": "string", ~/~/ ExtId 6081 + "GeoIds": [ ~/~/ Связанные поля 6082 + 0 6083 + ] 6084 +} 6085 + 6086 + 6087 +== **Удаление задания в Журнале заданий** == 6088 + 6089 +(% class="box warningmessage" %) 6090 +((( 6091 +**DELETE /api/v3/vehicletasks** 6092 +))) 6093 + 6094 +Пример запроса: 6095 + 6096 +((( 6097 +[ 6098 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6099 +] 6100 +))) 6101 + 6102 +((( 6103 + 6104 +))) 6105 + 6106 +Пример ответа: 6107 + 6108 +{ 6109 + "vehicleId": 0, ~/~/ Идентификатор ТС 6110 + "description": "string", ~/~/ Описание 6111 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6112 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6113 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6114 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6115 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6116 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6117 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6118 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6119 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6120 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6121 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6122 + "cost": { 6123 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6124 + "Name": "string", ~/~/ Наименование 6125 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6126 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6127 + "Norm": 0 ~/~/ Норма внесения 6128 + }, 6129 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6130 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6131 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6132 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6133 + "deleted": true, ~/~/ Признак удаления 6134 + "extId": "string", ~/~/ ExtId 6135 + "GeoIds": [ ~/~/ Связанные поля 6136 + 0 6137 + ] 6138 +} 6139 + 6140 + 6141 +== **Получение списка Журнала заданий** == 6142 + 6143 +(% class="box infomessage" %) 6144 +((( 6145 +**POST /api/v3/vehicletasks/getbyperiod** 6146 +))) 6147 + 6148 +Пример запроса: 6149 + 6150 +((( 6151 +{ 6152 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6153 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6154 + "TimeZone": 0, ~/~/ Часовой пояс. 6155 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6156 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6157 + ], 6158 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6159 + 0 6160 + ], 6161 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6162 + 0 6163 + ], 6164 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6165 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6166 +} 6167 +))) 6168 + 6169 + 6170 +Пример ответа: 6171 + 6172 +((( 6173 +{ 6174 + "total": 0, ~/~/ Общее количество записей 6175 + "pages": 0, ~/~/ Общее количество страниц 6176 + "currentPage": 0, ~/~/ Текущая страница 6177 + "items": [ ~/~/ Записи 6178 + { 6179 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6180 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6181 + "name": "string", ~/~/ Название задания. 6182 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6183 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6184 + "workKind": "string", ~/~/ Вид работ 6185 + "techOp": "string", ~/~/ Тех. операция 6186 + "trailerModel": "string", ~/~/ Модель агрегата 6187 + "width": "string", ~/~/ Ширина, м 6188 + "speed": "string", ~/~/ Тех. скорость 6189 + "fields": "string", ~/~/ Поля 6190 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6191 + "vehicles": "string", ~/~/ Объект-модель 6192 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6193 + "drivers": "string", ~/~/ Водители 6194 + "tmc": "string", ~/~/ ТМЦ 6195 + "client": "string", ~/~/ Клиент 6196 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6197 + "dep": "string", ~/~/ Подразделение 6198 + "geoIds": [ ~/~/ Связанные поля 6199 + 0 6200 + ] 6201 + } 6202 + ] 6203 +} 6204 +))) 6205 + 6206 + 6207 += **Раздел: Роли** = 6208 + 6209 +== **Получение списка клиентских и системных ролей пользователя ** == 6210 + 6211 +(% class="box successmessage" %) 6212 +((( 6213 +**POST /api/v3/groups/find** 6214 +))) 6215 + 6216 +Пример запроса: 6217 + 6218 +((( 6219 +{ 6220 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6221 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6222 +} 6223 +))) 6224 + 6225 +((( 6226 + 6227 +))) 6228 + 6229 +((( 6230 +Пример ответа: 6231 +))) 6232 + 6233 +((( 6234 +((( 6235 +{ 6236 + "groups": [ ~/~/ Системные роли пользователя 6237 + { 6238 + "code": "string", ~/~/ Код роли. 6239 + "name": "string", ~/~/ Имя 6240 + "shortName": "string" ~/~/ Короткое имя 6241 + } 6242 + ], 6243 + "customGroups": [ ~/~/ Системные роли пользователя 6244 + { 6245 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6246 + "name": "string", ~/~/ Наименование 6247 + "shortName": "string", ~/~/ Короткое наименование 6248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6249 + } 6250 + ] 6251 +} 6252 +))) 6253 +))) 6254 + 6255 +((( 6256 + 6257 +))) 6258 + 6259 +((( 6260 + 6261 +))) 6262 + 6263 += **Раздел: Локатор ** = 6264 + 6265 + 6266 +== **Получение данных по локатору** == 6267 + 6268 +(% class="box infomessage" %) 6269 +((( 6270 +**GET /api/v3/locators/{locatorId}** 6271 +))) 6272 + 6273 +В запросе указывается locatorid - идентификатор локатора 6274 + 6275 + 6276 +Пример ответа: 6277 + 6278 +((( 6279 +((( 6280 +{ 6281 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6282 + 0 6283 + ], 6284 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6285 + 0 6286 + ], 6287 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6288 + 0 6289 + ], 6290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6291 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6292 + "agentName": "string", ~/~/ Наименование агента. 6293 + "isEnabled": true, ~/~/ Активность 6294 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6295 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6296 + "name": "string", ~/~/ Наименование. 6297 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6298 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6299 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6300 + "validity": 0, ~/~/ Значение срока действия 6301 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6302 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6303 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6304 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6305 + "url": "string", ~/~/ Ссылка 6306 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6307 + 6308 + "showVehicleName": true, ~/~/ Наименование объекта 6309 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6310 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6311 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6312 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6313 + "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ГИС) 6314 + 6315 + 1 6316 + 6317 + ] 6318 +} 6319 +))) 6320 +))) 6321 + 6322 + 6323 +((( 6324 +((( 6325 + 6326 +))) 6327 +))) 6328 + 6329 + 6330 +== **Создание локатора** == 6331 + 6332 +(% class="box successmessage" %) 6333 +((( 6334 +**POST /api/v3/locators** 6335 +))) 6336 + 6337 +Пример запроса: 6338 + 6339 +((( 6340 +{ 6341 + "isEnabled": true, ~/~/ Активность 6342 + "name": "string", ~/~/ Наименование локатора 6343 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6344 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6345 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6346 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6347 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6348 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6349 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6350 + 0 6351 + ], 6352 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6353 + 0 6354 + ], 6355 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6356 + 0 6357 + ], 6358 + 6359 + "showVehicleName": true, ~/~/ Наименование объекта 6360 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6361 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6362 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6363 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6364 + "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ГИС) 6365 + 6366 + 1 6367 + 6368 + ] 6369 +} 6370 +))) 6371 + 6372 + 6373 +Пример ответа: 6374 + 6375 +((( 6376 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6377 +))) 6378 + 6379 + 6380 +== **Выводит список локаторов ** == 6381 + 6382 +(% class="box successmessage" %) 6383 +((( 6384 +**POST /api/v3/locators/find** 6385 +))) 6386 + 6387 +Пример запроса: 6388 + 6389 +((( 6390 +{ 6391 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6392 +} 6393 +))) 6394 + 6395 +((( 6396 + 6397 +))) 6398 + 6399 +((( 6400 + 6401 +))) 6402 + 6403 + 6404 +Пример ответа: 6405 + 6406 +((( 6407 +[ 6408 + { 6409 + "vehiclesCount": 0, ~/~/ Количество объектов. 6410 + "geozonesCount": 0, ~/~/ Количество геозон. 6411 + "fieldsCount": 0, ~/~/ Количество полей. 6412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6413 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6414 + "agentName": "string", ~/~/ Наименование агента. 6415 + "isEnabled": true, ~/~/ Активность локатора 6416 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6417 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6418 + "name": "string", ~/~/ Наименование локатора 6419 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6420 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6421 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6422 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6423 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6424 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6425 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6426 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6427 + "url": "string", ~/~/ ссылка на локатор 6428 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6429 + "showVehicleName": true, ~/~/ Наименование объекта 6430 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6431 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6432 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6433 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6434 + "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ГИС) 6435 + 6436 + 0 6437 + ] 6438 + } 6439 +] 6440 +))) 6441 + 6442 + 6443 +== **Изменение локатора** == 6444 + 6445 +(% class="box infomessage" %) 6446 +((( 6447 +**PUT /api/v3/locators** 6448 +))) 6449 + 6450 +Пример запроса: 6451 + 6452 +((( 6453 +{ 6454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6455 + "isEnabled": true, ~/~/ Активность 6456 + "name": "string", ~/~/ Наименование 6457 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6458 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6459 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6460 + "autoProlongation": true, ~/~/ Автопродление срока действия 6461 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6462 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6463 + 0 6464 + ], 6465 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6466 + 0 6467 + ], 6468 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6469 + 0 6470 + ], 6471 + "showVehicleName": true, ~/~/ Наименование объекта 6472 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6473 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6474 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6475 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6476 + "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ГИС) 6477 + 6478 + 0 6479 + 6480 + ] 6481 +} 6482 + 6483 + 6484 +))) 6485 + 6486 +Пример ответа: 6487 + 6488 +200 ~/~/ Success 6489 + 6490 + 6491 +== **Удалить локатор** == 6492 + 6493 +(% class="box warningmessage" %) 6494 +((( 6495 +**DELETE /api/v3/locators** 6496 +))) 6497 + 6498 +Пример запроса: 6499 + 6500 +((( 6501 +[ 6502 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6503 +] 6504 +))) 6505 + 6506 + 6507 += **Раздел: Яндекс Маршруты** = 6508 + 6509 + 6510 +== **Возвращение списка маршрутов** == 6511 + 6512 +(% class="box infomessage" %) 6513 +((( 6514 +**GET /api/v3/TransportRoutes** 6515 +))) 6516 + 6517 +Пример запроса: 6518 +Id ~/~/ Идентификатор поля 6519 + 6520 +Пример ответа: 6521 + 6522 +((( 6523 +[ 6524 + { 6525 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6526 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6527 + "name": "string", ~/~/ Наименование маршрута. 6528 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6529 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6530 + 0 6531 + ] 6532 + } 6533 +] 6534 +))) 6535 + 6536 + 6537 +== **Добавить маршрут** == 6538 + 6539 +(% class="box infomessage" %) 6540 +((( 6541 +**POST /api/v3/TransportRoutes** 6542 +))) 6543 + 6544 +Пример запроса: 6545 +{ 6546 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6548 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6549 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6550 + 0 6551 + ] 6552 +} 6553 + 6554 + 6555 +Пример ответа: 6556 + 6557 +((( 6558 +{ 6559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6560 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6561 + "name": "string", ~/~/ Определяет наименование маршрута 6562 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6563 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6564 + 0 6565 + ] 6566 +} 6567 +))) 6568 + 6569 + 6570 +== **Обновление маршрута** == 6571 + 6572 +(% class="box successmessage" %) 6573 +((( 6574 +**PUT /api/v3/TransportRoutes** 6575 +))) 6576 + 6577 +Пример запроса: 6578 + 6579 +((( 6580 +{ 6581 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6582 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6583 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6584 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6585 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6586 + 0 6587 + ] 6588 +} 6589 +))) 6590 + 6591 +Пример ответа: 6592 + 6593 +((( 6594 +{ 6595 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6596 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6597 + "name": "string", ~/~/ Определяет наименование маршрута 6598 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6599 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6600 + 0 6601 + ] 6602 +} 6603 +))) 6604 + 6605 + 6606 +== **Получить связки маршрутов ТС** == 6607 + 6608 +(% class="box infomessage" %) 6609 +((( 6610 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6611 +))) 6612 + 6613 +Пример запроса: 6614 + 6615 +((( 6616 +[ 6617 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6618 +] 6619 +))) 6620 + 6621 +Пример ответа: 6622 + 6623 +((( 6624 +[ 6625 + { 6626 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6627 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6628 + } 6629 +] 6630 +))) 6631 + 6632 + 6633 +== **Удалить маршрут** == 6634 + 6635 +(% class="box warningmessage" %) 6636 +((( 6637 +**DELETE /api/v3/TransportRoutes/{id}** 6638 +))) 6639 + 6640 +Пример запроса: 6641 +Id ~/~/ Идентификатор поля 6642 + 6643 + 6644 += **Раздел: Управление доступа к машинам** = 6645 + 6646 + 6647 +== Получение списка транспортных средств видимых пользователю == 6648 + 6649 +(% class="box infomessage" %) 6650 +((( 6651 +**GET /api/v3/UserVisibleVehicles/{userId}** 6652 +))) 6653 + 6654 +Пример ответа: 6655 + 6656 +((( 6657 +{ 6658 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6659 + 0 6660 + ] 6661 +} 6662 +))) 6663 + 6664 + 6665 +== Задает видимость транспортных средств пользователю == 6666 + 6667 +(% class="box infomessage" %) 6668 +((( 6669 +**POST /api/v3/UserVisibleVehicles** 6670 +))) 6671 + 6672 +Пример запроса: 6673 + 6674 +((( 6675 +((( 6676 +{ 6677 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6678 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6679 + 0 6680 + ] 6681 +} 6682 +))) 6683 + 6684 +((( 6685 + 6686 +))) 6687 + 6688 +((( 6689 +Пример ответа : 6690 +))) 6691 + 6692 +((( 6693 + 6694 +))) 6695 + 6696 +((( 6697 +200 ~/~/ Success 6698 +))) 6699 +))) 6700 + 6701 + 3542 3542 (% class="box" lang="en-US" style="text-align: center;" %) 3543 3543 ((( 3544 3544 (% 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]] **